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

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