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, 2001, 2002 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 int dev_is_tape(DEVICE *dev);
  87 void clrerror_dev(DEVICE *dev, int func);
  88 int fsr_dev(DEVICE *dev, int num);
  89
  90 extern int debug_level;
  91
  92 /*
  93  * Allocate and initialize the DEVICE structure
  94  * Note, if dev is non-NULL, it is already allocated,
  95  * thus we neither allocate it nor free it. This allows
  96  * the caller to put the packet in shared memory.
  97  *
  98  *  Note, for a tape, the device->device_name is the device name
  99  *     (e.g. /dev/nst0), and for a file, the device name
 100  *     is the directory in which the file will be placed.
 101  *
 102  */
 103 DEVICE *
 104 init_dev(DEVICE *dev, DEVRES *device)
 105 {
 106    struct stat statp;
 107    int tape;
 108    int errstat;
 109
 110    /* Check that device is available */
 111    if (stat(device->device_name, &statp) < 0) {
 112       if (dev) {
 113          dev->dev_errno = errno;
 114       }
 115       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
 116             strerror(errno));
 117       return NULL;
 118    }
 119    tape = FALSE;
 120    if (S_ISDIR(statp.st_mode)) {
 121       tape = FALSE;
 122    } else if (S_ISCHR(statp.st_mode)) {
 123       tape = TRUE;
 124    } else {
 125       if (dev) {
 126          dev->dev_errno = ENODEV;
 127       }
 128       Emsg2(M_FATAL, 0, "%s is an unknown device type. Must be tape or directory. st_mode=%x\n",
 129          dev_name, statp.st_mode);
 130       return NULL;
 131    }
 132    if (!dev) {
 133       dev = (DEVICE *)get_memory(sizeof(DEVICE));
 134       memset(dev, 0, sizeof(DEVICE));
 135       dev->state = ST_MALLOC;
 136    } else {
 137       memset(dev, 0, sizeof(DEVICE));
 138    }
 139    if (tape) {
 140       dev->state |= ST_TAPE;
 141    }
 142
 143    /* Copy user supplied device parameters from Resource */
 144    dev->dev_name = get_memory(strlen(device->device_name)+1);
 145    strcpy(dev->dev_name, device->device_name);
 146    dev->capabilities = device->cap_bits;
 147    dev->min_block_size = device->min_block_size;
 148    dev->max_block_size = device->max_block_size;
 149    dev->max_volume_jobs = device->max_volume_jobs;
 150    dev->max_volume_files = device->max_volume_files;
 151    dev->max_volume_size = device->max_volume_size;
 152    dev->max_file_size = device->max_file_size;
 153    dev->volume_capacity = device->volume_capacity;
 154    dev->max_rewind_wait = device->max_rewind_wait;
 155    dev->max_open_wait = device->max_open_wait;
 156    dev->device = device;
 157
 158
 159    dev->errmsg = get_pool_memory(PM_EMSG);
 160    *dev->errmsg = 0;
 161
 162    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 163       dev->dev_errno = errstat;
 164       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
 165       Emsg0(M_FATAL, 0, dev->errmsg);
 166    }
 167    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 168       dev->dev_errno = errstat;
 169       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 170       Emsg0(M_FATAL, 0, dev->errmsg);
 171    }
 172    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
 173       dev->dev_errno = errstat;
 174       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 175       Emsg0(M_FATAL, 0, dev->errmsg);
 176    }
 177    dev->fd = -1;
 178    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 179    return dev;
 180 }
 181
 182 /* Open the device with the operating system and
 183  * initialize buffer pointers.
 184  *
 185  * Note, for a tape, the VolName is the name we give to the
 186  *    volume (not really used here), but for a file, the
 187  *    VolName represents the name of the file to be created/opened.
 188  *    In the case of a file, the full name is the device name
 189  *    (archive_name) with the VolName concatenated.
 190  */
 191 int
 192 open_dev(DEVICE *dev, char *VolName, int mode)
 193 {
 194    POOLMEM *archive_name;
 195
 196    if (dev->state & ST_OPENED) {
 197       /*
 198        *  *****FIXME***** how to handle two threads wanting
 199        *  different volumes mounted???? E.g. one is waiting
 200        *  for the next volume to be mounted, and a new job
 201        *  starts and snatches up the device.
 202        */
 203       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 204          return -1;
 205       }
 206       dev->use_count++;
 207       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 208             dev->dev_name, dev->use_count);
 209       Emsg0(M_WARNING, 0, dev->errmsg);
 210       return dev->fd;
 211    }
 212    if (VolName) {
 213       strcpy(dev->VolCatInfo.VolCatName, VolName);
 214    }
 215
 216    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 217          dev->dev_name, dev->VolCatInfo.VolCatName);
 218    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 219    if (dev->state & ST_TAPE) {
 220       int timeout;
 221       Dmsg0(29, "open_dev: device is tape\n");
 222       if (mode == READ_WRITE) {
 223          dev->mode = O_RDWR | O_BINARY;
 224       } else {
 225          dev->mode = O_RDONLY | O_BINARY;
 226       }
 227       timeout = dev->max_open_wait;
 228       errno = 0;
 229       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 230          if (errno == EBUSY && timeout-- > 0) {
 231             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 232             sleep(1);
 233             continue;
 234          }
 235          dev->dev_errno = errno;
 236          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 237                dev->dev_name, strerror(dev->dev_errno));
 238          Emsg0(M_FATAL, 0, dev->errmsg);
 239          break;
 240       }
 241       if (dev->fd >= 0) {
 242          dev->dev_errno = 0;
 243          dev->state |= ST_OPENED;
 244          dev->use_count++;
 245          update_pos_dev(dev);             /* update position */
 246       }
 247       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 248    } else {
 249       /*
 250        * Handle opening of file
 251        */
 252       archive_name = get_pool_memory(PM_FNAME);
 253       strcpy(archive_name, dev->dev_name);
 254       if (archive_name[strlen(archive_name)] != '/') {
 255          strcat(archive_name, "/");
 256       }
 257       strcat(archive_name, VolName);
 258       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
 259       if (mode == READ_WRITE) {
 260          dev->mode = O_CREAT | O_RDWR | O_BINARY;
 261       } else {
 262          dev->mode = O_RDONLY | O_BINARY;
 263       }
 264       if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
 265          dev->dev_errno = errno;
 266          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
 267          Emsg0(M_FATAL, 0, dev->errmsg);
 268       } else {
 269          dev->dev_errno = 0;
 270          dev->state |= ST_OPENED;
 271          dev->use_count++;
 272          update_pos_dev(dev);                /* update position */
 273       }
 274       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
 275       free_pool_memory(archive_name);
 276    }
 277    return dev->fd;
 278 }
 279
 280 /*
 281  * Rewind the device.
 282  *  Returns: 1 on success
 283  *           0 on failure
 284  */
 285 int rewind_dev(DEVICE *dev)
 286 {
 287    struct mtop mt_com;
 288    unsigned int i;
 289
 290    Dmsg0(29, "rewind_dev\n");
 291    if (dev->fd < 0) {
 292       dev->dev_errno = EBADF;
 293       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
 294             dev->dev_name);
 295       Emsg0(M_FATAL, 0, dev->errmsg);
 296       return 0;
 297    }
 298    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT);  /* remove EOF/EOT flags */
 299    dev->block_num = dev->file = 0;
 300    dev->file_addr = 0;
 301    if (dev->state & ST_TAPE) {
 302       mt_com.mt_op = MTREW;
 303       mt_com.mt_count = 1;
 304       /* If we get an I/O error on rewind, it is probably because
 305        * the drive is actually busy. We loop for (about 5 minutes)
 306        * retrying every 5 seconds.
 307        */
 308       for (i=dev->max_rewind_wait; ; i -= 5) {
 309          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 310             if (i == dev->max_rewind_wait) {
 311                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
 312             }
 313             clrerror_dev(dev, MTREW);
 314             if (dev->dev_errno == EIO && i > 0) {
 315                Dmsg0(200, "Sleeping 5 seconds.\n");
 316                sleep(5);
 317                continue;
 318             }
 319             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
 320                dev->dev_name, strerror(dev->dev_errno));
 321             return 0;
 322          }
 323          break;
 324       }
 325    } else {
 326       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
 327          dev->dev_errno = errno;
 328          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 329             dev->dev_name, strerror(dev->dev_errno));
 330          return 0;
 331       }
 332    }
 333    return 1;
 334 }
 335
 336 /*
 337  * Position device to end of medium (end of data)
 338  *  Returns: 1 on succes
 339  *           0 on error
 340  */
 341 int
 342 eod_dev(DEVICE *dev)
 343 {
 344    struct mtop mt_com;
 345    struct mtget mt_stat;
 346    int stat = 0;
 347    off_t pos;
 348
 349    Dmsg0(29, "eod_dev\n");
 350    if (dev->state & ST_EOT) {
 351       return 1;
 352    }
 353    dev->state &= ~(ST_EOF);  /* remove EOF flags */
 354    dev->block_num = dev->file = 0;
 355    dev->file_addr = 0;
 356    if (!(dev->state & ST_TAPE)) {
 357       pos = lseek(dev->fd, (off_t)0, SEEK_END);
 358 //    Dmsg1(000, "====== Seek to %lld\n", pos);
 359       if (pos >= 0) {
 360          update_pos_dev(dev);
 361          dev->state |= ST_EOT;
 362          return 1;
 363       }
 364       return 0;
 365    }
 366    if (dev->capabilities & CAP_EOM) {
 367       mt_com.mt_op = MTEOM;
 368       mt_com.mt_count = 1;
 369       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
 370          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
 371          clrerror_dev(dev, mt_com.mt_op);
 372          update_pos_dev(dev);
 373          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
 374             dev->dev_name, strerror(dev->dev_errno));
 375          return 0;
 376       }
 377       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 378          dev->dev_errno = errno;
 379          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 380             dev->dev_name, strerror(dev->dev_errno));
 381          return 0;
 382       }
 383       Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 384       dev->file = mt_stat.mt_fileno;
 385
 386    /*
 387     * Rewind then use FSF until EOT reached
 388     */
 389    } else {
 390       if (!rewind_dev(dev)) {
 391          return 0;
 392       }
 393       while (!(dev->state & ST_EOT)) {
 394          Dmsg0(200, "Do fsf 1\n");
 395          if (fsf_dev(dev, 1) < 0) {
 396             Dmsg0(200, "fsf_dev return < 0\n");
 397             return 0;
 398          }
 399       }
 400    }
 401    update_pos_dev(dev);                      /* update position */
 402    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 403    return 1;
 404 }
 405
 406 /*
 407  * Set the position of the device.
 408  *  Returns: 1 on succes
 409  *           0 on error
 410  */
 411 int update_pos_dev(DEVICE *dev)
 412 {
 413 #ifdef xxxx
 414    struct mtget mt_stat;
 415 #endif
 416    off_t pos;
 417    int stat = 0;
 418
 419    if (dev->fd < 0) {
 420       dev->dev_errno = EBADF;
 421       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 422       Emsg0(M_FATAL, 0, dev->errmsg);
 423       return 0;
 424    }
 425
 426    /* Find out where we are */
 427    if (!(dev->state & ST_TAPE)) {
 428       dev->file = 0;
 429       dev->file_addr = 0;
 430       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 431       if (pos < 0) {
 432          Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 433          dev->dev_errno = errno;
 434          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 435             dev->dev_name, strerror(dev->dev_errno));
 436       } else {
 437          stat = 1;
 438          dev->file_addr = pos;
 439       }
 440       return stat;
 441    }
 442
 443 #ifdef REALLY_IMPLEMENTED
 444    if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 445       Dmsg1(50, "MTIOCGET error: %s\n", strerror(dev->dev_errno));
 446       dev->dev_errno = errno;
 447       Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 448          dev->dev_name, strerror(dev->dev_errno));
 449    } else {
 450       stat = 1;
 451    }
 452    return stat;
 453 #endif
 454    return 1;
 455 }
 456
 457
 458 /*
 459  * Return the status of the device.  This was meant
 460  * to be a generic routine. Unfortunately, it doesn't
 461  * seem possible (at least I do not know how to do it
 462  * currently), which means that for the moment, this
 463  * routine has very little value.
 464  *
 465  *   Returns: 1 on success
 466  *            0 on error
 467  */
 468 int
 469 status_dev(DEVICE *dev, uint32_t *status)
 470 {
 471    struct mtget mt_stat;
 472    uint32_t stat = 0;
 473
 474    if (dev->state & (ST_EOT | ST_WEOT)) {
 475       stat |= MT_EOD;
 476       Dmsg0(-20, " EOD");
 477    }
 478    if (dev->state & ST_EOF) {
 479       stat |= MT_EOF;
 480       Dmsg0(-20, " EOF");
 481    }
 482    if (dev->state & ST_TAPE) {
 483       stat |= MT_TAPE;
 484       Dmsg0(-20," Driver status:");
 485       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 486       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 487          dev->dev_errno = errno;
 488          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 489             dev->dev_name, strerror(dev->dev_errno));
 490          return 0;
 491       }
 492       Dmsg0(-20, " Device status:");
 493
 494 #if defined(HAVE_LINUX_OS)
 495       if (GMT_EOF(mt_stat.mt_gstat)) {
 496          stat |= MT_EOF;
 497          Dmsg0(-20, " EOF");
 498       }
 499       if (GMT_BOT(mt_stat.mt_gstat)) {
 500          stat |= MT_BOT;
 501          Dmsg0(-20, " BOT");
 502       }
 503       if (GMT_EOT(mt_stat.mt_gstat)) {
 504          stat |= MT_EOT;
 505          Dmsg0(-20, " EOT");
 506       }
 507       if (GMT_SM(mt_stat.mt_gstat)) {
 508          stat |= MT_SM;
 509          Dmsg0(-20, " SM");
 510       }
 511       if (GMT_EOD(mt_stat.mt_gstat)) {
 512          stat |= MT_EOD;
 513          Dmsg0(-20, " EOD");
 514       }
 515       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 516          stat |= MT_WR_PROT;
 517          Dmsg0(-20, " WR_PROT");
 518       }
 519       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 520          stat |= MT_ONLINE;
 521          Dmsg0(-20, " ONLINE");
 522       }
 523       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 524          stat |= MT_DR_OPEN;
 525          Dmsg0(-20, " DR_OPEN");
 526       }
 527       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 528          stat |= MT_IM_REP_EN;
 529          Dmsg0(-20, " IM_REP_EN");
 530       }
 531 #endif /* !SunOS && !OSF */
 532       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 533    } else {
 534       stat |= MT_ONLINE | MT_BOT;
 535    }
 536    *status = stat;
 537    return 1;
 538 }
 539
 540
 541 /*
 542  * Load medium in device
 543  *  Returns: 1 on success
 544  *           0 on failure
 545  */
 546 int load_dev(DEVICE *dev)
 547 {
 548 #ifdef MTLOAD
 549    struct mtop mt_com;
 550 #endif
 551
 552    if (dev->fd < 0) {
 553       dev->dev_errno = EBADF;
 554       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 555       Emsg0(M_FATAL, 0, dev->errmsg);
 556       return 0;
 557    }
 558    if (!(dev->state & ST_TAPE)) {
 559       return 1;
 560    }
 561 #ifndef MTLOAD
 562    Dmsg0(200, "stored: MTLOAD command not available\n");
 563    dev->dev_errno = ENOTTY;           /* function not available */
 564    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 565          dev->dev_name, strerror(dev->dev_errno));      return 0;
 566    return 0;
 567 #else
 568
 569    dev->block_num = dev->file = 0;
 570    dev->file_addr = 0;
 571    mt_com.mt_op = MTLOAD;
 572    mt_com.mt_count = 1;
 573    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 574       dev->dev_errno = errno;
 575       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 576          dev->dev_name, strerror(dev->dev_errno));      return 0;
 577    }
 578    return 1;
 579 #endif
 580 }
 581
 582 /*
 583  * Rewind device and put it offline
 584  *  Returns: 1 on success
 585  *           0 on failure
 586  */
 587 int offline_dev(DEVICE *dev)
 588 {
 589    struct mtop mt_com;
 590
 591    if (dev->fd < 0) {
 592       dev->dev_errno = EBADF;
 593       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 594       Emsg0(M_FATAL, 0, dev->errmsg);
 595       return 0;
 596    }
 597    if (!(dev->state & ST_TAPE)) {
 598       return 1;
 599    }
 600
 601    dev->block_num = dev->file = 0;
 602    dev->file_addr = 0;
 603 #ifdef MTUNLOCK
 604    mt_com.mt_op = MTUNLOCK;
 605    mt_com.mt_count = 1;
 606    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 607 #endif
 608    mt_com.mt_op = MTOFFL;
 609    mt_com.mt_count = 1;
 610    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 611       dev->dev_errno = errno;
 612       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 613          dev->dev_name, strerror(dev->dev_errno));
 614       return 0;
 615    }
 616    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 617    return 1;
 618 }
 619
 620
 621 /*
 622  * Foward space a file
 623  */
 624 int
 625 fsf_dev(DEVICE *dev, int num)
 626 {
 627    struct mtop mt_com;
 628    int stat = 0;
 629    char rbuf[1024];
 630
 631    if (dev->fd < 0) {
 632       dev->dev_errno = EBADF;
 633       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 634       Emsg0(M_FATAL, 0, dev->errmsg);
 635       return -1;
 636    }
 637
 638    if (!(dev->state & ST_TAPE)) {
 639       return 0;
 640    }
 641    if (dev->state & ST_EOT) {
 642       dev->dev_errno = 0;
 643       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 644       return -1;
 645    }
 646    if (dev->state & ST_EOF)
 647       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 648    if (dev->state & ST_EOT)
 649       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 650
 651    Dmsg0(29, "fsf_dev\n");
 652    dev->block_num = 0;
 653    if (dev->capabilities & CAP_FSF) {
 654       Dmsg0(200, "FSF has cap_fsf\n");
 655       mt_com.mt_op = MTFSF;
 656       mt_com.mt_count = 1;
 657       while (num-- && !(dev->state & ST_EOT)) {
 658          Dmsg0(200, "Doing read for fsf\n");
 659          if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
 660             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 661                stat = sizeof(rbuf);   /* This is OK */
 662             } else {
 663                dev->state |= ST_EOT;
 664                clrerror_dev(dev, -1);
 665                Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
 666                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 667                   dev->dev_name, strerror(dev->dev_errno));
 668                Dmsg1(200, "%s", dev->errmsg);
 669                break;
 670             }
 671          }
 672          if (stat == 0) {                /* EOF */
 673             update_pos_dev(dev);
 674             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 675             /* Two reads of zero means end of tape */
 676             if (dev->state & ST_EOF) {
 677                dev->state |= ST_EOT;
 678                Dmsg0(200, "Set ST_EOT\n");
 679                break;
 680             } else {
 681                dev->state |= ST_EOF;
 682                dev->file++;
 683                dev->file_addr = 0;
 684                continue;
 685             }
 686          } else {                        /* Got data */
 687             dev->state &= ~(ST_EOF|ST_EOT);
 688          }
 689
 690          Dmsg0(200, "Doing MT_FSF\n");
 691          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 692          if (stat < 0) {                 /* error => EOT */
 693             dev->state |= ST_EOT;
 694             Dmsg0(200, "Set ST_EOT\n");
 695             clrerror_dev(dev, MTFSF);
 696             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 697                dev->dev_name, strerror(dev->dev_errno));
 698             Dmsg0(200, "Got < 0 for MT_FSF\n");
 699             Dmsg1(200, "%s", dev->errmsg);
 700          } else {
 701             dev->state |= ST_EOF;     /* just read EOF */
 702             dev->file++;
 703             dev->file_addr = 0;
 704          }
 705       }
 706
 707    /*
 708     * No FSF, so use FSR to simulate it
 709     */
 710    } else {
 711       Dmsg0(200, "Doing FSR for FSF\n");
 712       while (num-- && !(dev->state & ST_EOT)) {
 713          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 714       }
 715       if (dev->state & ST_EOT) {
 716          dev->dev_errno = 0;
 717          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 718          stat = -1;
 719       } else {
 720          stat = 0;
 721       }
 722    }
 723    update_pos_dev(dev);
 724    Dmsg1(200, "Return %d from FSF\n", stat);
 725    if (dev->state & ST_EOF)
 726       Dmsg0(200, "ST_EOF set on exit FSF\n");
 727    if (dev->state & ST_EOT)
 728       Dmsg0(200, "ST_EOT set on exit FSF\n");
 729    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 730    return stat;
 731 }
 732
 733 /*
 734  * Backward space a file
 735  */
 736 int
 737 bsf_dev(DEVICE *dev, int num)
 738 {
 739    struct mtop mt_com;
 740    int stat;
 741
 742    if (dev->fd < 0) {
 743       dev->dev_errno = EBADF;
 744       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 745       Emsg0(M_FATAL, 0, dev->errmsg);
 746       return -1;
 747    }
 748
 749    if (!(dev->state & ST_TAPE)) {
 750       return 0;
 751    }
 752    Dmsg0(29, "bsf_dev\n");
 753    dev->state &= ~(ST_EOT|ST_EOF);
 754    dev->file -= num;
 755    dev->file_addr = 0;
 756    mt_com.mt_op = MTBSF;
 757    mt_com.mt_count = num;
 758    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 759    if (stat < 0) {
 760       clrerror_dev(dev, MTBSF);
 761       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 762          dev->dev_name, strerror(dev->dev_errno));
 763    }
 764    update_pos_dev(dev);
 765    return stat;
 766 }
 767
 768
 769 /*
 770  * Foward space a record
 771  */
 772 int
 773 fsr_dev(DEVICE *dev, int num)
 774 {
 775    struct mtop mt_com;
 776    int stat;
 777
 778    if (dev->fd < 0) {
 779       dev->dev_errno = EBADF;
 780       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 781       Emsg0(M_FATAL, 0, dev->errmsg);
 782       return -1;
 783    }
 784
 785    if (!(dev->state & ST_TAPE)) {
 786       return 0;
 787    }
 788    Dmsg0(29, "fsr_dev\n");
 789    dev->block_num += num;
 790    mt_com.mt_op = MTFSR;
 791    mt_com.mt_count = num;
 792    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 793    if (stat == 0) {
 794       dev->state &= ~ST_EOF;
 795    } else {
 796       if (dev->state & ST_EOF) {
 797          dev->state |= ST_EOT;
 798       } else {
 799          dev->state |= ST_EOF;           /* assume EOF */
 800          dev->file++;
 801          dev->file_addr = 0;
 802       }
 803       clrerror_dev(dev, MTFSR);
 804       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 805          dev->dev_name, strerror(dev->dev_errno));
 806    }
 807    update_pos_dev(dev);
 808    return stat;
 809 }
 810
 811 /*
 812  * Backward space a record
 813  */
 814 int
 815 bsr_dev(DEVICE *dev, int num)
 816 {
 817    struct mtop mt_com;
 818    int stat;
 819
 820    if (dev->fd < 0) {
 821       dev->dev_errno = EBADF;
 822       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 823       Emsg0(M_FATAL, 0, dev->errmsg);
 824       return -1;
 825    }
 826
 827    if (!(dev->state & ST_TAPE)) {
 828       return 0;
 829    }
 830    Dmsg0(29, "bsr_dev\n");
 831    dev->block_num -= num;
 832    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 833    mt_com.mt_op = MTBSR;
 834    mt_com.mt_count = num;
 835    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 836    if (stat < 0) {
 837       clrerror_dev(dev, MTBSR);
 838       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 839          dev->dev_name, strerror(dev->dev_errno));
 840    }
 841    update_pos_dev(dev);
 842    return stat;
 843 }
 844
 845
 846
 847 /*
 848  * Write an end of file on the device
 849  */
 850 int
 851 weof_dev(DEVICE *dev, int num)
 852 {
 853    struct mtop mt_com;
 854    int stat;
 855
 856    if (dev->fd < 0) {
 857       dev->dev_errno = EBADF;
 858       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 859       Emsg0(M_FATAL, 0, dev->errmsg);
 860       return -1;
 861    }
 862
 863    if (!(dev->state & ST_TAPE)) {
 864       return 0;
 865    }
 866    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
 867    dev->block_num = 0;
 868    Dmsg0(29, "weof_dev\n");
 869    mt_com.mt_op = MTWEOF;
 870    mt_com.mt_count = num;
 871    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 872    if (stat == 0) {
 873       dev->file++;
 874       dev->file_addr = 0;
 875    } else {
 876       clrerror_dev(dev, MTWEOF);
 877       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
 878          dev->dev_name, strerror(dev->dev_errno));
 879    }
 880    return stat;
 881 }
 882
 883 /*
 884  * Return string message with last error in English
 885  *  Be careful not to call this routine from within dev.c
 886  *  while editing an Mmsg(&) or you will end up in a recursive
 887  *  loop creating a Segmentation Violation.
 888  */
 889 char *
 890 strerror_dev(DEVICE *dev)
 891 {
 892    return dev->errmsg;
 893 }
 894
 895
 896 /*
 897  * If implemented in system, clear the tape
 898  * error status.
 899  */
 900 void
 901 clrerror_dev(DEVICE *dev, int func)
 902 {
 903    char *msg = NULL;
 904
 905    dev->dev_errno = errno;         /* save errno */
 906    if (errno == EIO) {
 907       dev->VolCatInfo.VolCatErrors++;
 908    }
 909
 910    if (!(dev->state & ST_TAPE)) {
 911       return;
 912    }
 913    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
 914       switch (func) {
 915          case -1:
 916             Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
 917             break;
 918          case MTWEOF:
 919             msg = "WTWEOF";
 920             dev->capabilities &= ~CAP_EOF; /* turn off feature */
 921             break;
 922          case MTEOM:
 923             msg = "WTEOM";
 924             dev->capabilities &= ~CAP_EOM; /* turn off feature */
 925             break;
 926          case MTFSF:
 927             msg = "MTFSF";
 928             dev->capabilities &= ~CAP_FSF; /* turn off feature */
 929             break;
 930          case MTBSF:
 931             msg = "MTBSF";
 932             dev->capabilities &= ~CAP_BSF; /* turn off feature */
 933             break;
 934          case MTFSR:
 935             msg = "MTFSR";
 936             dev->capabilities &= ~CAP_FSR; /* turn off feature */
 937             break;
 938          case MTBSR:
 939             msg = "MTBSR";
 940             dev->capabilities &= ~CAP_BSR; /* turn off feature */
 941             break;
 942          default:
 943             msg = "Unknown";
 944             break;
 945       }
 946       if (msg != NULL) {
 947          dev->dev_errno = ENOSYS;
 948          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
 949          Emsg0(M_ERROR, 0, dev->errmsg);
 950       }
 951    }
 952 #ifdef MTIOCLRERR
 953 {
 954    struct mtop mt_com;
 955    int stat;
 956    mt_com.mt_op = MTIOCLRERR;
 957    mt_com.mt_count = 1;
 958    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 959    Dmsg0(200, "Did MTIOCLRERR\n");
 960 }
 961 #endif
 962 }
 963
 964 /*
 965  * Flush buffer contents
 966  *  No longer used.
 967  */
 968 int flush_dev(DEVICE *dev)
 969 {
 970    return 1;
 971 }
 972
 973 static void do_close(DEVICE *dev)
 974 {
 975
 976    Dmsg0(29, "really close_dev\n");
 977    close(dev->fd);
 978    /* Clean up device packet so it can be reused */
 979    dev->fd = -1;
 980    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
 981    dev->block_num = 0;
 982    dev->file = 0;
 983    dev->file_addr = 0;
 984    dev->LastBlockNumWritten = 0;
 985    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
 986    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
 987    dev->use_count--;
 988 }
 989
 990 /*
 991  * Close the device
 992  */
 993 void
 994 close_dev(DEVICE *dev)
 995 {
 996    if (!dev) {
 997       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 998       Emsg0(M_FATAL, 0, dev->errmsg);
 999       return;
1000    }
1001    if (dev->fd >= 0 && dev->use_count == 1) {
1002       do_close(dev);
1003    } else {
1004       Dmsg0(29, "close_dev but in use so leave open.\n");
1005       dev->use_count--;
1006    }
1007 }
1008
1009 /*
1010  * Used when unmounting the device
1011  */
1012 void force_close_dev(DEVICE *dev)
1013 {
1014    if (!dev) {
1015       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1016       Emsg0(M_FATAL, 0, dev->errmsg);
1017       return;
1018    }
1019    Dmsg0(29, "really close_dev\n");
1020    do_close(dev);
1021 }
1022
1023 int truncate_dev(DEVICE *dev)
1024 {
1025    if (dev->state & ST_TAPE) {
1026       return 1;
1027    }
1028    if (ftruncate(dev->fd, 0) != 0) {
1029       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1030       return 0;
1031    }
1032    return 1;
1033 }
1034
1035 int
1036 dev_is_tape(DEVICE *dev)
1037 {
1038    return (dev->state & ST_TAPE) ? 1 : 0;
1039 }
1040
1041 char *
1042 dev_name(DEVICE *dev)
1043 {
1044    return dev->dev_name;
1045 }
1046
1047 char *
1048 dev_vol_name(DEVICE *dev)
1049 {
1050    return dev->VolCatInfo.VolCatName;
1051 }
1052
1053 uint32_t dev_block(DEVICE *dev)
1054 {
1055    update_pos_dev(dev);
1056    return dev->block_num;
1057 }
1058
1059 uint32_t dev_file(DEVICE *dev)
1060 {
1061    update_pos_dev(dev);
1062    return dev->file;
1063 }
1064
1065 /*
1066  * Free memory allocated for the device
1067  */
1068 void
1069 term_dev(DEVICE *dev)
1070 {
1071    if (!dev) {
1072       dev->dev_errno = EBADF;
1073       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1074       Emsg0(M_FATAL, 0, dev->errmsg);
1075       return;
1076    }
1077    close_dev(dev);
1078    Dmsg0(29, "term_dev\n");
1079    if (dev->dev_name) {
1080       free_memory(dev->dev_name);
1081       dev->dev_name = NULL;
1082    }
1083    if (dev->errmsg) {
1084       free_pool_memory(dev->errmsg);
1085       dev->errmsg = NULL;
1086    }
1087 #ifdef NEW_LOCK
1088    rwl_destroy(&dev->lock);
1089 #endif
1090    pthread_mutex_destroy(&dev->mutex);
1091    pthread_cond_destroy(&dev->wait);
1092    pthread_cond_destroy(&dev->wait_next_vol);
1093    if (dev->state & ST_MALLOC) {
1094       free_pool_memory((POOLMEM *)dev);
1095    }
1096 }
1097
1098
1099 /* To make following two functions more readable */
1100
1101 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1102
1103 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1104 {
1105    jcr->prev_dev = NULL;
1106    jcr->next_dev = attached_jcrs;
1107    if (attached_jcrs) {
1108       attached_jcrs->prev_dev = jcr;
1109    }
1110    attached_jcrs = jcr;
1111    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1112 }
1113
1114 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1115 {
1116    if (!jcr->prev_dev) {
1117       attached_jcrs = jcr->next_dev;
1118    } else {
1119       jcr->prev_dev->next_dev = jcr->next_dev;
1120    }
1121    if (jcr->next_dev) {
1122       jcr->next_dev->prev_dev = jcr->prev_dev;
1123    }
1124    jcr->next_dev = jcr->prev_dev = NULL;
1125    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1126 }
1127
1128 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1129 {
1130    if (jcr == NULL) {
1131       return attached_jcrs;
1132    }
1133    return jcr->next_dev;
1134 }