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