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

   1 /*
   2  *
   3  *   dev.c  -- low level operations on device (storage device)
   4  *
   5  *              Kern Sibbald
   6  *
   7  *     NOTE!!!! None of these routines are reentrant. You must
   8  *        use lock_device() and unlock_device() at a higher level,
   9  *        or use the xxx_device() equivalents.  By moving the
  10  *        thread synchronization to a higher level, we permit
  11  *        the higher level routines to "seize" the device and
  12  *        to carry out operations without worrying about who
  13  *        set what lock (i.e. race conditions).
  14  *
  15  *     Note, this is the device dependent code, and my have
  16  *           to be modified for each system, but is meant to
  17  *           be as "generic" as possible.
  18  *
  19  *     The purpose of this code is to develop a SIMPLE Storage
  20  *     daemon. More complicated coding (double buffering, writer
  21  *     thread, ...) is left for a later version.
  22  *
  23  *     Unfortunately, I have had to add more and more complication
  24  *     to this code. This was not foreseen as noted above, and as
  25  *     a consequence has lead to something more contorted than is
  26  *     really necessary -- KES.  Note, this contortion has been
  27  *     corrected to a large extent by a rewrite (Apr MMI).
  28  *
  29  *   Version $Id$
  30  */
  31 /*
  32    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  33
  34    This program is free software; you can redistribute it and/or
  35    modify it under the terms of the GNU General Public License as
  36    published by the Free Software Foundation; either version 2 of
  37    the License, or (at your option) any later version.
  38
  39    This program is distributed in the hope that it will be useful,
  40    but WITHOUT ANY WARRANTY; without even the implied warranty of
  41    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  42    General Public License for more details.
  43
  44    You should have received a copy of the GNU General Public
  45    License along with this program; if not, write to the Free
  46    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  47    MA 02111-1307, USA.
  48
  49  */
  50
  51 /*
  52  * Handling I/O errors and end of tape conditions are a bit tricky.
  53  * This is how it is currently done when writting.
  54  * On either an I/O error or end of tape,
  55  * we will stop writing on the physical device (no I/O recovery is
  56  * attempted at least in this daemon). The state flag will be sent
  57  * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
  58  * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
  59  * cleared only when the problem goes away.  Now when ST_WEOT
  60  * is set all calls to write_dev() are handled as usual. However,
  61  * in write_block() instead of attempting to write the block to
  62  * the physical device, it is chained into a list of blocks written
  63  * after the EOT condition.  In addition, all threads are blocked
  64  * from writing on the tape by calling lock(), and thread other
  65  * than the first thread to hit the EOT will block on a condition
  66  * variable. The first thread to hit the EOT will continue to
  67  * be able to read and write the tape (he sort of tunnels through
  68  * the locking mechanism -- see lock() for details).
  69  *
  70  * Now presumably somewhere higher in the chain of command
  71  * (device.c), someone will notice the EOT condition and
  72  * get a new tape up, get the tape label read, and mark
  73  * the label for rewriting. Then this higher level routine
  74  * will write the unwritten buffer to the new volume.
  75  * Finally, he will release
  76  * any blocked threads by doing a broadcast on the condition
  77  * variable.  At that point, we should be totally back in
  78  * business with no lost data.
  79  */
  80
  81
  82 #include "bacula.h"
  83 #include "stored.h"
  84
  85 /* Forward referenced functions */
  86 int dev_is_tape(DEVICE *dev);
  87 void clrerror_dev(DEVICE *dev, int func);
  88 int fsr_dev(DEVICE *dev, int num);
  89
  90 extern int debug_level;
  91
  92 /*
  93  * Allocate and initialize the DEVICE structure
  94  * Note, if dev is non-NULL, it is already allocated,
  95  * thus we neither allocate it nor free it. This allows
  96  * the caller to put the packet in shared memory.
  97  *
  98  *  Note, for a tape, the device->device_name is the device name
  99  *     (e.g. /dev/nst0), and for a file, the device name
 100  *     is the directory in which the file will be placed.
 101  *
 102  */
 103 DEVICE *
 104 init_dev(DEVICE *dev, DEVRES *device)
 105 {
 106    struct stat statp;
 107    int tape, fifo;
 108    int errstat;
 109
 110    /* Check that device is available */
 111    if (stat(device->device_name, &statp) < 0) {
 112       if (dev) {
 113          dev->dev_errno = errno;
 114       }
 115       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
 116             strerror(errno));
 117       return NULL;
 118    }
 119    tape = FALSE;
 120    fifo = FALSE;
 121    if (S_ISDIR(statp.st_mode)) {
 122       tape = FALSE;
 123    } else if (S_ISCHR(statp.st_mode)) {
 124       tape = TRUE;
 125    } else if (S_ISFIFO(statp.st_mode)) {
 126       fifo = TRUE;
 127    } else {
 128       if (dev) {
 129          dev->dev_errno = ENODEV;
 130       }
 131       Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
 132          dev_name, statp.st_mode);
 133       return NULL;
 134    }
 135    if (!dev) {
 136       dev = (DEVICE *)get_memory(sizeof(DEVICE));
 137       memset(dev, 0, sizeof(DEVICE));
 138       dev->state = ST_MALLOC;
 139    } else {
 140       memset(dev, 0, sizeof(DEVICE));
 141    }
 142
 143    /* Copy user supplied device parameters from Resource */
 144    dev->dev_name = get_memory(strlen(device->device_name)+1);
 145    strcpy(dev->dev_name, device->device_name);
 146    dev->capabilities = device->cap_bits;
 147    dev->min_block_size = device->min_block_size;
 148    dev->max_block_size = device->max_block_size;
 149    dev->max_volume_jobs = device->max_volume_jobs;
 150    dev->max_volume_files = device->max_volume_files;
 151    dev->max_volume_size = device->max_volume_size;
 152    dev->max_file_size = device->max_file_size;
 153    dev->volume_capacity = device->volume_capacity;
 154    dev->max_rewind_wait = device->max_rewind_wait;
 155    dev->max_open_wait = device->max_open_wait;
 156    dev->max_open_vols = device->max_open_vols;
 157    dev->device = device;
 158
 159    if (tape) {
 160       dev->state |= ST_TAPE;
 161    } else if (fifo) {
 162       dev->state |= ST_FIFO;
 163       dev->capabilities |= CAP_STREAM; /* set stream device */
 164    } else {
 165       dev->state |= ST_FILE;
 166    }
 167
 168    if (dev->max_block_size > 1000000) {
 169       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
 170          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
 171       dev->max_block_size = 0;
 172    }
 173    if (dev->max_block_size % TAPE_BSIZE != 0) {
 174       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
 175          dev->max_block_size, dev->dev_name);
 176    }
 177
 178    dev->errmsg = get_pool_memory(PM_EMSG);
 179    *dev->errmsg = 0;
 180
 181    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 182       dev->dev_errno = errstat;
 183       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
 184       Emsg0(M_FATAL, 0, dev->errmsg);
 185    }
 186    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 187       dev->dev_errno = errstat;
 188       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 189       Emsg0(M_FATAL, 0, dev->errmsg);
 190    }
 191    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
 192       dev->dev_errno = errstat;
 193       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 194       Emsg0(M_FATAL, 0, dev->errmsg);
 195    }
 196    dev->fd = -1;
 197    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 198    return dev;
 199 }
 200
 201 /* Open the device with the operating system and
 202  * initialize buffer pointers.
 203  *
 204  * Note, for a tape, the VolName is the name we give to the
 205  *    volume (not really used here), but for a file, the
 206  *    VolName represents the name of the file to be created/opened.
 207  *    In the case of a file, the full name is the device name
 208  *    (archive_name) with the VolName concatenated.
 209  */
 210 int
 211 open_dev(DEVICE *dev, char *VolName, int mode)
 212 {
 213    POOLMEM *archive_name;
 214
 215    if (dev->state & ST_OPENED) {
 216       /*
 217        *  *****FIXME***** how to handle two threads wanting
 218        *  different volumes mounted???? E.g. one is waiting
 219        *  for the next volume to be mounted, and a new job
 220        *  starts and snatches up the device.
 221        */
 222       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 223          return -1;
 224       }
 225       dev->use_count++;
 226       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 227             dev->dev_name, dev->use_count);
 228       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
 229       return dev->fd;
 230    }
 231    if (VolName) {
 232       strcpy(dev->VolCatInfo.VolCatName, VolName);
 233    }
 234
 235    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 236          dev->dev_name, dev->VolCatInfo.VolCatName);
 237    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 238    if (dev->state & (ST_TAPE|ST_FIFO)) {
 239       int timeout;
 240       Dmsg0(29, "open_dev: device is tape\n");
 241       if (mode == OPEN_READ_WRITE) {
 242          dev->mode = O_RDWR | O_BINARY;
 243       } else if (mode == OPEN_READ_ONLY) {
 244          dev->mode = O_RDONLY | O_BINARY;
 245       } else if (mode == OPEN_WRITE_ONLY) {
 246          dev->mode = O_WRONLY | O_BINARY;
 247       } else {
 248          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 249       }
 250       timeout = dev->max_open_wait;
 251       errno = 0;
 252       if (dev->state & ST_FIFO && timeout) {
 253          /* Set open timer */
 254          dev->tid = start_thread_timer(pthread_self(), timeout);
 255       }
 256       /* If busy retry each second for max_open_wait seconds */
 257       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 258          if (errno == EAGAIN) {
 259             continue;
 260          }
 261          if (errno == EBUSY && timeout-- > 0) {
 262             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 263             sleep(1);
 264             continue;
 265          }
 266          dev->dev_errno = errno;
 267          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 268                dev->dev_name, strerror(dev->dev_errno));
 269          /* Stop any open timer we set */
 270          if (dev->tid) {
 271             stop_thread_timer(dev->tid);
 272             dev->tid = 0;
 273          }
 274          Emsg0(M_FATAL, 0, dev->errmsg);
 275          break;
 276       }
 277       if (dev->fd >= 0) {
 278          dev->dev_errno = 0;
 279          dev->state |= ST_OPENED;
 280          dev->use_count++;
 281          update_pos_dev(dev);             /* update position */
 282       }
 283       /* Stop any open() timer we started */
 284       if (dev->tid) {
 285          stop_thread_timer(dev->tid);
 286          dev->tid = 0;
 287       }
 288       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 289    } else {
 290       /*
 291        * Handle opening of file
 292        */
 293       archive_name = get_pool_memory(PM_FNAME);
 294       pm_strcpy(&archive_name, dev->dev_name);
 295       if (archive_name[strlen(archive_name)] != '/') {
 296          pm_strcat(&archive_name, "/");
 297       }
 298       pm_strcat(&archive_name, VolName);
 299       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
 300       if (mode == OPEN_READ_WRITE) {
 301          dev->mode = O_CREAT | O_RDWR | O_BINARY;
 302       } else if (mode == OPEN_READ_ONLY) {
 303          dev->mode = O_RDONLY | O_BINARY;
 304       } else if (mode == OPEN_WRITE_ONLY) {
 305          dev->mode = O_WRONLY | O_BINARY;
 306       } else {
 307          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 308       }
 309       /* If creating file, give 0640 permissions */
 310       if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
 311          dev->dev_errno = errno;
 312          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
 313          Emsg0(M_FATAL, 0, dev->errmsg);
 314       } else {
 315          dev->dev_errno = 0;
 316          dev->state |= ST_OPENED;
 317          dev->use_count++;
 318          update_pos_dev(dev);                /* update position */
 319       }
 320       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
 321       free_pool_memory(archive_name);
 322    }
 323    return dev->fd;
 324 }
 325
 326 /*
 327  * Rewind the device.
 328  *  Returns: 1 on success
 329  *           0 on failure
 330  */
 331 int rewind_dev(DEVICE *dev)
 332 {
 333    struct mtop mt_com;
 334    unsigned int i;
 335
 336    Dmsg0(29, "rewind_dev\n");
 337    if (dev->fd < 0) {
 338       dev->dev_errno = EBADF;
 339       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
 340             dev->dev_name);
 341       Emsg0(M_FATAL, 0, dev->errmsg);
 342       return 0;
 343    }
 344    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT);  /* remove EOF/EOT flags */
 345    dev->block_num = dev->file = 0;
 346    dev->file_addr = 0;
 347    if (dev->state & ST_TAPE) {
 348       mt_com.mt_op = MTREW;
 349       mt_com.mt_count = 1;
 350       /* If we get an I/O error on rewind, it is probably because
 351        * the drive is actually busy. We loop for (about 5 minutes)
 352        * retrying every 5 seconds.
 353        */
 354       for (i=dev->max_rewind_wait; ; i -= 5) {
 355          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 356             if (i == dev->max_rewind_wait) {
 357                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
 358             }
 359             clrerror_dev(dev, MTREW);
 360             if (dev->dev_errno == EIO && i > 0) {
 361                Dmsg0(200, "Sleeping 5 seconds.\n");
 362                sleep(5);
 363                continue;
 364             }
 365             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
 366                dev->dev_name, strerror(dev->dev_errno));
 367             return 0;
 368          }
 369          break;
 370       }
 371    } else if (dev->state & ST_FILE) {
 372       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
 373          dev->dev_errno = errno;
 374          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 375             dev->dev_name, strerror(dev->dev_errno));
 376          return 0;
 377       }
 378    }
 379    return 1;
 380 }
 381
 382 /*
 383  * Position device to end of medium (end of data)
 384  *  Returns: 1 on succes
 385  *           0 on error
 386  */
 387 int
 388 eod_dev(DEVICE *dev)
 389 {
 390    struct mtop mt_com;
 391    struct mtget mt_stat;
 392    int stat = 0;
 393    off_t pos;
 394
 395    Dmsg0(29, "eod_dev\n");
 396    if (dev->state & ST_EOT) {
 397       return 1;
 398    }
 399    dev->state &= ~(ST_EOF);  /* remove EOF flags */
 400    dev->block_num = dev->file = 0;
 401    dev->file_addr = 0;
 402    if (dev->state & (ST_FIFO | ST_PROG)) {
 403       return 1;
 404    }
 405    if (!(dev->state & ST_TAPE)) {
 406       pos = lseek(dev->fd, (off_t)0, SEEK_END);
 407 //    Dmsg1(000, "====== Seek to %lld\n", pos);
 408       if (pos >= 0) {
 409          update_pos_dev(dev);
 410          dev->state |= ST_EOT;
 411          return 1;
 412       }
 413       return 0;
 414    }
 415    if (dev->capabilities & CAP_EOM) {
 416       mt_com.mt_op = MTEOM;
 417       mt_com.mt_count = 1;
 418       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
 419          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
 420          clrerror_dev(dev, mt_com.mt_op);
 421          update_pos_dev(dev);
 422          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
 423             dev->dev_name, strerror(dev->dev_errno));
 424          return 0;
 425       }
 426       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 427          dev->dev_errno = errno;
 428          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 429             dev->dev_name, strerror(dev->dev_errno));
 430          return 0;
 431       }
 432       Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 433       dev->file = mt_stat.mt_fileno;
 434
 435    /*
 436     * Rewind then use FSF until EOT reached
 437     */
 438    } else {
 439       if (!rewind_dev(dev)) {
 440          return 0;
 441       }
 442       while (!(dev->state & ST_EOT)) {
 443          Dmsg0(200, "Do fsf 1\n");
 444          if (!fsf_dev(dev, 1)) {
 445             Dmsg0(200, "fsf_dev error.\n");
 446             return 0;
 447          }
 448       }
 449    }
 450    update_pos_dev(dev);                      /* update position */
 451    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 452    return 1;
 453 }
 454
 455 /*
 456  * Set the position of the device -- only for files
 457  *   For other devices, there is no generic way to do it.
 458  *  Returns: 1 on succes
 459  *           0 on error
 460  */
 461 int update_pos_dev(DEVICE *dev)
 462 {
 463    off_t pos;
 464    int stat = 0;
 465
 466    if (dev->fd < 0) {
 467       dev->dev_errno = EBADF;
 468       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 469       Emsg0(M_FATAL, 0, dev->errmsg);
 470       return 0;
 471    }
 472
 473    /* Find out where we are */
 474    if (dev->state & ST_FILE) {
 475       dev->file = 0;
 476       dev->file_addr = 0;
 477       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 478       if (pos < 0) {
 479          Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 480          dev->dev_errno = errno;
 481          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 482             dev->dev_name, strerror(dev->dev_errno));
 483       } else {
 484          stat = 1;
 485          dev->file_addr = pos;
 486       }
 487       return stat;
 488    }
 489    return 1;
 490 }
 491
 492
 493 /*
 494  * Return the status of the device.  This was meant
 495  * to be a generic routine. Unfortunately, it doesn't
 496  * seem possible (at least I do not know how to do it
 497  * currently), which means that for the moment, this
 498  * routine has very little value.
 499  *
 500  *   Returns: 1 on success
 501  *            0 on error
 502  */
 503 int
 504 status_dev(DEVICE *dev, uint32_t *status)
 505 {
 506    struct mtget mt_stat;
 507    uint32_t stat = 0;
 508
 509    if (dev->state & (ST_EOT | ST_WEOT)) {
 510       stat |= MT_EOD;
 511       Dmsg0(-20, " EOD");
 512    }
 513    if (dev->state & ST_EOF) {
 514       stat |= MT_EOF;
 515       Dmsg0(-20, " EOF");
 516    }
 517    if (dev->state & ST_TAPE) {
 518       stat |= MT_TAPE;
 519       Dmsg0(-20," Driver status:");
 520       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 521       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 522          dev->dev_errno = errno;
 523          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 524             dev->dev_name, strerror(dev->dev_errno));
 525          return 0;
 526       }
 527       Dmsg0(-20, " Device status:");
 528
 529 #if defined(HAVE_LINUX_OS)
 530       if (GMT_EOF(mt_stat.mt_gstat)) {
 531          stat |= MT_EOF;
 532          Dmsg0(-20, " EOF");
 533       }
 534       if (GMT_BOT(mt_stat.mt_gstat)) {
 535          stat |= MT_BOT;
 536          Dmsg0(-20, " BOT");
 537       }
 538       if (GMT_EOT(mt_stat.mt_gstat)) {
 539          stat |= MT_EOT;
 540          Dmsg0(-20, " EOT");
 541       }
 542       if (GMT_SM(mt_stat.mt_gstat)) {
 543          stat |= MT_SM;
 544          Dmsg0(-20, " SM");
 545       }
 546       if (GMT_EOD(mt_stat.mt_gstat)) {
 547          stat |= MT_EOD;
 548          Dmsg0(-20, " EOD");
 549       }
 550       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 551          stat |= MT_WR_PROT;
 552          Dmsg0(-20, " WR_PROT");
 553       }
 554       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 555          stat |= MT_ONLINE;
 556          Dmsg0(-20, " ONLINE");
 557       }
 558       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 559          stat |= MT_DR_OPEN;
 560          Dmsg0(-20, " DR_OPEN");
 561       }
 562       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 563          stat |= MT_IM_REP_EN;
 564          Dmsg0(-20, " IM_REP_EN");
 565       }
 566 #endif /* !SunOS && !OSF */
 567       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 568    } else {
 569       stat |= MT_ONLINE | MT_BOT;
 570    }
 571    *status = stat;
 572    return 1;
 573 }
 574
 575
 576 /*
 577  * Load medium in device
 578  *  Returns: 1 on success
 579  *           0 on failure
 580  */
 581 int load_dev(DEVICE *dev)
 582 {
 583 #ifdef MTLOAD
 584    struct mtop mt_com;
 585 #endif
 586
 587    if (dev->fd < 0) {
 588       dev->dev_errno = EBADF;
 589       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 590       Emsg0(M_FATAL, 0, dev->errmsg);
 591       return 0;
 592    }
 593    if (!(dev->state & ST_TAPE)) {
 594       return 1;
 595    }
 596 #ifndef MTLOAD
 597    Dmsg0(200, "stored: MTLOAD command not available\n");
 598    dev->dev_errno = ENOTTY;           /* function not available */
 599    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 600          dev->dev_name, strerror(dev->dev_errno));      return 0;
 601    return 0;
 602 #else
 603
 604    dev->block_num = dev->file = 0;
 605    dev->file_addr = 0;
 606    mt_com.mt_op = MTLOAD;
 607    mt_com.mt_count = 1;
 608    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 609       dev->dev_errno = errno;
 610       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 611          dev->dev_name, strerror(dev->dev_errno));      return 0;
 612    }
 613    return 1;
 614 #endif
 615 }
 616
 617 /*
 618  * Rewind device and put it offline
 619  *  Returns: 1 on success
 620  *           0 on failure
 621  */
 622 int offline_dev(DEVICE *dev)
 623 {
 624    struct mtop mt_com;
 625
 626    if (dev->fd < 0) {
 627       dev->dev_errno = EBADF;
 628       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 629       Emsg0(M_FATAL, 0, dev->errmsg);
 630       return 0;
 631    }
 632    if (!(dev->state & ST_TAPE)) {
 633       return 1;
 634    }
 635
 636    dev->block_num = dev->file = 0;
 637    dev->file_addr = 0;
 638 #ifdef MTUNLOCK
 639    mt_com.mt_op = MTUNLOCK;
 640    mt_com.mt_count = 1;
 641    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 642 #endif
 643    mt_com.mt_op = MTOFFL;
 644    mt_com.mt_count = 1;
 645    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 646       dev->dev_errno = errno;
 647       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 648          dev->dev_name, strerror(dev->dev_errno));
 649       return 0;
 650    }
 651    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 652    return 1;
 653 }
 654
 655
 656 /*
 657  * Foward space a file
 658  *   Returns: 1 on success
 659  *            0 on failure
 660  */
 661 int
 662 fsf_dev(DEVICE *dev, int num)
 663 {
 664    struct mtop mt_com;
 665    int stat = 0;
 666    char rbuf[1024];
 667
 668    if (dev->fd < 0) {
 669       dev->dev_errno = EBADF;
 670       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 671       Emsg0(M_FATAL, 0, dev->errmsg);
 672       return 0;
 673    }
 674
 675    if (!(dev->state & ST_TAPE)) {
 676       return 1;
 677    }
 678    if (dev->state & ST_EOT) {
 679       dev->dev_errno = 0;
 680       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 681       return 0;
 682    }
 683    if (dev->state & ST_EOF)
 684       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 685    if (dev->state & ST_EOT)
 686       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 687
 688    Dmsg0(29, "fsf_dev\n");
 689    dev->block_num = 0;
 690    if (dev->capabilities & CAP_FSF) {
 691       Dmsg0(200, "FSF has cap_fsf\n");
 692       mt_com.mt_op = MTFSF;
 693       mt_com.mt_count = 1;
 694       while (num-- && !(dev->state & ST_EOT)) {
 695          Dmsg0(200, "Doing read for fsf\n");
 696          if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
 697             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 698                stat = sizeof(rbuf);   /* This is OK */
 699             } else {
 700                dev->state |= ST_EOT;
 701                clrerror_dev(dev, -1);
 702                Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
 703                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 704                   dev->dev_name, strerror(dev->dev_errno));
 705                Dmsg1(200, "%s", dev->errmsg);
 706                break;
 707             }
 708          }
 709          if (stat == 0) {                /* EOF */
 710             update_pos_dev(dev);
 711             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 712             /* Two reads of zero means end of tape */
 713             if (dev->state & ST_EOF) {
 714                dev->state |= ST_EOT;
 715                Dmsg0(200, "Set ST_EOT\n");
 716                break;
 717             } else {
 718                dev->state |= ST_EOF;
 719                dev->file++;
 720                dev->file_addr = 0;
 721                continue;
 722             }
 723          } else {                        /* Got data */
 724             dev->state &= ~(ST_EOF|ST_EOT);
 725          }
 726
 727          Dmsg0(200, "Doing MT_FSF\n");
 728          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 729          if (stat < 0) {                 /* error => EOT */
 730             dev->state |= ST_EOT;
 731             Dmsg0(200, "Set ST_EOT\n");
 732             clrerror_dev(dev, MTFSF);
 733             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 734                dev->dev_name, strerror(dev->dev_errno));
 735             Dmsg0(200, "Got < 0 for MT_FSF\n");
 736             Dmsg1(200, "%s", dev->errmsg);
 737          } else {
 738             dev->state |= ST_EOF;     /* just read EOF */
 739             dev->file++;
 740             dev->file_addr = 0;
 741          }
 742       }
 743
 744    /*
 745     * No FSF, so use FSR to simulate it
 746     */
 747    } else {
 748       Dmsg0(200, "Doing FSR for FSF\n");
 749       while (num-- && !(dev->state & ST_EOT)) {
 750          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 751       }
 752       if (dev->state & ST_EOT) {
 753          dev->dev_errno = 0;
 754          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 755          stat = -1;
 756       } else {
 757          stat = 0;
 758       }
 759    }
 760    update_pos_dev(dev);
 761    Dmsg1(200, "Return %d from FSF\n", stat);
 762    if (dev->state & ST_EOF)
 763       Dmsg0(200, "ST_EOF set on exit FSF\n");
 764    if (dev->state & ST_EOT)
 765       Dmsg0(200, "ST_EOT set on exit FSF\n");
 766    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 767    return stat == 0 ? 1 : 0;
 768 }
 769
 770 /*
 771  * Backward space a file
 772  */
 773 int
 774 bsf_dev(DEVICE *dev, int num)
 775 {
 776    struct mtop mt_com;
 777    int stat;
 778
 779    if (dev->fd < 0) {
 780       dev->dev_errno = EBADF;
 781       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 782       Emsg0(M_FATAL, 0, dev->errmsg);
 783       return -1;
 784    }
 785
 786    if (!(dev->state & ST_TAPE)) {
 787       return 0;
 788    }
 789    Dmsg0(29, "bsf_dev\n");
 790    dev->state &= ~(ST_EOT|ST_EOF);
 791    dev->file -= num;
 792    dev->file_addr = 0;
 793    mt_com.mt_op = MTBSF;
 794    mt_com.mt_count = num;
 795    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 796    if (stat < 0) {
 797       clrerror_dev(dev, MTBSF);
 798       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 799          dev->dev_name, strerror(dev->dev_errno));
 800    }
 801    update_pos_dev(dev);
 802    return stat;
 803 }
 804
 805
 806 /*
 807  * Foward space a record
 808  */
 809 int
 810 fsr_dev(DEVICE *dev, int num)
 811 {
 812    struct mtop mt_com;
 813    int stat;
 814
 815    if (dev->fd < 0) {
 816       dev->dev_errno = EBADF;
 817       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 818       Emsg0(M_FATAL, 0, dev->errmsg);
 819       return -1;
 820    }
 821
 822    if (!(dev->state & ST_TAPE)) {
 823       return 0;
 824    }
 825    Dmsg0(29, "fsr_dev\n");
 826    dev->block_num += num;
 827    mt_com.mt_op = MTFSR;
 828    mt_com.mt_count = num;
 829    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 830    if (stat == 0) {
 831       dev->state &= ~ST_EOF;
 832    } else {
 833       if (dev->state & ST_EOF) {
 834          dev->state |= ST_EOT;
 835       } else {
 836          dev->state |= ST_EOF;           /* assume EOF */
 837          dev->file++;
 838          dev->file_addr = 0;
 839       }
 840       clrerror_dev(dev, MTFSR);
 841       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 842          dev->dev_name, strerror(dev->dev_errno));
 843    }
 844    update_pos_dev(dev);
 845    return stat;
 846 }
 847
 848 /*
 849  * Backward space a record
 850  *   Returns:  0 on success
 851  *            -1 on failure
 852  */
 853 int
 854 bsr_dev(DEVICE *dev, int num)
 855 {
 856    struct mtop mt_com;
 857    int stat;
 858
 859    if (dev->fd < 0) {
 860       dev->dev_errno = EBADF;
 861       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 862       Emsg0(M_FATAL, 0, dev->errmsg);
 863       return -1;
 864    }
 865
 866    if (!(dev->state & ST_TAPE)) {
 867       return 0;
 868    }
 869    Dmsg0(29, "bsr_dev\n");
 870    dev->block_num -= num;
 871    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 872    mt_com.mt_op = MTBSR;
 873    mt_com.mt_count = num;
 874    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 875    if (stat < 0) {
 876       clrerror_dev(dev, MTBSR);
 877       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 878          dev->dev_name, strerror(dev->dev_errno));
 879    }
 880    update_pos_dev(dev);
 881    return stat;
 882 }
 883
 884
 885
 886 /*
 887  * Write an end of file on the device
 888  */
 889 int
 890 weof_dev(DEVICE *dev, int num)
 891 {
 892    struct mtop mt_com;
 893    int stat;
 894
 895    if (dev->fd < 0) {
 896       dev->dev_errno = EBADF;
 897       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 898       Emsg0(M_FATAL, 0, dev->errmsg);
 899       return -1;
 900    }
 901
 902    if (!(dev->state & ST_TAPE)) {
 903       return 0;
 904    }
 905    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
 906    dev->block_num = 0;
 907    Dmsg0(29, "weof_dev\n");
 908    mt_com.mt_op = MTWEOF;
 909    mt_com.mt_count = num;
 910    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 911    if (stat == 0) {
 912       dev->file++;
 913       dev->file_addr = 0;
 914    } else {
 915       clrerror_dev(dev, MTWEOF);
 916       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
 917          dev->dev_name, strerror(dev->dev_errno));
 918    }
 919    return stat;
 920 }
 921
 922 /*
 923  * Return string message with last error in English
 924  *  Be careful not to call this routine from within dev.c
 925  *  while editing an Mmsg(&) or you will end up in a recursive
 926  *  loop creating a Segmentation Violation.
 927  */
 928 char *
 929 strerror_dev(DEVICE *dev)
 930 {
 931    return dev->errmsg;
 932 }
 933
 934
 935 /*
 936  * If implemented in system, clear the tape
 937  * error status.
 938  */
 939 void
 940 clrerror_dev(DEVICE *dev, int func)
 941 {
 942    char *msg = NULL;
 943
 944    dev->dev_errno = errno;         /* save errno */
 945    if (errno == EIO) {
 946       dev->VolCatInfo.VolCatErrors++;
 947    }
 948
 949    if (!(dev->state & ST_TAPE)) {
 950       return;
 951    }
 952    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
 953       switch (func) {
 954          case -1:
 955             Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
 956             break;
 957          case MTWEOF:
 958             msg = "WTWEOF";
 959             dev->capabilities &= ~CAP_EOF; /* turn off feature */
 960             break;
 961          case MTEOM:
 962             msg = "WTEOM";
 963             dev->capabilities &= ~CAP_EOM; /* turn off feature */
 964             break;
 965          case MTFSF:
 966             msg = "MTFSF";
 967             dev->capabilities &= ~CAP_FSF; /* turn off feature */
 968             break;
 969          case MTBSF:
 970             msg = "MTBSF";
 971             dev->capabilities &= ~CAP_BSF; /* turn off feature */
 972             break;
 973          case MTFSR:
 974             msg = "MTFSR";
 975             dev->capabilities &= ~CAP_FSR; /* turn off feature */
 976             break;
 977          case MTBSR:
 978             msg = "MTBSR";
 979             dev->capabilities &= ~CAP_BSR; /* turn off feature */
 980             break;
 981          default:
 982             msg = "Unknown";
 983             break;
 984       }
 985       if (msg != NULL) {
 986          dev->dev_errno = ENOSYS;
 987          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
 988          Emsg0(M_ERROR, 0, dev->errmsg);
 989       }
 990    }
 991 #ifdef MTIOCLRERR
 992 {
 993    struct mtop mt_com;
 994    int stat;
 995    mt_com.mt_op = MTIOCLRERR;
 996    mt_com.mt_count = 1;
 997    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 998    Dmsg0(200, "Did MTIOCLRERR\n");
 999 }
