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