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