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(000, "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(000, "====== 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       while (!(dev->state & ST_EOT)) {
 458          Dmsg0(200, "Do fsf 1\n");
 459          if (!fsf_dev(dev, 1)) {
 460             Dmsg0(200, "fsf_dev error.\n");
 461             return 0;
 462          }
 463       }
 464    }
 465    /*
 466     * Some drivers leave us after second EOF when doing
 467     * MTEOM, so we must backup so that appending overwrites
 468     * the second EOF.
 469     */
 470    if (dev_cap(dev, CAP_BSFATEOM)) {
 471       stat =  bsf_dev(dev, 1);
 472       dev->file++;                    /* keep same file */
 473    } else {
 474       update_pos_dev(dev);                   /* update position */
 475       stat = 1;
 476    }
 477    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 478    return stat;
 479 }
 480
 481 /*
 482  * Set the position of the device -- only for files
 483  *   For other devices, there is no generic way to do it.
 484  *  Returns: 1 on succes
 485  *           0 on error
 486  */
 487 int update_pos_dev(DEVICE *dev)
 488 {
 489    off_t pos;
 490    int stat = 0;
 491
 492    if (dev->fd < 0) {
 493       dev->dev_errno = EBADF;
 494       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 495       Emsg0(M_FATAL, 0, dev->errmsg);
 496       return 0;
 497    }
 498
 499    /* Find out where we are */
 500    if (dev->state & ST_FILE) {
 501       dev->file = 0;
 502       dev->file_addr = 0;
 503       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 504       if (pos < 0) {
 505          Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 506          dev->dev_errno = errno;
 507          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 508             dev->dev_name, strerror(dev->dev_errno));
 509       } else {
 510          stat = 1;
 511          dev->file_addr = pos;
 512       }
 513       return stat;
 514    }
 515    return 1;
 516 }
 517
 518
 519 /*
 520  * Return the status of the device.  This was meant
 521  * to be a generic routine. Unfortunately, it doesn't
 522  * seem possible (at least I do not know how to do it
 523  * currently), which means that for the moment, this
 524  * routine has very little value.
 525  *
 526  *   Returns: 1 on success
 527  *            0 on error
 528  */
 529 int
 530 status_dev(DEVICE *dev, uint32_t *status)
 531 {
 532    struct mtget mt_stat;
 533    uint32_t stat = 0;
 534
 535    if (dev->state & (ST_EOT | ST_WEOT)) {
 536       stat |= BMT_EOD;
 537       Dmsg0(-20, " EOD");
 538    }
 539    if (dev->state & ST_EOF) {
 540       stat |= BMT_EOF;
 541       Dmsg0(-20, " EOF");
 542    }
 543    if (dev->state & ST_TAPE) {
 544       stat |= BMT_TAPE;
 545       Dmsg0(-20," Driver status:");
 546       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 547       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 548          dev->dev_errno = errno;
 549          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 550             dev->dev_name, strerror(dev->dev_errno));
 551          return 0;
 552       }
 553       Dmsg0(-20, " Device status:");
 554
 555 #if defined(HAVE_LINUX_OS)
 556       if (GMT_EOF(mt_stat.mt_gstat)) {
 557          stat |= BMT_EOF;
 558          Dmsg0(-20, " EOF");
 559       }
 560       if (GMT_BOT(mt_stat.mt_gstat)) {
 561          stat |= BMT_BOT;
 562          Dmsg0(-20, " BOT");
 563       }
 564       if (GMT_EOT(mt_stat.mt_gstat)) {
 565          stat |= BMT_EOT;
 566          Dmsg0(-20, " EOT");
 567       }
 568       if (GMT_SM(mt_stat.mt_gstat)) {
 569          stat |= BMT_SM;
 570          Dmsg0(-20, " SM");
 571       }
 572       if (GMT_EOD(mt_stat.mt_gstat)) {
 573          stat |= BMT_EOD;
 574          Dmsg0(-20, " EOD");
 575       }
 576       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 577          stat |= BMT_WR_PROT;
 578          Dmsg0(-20, " WR_PROT");
 579       }
 580       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 581          stat |= BMT_ONLINE;
 582          Dmsg0(-20, " ONLINE");
 583       }
 584       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 585          stat |= BMT_DR_OPEN;
 586          Dmsg0(-20, " DR_OPEN");
 587       }
 588       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 589          stat |= BMT_IM_REP_EN;
 590          Dmsg0(-20, " IM_REP_EN");
 591       }
 592 #endif /* !SunOS && !OSF */
 593       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 594    } else {
 595       stat |= BMT_ONLINE | BMT_BOT;
 596    }
 597    *status = stat;
 598    return 1;
 599 }
 600
 601
 602 /*
 603  * Load medium in device
 604  *  Returns: 1 on success
 605  *           0 on failure
 606  */
 607 int load_dev(DEVICE *dev)
 608 {
 609 #ifdef MTLOAD
 610    struct mtop mt_com;
 611 #endif
 612
 613    if (dev->fd < 0) {
 614       dev->dev_errno = EBADF;
 615       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 616       Emsg0(M_FATAL, 0, dev->errmsg);
 617       return 0;
 618    }
 619    if (!(dev->state & ST_TAPE)) {
 620       return 1;
 621    }
 622 #ifndef MTLOAD
 623    Dmsg0(200, "stored: MTLOAD command not available\n");
 624    dev->dev_errno = ENOTTY;           /* function not available */
 625    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 626          dev->dev_name, strerror(dev->dev_errno));      return 0;
 627    return 0;
 628 #else
 629
 630    dev->block_num = dev->file = 0;
 631    dev->file_addr = 0;
 632    mt_com.mt_op = MTLOAD;
 633    mt_com.mt_count = 1;
 634    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 635       dev->dev_errno = errno;
 636       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 637          dev->dev_name, strerror(dev->dev_errno));      return 0;
 638    }
 639    return 1;
 640 #endif
 641 }
 642
 643 /*
 644  * Rewind device and put it offline
 645  *  Returns: 1 on success
 646  *           0 on failure
 647  */
 648 int offline_dev(DEVICE *dev)
 649 {
 650    struct mtop mt_com;
 651
 652    if (dev->fd < 0) {
 653       dev->dev_errno = EBADF;
 654       Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
 655       Emsg0(M_FATAL, 0, dev->errmsg);
 656       return 0;
 657    }
 658    if (!(dev->state & ST_TAPE)) {
 659       return 1;
 660    }
 661
 662    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
 663    dev->block_num = dev->file = 0;
 664    dev->file_addr = 0;
 665 #ifdef MTUNLOCK
 666    mt_com.mt_op = MTUNLOCK;
 667    mt_com.mt_count = 1;
 668    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 669 #endif
 670    mt_com.mt_op = MTOFFL;
 671    mt_com.mt_count = 1;
 672    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 673       dev->dev_errno = errno;
 674       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 675          dev->dev_name, strerror(dev->dev_errno));
 676       return 0;
 677    }
 678    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 679    return 1;
 680 }
 681
 682 int offline_or_rewind_dev(DEVICE *dev)
 683 {
 684    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
 685       return offline_dev(dev);
 686    } else {
 687    /*
 688     * Note, this rewind probably should not be here (it wasn't
 689     *  in prior versions of Bacula), but on FreeBSD, this is
 690     *  needed in the case the tape was "frozen" due to an error
 691     *  such as backspacing after writing and EOF. If it is not
 692     *  done, all future references to the drive get and I/O error.
 693     */
 694       return rewind_dev(dev);
 695    }
 696 }
 697
 698 /*
 699  * Foward space a file
 700  *   Returns: 1 on success
 701  *            0 on failure
 702  */
 703 int
 704 fsf_dev(DEVICE *dev, int num)
 705 {
 706    struct mtop mt_com;
 707    int stat = 0;
 708
 709    if (dev->fd < 0) {
 710       dev->dev_errno = EBADF;
 711       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 712       Emsg0(M_FATAL, 0, dev->errmsg);
 713       return 0;
 714    }
 715
 716    if (!(dev->state & ST_TAPE)) {
 717       return 1;
 718    }
 719    if (dev->state & ST_EOT) {
 720       dev->dev_errno = 0;
 721       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 722       return 0;
 723    }
 724    if (dev->state & ST_EOF) {
 725       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 726    }
 727    if (dev->state & ST_EOT) {
 728       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 729    }
 730
 731    Dmsg0(29, "fsf_dev\n");
 732    dev->block_num = 0;
 733    if (dev_cap(dev, CAP_FSF)) {
 734       POOLMEM *rbuf;
 735       int rbuf_len;
 736       Dmsg0(200, "FSF has cap_fsf\n");
 737       if (dev->max_block_size == 0) {
 738          rbuf_len = DEFAULT_BLOCK_SIZE;
 739       } else {
 740          rbuf_len = dev->max_block_size;
 741       }
 742       rbuf = get_memory(rbuf_len);
 743       mt_com.mt_op = MTFSF;
 744       mt_com.mt_count = 1;
 745       while (num-- && !(dev->state & ST_EOT)) {
 746          Dmsg0(200, "Doing read before fsf\n");
 747          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
 748             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 749                stat = rbuf_len;        /* This is OK */
 750             } else {
 751                dev->state |= ST_EOT;
 752                clrerror_dev(dev, -1);
 753                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
 754                   strerror(dev->dev_errno));
 755                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 756                   dev->dev_name, strerror(dev->dev_errno));
 757                Dmsg1(200, "%s", dev->errmsg);
 758                break;
 759             }
 760          }
 761          if (stat == 0) {                /* EOF */
 762             update_pos_dev(dev);
 763             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 764             /* Two reads of zero means end of tape */
 765             if (dev->state & ST_EOF) {
 766                dev->state |= ST_EOT;
 767                Dmsg0(200, "Set ST_EOT\n");
 768                break;
 769             } else {
 770                dev->state |= ST_EOF;
 771                dev->file++;
 772                dev->file_addr = 0;
 773                continue;
 774             }
 775          } else {                        /* Got data */
 776             dev->state &= ~(ST_EOF|ST_EOT);
 777          }
 778
 779          Dmsg0(200, "Doing MTFSF\n");
 780          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 781          if (stat < 0) {                 /* error => EOT */
 782             dev->state |= ST_EOT;
 783             Dmsg0(200, "Set ST_EOT\n");
 784             clrerror_dev(dev, MTFSF);
 785             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 786                dev->dev_name, strerror(dev->dev_errno));
 787             Dmsg0(200, "Got < 0 for MTFSF\n");
 788             Dmsg1(200, "%s", dev->errmsg);
 789          } else {
 790             dev->state |= ST_EOF;     /* just read EOF */
 791             dev->file++;
 792             dev->file_addr = 0;
 793          }
 794       }
 795       free_memory(rbuf);
 796
 797    /*
 798     * No FSF, so use FSR to simulate it
 799     */
 800    } else {
 801       Dmsg0(200, "Doing FSR for FSF\n");
 802       while (num-- && !(dev->state & ST_EOT)) {
 803          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 804       }
 805       if (dev->state & ST_EOT) {
 806          dev->dev_errno = 0;
 807          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 808          stat = -1;
 809       } else {
 810          stat = 0;
 811       }
 812    }
 813    update_pos_dev(dev);
 814    Dmsg1(200, "Return %d from FSF\n", stat);
 815    if (dev->state & ST_EOF)
 816       Dmsg0(200, "ST_EOF set on exit FSF\n");
 817    if (dev->state & ST_EOT)
 818       Dmsg0(200, "ST_EOT set on exit FSF\n");
 819    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 820    return stat == 0 ? 1 : 0;
 821 }
 822
 823 /*
 824  * Backward space a file
 825  *  Returns: 0 on failure
 826  *           1 on success
 827  */
 828 int
 829 bsf_dev(DEVICE *dev, int num)
 830 {
 831    struct mtop mt_com;
 832    int stat;
 833
 834    if (dev->fd < 0) {
 835       dev->dev_errno = EBADF;
 836       Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
 837       Emsg0(M_FATAL, 0, dev->errmsg);
 838       return 0;
 839    }
 840
 841    if (!(dev_state(dev, ST_TAPE))) {
 842       Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
 843          dev->dev_name);
 844       return 0;
 845    }
 846    Dmsg0(29, "bsf_dev\n");
 847    dev->state &= ~(ST_EOT|ST_EOF);
 848    dev->file -= num;
 849    dev->file_addr = 0;
 850    mt_com.mt_op = MTBSF;
 851    mt_com.mt_count = num;
 852    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 853    if (stat < 0) {
 854       clrerror_dev(dev, MTBSF);
 855       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 856          dev->dev_name, strerror(dev->dev_errno));
 857    }
 858    update_pos_dev(dev);
 859    return stat == 0 ? 1 : 0;
 860 }
 861
 862
 863 /*
 864  * Foward space a record
 865  *  Returns: 0 on failure
 866  *           1 on success
 867  */
 868 int
 869 fsr_dev(DEVICE *dev, int num)
 870 {
 871    struct mtop mt_com;
 872    int stat;
 873
 874    if (dev->fd < 0) {
 875       dev->dev_errno = EBADF;
 876       Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
 877       Emsg0(M_FATAL, 0, dev->errmsg);
 878       return 0;
 879    }
 880
 881    if (!(dev_state(dev, ST_TAPE))) {
 882       return 0;
 883    }
 884    Dmsg0(29, "fsr_dev\n");
 885    dev->block_num += num;
 886    mt_com.mt_op = MTFSR;
 887    mt_com.mt_count = num;
 888    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 889    if (stat == 0) {
 890       dev->state &= ~ST_EOF;
 891    } else {
 892       if (dev->state & ST_EOF) {
 893          dev->state |= ST_EOT;
 894       } else {
 895          dev->state |= ST_EOF;           /* assume EOF */
 896          dev->file++;
 897          dev->file_addr = 0;
 898       }
 899       clrerror_dev(dev, MTFSR);
 900       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 901          dev->dev_name, strerror(dev->dev_errno));
 902    }
 903    update_pos_dev(dev);
 904    return stat == 0 ? 1 : 0;
 905 }
 906
 907 /*
 908  * Backward space a record
 909  *   Returns:  0 on failure
 910  *             1 on success
 911  */
 912 int
 913 bsr_dev(DEVICE *dev, int num)
 914 {
 915    struct mtop mt_com;
 916    int stat;
 917
 918    if (dev->fd < 0) {
 919       dev->dev_errno = EBADF;
 920       Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
 921       Emsg0(M_FATAL, 0, dev->errmsg);
 922       return 0;
 923    }
 924
 925    if (!(dev->state & ST_TAPE)) {
 926       return 0;
 927    }
 928
 929    if (!dev_cap(dev, CAP_BSR)) {
 930       Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
 931          dev->dev_name);
 932       return 0;
 933    }
 934
 935    Dmsg0(29, "bsr_dev\n");
 936    dev->block_num -= num;
 937    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 938    mt_com.mt_op = MTBSR;
 939    mt_com.mt_count = num;
 940    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 941    if (stat < 0) {
 942       clrerror_dev(dev, MTBSR);
 943       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 944          dev->dev_name, strerror(dev->dev_errno));
 945    }
 946    update_pos_dev(dev);
 947    return stat == 0 ? 1 : 0;
 948 }
 949
 950 /*
 951  * Reposition the device to file, block
 952  *   Currently only works for tapes.
 953  * Returns: 0 on failure
 954  *          1 on success
 955  */
 956 int
 957 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
 958 {
 959    if (dev->fd < 0) {
 960       dev->dev_errno = EBADF;
 961       Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
 962       Emsg0(M_FATAL, 0, dev->errmsg);
 963       return 0;
 964    }
 965
 966    if (!(dev_state(dev, ST_TAPE))) {
 967       return 0;
 968    }
 969    Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
 970       dev->file, dev->block_num, file, block);
 971    if (file < dev->file) {
 972       Dmsg0(100, "Rewind_dev\n");
 973       if (!rewind_dev(dev)) {
 974          return 0;
 975       }
 976    }
 977    if (file > dev->file) {
 978       Dmsg1(100, "fsf %d\n", file-dev->file);
 979       if (!fsf_dev(dev, file-dev->file)) {
 980          return 0;
 981       }
 982    }
 983    if (block < dev->block_num) {
 984       bsf_dev(dev, 1);
 985       fsf_dev(dev, 1);
 986    }
 987    if (block > dev->block_num) {
 988       /* Ignore errors as Bacula can read to the correct block */
 989       Dmsg1(100, "fsr %d\n", block-dev->block_num);
 990       fsr_dev(dev, block-dev->block_num);
 991    }
 992    return 1;
 993 }
 994
 995
 996
 997 /*
 998  * Write an end of file on the device
 999  *   Returns: 0 on success
1000  *            non-zero on failure
1001  */
1002 int
1003 weof_dev(DEVICE *dev, int num)
1004 {
1005    struct mtop mt_com;
1006    int stat;
1007
1008    if (dev->fd < 0) {
1009       dev->dev_errno = EBADF;
1010       Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1011       Emsg0(M_FATAL, 0, dev->errmsg);
1012       return -1;
1013    }
1014
1015    if (!(dev->state & ST_TAPE)) {
1016       return 0;
1017    }
1018    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
1019    dev->block_num = 0;
1020    Dmsg0(29, "weof_dev\n");
1021    mt_com.mt_op = MTWEOF;
1022    mt_com.mt_count = num;
1023    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1024    if (stat == 0) {
1025       dev->file += num;
1026       dev->file_addr = 0;
1027    } else {
1028       clrerror_dev(dev, MTWEOF);
1029       if (stat == -1) {
1030       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1031          dev->dev_name, strerror(dev->dev_errno));
1032        }
1033    }
1034    return stat;
1035 }
1036
1037 /*
1038  * Return string message with last error in English
1039  *  Be careful not to call this routine from within dev.c
1040  *  while editing an Mmsg(&) or you will end up in a recursive
1041  *  loop creating a Segmentation Violation.
1042  */
1043 char *
1044 strerror_dev(DEVICE *dev)
1045 {
1046    return dev->errmsg;
1047 }
1048
1049
1050 /*
1051  * If implemented in system, clear the tape
1052  * error status.
1053  */
1054 void
1055 clrerror_dev(DEVICE *dev, int func)
1056 {
1057    char *msg = NULL;
1058
1059    dev->dev_errno = errno;         /* save errno */
1060    if (errno == EIO) {
1061       dev->VolCatInfo.VolCatErrors++;
1062    }
1063
1064    if (!(dev->state & ST_TAPE)) {
1065       return;
1066    }
1067    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1068       switch (func) {
1069       case -1:
1070          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1071          break;
1072       case MTWEOF:
1073          msg = "WTWEOF";
1074          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1075          break;
1076 #ifdef MTEOM
1077       case MTEOM:
1078          msg = "WTEOM";
1079          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1080          break;
1081 #endif
1082       case MTFSF:
1083          msg = "MTFSF";
1084          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1085          break;
1086       case MTBSF:
1087          msg = "MTBSF";
1088          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1089          break;
1090       case MTFSR:
1091          msg = "MTFSR";
1092          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1093          break;
1094       case MTBSR:
1095          msg = "MTBSR";
1096          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1097          break;
1098       default:
1099          msg = "Unknown";
1100          break;
1101       }
1102       if (msg != NULL) {
1103          dev->dev_errno = ENOSYS;
1104          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1105          Emsg0(M_ERROR, 0, dev->errmsg);
1106       }
1107    }
1108 /* Found on Linux */
1109 #ifdef MTIOCLRERR
1110 {
1111    struct mtop mt_com;
1112    mt_com.mt_op = MTIOCLRERR;
1113    mt_com.mt_count = 1;
1114    /* Clear any error condition on the tape */
1115    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1116    Dmsg0(200, "Did MTIOCLRERR\n");
1117 }
1118 #endif
1119
1120 /* Typically on FreeBSD */
1121 #ifdef MTIOCERRSTAT
1122 {
1123    /* Read and clear SCSI error status */
1124    union mterrstat mt_errstat;
1125    Pmsg2(000, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1126       strerror(dev->dev_errno));
1127    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1128 }
1129 #endif
1130 }
1131
1132 /*
1133  * Flush buffer contents
1134  *  No longer used.
1135  */
1136 int flush_dev(DEVICE *dev)
1137 {
1138    return 1;
1139 }
1140
1141 static void do_close(DEVICE *dev)
1142 {
1143
1144    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1145    if (dev->fd >= 0) {
1146       close(dev->fd);
1147    }
1148    /* Clean up device packet so it can be reused */
1149    dev->fd = -1;
1150    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1151    dev->file = dev->block_num = 0;
1152    dev->file_addr = 0;
1153    dev->EndFile = dev->EndBlock = 0;
1154    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1155    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1156    if (dev->tid) {
1157       stop_thread_timer(dev->tid);
1158       dev->tid = 0;
1159    }
1160    dev->use_count = 0;
1161 }
1162
1163 /*
1164  * Close the device
1165  */
1166 void
1167 close_dev(DEVICE *dev)
1168 {
1169    if (!dev) {
1170       Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1171       Emsg0(M_FATAL, 0, dev->errmsg);
1172       return;
1173    }
1174    if (dev->fd >= 0 && dev->use_count == 1) {
1175       do_close(dev);
1176    } else if (dev->use_count > 0) {
1177       dev->use_count--;
1178    }
1179
1180 #ifdef FULL_DEBUG
1181    ASSERT(dev->use_count >= 0);
1182 #endif
1183 }
1184
1185 /*
1186  * Used when unmounting the device, ignore use_count
1187  */
1188 void force_close_dev(DEVICE *dev)
1189 {
1190    if (!dev) {
1191       Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1192       Emsg0(M_FATAL, 0, dev->errmsg);
1193       return;
1194    }
1195    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1196    do_close(dev);
1197
1198 #ifdef FULL_DEBUG
1199    ASSERT(dev->use_count >= 0);
1200 #endif
1201 }
1202
1203 int truncate_dev(DEVICE *dev)
1204 {
1205    if (dev->state & ST_TAPE) {
1206       return 1;
1207    }
1208    if (ftruncate(dev->fd, 0) != 0) {
1209       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1210       return 0;
1211    }
1212    return 1;
1213 }
1214
1215 int
1216 dev_is_tape(DEVICE *dev)
1217 {
1218    return (dev->state & ST_TAPE) ? 1 : 0;
1219 }
1220
1221
1222 /*
1223  * return 1 if the device is read for write, and 0 otherwise
1224  *   This is meant for checking at the end of a job to see
1225  *   if we still have a tape (perhaps not if at end of tape
1226  *   and the job is canceled).
1227  */
1228 int
1229 dev_can_write(DEVICE *dev)
1230 {
1231    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1232        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1233       return 1;
1234    } else {
1235       return 0;
1236    }
1237 }
1238
1239 char *
1240 dev_name(DEVICE *dev)
1241 {
1242    return dev->dev_name;
1243 }
1244
1245 char *
1246 dev_vol_name(DEVICE *dev)
1247 {
1248    return dev->VolCatInfo.VolCatName;
1249 }
1250
1251 uint32_t dev_block(DEVICE *dev)
1252 {
1253    update_pos_dev(dev);
1254    return dev->block_num;
1255 }
1256
1257 uint32_t dev_file(DEVICE *dev)
1258 {
1259    update_pos_dev(dev);
1260    return dev->file;
1261 }
1262
1263 /*
1264  * Free memory allocated for the device
1265  */
1266 void
1267 term_dev(DEVICE *dev)
1268 {
1269    if (!dev) {
1270       dev->dev_errno = EBADF;
1271       Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1272       Emsg0(M_FATAL, 0, dev->errmsg);
1273       return;
1274    }
1275    do_close(dev);
1276    Dmsg0(29, "term_dev\n");
1277    if (dev->dev_name) {
1278       free_memory(dev->dev_name);
1279       dev->dev_name = NULL;
1280    }
1281    if (dev->errmsg) {
1282       free_pool_memory(dev->errmsg);
1283       dev->errmsg = NULL;
1284    }
1285    pthread_mutex_destroy(&dev->mutex);
1286    pthread_cond_destroy(&dev->wait);
1287    pthread_cond_destroy(&dev->wait_next_vol);
1288    if (dev->state & ST_MALLOC) {
1289       free_pool_memory((POOLMEM *)dev);
1290    }
1291 }
1292
1293 /*
1294  * We attach a jcr to the device so that when
1295  *   the Volume is full during writing, a
1296  *   JobMedia record will be created for this
1297  *   Job.
1298  */
1299 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1300 {
1301    jcr->prev_dev = (JCR *)NULL;
1302    jcr->next_dev = dev->attached_jcrs;
1303    if (dev->attached_jcrs) {
1304       dev->attached_jcrs->prev_dev = jcr;
1305    }
1306    dev->attached_jcrs = jcr;
1307    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1308 }
1309
1310 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1311 {
1312    if (!jcr->prev_dev) {
1313       dev->attached_jcrs = jcr->next_dev;
1314    } else {
1315       jcr->prev_dev->next_dev = jcr->next_dev;
1316    }
1317    if (jcr->next_dev) {
1318       jcr->next_dev->prev_dev = jcr->prev_dev;
1319    }
1320    jcr->next_dev = jcr->prev_dev = NULL;
1321    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1322 }
1323
1324 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1325 {
1326    if (jcr == (JCR *)NULL) {
1327       return dev->attached_jcrs;
1328    }
1329    return jcr->next_dev;
1330 }