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

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