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->device = device;
 157
 158    if (tape) {
 159       dev->state |= ST_TAPE;
 160    } else if (fifo) {
 161       dev->state |= ST_FIFO;
 162       dev->capabilities |= CAP_STREAM; /* set stream device */
 163    } else {
 164       dev->state |= ST_FILE;
 165    }
 166
 167    if (dev->max_block_size > 1000000) {
 168       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
 169          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
 170       dev->max_block_size = 0;
 171    }
 172    if (dev->max_block_size % TAPE_BSIZE != 0) {
 173       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
 174          dev->max_block_size, dev->dev_name);
 175    }
 176
 177    dev->errmsg = get_pool_memory(PM_EMSG);
 178    *dev->errmsg = 0;
 179
 180    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 181       dev->dev_errno = errstat;
 182       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
 183       Emsg0(M_FATAL, 0, dev->errmsg);
 184    }
 185    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 186       dev->dev_errno = errstat;
 187       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 188       Emsg0(M_FATAL, 0, dev->errmsg);
 189    }
 190    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
 191       dev->dev_errno = errstat;
 192       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 193       Emsg0(M_FATAL, 0, dev->errmsg);
 194    }
 195    dev->fd = -1;
 196    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 197    return dev;
 198 }
 199
 200 /* Open the device with the operating system and
 201  * initialize buffer pointers.
 202  *
 203  * Note, for a tape, the VolName is the name we give to the
 204  *    volume (not really used here), but for a file, the
 205  *    VolName represents the name of the file to be created/opened.
 206  *    In the case of a file, the full name is the device name
 207  *    (archive_name) with the VolName concatenated.
 208  */
 209 int
 210 open_dev(DEVICE *dev, char *VolName, int mode)
 211 {
 212    POOLMEM *archive_name;
 213
 214    if (dev->state & ST_OPENED) {
 215       /*
 216        *  *****FIXME***** how to handle two threads wanting
 217        *  different volumes mounted???? E.g. one is waiting
 218        *  for the next volume to be mounted, and a new job
 219        *  starts and snatches up the device.
 220        */
 221       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 222          return -1;
 223       }
 224       dev->use_count++;
 225       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 226             dev->dev_name, dev->use_count);
 227       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
 228       return dev->fd;
 229    }
 230    if (VolName) {
 231       strcpy(dev->VolCatInfo.VolCatName, VolName);
 232    }
 233
 234    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 235          dev->dev_name, dev->VolCatInfo.VolCatName);
 236    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 237    if (dev->state & (ST_TAPE|ST_FIFO)) {
 238       int timeout;
 239       Dmsg0(29, "open_dev: device is tape\n");
 240       if (mode == OPEN_READ_WRITE) {
 241          dev->mode = O_RDWR | O_BINARY;
 242       } else if (mode == OPEN_READ_ONLY) {
 243          dev->mode = O_RDONLY | O_BINARY;
 244       } else if (mode == OPEN_WRITE_ONLY) {
 245          dev->mode = O_WRONLY | O_BINARY;
 246       } else {
 247          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 248       }
 249       timeout = dev->max_open_wait;
 250       errno = 0;
 251       if (dev->state & ST_FIFO && timeout) {
 252          /* Set open timer */
 253          dev->tid = start_thread_timer(pthread_self(), timeout);
 254       }
 255       /* If busy retry each second for max_open_wait seconds */
 256       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 257          if (errno == EAGAIN) {
 258             continue;
 259          }
 260          if (errno == EBUSY && timeout-- > 0) {
 261             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 262             sleep(1);
 263             continue;
 264          }
 265          dev->dev_errno = errno;
 266          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 267                dev->dev_name, strerror(dev->dev_errno));
 268          /* Stop any open timer we set */
 269          if (dev->tid) {
 270             stop_thread_timer(dev->tid);
 271             dev->tid = 0;
 272          }
 273          Emsg0(M_FATAL, 0, dev->errmsg);
 274          break;
 275       }
 276       if (dev->fd >= 0) {
 277          dev->dev_errno = 0;
 278          dev->state |= ST_OPENED;
 279          dev->use_count++;
 280          update_pos_dev(dev);             /* update position */
 281       }
 282       /* Stop any open() timer we started */
 283       if (dev->tid) {
 284          stop_thread_timer(dev->tid);
 285          dev->tid = 0;
 286       }
 287       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 288    } else {
 289       /*
 290        * Handle opening of file
 291        */
 292       archive_name = get_pool_memory(PM_FNAME);
 293       pm_strcpy(&archive_name, dev->dev_name);
 294       if (archive_name[strlen(archive_name)] != '/') {
 295          pm_strcat(&archive_name, "/");
 296       }
 297       pm_strcat(&archive_name, VolName);
 298       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
 299       if (mode == OPEN_READ_WRITE) {
 300          dev->mode = O_CREAT | O_RDWR | O_BINARY;
 301       } else if (mode == OPEN_READ_ONLY) {
 302          dev->mode = O_RDONLY | O_BINARY;
 303       } else if (mode == OPEN_WRITE_ONLY) {
 304          dev->mode = O_WRONLY | O_BINARY;
 305       } else {
 306          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 307       }
 308       if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
 309          dev->dev_errno = errno;
 310          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
 311          Emsg0(M_FATAL, 0, dev->errmsg);
 312       } else {
 313          dev->dev_errno = 0;
 314          dev->state |= ST_OPENED;
 315          dev->use_count++;
 316          update_pos_dev(dev);                /* update position */
 317       }
 318       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
 319       free_pool_memory(archive_name);
 320    }
 321    return dev->fd;
 322 }
 323
 324 /*
 325  * Rewind the device.
 326  *  Returns: 1 on success
 327  *           0 on failure
 328  */
 329 int rewind_dev(DEVICE *dev)
 330 {
 331    struct mtop mt_com;
 332    unsigned int i;
 333
 334    Dmsg0(29, "rewind_dev\n");
 335    if (dev->fd < 0) {
 336       dev->dev_errno = EBADF;
 337       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
 338             dev->dev_name);
 339       Emsg0(M_FATAL, 0, dev->errmsg);
 340       return 0;
 341    }
 342    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT);  /* remove EOF/EOT flags */
 343    dev->block_num = dev->file = 0;
 344    dev->file_addr = 0;
 345    if (dev->state & ST_TAPE) {
 346       mt_com.mt_op = MTREW;
 347       mt_com.mt_count = 1;
 348       /* If we get an I/O error on rewind, it is probably because
 349        * the drive is actually busy. We loop for (about 5 minutes)
 350        * retrying every 5 seconds.
 351        */
 352       for (i=dev->max_rewind_wait; ; i -= 5) {
 353          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 354             if (i == dev->max_rewind_wait) {
 355                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
 356             }
 357             clrerror_dev(dev, MTREW);
 358             if (dev->dev_errno == EIO && i > 0) {
 359                Dmsg0(200, "Sleeping 5 seconds.\n");
 360                sleep(5);
 361                continue;
 362             }
 363             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
 364                dev->dev_name, strerror(dev->dev_errno));
 365             return 0;
 366          }
 367          break;
 368       }
 369    } else if (dev->state & ST_FILE) {
 370       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
 371          dev->dev_errno = errno;
 372          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 373             dev->dev_name, strerror(dev->dev_errno));
 374          return 0;
 375       }
 376    }
 377    return 1;
 378 }
 379
 380 /*
 381  * Position device to end of medium (end of data)
 382  *  Returns: 1 on succes
 383  *           0 on error
 384  */
 385 int
 386 eod_dev(DEVICE *dev)
 387 {
 388    struct mtop mt_com;
 389    struct mtget mt_stat;
 390    int stat = 0;
 391    off_t pos;
 392
 393    Dmsg0(29, "eod_dev\n");
 394    if (dev->state & ST_EOT) {
 395       return 1;
 396    }
 397    dev->state &= ~(ST_EOF);  /* remove EOF flags */
 398    dev->block_num = dev->file = 0;
 399    dev->file_addr = 0;
 400    if (dev->state & (ST_FIFO | ST_PROG)) {
 401       return 1;
 402    }
 403    if (!(dev->state & ST_TAPE)) {
 404       pos = lseek(dev->fd, (off_t)0, SEEK_END);
 405 //    Dmsg1(000, "====== Seek to %lld\n", pos);
 406       if (pos >= 0) {
 407          update_pos_dev(dev);
 408          dev->state |= ST_EOT;
 409          return 1;
 410       }
 411       return 0;
 412    }
 413    if (dev->capabilities & CAP_EOM) {
 414       mt_com.mt_op = MTEOM;
 415       mt_com.mt_count = 1;
 416       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
 417          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
 418          clrerror_dev(dev, mt_com.mt_op);
 419          update_pos_dev(dev);
 420          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
 421             dev->dev_name, strerror(dev->dev_errno));
 422          return 0;
 423       }
 424       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 425          dev->dev_errno = errno;
 426          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 427             dev->dev_name, strerror(dev->dev_errno));
 428          return 0;
 429       }
 430       Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 431       dev->file = mt_stat.mt_fileno;
 432
 433    /*
 434     * Rewind then use FSF until EOT reached
 435     */
 436    } else {
 437       if (!rewind_dev(dev)) {
 438          return 0;
 439       }
 440       while (!(dev->state & ST_EOT)) {
 441          Dmsg0(200, "Do fsf 1\n");
 442          if (!fsf_dev(dev, 1)) {
 443             Dmsg0(200, "fsf_dev error.\n");
 444             return 0;
 445          }
 446       }
 447    }
 448    update_pos_dev(dev);                      /* update position */
 449    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 450    return 1;
 451 }
 452
 453 /*
 454  * Set the position of the device -- only for files
 455  *   For other devices, there is no generic way to do it.
 456  *  Returns: 1 on succes
 457  *           0 on error
 458  */
 459 int update_pos_dev(DEVICE *dev)
 460 {
 461    off_t pos;
 462    int stat = 0;
 463
 464    if (dev->fd < 0) {
 465       dev->dev_errno = EBADF;
 466       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 467       Emsg0(M_FATAL, 0, dev->errmsg);
 468       return 0;
 469    }
 470
 471    /* Find out where we are */
 472    if (dev->state & ST_FILE) {
 473       dev->file = 0;
 474       dev->file_addr = 0;
 475       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 476       if (pos < 0) {
 477          Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 478          dev->dev_errno = errno;
 479          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 480             dev->dev_name, strerror(dev->dev_errno));
 481       } else {
 482          stat = 1;
 483          dev->file_addr = pos;
 484       }
 485       return stat;
 486    }
 487    return 1;
 488 }
 489
 490
 491 /*
 492  * Return the status of the device.  This was meant
 493  * to be a generic routine. Unfortunately, it doesn't
 494  * seem possible (at least I do not know how to do it
 495  * currently), which means that for the moment, this
 496  * routine has very little value.
 497  *
 498  *   Returns: 1 on success
 499  *            0 on error
 500  */
 501 int
 502 status_dev(DEVICE *dev, uint32_t *status)
 503 {
 504    struct mtget mt_stat;
 505    uint32_t stat = 0;
 506
 507    if (dev->state & (ST_EOT | ST_WEOT)) {
 508       stat |= MT_EOD;
 509       Dmsg0(-20, " EOD");
 510    }
 511    if (dev->state & ST_EOF) {
 512       stat |= MT_EOF;
 513       Dmsg0(-20, " EOF");
 514    }
 515    if (dev->state & ST_TAPE) {
 516       stat |= MT_TAPE;
 517       Dmsg0(-20," Driver status:");
 518       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 519       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 520          dev->dev_errno = errno;
 521          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 522             dev->dev_name, strerror(dev->dev_errno));
 523          return 0;
 524       }
 525       Dmsg0(-20, " Device status:");
 526
 527 #if defined(HAVE_LINUX_OS)
 528       if (GMT_EOF(mt_stat.mt_gstat)) {
 529          stat |= MT_EOF;
 530          Dmsg0(-20, " EOF");
 531       }
 532       if (GMT_BOT(mt_stat.mt_gstat)) {
 533          stat |= MT_BOT;
 534          Dmsg0(-20, " BOT");
 535       }
 536       if (GMT_EOT(mt_stat.mt_gstat)) {
 537          stat |= MT_EOT;
 538          Dmsg0(-20, " EOT");
 539       }
 540       if (GMT_SM(mt_stat.mt_gstat)) {
 541          stat |= MT_SM;
 542          Dmsg0(-20, " SM");
 543       }
 544       if (GMT_EOD(mt_stat.mt_gstat)) {
 545          stat |= MT_EOD;
 546          Dmsg0(-20, " EOD");
 547       }
 548       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 549          stat |= MT_WR_PROT;
 550          Dmsg0(-20, " WR_PROT");
 551       }
 552       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 553          stat |= MT_ONLINE;
 554          Dmsg0(-20, " ONLINE");
 555       }
 556       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 557          stat |= MT_DR_OPEN;
 558          Dmsg0(-20, " DR_OPEN");
 559       }
 560       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 561          stat |= MT_IM_REP_EN;
 562          Dmsg0(-20, " IM_REP_EN");
 563       }
 564 #endif /* !SunOS && !OSF */
 565       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 566    } else {
 567       stat |= MT_ONLINE | MT_BOT;
 568    }
 569    *status = stat;
 570    return 1;
 571 }
 572
 573
 574 /*
 575  * Load medium in device
 576  *  Returns: 1 on success
 577  *           0 on failure
 578  */
 579 int load_dev(DEVICE *dev)
 580 {
 581 #ifdef MTLOAD
 582    struct mtop mt_com;
 583 #endif
 584
 585    if (dev->fd < 0) {
 586       dev->dev_errno = EBADF;
 587       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 588       Emsg0(M_FATAL, 0, dev->errmsg);
 589       return 0;
 590    }
 591    if (!(dev->state & ST_TAPE)) {
 592       return 1;
 593    }
 594 #ifndef MTLOAD
 595    Dmsg0(200, "stored: MTLOAD command not available\n");
 596    dev->dev_errno = ENOTTY;           /* function not available */
 597    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 598          dev->dev_name, strerror(dev->dev_errno));      return 0;
 599    return 0;
 600 #else
 601
 602    dev->block_num = dev->file = 0;
 603    dev->file_addr = 0;
 604    mt_com.mt_op = MTLOAD;
 605    mt_com.mt_count = 1;
 606    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 607       dev->dev_errno = errno;
 608       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 609          dev->dev_name, strerror(dev->dev_errno));      return 0;
 610    }
 611    return 1;
 612 #endif
 613 }
 614
 615 /*
 616  * Rewind device and put it offline
 617  *  Returns: 1 on success
 618  *           0 on failure
 619  */
 620 int offline_dev(DEVICE *dev)
 621 {
 622    struct mtop mt_com;
 623
 624    if (dev->fd < 0) {
 625       dev->dev_errno = EBADF;
 626       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 627       Emsg0(M_FATAL, 0, dev->errmsg);
 628       return 0;
 629    }
 630    if (!(dev->state & ST_TAPE)) {
 631       return 1;
 632    }
 633
 634    dev->block_num = dev->file = 0;
 635    dev->file_addr = 0;
 636 #ifdef MTUNLOCK
 637    mt_com.mt_op = MTUNLOCK;
 638    mt_com.mt_count = 1;
 639    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 640 #endif
 641    mt_com.mt_op = MTOFFL;
 642    mt_com.mt_count = 1;
 643    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 644       dev->dev_errno = errno;
 645       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 646          dev->dev_name, strerror(dev->dev_errno));
 647       return 0;
 648    }
 649    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 650    return 1;
 651 }
 652
 653
 654 /*
 655  * Foward space a file
 656  *   Returns: 1 on success
 657  *            0 on failure
 658  */
 659 int
 660 fsf_dev(DEVICE *dev, int num)
 661 {
 662    struct mtop mt_com;
 663    int stat = 0;
 664    char rbuf[1024];
 665
 666    if (dev->fd < 0) {
 667       dev->dev_errno = EBADF;
 668       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 669       Emsg0(M_FATAL, 0, dev->errmsg);
 670       return 0;
 671    }
 672
 673    if (!(dev->state & ST_TAPE)) {
 674       return 1;
 675    }
 676    if (dev->state & ST_EOT) {
 677       dev->dev_errno = 0;
 678       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 679       return 0;
 680    }
 681    if (dev->state & ST_EOF)
 682       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 683    if (dev->state & ST_EOT)
 684       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 685
 686    Dmsg0(29, "fsf_dev\n");
 687    dev->block_num = 0;
 688    if (dev->capabilities & CAP_FSF) {
 689       Dmsg0(200, "FSF has cap_fsf\n");
 690       mt_com.mt_op = MTFSF;
 691       mt_com.mt_count = 1;
 692       while (num-- && !(dev->state & ST_EOT)) {
 693          Dmsg0(200, "Doing read for fsf\n");
 694          if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
 695             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 696                stat = sizeof(rbuf);   /* This is OK */
 697             } else {
 698                dev->state |= ST_EOT;
 699                clrerror_dev(dev, -1);
 700                Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
 701                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 702                   dev->dev_name, strerror(dev->dev_errno));
 703                Dmsg1(200, "%s", dev->errmsg);
 704                break;
 705             }
 706          }
 707          if (stat == 0) {                /* EOF */
 708             update_pos_dev(dev);
 709             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 710             /* Two reads of zero means end of tape */
 711             if (dev->state & ST_EOF) {
 712                dev->state |= ST_EOT;
 713                Dmsg0(200, "Set ST_EOT\n");
 714                break;
 715             } else {
 716                dev->state |= ST_EOF;
 717                dev->file++;
 718                dev->file_addr = 0;
 719                continue;
 720             }
 721          } else {                        /* Got data */
 722             dev->state &= ~(ST_EOF|ST_EOT);
 723          }
 724
 725          Dmsg0(200, "Doing MT_FSF\n");
 726          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 727          if (stat < 0) {                 /* error => EOT */
 728             dev->state |= ST_EOT;
 729             Dmsg0(200, "Set ST_EOT\n");
 730             clrerror_dev(dev, MTFSF);
 731             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 732                dev->dev_name, strerror(dev->dev_errno));
 733             Dmsg0(200, "Got < 0 for MT_FSF\n");
 734             Dmsg1(200, "%s", dev->errmsg);
 735          } else {
 736             dev->state |= ST_EOF;     /* just read EOF */
 737             dev->file++;
 738             dev->file_addr = 0;
 739          }
 740       }
 741
 742    /*
 743     * No FSF, so use FSR to simulate it
 744     */
 745    } else {
 746       Dmsg0(200, "Doing FSR for FSF\n");
 747       while (num-- && !(dev->state & ST_EOT)) {
 748          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 749       }
 750       if (dev->state & ST_EOT) {
 751          dev->dev_errno = 0;
 752          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 753          stat = -1;
 754       } else {
 755          stat = 0;
 756       }
 757    }
 758    update_pos_dev(dev);
 759    Dmsg1(200, "Return %d from FSF\n", stat);
 760    if (dev->state & ST_EOF)
 761       Dmsg0(200, "ST_EOF set on exit FSF\n");
 762    if (dev->state & ST_EOT)
 763       Dmsg0(200, "ST_EOT set on exit FSF\n");
 764    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 765    return stat == 0 ? 1 : 0;
 766 }
 767
 768 /*
 769  * Backward space a file
 770  */
 771 int
 772 bsf_dev(DEVICE *dev, int num)
 773 {
 774    struct mtop mt_com;
 775    int stat;
 776
 777    if (dev->fd < 0) {
 778       dev->dev_errno = EBADF;
 779       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 780       Emsg0(M_FATAL, 0, dev->errmsg);
 781       return -1;
 782    }
 783
 784    if (!(dev->state & ST_TAPE)) {
 785       return 0;
 786    }
 787    Dmsg0(29, "bsf_dev\n");
 788    dev->state &= ~(ST_EOT|ST_EOF);
 789    dev->file -= num;
 790    dev->file_addr = 0;
 791    mt_com.mt_op = MTBSF;
 792    mt_com.mt_count = num;
 793    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 794    if (stat < 0) {
 795       clrerror_dev(dev, MTBSF);
 796       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 797          dev->dev_name, strerror(dev->dev_errno));
 798    }
 799    update_pos_dev(dev);
 800    return stat;
 801 }
 802
 803
 804 /*
 805  * Foward space a record
 806  */
 807 int
 808 fsr_dev(DEVICE *dev, int num)
 809 {
 810    struct mtop mt_com;
 811    int stat;
 812
 813    if (dev->fd < 0) {
 814       dev->dev_errno = EBADF;
 815       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 816       Emsg0(M_FATAL, 0, dev->errmsg);
 817       return -1;
 818    }
 819
 820    if (!(dev->state & ST_TAPE)) {
 821       return 0;
 822    }
 823    Dmsg0(29, "fsr_dev\n");
 824    dev->block_num += num;
 825    mt_com.mt_op = MTFSR;
 826    mt_com.mt_count = num;
 827    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 828    if (stat == 0) {
 829       dev->state &= ~ST_EOF;
 830    } else {
 831       if (dev->state & ST_EOF) {
 832          dev->state |= ST_EOT;
 833       } else {
 834          dev->state |= ST_EOF;           /* assume EOF */
 835          dev->file++;
 836          dev->file_addr = 0;
 837       }
 838       clrerror_dev(dev, MTFSR);
 839       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 840          dev->dev_name, strerror(dev->dev_errno));
 841    }
 842    update_pos_dev(dev);
 843    return stat;
 844 }
 845
 846 /*
 847  * Backward space a record
 848  *   Returns:  0 on success
 849  *            -1 on failure
 850  */
 851 int
 852 bsr_dev(DEVICE *dev, int num)
 853 {
 854    struct mtop mt_com;
 855    int stat;
 856
 857    if (dev->fd < 0) {
 858       dev->dev_errno = EBADF;
 859       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 860       Emsg0(M_FATAL, 0, dev->errmsg);
 861       return -1;
 862    }
 863
 864    if (!(dev->state & ST_TAPE)) {
 865       return 0;
 866    }
 867    Dmsg0(29, "bsr_dev\n");
 868    dev->block_num -= num;
 869    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 870    mt_com.mt_op = MTBSR;
 871    mt_com.mt_count = num;
 872    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 873    if (stat < 0) {
 874       clrerror_dev(dev, MTBSR);
 875       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 876          dev->dev_name, strerror(dev->dev_errno));
 877    }
 878    update_pos_dev(dev);
 879    return stat;
 880 }
 881
 882
 883
 884 /*
 885  * Write an end of file on the device
 886  */
 887 int
 888 weof_dev(DEVICE *dev, int num)
 889 {
 890    struct mtop mt_com;
 891    int stat;
 892
 893    if (dev->fd < 0) {
 894       dev->dev_errno = EBADF;
 895       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 896       Emsg0(M_FATAL, 0, dev->errmsg);
 897       return -1;
 898    }
 899
 900    if (!(dev->state & ST_TAPE)) {
 901       return 0;
 902    }
 903    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
 904    dev->block_num = 0;
 905    Dmsg0(29, "weof_dev\n");
 906    mt_com.mt_op = MTWEOF;
 907    mt_com.mt_count = num;
 908    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 909    if (stat == 0) {
 910       dev->file++;
 911       dev->file_addr = 0;
 912    } else {
 913       clrerror_dev(dev, MTWEOF);
 914       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
 915          dev->dev_name, strerror(dev->dev_errno));
 916    }
 917    return stat;
 918 }
 919
 920 /*
 921  * Return string message with last error in English
 922  *  Be careful not to call this routine from within dev.c
 923  *  while editing an Mmsg(&) or you will end up in a recursive
 924  *  loop creating a Segmentation Violation.
 925  */
 926 char *
 927 strerror_dev(DEVICE *dev)
 928 {
 929    return dev->errmsg;
 930 }
 931
 932
 933 /*
 934  * If implemented in system, clear the tape
 935  * error status.
 936  */
 937 void
 938 clrerror_dev(DEVICE *dev, int func)
 939 {
 940    char *msg = NULL;
 941
 942    dev->dev_errno = errno;         /* save errno */
 943    if (errno == EIO) {
 944       dev->VolCatInfo.VolCatErrors++;
 945    }
 946
 947    if (!(dev->state & ST_TAPE)) {
 948       return;
 949    }
 950    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
 951       switch (func) {
 952          case -1:
 953             Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
 954             break;
 955          case MTWEOF:
 956             msg = "WTWEOF";
 957             dev->capabilities &= ~CAP_EOF; /* turn off feature */
 958             break;
 959          case MTEOM:
 960             msg = "WTEOM";
 961             dev->capabilities &= ~CAP_EOM; /* turn off feature */
 962             break;
 963          case MTFSF:
 964             msg = "MTFSF";
 965             dev->capabilities &= ~CAP_FSF; /* turn off feature */
 966             break;
 967          case MTBSF:
 968             msg = "MTBSF";
 969             dev->capabilities &= ~CAP_BSF; /* turn off feature */
 970             break;
 971          case MTFSR:
 972             msg = "MTFSR";
 973             dev->capabilities &= ~CAP_FSR; /* turn off feature */
 974             break;
 975          case MTBSR:
 976             msg = "MTBSR";
 977             dev->capabilities &= ~CAP_BSR; /* turn off feature */
 978             break;
 979          default:
 980             msg = "Unknown";
 981             break;
 982       }
 983       if (msg != NULL) {
 984          dev->dev_errno = ENOSYS;
 985          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
 986          Emsg0(M_ERROR, 0, dev->errmsg);
 987       }
 988    }
 989 #ifdef MTIOCLRERR
 990 {
 991    struct mtop mt_com;
 992    int stat;
 993    mt_com.mt_op = MTIOCLRERR;
 994    mt_com.mt_count = 1;
 995    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 996    Dmsg0(200, "Did MTIOCLRERR\n");
 997 }
 998 #endif
 999 }
