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

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