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, MM
   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-2004 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_block_to_device() call the fix_up
  61  * routine. In addition, all threads are blocked
  62  * from writing on the tape by calling lock_dev(), and thread other
  63  * than the first thread to hit the EOT will block on a condition
  64  * variable. The first thread to hit the EOT will continue to
  65  * be able to read and write the tape (he sort of tunnels through
  66  * the locking mechanism -- see lock_dev() for details).
  67  *
  68  * Now presumably somewhere higher in the chain of command
  69  * (device.c), someone will notice the EOT condition and
  70  * get a new tape up, get the tape label read, and mark
  71  * the label for rewriting. Then this higher level routine
  72  * will write the unwritten buffer to the new volume.
  73  * Finally, he will release
  74  * any blocked threads by doing a broadcast on the condition
  75  * variable.  At that point, we should be totally back in
  76  * business with no lost data.
  77  */
  78
  79
  80 #include "bacula.h"
  81 #include "stored.h"
  82
  83 /* Forward referenced functions */
  84 void set_os_device_parameters(DEVICE *dev);
  85
  86 /*
  87  * Allocate and initialize the DEVICE structure
  88  * Note, if dev is non-NULL, it is already allocated,
  89  * thus we neither allocate it nor free it. This allows
  90  * the caller to put the packet in shared memory.
  91  *
  92  *  Note, for a tape, the device->device_name is the device name
  93  *     (e.g. /dev/nst0), and for a file, the device name
  94  *     is the directory in which the file will be placed.
  95  *
  96  */
  97 DEVICE *
  98 init_dev(DEVICE *dev, DEVRES *device)
  99 {
 100    struct stat statp;
 101    bool tape, fifo;
 102    int errstat;
 103    DCR *dcr = NULL;
 104
 105    /* Check that device is available */
 106    if (stat(device->device_name, &statp) < 0) {
 107       berrno be;
 108       if (dev) {
 109          dev->dev_errno = errno;
 110       }
 111       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
 112             be.strerror());
 113       return NULL;
 114    }
 115    tape = false;
 116    fifo = false;
 117    if (S_ISDIR(statp.st_mode)) {
 118       tape = false;
 119    } else if (S_ISCHR(statp.st_mode)) {
 120       tape = true;
 121    } else if (S_ISFIFO(statp.st_mode)) {
 122       fifo = 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          device->device_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
 139    /* Copy user supplied device parameters from Resource */
 140    dev->dev_name = get_memory(strlen(device->device_name)+1);
 141    strcpy(dev->dev_name, device->device_name);
 142    dev->capabilities = device->cap_bits;
 143    dev->min_block_size = device->min_block_size;
 144    dev->max_block_size = device->max_block_size;
 145    dev->max_volume_size = device->max_volume_size;
 146    dev->max_file_size = device->max_file_size;
 147    dev->volume_capacity = device->volume_capacity;
 148    dev->max_rewind_wait = device->max_rewind_wait;
 149    dev->max_open_wait = device->max_open_wait;
 150    dev->max_open_vols = device->max_open_vols;
 151    dev->vol_poll_interval = device->vol_poll_interval;
 152    dev->max_spool_size = device->max_spool_size;
 153    dev->drive_index = device->drive_index;
 154    /* Sanity check */
 155    if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
 156       dev->vol_poll_interval = 60;
 157    }
 158    dev->device = device;
 159
 160    if (tape) {
 161       dev->state |= ST_TAPE;
 162    } else if (fifo) {
 163       dev->state |= ST_FIFO;
 164       dev->capabilities |= CAP_STREAM; /* set stream device */
 165    } else {
 166       dev->state |= ST_FILE;
 167    }
 168
 169    if (dev->max_block_size > 1000000) {
 170       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
 171          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
 172       dev->max_block_size = 0;
 173    }
 174    if (dev->max_block_size % TAPE_BSIZE != 0) {
 175       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
 176          dev->max_block_size, dev->dev_name);
 177    }
 178
 179    dev->errmsg = get_pool_memory(PM_EMSG);
 180    *dev->errmsg = 0;
 181
 182    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 183       berrno be;
 184       dev->dev_errno = errstat;
 185       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
 186       Emsg0(M_FATAL, 0, dev->errmsg);
 187    }
 188    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 189       berrno be;
 190       dev->dev_errno = errstat;
 191       Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
 192       Emsg0(M_FATAL, 0, dev->errmsg);
 193    }
 194    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
 195       berrno be;
 196       dev->dev_errno = errstat;
 197       Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
 198       Emsg0(M_FATAL, 0, dev->errmsg);
 199    }
 200    if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
 201       berrno be;
 202       dev->dev_errno = errstat;
 203       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
 204       Emsg0(M_FATAL, 0, dev->errmsg);
 205    }
 206    if ((errstat = rwl_init(&dev->lock)) != 0) {
 207       berrno be;
 208       dev->dev_errno = errstat;
 209       Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
 210       Emsg0(M_FATAL, 0, dev->errmsg);
 211    }
 212
 213    dev->fd = -1;
 214    dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
 215    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 216
 217    return dev;
 218 }
 219
 220 /* Open the device with the operating system and
 221  * initialize buffer pointers.
 222  *
 223  * Note, for a tape, the VolName is the name we give to the
 224  *    volume (not really used here), but for a file, the
 225  *    VolName represents the name of the file to be created/opened.
 226  *    In the case of a file, the full name is the device name
 227  *    (archive_name) with the VolName concatenated.
 228  */
 229 int
 230 open_dev(DEVICE *dev, char *VolName, int mode)
 231 {
 232    POOLMEM *archive_name;
 233
 234    if (dev->state & ST_OPENED) {
 235       /*
 236        *  *****FIXME***** how to handle two threads wanting
 237        *  different volumes mounted???? E.g. one is waiting
 238        *  for the next volume to be mounted, and a new job
 239        *  starts and snatches up the device.
 240        */
 241       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 242          return -1;
 243       }
 244       dev->use_count++;
 245       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 246             dev->dev_name, dev->use_count);
 247       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
 248       return dev->fd;
 249    }
 250    if (VolName) {
 251       bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
 252    }
 253
 254    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 255          dev->dev_name, dev->VolCatInfo.VolCatName);
 256    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 257    if (dev->state & (ST_TAPE|ST_FIFO)) {
 258       int timeout;
 259       Dmsg0(29, "open_dev: device is tape\n");
 260       if (mode == OPEN_READ_WRITE) {
 261          dev->mode = O_RDWR | O_BINARY;
 262       } else if (mode == OPEN_READ_ONLY) {
 263          dev->mode = O_RDONLY | O_BINARY;
 264       } else if (mode == OPEN_WRITE_ONLY) {
 265          dev->mode = O_WRONLY | O_BINARY;
 266       } else {
 267          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 268       }
 269       timeout = dev->max_open_wait;
 270       errno = 0;
 271       if (dev->state & ST_FIFO && timeout) {
 272          /* Set open timer */
 273          dev->tid = start_thread_timer(pthread_self(), timeout);
 274       }
 275       /* If busy retry each second for max_open_wait seconds */
 276       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 277          if (errno == EINTR || errno == EAGAIN) {
 278             continue;
 279          }
 280          if (errno == EBUSY && timeout-- > 0) {
 281             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 282             bmicrosleep(1, 0);
 283             continue;
 284          }
 285          dev->dev_errno = errno;
 286          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 287                dev->dev_name, strerror(dev->dev_errno));
 288          /* Stop any open timer we set */
 289          if (dev->tid) {
 290             stop_thread_timer(dev->tid);
 291             dev->tid = 0;
 292          }
 293          Emsg0(M_FATAL, 0, dev->errmsg);
 294          break;
 295       }
 296       if (dev->fd >= 0) {
 297          dev->dev_errno = 0;
 298          dev->state |= ST_OPENED;
 299          dev->use_count = 1;
 300          update_pos_dev(dev);             /* update position */
 301          set_os_device_parameters(dev);      /* do system dependent stuff */
 302       }
 303       /* Stop any open() timer we started */
 304       if (dev->tid) {
 305          stop_thread_timer(dev->tid);
 306          dev->tid = 0;
 307       }
 308       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 309    } else {
 310       /*
 311        * Handle opening of File Archive (not a tape)
 312        */
 313       if (VolName == NULL || *VolName == 0) {
 314          Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
 315             dev->dev_name);
 316          return -1;
 317       }
 318       archive_name = get_pool_memory(PM_FNAME);
 319       pm_strcpy(archive_name, dev->dev_name);
 320       if (archive_name[strlen(archive_name)] != '/') {
 321          pm_strcat(archive_name, "/");
 322       }
 323       pm_strcat(archive_name, VolName);
 324       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
 325       if (mode == OPEN_READ_WRITE) {
 326          dev->mode = O_CREAT | O_RDWR | O_BINARY;
 327       } else if (mode == OPEN_READ_ONLY) {
 328          dev->mode = O_RDONLY | O_BINARY;
 329       } else if (mode == OPEN_WRITE_ONLY) {
 330          dev->mode = O_WRONLY | O_BINARY;
 331       } else {
 332          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 333       }
 334       /* If creating file, give 0640 permissions */
 335       if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
 336          dev->dev_errno = errno;
 337          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
 338          Emsg0(M_FATAL, 0, dev->errmsg);
 339       } else {
 340          dev->dev_errno = 0;
 341          dev->state |= ST_OPENED;
 342          dev->use_count = 1;
 343          update_pos_dev(dev);                /* update position */
 344       }
 345       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
 346       free_pool_memory(archive_name);
 347    }
 348    return dev->fd;
 349 }
 350
 351 #ifdef debug_tracing
 352 #undef rewind_dev
 353 int _rewind_dev(char *file, int line, DEVICE *dev)
 354 {
 355    Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
 356    return rewind_dev(dev);
 357 }
 358 #endif
 359
 360
 361 /*
 362  * Rewind the device.
 363  *  Returns: true  on success
 364  *           false on failure
 365  */
 366 bool rewind_dev(DEVICE *dev)
 367 {
 368    struct mtop mt_com;
 369    unsigned int i;
 370
 371    Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
 372    if (dev->fd < 0) {
 373       dev->dev_errno = EBADF;
 374       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
 375             dev->dev_name);
 376       Emsg0(M_FATAL, 0, dev->errmsg);
 377       return false;
 378    }
 379    dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
 380    dev->block_num = dev->file = 0;
 381    dev->file_addr = 0;
 382    if (dev->state & ST_TAPE) {
 383       mt_com.mt_op = MTREW;
 384       mt_com.mt_count = 1;
 385       /* If we get an I/O error on rewind, it is probably because
 386        * the drive is actually busy. We loop for (about 5 minutes)
 387        * retrying every 5 seconds.
 388        */
 389       for (i=dev->max_rewind_wait; ; i -= 5) {
 390          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 391             berrno be;
 392             if (i == dev->max_rewind_wait) {
 393                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
 394             }
 395             clrerror_dev(dev, MTREW);
 396             if (dev->dev_errno == EIO && i > 0) {
 397                Dmsg0(200, "Sleeping 5 seconds.\n");
 398                bmicrosleep(5, 0);
 399                continue;
 400             }
 401             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
 402                dev->dev_name, be.strerror(dev->dev_errno));
 403             return false;
 404          }
 405          break;
 406       }
 407    } else if (dev->state & ST_FILE) {
 408       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
 409          berrno be;
 410          dev->dev_errno = errno;
 411          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 412             dev->dev_name, be.strerror(dev->dev_errno));
 413          return false;
 414       }
 415    }
 416    return true;
 417 }
 418
 419 /*
 420  * Position device to end of medium (end of data)
 421  *  Returns: 1 on succes
 422  *           0 on error
 423  */
 424 int
 425 eod_dev(DEVICE *dev)
 426 {
 427    struct mtop mt_com;
 428    struct mtget mt_stat;
 429    int stat = 0;
 430    off_t pos;
 431
 432    Dmsg0(29, "eod_dev\n");
 433    if (dev->state & ST_EOT) {
 434       return 1;
 435    }
 436    dev->state &= ~(ST_EOF);  /* remove EOF flags */
 437    dev->block_num = dev->file = 0;
 438    dev->file_addr = 0;
 439    if (dev->state & (ST_FIFO | ST_PROG)) {
 440       return 1;
 441    }
 442    if (!(dev->state & ST_TAPE)) {
 443       pos = lseek(dev->fd, (off_t)0, SEEK_END);
 444 //    Dmsg1(100, "====== Seek to %lld\n", pos);
 445       if (pos >= 0) {
 446          update_pos_dev(dev);
 447          dev->state |= ST_EOT;
 448          return 1;
 449       }
 450       dev->dev_errno = errno;
 451       berrno be;
 452       Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 453              dev->dev_name, be.strerror(dev->dev_errno));
 454       return 0;
 455    }
 456 #ifdef MTEOM
 457
 458    if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
 459       struct mtget mt_stat;
 460       Dmsg0(100,"Using FAST FSF for EOM\n");
 461       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
 462         if (!rewind_dev(dev)) {
 463           return 0;
 464         }
 465       }
 466       mt_com.mt_op = MTFSF;
 467       /*
 468        * ***FIXEM*** fix code to handle case that INT16_MAX is
 469        *   not large enough.
 470        */
 471       mt_com.mt_count = INT16_MAX;    /* use big positive number */
 472       if (mt_com.mt_count < 0) {
 473          mt_com.mt_count = INT16_MAX; /* brain damaged system */
 474       }
 475    }
 476
 477    if (dev_cap(dev, CAP_EOM)) {
 478       Dmsg0(100,"Using EOM for EOM\n");
 479       mt_com.mt_op = MTEOM;
 480       mt_com.mt_count = 1;
 481    }
 482    if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
 483       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
 484          berrno be;
 485          clrerror_dev(dev, mt_com.mt_op);
 486          Dmsg1(50, "ioctl error: %s\n", be.strerror(dev->dev_errno));
 487          update_pos_dev(dev);
 488          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
 489             dev->dev_name, be.strerror(dev->dev_errno));
 490          return 0;
 491       }
 492
 493       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 494          berrno be;
 495          clrerror_dev(dev, -1);
 496          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 497             dev->dev_name, be.strerror(dev->dev_errno));
 498          return 0;
 499       }
 500       Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 501       dev->file = mt_stat.mt_fileno;
 502
 503    /*
 504     * Rewind then use FSF until EOT reached
 505     */
 506    } else {
 507 #else
 508    {
 509 #endif
 510       if (!rewind_dev(dev)) {
 511          return 0;
 512       }
 513       /*
 514        * Move file by file to the end of the tape
 515        */
 516       int file_num;
 517       for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
 518          Dmsg0(200, "eod_dev: doing fsf 1\n");
 519          if (!fsf_dev(dev, 1)) {
 520             Dmsg0(200, "fsf_dev error.\n");
 521             return 0;
 522          }
 523          /*
 524           * Avoid infinite loop. ***FIXME*** possibly add code
 525           *   to set EOD or to turn off CAP_FASTFSF if on.
 526           */
 527          if (file_num == (int)dev->file) {
 528             struct mtget mt_stat;
 529             Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
 530             if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
 531                       mt_stat.mt_fileno >= 0) {
 532                Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
 533                dev->file = mt_stat.mt_fileno;
 534             }
 535             stat = 0;
 536             break;                    /* we are not progressing, bail out */
 537          }
 538       }
 539    }
 540    /*
 541     * Some drivers leave us after second EOF when doing
 542     * MTEOM, so we must backup so that appending overwrites
 543     * the second EOF.
 544     */
 545    if (dev_cap(dev, CAP_BSFATEOM)) {
 546       struct mtget mt_stat;
 547       /* Backup over EOF */
 548       stat = bsf_dev(dev, 1);
 549       /* If BSF worked and fileno is known (not -1), set file */
 550       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
 551          Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
 552          dev->file = mt_stat.mt_fileno;
 553       } else {
 554          dev->file++;                 /* wing it -- not correct on all OSes */
 555       }
 556    } else {
 557       update_pos_dev(dev);                   /* update position */
 558       stat = 1;
 559    }
 560    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 561    return stat;
 562 }
 563
 564 /*
 565  * Set the position of the device -- only for files
 566  *   For other devices, there is no generic way to do it.
 567  *  Returns: true  on succes
 568  *           false on error
 569  */
 570 bool update_pos_dev(DEVICE *dev)
 571 {
 572    off_t pos;
 573    bool ok = true;
 574
 575    if (dev->fd < 0) {
 576       dev->dev_errno = EBADF;
 577       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 578       Emsg0(M_FATAL, 0, dev->errmsg);
 579       return false;
 580    }
 581
 582    /* Find out where we are */
 583    if (dev->state & ST_FILE) {
 584       dev->file = 0;
 585       dev->file_addr = 0;
 586       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 587       if (pos < 0) {
 588          Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 589          dev->dev_errno = errno;
 590          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 591             dev->dev_name, strerror(dev->dev_errno));
 592          ok = false;
 593       } else {
 594          dev->file_addr = pos;
 595       }
 596    }
 597    return ok;
 598 }
 599
 600
 601 /*
 602  * Return the status of the device.  This was meant
 603  * to be a generic routine. Unfortunately, it doesn't
 604  * seem possible (at least I do not know how to do it
 605  * currently), which means that for the moment, this
 606  * routine has very little value.
 607  *
 608  *   Returns: status
 609  */
 610 uint32_t status_dev(DEVICE *dev)
 611 {
 612    struct mtget mt_stat;
 613    uint32_t stat = 0;
 614
 615    if (dev->state & (ST_EOT | ST_WEOT)) {
 616       stat |= BMT_EOD;
 617       Dmsg0(-20, " EOD");
 618    }
 619    if (dev->state & ST_EOF) {
 620       stat |= BMT_EOF;
 621       Dmsg0(-20, " EOF");
 622    }
 623    if (dev->state & ST_TAPE) {
 624       stat |= BMT_TAPE;
 625       Dmsg0(-20," Bacula status:");
 626       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 627       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 628          berrno be;
 629          dev->dev_errno = errno;
 630          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 631             dev->dev_name, be.strerror(dev->dev_errno));
 632          return 0;
 633       }
 634       Dmsg0(-20, " Device status:");
 635
 636 #if defined(HAVE_LINUX_OS)
 637       if (GMT_EOF(mt_stat.mt_gstat)) {
 638          stat |= BMT_EOF;
 639          Dmsg0(-20, " EOF");
 640       }
 641       if (GMT_BOT(mt_stat.mt_gstat)) {
 642          stat |= BMT_BOT;
 643          Dmsg0(-20, " BOT");
 644       }
 645       if (GMT_EOT(mt_stat.mt_gstat)) {
 646          stat |= BMT_EOT;
 647          Dmsg0(-20, " EOT");
 648       }
 649       if (GMT_SM(mt_stat.mt_gstat)) {
 650          stat |= BMT_SM;
 651          Dmsg0(-20, " SM");
 652       }
 653       if (GMT_EOD(mt_stat.mt_gstat)) {
 654          stat |= BMT_EOD;
 655          Dmsg0(-20, " EOD");
 656       }
 657       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 658          stat |= BMT_WR_PROT;
 659          Dmsg0(-20, " WR_PROT");
 660       }
 661       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 662          stat |= BMT_ONLINE;
 663          Dmsg0(-20, " ONLINE");
 664       }
 665       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 666          stat |= BMT_DR_OPEN;
 667          Dmsg0(-20, " DR_OPEN");
 668       }
 669       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 670          stat |= BMT_IM_REP_EN;
 671          Dmsg0(-20, " IM_REP_EN");
 672       }
 673 #endif /* !SunOS && !OSF */
 674       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 675    } else {
 676       stat |= BMT_ONLINE | BMT_BOT;
 677    }
 678    return stat;
 679 }
 680
 681
 682 /*
 683  * Load medium in device
 684  *  Returns: true  on success
 685  *           false on failure
 686  */
 687 bool load_dev(DEVICE *dev)
 688 {
 689 #ifdef MTLOAD
 690    struct mtop mt_com;
 691 #endif
 692
 693    if (dev->fd < 0) {
 694       dev->dev_errno = EBADF;
 695       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 696       Emsg0(M_FATAL, 0, dev->errmsg);
 697       return false;
 698    }
 699    if (!(dev->state & ST_TAPE)) {
 700       return true;
 701    }
 702 #ifndef MTLOAD
 703    Dmsg0(200, "stored: MTLOAD command not available\n");
 704    berrno be;
 705    dev->dev_errno = ENOTTY;           /* function not available */
 706    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 707          dev->dev_name, be.strerror(dev->dev_errno));      return 0;
 708    return false;
 709 #else
 710
 711    dev->block_num = dev->file = 0;
 712    dev->file_addr = 0;
 713    mt_com.mt_op = MTLOAD;
 714    mt_com.mt_count = 1;
 715    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 716       berrno be;
 717       dev->dev_errno = errno;
 718       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 719          dev->dev_name, be.strerror(dev->dev_errno));      return 0;
 720       return false;
 721    }
 722    return true;
 723 #endif
 724 }
 725
 726 /*
 727  * Rewind device and put it offline
 728  *  Returns: true  on success
 729  *           false on failure
 730  */
 731 bool offline_dev(DEVICE *dev)
 732 {
 733    struct mtop mt_com;
 734
 735    if (dev->fd < 0) {
 736       dev->dev_errno = EBADF;
 737       Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
 738       Emsg0(M_FATAL, 0, dev->errmsg);
 739       return false;
 740    }
 741    if (!(dev->state & ST_TAPE)) {
 742       return true;
 743    }
 744
 745    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
 746    dev->block_num = dev->file = 0;
 747    dev->file_addr = 0;
 748 #ifdef MTUNLOCK
 749    mt_com.mt_op = MTUNLOCK;
 750    mt_com.mt_count = 1;
 751    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 752 #endif
 753    mt_com.mt_op = MTOFFL;
 754    mt_com.mt_count = 1;
 755    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 756       berrno be;
 757       dev->dev_errno = errno;
 758       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 759          dev->dev_name, be.strerror(dev->dev_errno));
 760       return false;
 761    }
 762    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 763    return true;
 764 }
 765
 766 int offline_or_rewind_dev(DEVICE *dev)
 767 {
 768    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
 769       return offline_dev(dev);
 770    } else {
 771    /*
 772     * Note, this rewind probably should not be here (it wasn't
 773     *  in prior versions of Bacula), but on FreeBSD, this is
 774     *  needed in the case the tape was "frozen" due to an error
 775     *  such as backspacing after writing and EOF. If it is not
 776     *  done, all future references to the drive get and I/O error.
 777     */
 778       clrerror_dev(dev, MTREW);
 779       return rewind_dev(dev);
 780    }
 781 }
 782
 783 /*
 784  * Foward space a file
 785  *   Returns: true  on success
 786  *            false on failure
 787  */
 788 bool
 789 fsf_dev(DEVICE *dev, int num)
 790 {
 791    struct mtget mt_stat;
 792    struct mtop mt_com;
 793    int stat = 0;
 794
 795    if (dev->fd < 0) {
 796       dev->dev_errno = EBADF;
 797       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 798       Emsg0(M_FATAL, 0, dev->errmsg);
 799       return false;
 800    }
 801
 802    if (!(dev->state & ST_TAPE)) {
 803       return true;
 804    }
 805    if (dev->state & ST_EOT) {
 806       dev->dev_errno = 0;
 807       Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 808       return false;
 809    }
 810    if (dev->state & ST_EOF) {
 811       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 812    }
 813
 814    Dmsg0(29, "fsf_dev\n");
 815    dev->block_num = 0;
 816    /*
 817     * If Fast forward space file is set, then we
 818     *  use MTFSF to forward space and MTIOCGET
 819     *  to get the file position. We assume that
 820     *  the SCSI driver will ensure that we do not
 821     *  forward space over the end of data mark.
 822     */
 823    if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
 824       mt_com.mt_op = MTFSF;
 825       mt_com.mt_count = num;
 826       stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 827       if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 828          berrno be;
 829          dev->state |= ST_EOT;
 830          Dmsg0(200, "Set ST_EOT\n");
 831          clrerror_dev(dev, MTFSF);
 832          Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 833             dev->dev_name, be.strerror());
 834          Dmsg1(200, "%s", dev->errmsg);
 835          return false;
 836       }
 837       Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 838       dev->file = mt_stat.mt_fileno;
 839       dev->state |= ST_EOF;     /* just read EOF */
 840       dev->file_addr = 0;
 841       return true;
 842
 843    /*
 844     * Here if CAP_FSF is set, and virtually all drives
 845     *  these days support it, we read a record, then forward
 846     *  space one file. Using this procedure, which is slow,
 847     *  is the only way we can be sure that we don't read
 848     *  two consecutive EOF marks, which means End of Data.
 849     */
 850    } else if (dev_cap(dev, CAP_FSF)) {
 851       POOLMEM *rbuf;
 852       int rbuf_len;
 853       Dmsg0(200, "FSF has cap_fsf\n");
 854       if (dev->max_block_size == 0) {
 855          rbuf_len = DEFAULT_BLOCK_SIZE;
 856       } else {
 857          rbuf_len = dev->max_block_size;
 858       }
 859       rbuf = get_memory(rbuf_len);
 860       mt_com.mt_op = MTFSF;
 861       mt_com.mt_count = 1;
 862       while (num-- && !(dev->state & ST_EOT)) {
 863          Dmsg0(200, "Doing read before fsf\n");
 864          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
 865             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 866                stat = rbuf_len;        /* This is OK */
 867             } else {
 868                berrno be;
 869                dev->state |= ST_EOT;
 870                clrerror_dev(dev, -1);
 871                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
 872                   be.strerror());
 873                Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
 874                   dev->dev_name, be.strerror(dev->dev_errno));
 875                Dmsg1(200, "%s", dev->errmsg);
 876                break;
 877             }
 878          }
 879          if (stat == 0) {                /* EOF */
 880             update_pos_dev(dev);
 881             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 882             /* Two reads of zero means end of tape */
 883             if (dev->state & ST_EOF) {
 884                dev->state |= ST_EOT;
 885                Dmsg0(200, "Set ST_EOT\n");
 886                break;
 887             } else {
 888                dev->state |= ST_EOF;
 889                dev->file++;
 890                dev->file_addr = 0;
 891                continue;
 892             }
 893          } else {                        /* Got data */
 894             dev->state &= ~(ST_EOF|ST_EOT);
 895          }
 896
 897          Dmsg0(200, "Doing MTFSF\n");
 898          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 899          if (stat < 0) {                 /* error => EOT */
 900             berrno be;
 901             dev->state |= ST_EOT;
 902             Dmsg0(200, "Set ST_EOT\n");
 903             clrerror_dev(dev, MTFSF);
 904             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 905                dev->dev_name, be.strerror(dev->dev_errno));
 906             Dmsg0(200, "Got < 0 for MTFSF\n");
 907             Dmsg1(200, "%s", dev->errmsg);
 908          } else {
 909             dev->state |= ST_EOF;     /* just read EOF */
 910             dev->file++;
 911             dev->file_addr = 0;
 912          }
 913       }
 914       free_memory(rbuf);
 915
 916    /*
 917     * No FSF, so use FSR to simulate it
 918     */
 919    } else {
 920       Dmsg0(200, "Doing FSR for FSF\n");
 921       while (num-- && !(dev->state & ST_EOT)) {
 922          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 923       }
 924       if (dev->state & ST_EOT) {
 925          dev->dev_errno = 0;
 926          Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 927          stat = -1;
 928       } else {
 929          stat = 0;
 930       }
 931    }
 932    update_pos_dev(dev);
 933    Dmsg1(200, "Return %d from FSF\n", stat);
 934    if (dev->state & ST_EOF)
 935       Dmsg0(200, "ST_EOF set on exit FSF\n");
 936    if (dev->state & ST_EOT)
 937       Dmsg0(200, "ST_EOT set on exit FSF\n");
 938    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 939    return stat == 0;
 940 }
 941
 942 /*
 943  * Backward space a file
 944  *  Returns: false on failure
 945  *           true  on success
 946  */
 947 bool
 948 bsf_dev(DEVICE *dev, int num)
 949 {
 950    struct mtop mt_com;
 951    int stat;
 952
 953    if (dev->fd < 0) {
 954       dev->dev_errno = EBADF;
 955       Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
 956       Emsg0(M_FATAL, 0, dev->errmsg);
 957       return false;
 958    }
 959
 960    if (!(dev_state(dev, ST_TAPE))) {
 961       Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
 962          dev->dev_name);
 963       return false;
 964    }
 965    Dmsg0(29, "bsf_dev\n");
 966    dev->state &= ~(ST_EOT|ST_EOF);
 967    dev->file -= num;
 968    dev->file_addr = 0;
 969    mt_com.mt_op = MTBSF;
 970    mt_com.mt_count = num;
 971    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 972    if (stat < 0) {
 973       berrno be;
 974       clrerror_dev(dev, MTBSF);
 975       Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 976          dev->dev_name, be.strerror(dev->dev_errno));
 977    }
 978    update_pos_dev(dev);
 979    return stat == 0;
 980 }
 981
 982
 983 /*
 984  * Foward space a record
 985  *  Returns: false on failure
 986  *           true  on success
 987  */
 988 bool
 989 fsr_dev(DEVICE *dev, int num)
 990 {
 991    struct mtop mt_com;
 992    int stat;
 993
 994    if (dev->fd < 0) {
 995       dev->dev_errno = EBADF;
 996       Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
 997       Emsg0(M_FATAL, 0, dev->errmsg);
 998       return false;
 999    }
1000
1001    if (!(dev_state(dev, ST_TAPE))) {
1002       return false;
1003    }
1004    if (!dev_cap(dev, CAP_FSR)) {
1005       Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
1006       return false;
1007    }
1008
1009    Dmsg0(29, "fsr_dev\n");
1010    mt_com.mt_op = MTFSR;
1011    mt_com.mt_count = num;
1012    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1013    if (stat == 0) {
1014       dev->state &= ~ST_EOF;
1015       dev->block_num += num;
1016    } else {
1017       berrno be;
1018       struct mtget mt_stat;
1019       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1020          Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1021             dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1022          dev->file = mt_stat.mt_fileno;
1023          dev->block_num = mt_stat.mt_blkno;
1024       } else {
1025          if (dev->state & ST_EOF) {
1026             dev->state |= ST_EOT;
1027          } else {
1028             dev->state |= ST_EOF;           /* assume EOF */
1029             dev->file++;
1030             dev->block_num = 0;
1031             dev->file_addr = 0;
1032          }
1033       }
1034       clrerror_dev(dev, MTFSR);
1035       Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1036          dev->dev_name, be.strerror(dev->dev_errno));
1037    }
1038    update_pos_dev(dev);
1039    return stat == 0;
1040 }
1041
1042 /*
1043  * Backward space a record
1044  *   Returns:  false on failure
1045  *             true  on success
1046  */
1047 bool
1048 bsr_dev(DEVICE *dev, int num)
1049 {
1050    struct mtop mt_com;
1051    int stat;
1052
1053    if (dev->fd < 0) {
1054       dev->dev_errno = EBADF;
1055       Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1056       Emsg0(M_FATAL, 0, dev->errmsg);
1057       return false;
1058    }
1059
1060    if (!(dev->state & ST_TAPE)) {
1061       return false;
1062    }
1063
1064    if (!dev_cap(dev, CAP_BSR)) {
1065       Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1066       return false;
1067    }
1068
1069    Dmsg0(29, "bsr_dev\n");
1070    dev->block_num -= num;
1071    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1072    mt_com.mt_op = MTBSR;
1073    mt_com.mt_count = num;
1074    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1075    if (stat < 0) {
1076       berrno be;
1077       clrerror_dev(dev, MTBSR);
1078       Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1079          dev->dev_name, be.strerror(dev->dev_errno));
1080    }
1081    update_pos_dev(dev);
1082    return stat == 0;
1083 }
1084
1085 /*
1086  * Reposition the device to file, block
1087  * Returns: false on failure
1088  *          true  on success
1089  */
1090 bool
1091 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1092 {
1093    if (dev->fd < 0) {
1094       dev->dev_errno = EBADF;
1095       Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1096       Emsg0(M_FATAL, 0, dev->errmsg);
1097       return false;
1098    }
1099
1100    if (!(dev_state(dev, ST_TAPE))) {
1101       off_t pos = (((off_t)file)<<32) + block;
1102       Dmsg1(100, "===== lseek to %d\n", (int)pos);
1103       if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1104          dev->dev_errno = errno;
1105          Mmsg2(dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1106             dev->dev_name, strerror(dev->dev_errno));
1107          return false;
1108       }
1109       dev->file = file;
1110       dev->block_num = block;
1111       dev->file_addr = pos;
1112       return true;
1113    }
1114    Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1115       dev->file, dev->block_num, file, block);
1116    if (file < dev->file) {
1117       Dmsg0(100, "Rewind_dev\n");
1118       if (!rewind_dev(dev)) {
1119          return false;
1120       }
1121    }
1122    if (file > dev->file) {
1123       Dmsg1(100, "fsf %d\n", file-dev->file);
1124       if (!fsf_dev(dev, file-dev->file)) {
1125          return false;
1126       }
1127    }
1128    if (block < dev->block_num) {
1129       bsf_dev(dev, 1);
1130       fsf_dev(dev, 1);
1131    }
1132    if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1133       /* Ignore errors as Bacula can read to the correct block */
1134       Dmsg1(100, "fsr %d\n", block-dev->block_num);
1135       return fsr_dev(dev, block-dev->block_num);
1136    }
1137    return true;
1138 }
1139
1140
1141
1142 /*
1143  * Write an end of file on the device
1144  *   Returns: 0 on success
1145  *            non-zero on failure
1146  */
1147 int
1148 weof_dev(DEVICE *dev, int num)
1149 {
1150    struct mtop mt_com;
1151    int stat;
1152
1153    if (dev->fd < 0) {
1154       dev->dev_errno = EBADF;
1155       Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1156       Emsg0(M_FATAL, 0, dev->errmsg);
1157       return -1;
1158    }
1159
1160    if (!(dev_state(dev, ST_TAPE))) {
1161       return 0;
1162    }
1163    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
1164    Dmsg0(29, "weof_dev\n");
1165    mt_com.mt_op = MTWEOF;
1166    mt_com.mt_count = num;
1167    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1168    if (stat == 0) {
1169       dev->block_num = 0;
1170       dev->file += num;
1171       dev->file_addr = 0;
1172    } else {
1173       berrno be;
1174       clrerror_dev(dev, MTWEOF);
1175       if (stat == -1) {
1176          Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1177             dev->dev_name, be.strerror());
1178        }
1179    }
1180    return stat;
1181 }
1182
1183 /*
1184  * Return string message with last error in English
1185  *  Be careful not to call this routine from within dev.c
1186  *  while editing an Mmsg() or you will end up in a recursive
1187  *  loop creating a Segmentation Violation.
1188  */
1189 char *
1190 strerror_dev(DEVICE *dev)
1191 {
1192    return dev->errmsg;
1193 }
1194
1195
1196 /*
1197  * If implemented in system, clear the tape
1198  * error status.
1199  */
1200 void
1201 clrerror_dev(DEVICE *dev, int func)
1202 {
1203    const char *msg = NULL;
1204    struct mtget mt_stat;
1205
1206    dev->dev_errno = errno;         /* save errno */
1207    if (errno == EIO) {
1208       dev->VolCatInfo.VolCatErrors++;
1209    }
1210
1211    if (!(dev->state & ST_TAPE)) {
1212       return;
1213    }
1214    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1215       switch (func) {
1216       case -1:
1217          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1218          break;
1219       case MTWEOF:
1220          msg = "WTWEOF";
1221          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1222          break;
1223 #ifdef MTEOM
1224       case MTEOM:
1225          msg = "WTEOM";
1226          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1227          break;
1228 #endif
1229       case MTFSF:
1230          msg = "MTFSF";
1231          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1232          break;
1233       case MTBSF:
1234          msg = "MTBSF";
1235          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1236          break;
1237       case MTFSR:
1238          msg = "MTFSR";
1239          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1240          break;
1241       case MTBSR:
1242          msg = "MTBSR";
1243          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1244          break;
1245       default:
1246          msg = "Unknown";
1247          break;
1248       }
1249       if (msg != NULL) {
1250          dev->dev_errno = ENOSYS;
1251          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1252          Emsg0(M_ERROR, 0, dev->errmsg);
1253       }
1254    }
1255    /* On some systems such as NetBSD, this clears all errors */
1256    ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1257
1258 /* Found on Linux */
1259 #ifdef MTIOCLRERR
1260 {
1261    struct mtop mt_com;
1262    mt_com.mt_op = MTIOCLRERR;
1263    mt_com.mt_count = 1;
1264    /* Clear any error condition on the tape */
1265    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1266    Dmsg0(200, "Did MTIOCLRERR\n");
1267 }
1268 #endif
1269
1270 /* Typically on FreeBSD */
1271 #ifdef MTIOCERRSTAT
1272 {
1273    /* Read and clear SCSI error status */
1274    union mterrstat mt_errstat;
1275    Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1276       strerror(dev->dev_errno));
1277    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1278 }
1279 #endif
1280
1281 /* Clear Subsystem Exception OSF1 */
1282 #ifdef MTCSE
1283 {
1284    struct mtop mt_com;
1285    mt_com.mt_op = MTCSE;
1286    mt_com.mt_count = 1;
1287    /* Clear any error condition on the tape */
1288    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1289    Dmsg0(200, "Did MTCSE\n");
1290 }
1291 #endif
1292 }
1293
1294 /*
1295  * Flush buffer contents
1296  *  No longer used.
1297  */
1298 int flush_dev(DEVICE *dev)
1299 {
1300    return 1;
1301 }
1302
1303 static void do_close(DEVICE *dev)
1304 {
1305
1306    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1307    if (dev->fd >= 0) {
1308       close(dev->fd);
1309    }
1310    /* Clean up device packet so it can be reused */
1311    dev->fd = -1;
1312    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1313    dev->file = dev->block_num = 0;
1314    dev->file_addr = 0;
1315    dev->EndFile = dev->EndBlock = 0;
1316    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1317    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1318    if (dev->tid) {
1319       stop_thread_timer(dev->tid);
1320       dev->tid = 0;
1321    }
1322    dev->use_count = 0;
1323 }
1324
1325 /*
1326  * Close the device
1327  */
1328 void
1329 close_dev(DEVICE *dev)
1330 {
1331    if (!dev) {
1332       Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1333       Emsg0(M_FATAL, 0, dev->errmsg);
1334       return;
1335    }
1336    if (dev->fd >= 0 && dev->use_count == 1) {
1337       do_close(dev);
1338    } else if (dev->use_count > 0) {
1339       dev->use_count--;
1340    }
1341
1342 #ifdef FULL_DEBUG
1343    ASSERT(dev->use_count >= 0);
1344 #endif
1345 }
1346
1347 /*
1348  * Used when unmounting the device, ignore use_count
1349  */
1350 void force_close_dev(DEVICE *dev)
1351 {
1352    if (!dev) {
1353       Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1354       Emsg0(M_FATAL, 0, dev->errmsg);
1355       return;
1356    }
1357    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1358    do_close(dev);
1359
1360 #ifdef FULL_DEBUG
1361    ASSERT(dev->use_count >= 0);
1362 #endif
1363 }
1364
1365 bool truncate_dev(DEVICE *dev)
1366 {
1367    if (dev->state & ST_TAPE) {
1368       return true;                    /* we don't really truncate tapes */
1369       /* maybe we should rewind and write and eof ???? */
1370    }
1371    if (ftruncate(dev->fd, 0) != 0) {
1372       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1373       return false;
1374    }
1375    return true;
1376 }
1377
1378 bool
1379 dev_is_tape(DEVICE *dev)
1380 {
1381    return (dev->state & ST_TAPE) ? true : false;
1382 }
1383
1384
1385 /*
1386  * return 1 if the device is read for write, and 0 otherwise
1387  *   This is meant for checking at the end of a job to see
1388  *   if we still have a tape (perhaps not if at end of tape
1389  *   and the job is canceled).
1390  */
1391 bool
1392 dev_can_write(DEVICE *dev)
1393 {
1394    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1395        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1396       return true;
1397    } else {
1398       return false;
1399    }
1400 }
1401
1402 char *
1403 dev_name(DEVICE *dev)
1404 {
1405    return dev->dev_name;
1406 }
1407
1408 char *
1409 dev_vol_name(DEVICE *dev)
1410 {
1411    return dev->VolCatInfo.VolCatName;
1412 }
1413
1414 uint32_t dev_block(DEVICE *dev)
1415 {
1416    update_pos_dev(dev);
1417    return dev->block_num;
1418 }
1419
1420 uint32_t dev_file(DEVICE *dev)
1421 {
1422    update_pos_dev(dev);
1423    return dev->file;
1424 }
1425
1426 /*
1427  * Free memory allocated for the device
1428  */
1429 void
1430 term_dev(DEVICE *dev)
1431 {
1432    if (!dev) {
1433       dev->dev_errno = EBADF;
1434       Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1435       Emsg0(M_FATAL, 0, dev->errmsg);
1436       return;
1437    }
1438    do_close(dev);
1439    Dmsg0(29, "term_dev\n");
1440    if (dev->dev_name) {
1441       free_memory(dev->dev_name);
1442       dev->dev_name = NULL;
1443    }
1444    if (dev->errmsg) {
1445       free_pool_memory(dev->errmsg);
1446       dev->errmsg = NULL;
1447    }
1448    pthread_mutex_destroy(&dev->mutex);
1449    pthread_cond_destroy(&dev->wait);
1450    pthread_cond_destroy(&dev->wait_next_vol);
1451    pthread_mutex_destroy(&dev->spool_mutex);
1452    rwl_destroy(&dev->lock);
1453    if (dev->attached_dcrs) {
1454       delete dev->attached_dcrs;
1455       dev->attached_dcrs = NULL;
1456    }
1457    if (dev->state & ST_MALLOC) {
1458       free_pool_memory((POOLMEM *)dev);
1459    }
1460 }
1461
1462 /*
1463  * This routine initializes the device wait timers
1464  */
1465 void init_dev_wait_timers(DEVICE *dev)
1466 {
1467    /* ******FIXME******* put these on config variables */
1468    dev->min_wait = 60 * 60;
1469    dev->max_wait = 24 * 60 * 60;
1470    dev->max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
1471    dev->wait_sec = dev->min_wait;
1472    dev->rem_wait_sec = dev->wait_sec;
1473    dev->num_wait = 0;
1474    dev->poll = false;
1475    dev->BadVolName[0] = 0;
1476 }
1477
1478 /*
1479  * Returns: true if time doubled
1480  *          false if max time expired
1481  */
1482 bool double_dev_wait_time(DEVICE *dev)
1483 {
1484    dev->wait_sec *= 2;               /* double wait time */
1485    if (dev->wait_sec > dev->max_wait) {   /* but not longer than maxtime */
1486       dev->wait_sec = dev->max_wait;
1487    }
1488    dev->num_wait++;
1489    dev->rem_wait_sec = dev->wait_sec;
1490    if (dev->num_wait >= dev->max_num_wait) {
1491       return false;
1492    }
1493    return true;
1494 }
1495
1496 void set_os_device_parameters(DEVICE *dev)
1497 {
1498 #ifdef HAVE_LINUX_OS
1499    struct mtop mt_com;
1500    if (dev->min_block_size == dev->max_block_size &&
1501        dev->min_block_size == 0) {    /* variable block mode */
1502       mt_com.mt_op = MTSETBLK;
1503       mt_com.mt_count = 0;
1504       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1505          clrerror_dev(dev, MTSETBLK);
1506       }
1507       mt_com.mt_op = MTSETDRVBUFFER;
1508       mt_com.mt_count = MT_ST_CLEARBOOLEANS;
1509       if (!dev_cap(dev, CAP_TWOEOF)) {
1510          mt_com.mt_count |= MT_ST_TWO_FM;
1511       }
1512       if (dev_cap(dev, CAP_EOM)) {
1513          mt_com.mt_count |= MT_ST_FAST_MTEOM;
1514       }
1515       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1516          clrerror_dev(dev, MTSETBLK);
1517       }
1518    }
1519    return;
1520 #endif
1521
1522 #ifdef HAVE_NETBSD_OS
1523    struct mtop mt_com;
1524    if (dev->min_block_size == dev->max_block_size &&
1525        dev->min_block_size == 0) {    /* variable block mode */
1526       mt_com.mt_op = MTSETBSIZ;
1527       mt_com.mt_count = 0;
1528       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1529          clrerror_dev(dev, MTSETBSIZ);
1530       }
1531       /* Get notified at logical end of tape */
1532       mt_com.mt_op = MTEWARN;
1533       mt_com.mt_count = 1;
1534       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1535          clrerror_dev(dev, MTEWARN);
1536       }
1537    }
1538    return;
1539 #endif
1540
1541 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
1542    struct mtop mt_com;
1543    if (dev->min_block_size == dev->max_block_size &&
1544        dev->min_block_size == 0) {    /* variable block mode */
1545       mt_com.mt_op = MTSETBSIZ;
1546       mt_com.mt_count = 0;
1547       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1548          clrerror_dev(dev, MTSETBSIZ);
1549       }
1550    }
1551    return;
1552 #endif
1553
1554 #ifdef HAVE_SUN_OS
1555    struct mtop mt_com;
1556    if (dev->min_block_size == dev->max_block_size &&
1557        dev->min_block_size == 0) {    /* variable block mode */
1558       mt_com.mt_op = MTSRSZ;
1559       mt_com.mt_count = 0;
1560       if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1561          clrerror_dev(dev, MTSRSZ);
1562       }
1563    }
1564    return;
1565 #endif
1566
1567 }