1000
1001 /*
1002  * Flush buffer contents
1003  *  No longer used.
1004  */
1005 int flush_dev(DEVICE *dev)
1006 {
1007    return 1;
1008 }
1009
1010 static void do_close(DEVICE *dev)
1011 {
1012
1013    Dmsg0(29, "really close_dev\n");
1014    close(dev->fd);
1015    /* Clean up device packet so it can be reused */
1016    dev->fd = -1;
1017    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1018    dev->file = dev->block_num = 0;
1019    dev->file_addr = 0;
1020    dev->EndFile = dev->EndBlock = 0;
1021    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1022    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1023    dev->use_count--;
1024    if (dev->tid) {
1025       stop_thread_timer(dev->tid);
1026       dev->tid = 0;
1027    }
1028 }
1029
1030 /*
1031  * Close the device
1032  */
1033 void
1034 close_dev(DEVICE *dev)
1035 {
1036    if (!dev) {
1037       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1038       Emsg0(M_FATAL, 0, dev->errmsg);
1039       return;
1040    }
1041    if (dev->fd >= 0 && dev->use_count == 1) {
1042       do_close(dev);
1043    } else {
1044       Dmsg0(29, "close_dev but in use so leave open.\n");
1045       dev->use_count--;
1046    }
1047 }
1048
1049 /*
1050  * Used when unmounting the device
1051  */
1052 void force_close_dev(DEVICE *dev)
1053 {
1054    if (!dev) {
1055       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1056       Emsg0(M_FATAL, 0, dev->errmsg);
1057       return;
1058    }
1059    Dmsg0(29, "really close_dev\n");
1060    do_close(dev);
1061 }
1062
1063 int truncate_dev(DEVICE *dev)
1064 {
1065    if (dev->state & ST_TAPE) {
1066       return 1;
1067    }
1068    if (ftruncate(dev->fd, 0) != 0) {
1069       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1070       return 0;
1071    }
1072    return 1;
1073 }
1074
1075 int
1076 dev_is_tape(DEVICE *dev)
1077 {
1078    return (dev->state & ST_TAPE) ? 1 : 0;
1079 }
1080
1081 char *
1082 dev_name(DEVICE *dev)
1083 {
1084    return dev->dev_name;
1085 }
1086
1087 char *
1088 dev_vol_name(DEVICE *dev)
1089 {
1090    return dev->VolCatInfo.VolCatName;
1091 }
1092
1093 uint32_t dev_block(DEVICE *dev)
1094 {
1095    update_pos_dev(dev);
1096    return dev->block_num;
1097 }
1098
1099 uint32_t dev_file(DEVICE *dev)
1100 {
1101    update_pos_dev(dev);
1102    return dev->file;
1103 }
1104
1105 /*
1106  * Free memory allocated for the device
1107  */
1108 void
1109 term_dev(DEVICE *dev)
1110 {
1111    if (!dev) {
1112       dev->dev_errno = EBADF;
1113       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1114       Emsg0(M_FATAL, 0, dev->errmsg);
1115       return;
1116    }
1117    do_close(dev);
1118    Dmsg0(29, "term_dev\n");
1119    if (dev->dev_name) {
1120       free_memory(dev->dev_name);
1121       dev->dev_name = NULL;
1122    }
1123    if (dev->errmsg) {
1124       free_pool_memory(dev->errmsg);
1125       dev->errmsg = NULL;
1126    }
1127    pthread_mutex_destroy(&dev->mutex);
1128    pthread_cond_destroy(&dev->wait);
1129    pthread_cond_destroy(&dev->wait_next_vol);
1130    if (dev->state & ST_MALLOC) {
1131       free_pool_memory((POOLMEM *)dev);
1132    }
1133 }
1134
1135
1136 /* To make following two functions more readable */
1137
1138 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1139
1140 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1141 {
1142    jcr->prev_dev = NULL;
1143    jcr->next_dev = attached_jcrs;
1144    if (attached_jcrs) {
1145       attached_jcrs->prev_dev = jcr;
1146    }
1147    attached_jcrs = jcr;
1148    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1149 }
1150
1151 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1152 {
1153    if (!jcr->prev_dev) {
1154       attached_jcrs = jcr->next_dev;
1155    } else {
1156       jcr->prev_dev->next_dev = jcr->next_dev;
1157    }
1158    if (jcr->next_dev) {
1159       jcr->next_dev->prev_dev = jcr->prev_dev;
1160    }
1161    jcr->next_dev = jcr->prev_dev = NULL;
1162    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1163 }
1164
1165 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1166 {
1167    if (jcr == NULL) {
1168       return attached_jcrs;
1169    }
1170    return jcr->next_dev;
1171 }