1000 #endif
1001 }
1002
1003 /*
1004  * Flush buffer contents
1005  *  No longer used.
1006  */
1007 int flush_dev(DEVICE *dev)
1008 {
1009    return 1;
1010 }
1011
1012 static void do_close(DEVICE *dev)
1013 {
1014
1015    Dmsg0(29, "really close_dev\n");
1016    close(dev->fd);
1017    /* Clean up device packet so it can be reused */
1018    dev->fd = -1;
1019    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1020    dev->file = dev->block_num = 0;
1021    dev->file_addr = 0;
1022    dev->EndFile = dev->EndBlock = 0;
1023    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1024    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1025    dev->use_count--;
1026    if (dev->tid) {
1027       stop_thread_timer(dev->tid);
1028       dev->tid = 0;
1029    }
1030 }
1031
1032 /*
1033  * Close the device
1034  */
1035 void
1036 close_dev(DEVICE *dev)
1037 {
1038    if (!dev) {
1039       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1040       Emsg0(M_FATAL, 0, dev->errmsg);
1041       return;
1042    }
1043    if (dev->fd >= 0 && dev->use_count == 1) {
1044       do_close(dev);
1045    } else {
1046       Dmsg0(29, "close_dev but in use so leave open.\n");
1047       dev->use_count--;
1048    }
1049 }
1050
1051 /*
1052  * Used when unmounting the device
1053  */
1054 void force_close_dev(DEVICE *dev)
1055 {
1056    if (!dev) {
1057       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1058       Emsg0(M_FATAL, 0, dev->errmsg);
1059       return;
1060    }
1061    Dmsg0(29, "really close_dev\n");
1062    do_close(dev);
1063 }
1064
1065 int truncate_dev(DEVICE *dev)
1066 {
1067    if (dev->state & ST_TAPE) {
1068       return 1;
1069    }
1070    if (ftruncate(dev->fd, 0) != 0) {
1071       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1072       return 0;
1073    }
1074    return 1;
1075 }
1076
1077 int
1078 dev_is_tape(DEVICE *dev)
1079 {
1080    return (dev->state & ST_TAPE) ? 1 : 0;
1081 }
1082
1083 char *
1084 dev_name(DEVICE *dev)
1085 {
1086    return dev->dev_name;
1087 }
1088
1089 char *
1090 dev_vol_name(DEVICE *dev)
1091 {
1092    return dev->VolCatInfo.VolCatName;
1093 }
1094
1095 uint32_t dev_block(DEVICE *dev)
1096 {
1097    update_pos_dev(dev);
1098    return dev->block_num;
1099 }
1100
1101 uint32_t dev_file(DEVICE *dev)
1102 {
1103    update_pos_dev(dev);
1104    return dev->file;
1105 }
1106
1107 /*
1108  * Free memory allocated for the device
1109  */
1110 void
1111 term_dev(DEVICE *dev)
1112 {
1113    if (!dev) {
1114       dev->dev_errno = EBADF;
1115       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1116       Emsg0(M_FATAL, 0, dev->errmsg);
1117       return;
1118    }
1119    do_close(dev);
1120    Dmsg0(29, "term_dev\n");
1121    if (dev->dev_name) {
1122       free_memory(dev->dev_name);
1123       dev->dev_name = NULL;
1124    }
1125    if (dev->errmsg) {
1126       free_pool_memory(dev->errmsg);
1127       dev->errmsg = NULL;
1128    }
1129    pthread_mutex_destroy(&dev->mutex);
1130    pthread_cond_destroy(&dev->wait);
1131    pthread_cond_destroy(&dev->wait_next_vol);
1132    if (dev->state & ST_MALLOC) {
1133       free_pool_memory((POOLMEM *)dev);
1134    }
1135 }
1136
1137
1138 /* To make following two functions more readable */
1139
1140 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1141
1142 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1143 {
1144    jcr->prev_dev = NULL;
1145    jcr->next_dev = attached_jcrs;
1146    if (attached_jcrs) {
1147       attached_jcrs->prev_dev = jcr;
1148    }
1149    attached_jcrs = jcr;
1150    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1151 }
1152
1153 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1154 {
1155    if (!jcr->prev_dev) {
1156       attached_jcrs = jcr->next_dev;
1157    } else {
1158       jcr->prev_dev->next_dev = jcr->next_dev;
1159    }
1160    if (jcr->next_dev) {
1161       jcr->next_dev->prev_dev = jcr->prev_dev;
1162    }
1163    jcr->next_dev = jcr->prev_dev = NULL;
1164    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1165 }
1166
1167 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1168 {
1169    if (jcr == NULL) {
1170       return attached_jcrs;
1171    }
1172    return jcr->next_dev;
1173 }