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