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

   1 /*
   2  *
   3  *   dev.c  -- low level operations on device (storage device)
   4  *
   5  *              Kern Sibbald
   6  *
   7  *     NOTE!!!! None of these routines are reentrant. You must
   8  *        use lock_device() and unlock_device() at a higher level,
   9  *        or use the xxx_device() equivalents.  By moving the
  10  *        thread synchronization to a higher level, we permit
  11  *        the higher level routines to "seize" the device and
  12  *        to carry out operations without worrying about who
  13  *        set what lock (i.e. race conditions).
  14  *
  15  *     Note, this is the device dependent code, and my have
  16  *           to be modified for each system, but is meant to
  17  *           be as "generic" as possible.
  18  *
  19  *     The purpose of this code is to develop a SIMPLE Storage
  20  *     daemon. More complicated coding (double buffering, writer
  21  *     thread, ...) is left for a later version.
  22  *
  23  *     Unfortunately, I have had to add more and more complication
  24  *     to this code. This was not foreseen as noted above, and as
  25  *     a consequence has lead to something more contorted than is
  26  *     really necessary -- KES.  Note, this contortion has been
  27  *     corrected to a large extent by a rewrite (Apr MMI).
  28  *
  29  *   Version $Id$
  30  */
  31 /*
  32    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  33
  34    This program is free software; you can redistribute it and/or
  35    modify it under the terms of the GNU General Public License as
  36    published by the Free Software Foundation; either version 2 of
  37    the License, or (at your option) any later version.
  38
  39    This program is distributed in the hope that it will be useful,
  40    but WITHOUT ANY WARRANTY; without even the implied warranty of
  41    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  42    General Public License for more details.
  43
  44    You should have received a copy of the GNU General Public
  45    License along with this program; if not, write to the Free
  46    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  47    MA 02111-1307, USA.
  48
  49  */
  50
  51 /*
  52  * Handling I/O errors and end of tape conditions are a bit tricky.
  53  * This is how it is currently done when writting.
  54  * On either an I/O error or end of tape,
  55  * we will stop writing on the physical device (no I/O recovery is
  56  * attempted at least in this daemon). The state flag will be sent
  57  * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
  58  * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
  59  * cleared only when the problem goes away.  Now when ST_WEOT
  60  * is set all calls to write_dev() are handled as usual. However,
  61  * in write_block() instead of attempting to write the block to
  62  * the physical device, it is chained into a list of blocks written
  63  * after the EOT condition.  In addition, all threads are blocked
  64  * from writing on the tape by calling lock(), and thread other
  65  * than the first thread to hit the EOT will block on a condition
  66  * variable. The first thread to hit the EOT will continue to
  67  * be able to read and write the tape (he sort of tunnels through
  68  * the locking mechanism -- see lock() for details).
  69  *
  70  * Now presumably somewhere higher in the chain of command
  71  * (device.c), someone will notice the EOT condition and
  72  * get a new tape up, get the tape label read, and mark
  73  * the label for rewriting. Then this higher level routine
  74  * will write the unwritten buffer to the new volume.
  75  * Finally, he will release
  76  * any blocked threads by doing a broadcast on the condition
  77  * variable.  At that point, we should be totally back in
  78  * business with no lost data.
  79  */
  80
  81
  82 #include "bacula.h"
  83 #include "stored.h"
  84
  85 /* Forward referenced functions */
  86 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, fifo;
 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    fifo = FALSE;
 121    if (S_ISDIR(statp.st_mode)) {
 122       tape = FALSE;
 123    } else if (S_ISCHR(statp.st_mode)) {
 124       tape = TRUE;
 125    } else if (S_ISFIFO(statp.st_mode)) {
 126       fifo = TRUE;
 127    } else {
 128       if (dev) {
 129          dev->dev_errno = ENODEV;
 130       }
 131       Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
 132          dev_name, statp.st_mode);
 133       return NULL;
 134    }
 135    if (!dev) {
 136       dev = (DEVICE *)get_memory(sizeof(DEVICE));
 137       memset(dev, 0, sizeof(DEVICE));
 138       dev->state = ST_MALLOC;
 139    } else {
 140       memset(dev, 0, sizeof(DEVICE));
 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_size = device->max_volume_size;
 150    dev->max_file_size = device->max_file_size;
 151    dev->volume_capacity = device->volume_capacity;
 152    dev->max_rewind_wait = device->max_rewind_wait;
 153    dev->max_open_wait = device->max_open_wait;
 154    dev->max_open_vols = device->max_open_vols;
 155    dev->device = device;
 156
 157    if (tape) {
 158       dev->state |= ST_TAPE;
 159    } else if (fifo) {
 160       dev->state |= ST_FIFO;
 161       dev->capabilities |= CAP_STREAM; /* set stream device */
 162    } else {
 163       dev->state |= ST_FILE;
 164    }
 165
 166    if (dev->max_block_size > 1000000) {
 167       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
 168          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
 169       dev->max_block_size = 0;
 170    }
 171    if (dev->max_block_size % TAPE_BSIZE != 0) {
 172       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
 173          dev->max_block_size, dev->dev_name);
 174    }
 175
 176    dev->errmsg = get_pool_memory(PM_EMSG);
 177    *dev->errmsg = 0;
 178
 179    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 180       dev->dev_errno = errstat;
 181       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
 182       Emsg0(M_FATAL, 0, dev->errmsg);
 183    }
 184    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 185       dev->dev_errno = errstat;
 186       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 187       Emsg0(M_FATAL, 0, dev->errmsg);
 188    }
 189    if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
 190       dev->dev_errno = errstat;
 191       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 192       Emsg0(M_FATAL, 0, dev->errmsg);
 193    }
 194    dev->fd = -1;
 195    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 196    return dev;
 197 }
 198
 199 /* Open the device with the operating system and
 200  * initialize buffer pointers.
 201  *
 202  * Note, for a tape, the VolName is the name we give to the
 203  *    volume (not really used here), but for a file, the
 204  *    VolName represents the name of the file to be created/opened.
 205  *    In the case of a file, the full name is the device name
 206  *    (archive_name) with the VolName concatenated.
 207  */
 208 int
 209 open_dev(DEVICE *dev, char *VolName, int mode)
 210 {
 211    POOLMEM *archive_name;
 212
 213    if (dev->state & ST_OPENED) {
 214       /*
 215        *  *****FIXME***** how to handle two threads wanting
 216        *  different volumes mounted???? E.g. one is waiting
 217        *  for the next volume to be mounted, and a new job
 218        *  starts and snatches up the device.
 219        */
 220       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 221          return -1;
 222       }
 223       dev->use_count++;
 224       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 225             dev->dev_name, dev->use_count);
 226       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
 227       return dev->fd;
 228    }
 229    if (VolName) {
 230       strcpy(dev->VolCatInfo.VolCatName, VolName);
 231    }
 232
 233    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 234          dev->dev_name, dev->VolCatInfo.VolCatName);
 235    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 236    if (dev->state & (ST_TAPE|ST_FIFO)) {
 237       int timeout;
 238       Dmsg0(29, "open_dev: device is tape\n");
 239       if (mode == OPEN_READ_WRITE) {
 240          dev->mode = O_RDWR | O_BINARY;
 241       } else if (mode == OPEN_READ_ONLY) {
 242          dev->mode = O_RDONLY | O_BINARY;
 243       } else if (mode == OPEN_WRITE_ONLY) {
 244          dev->mode = O_WRONLY | O_BINARY;
 245       } else {
 246          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 247       }
 248       timeout = dev->max_open_wait;
 249       errno = 0;
 250       if (dev->state & ST_FIFO && timeout) {
 251          /* Set open timer */
 252          dev->tid = start_thread_timer(pthread_self(), timeout);
 253       }
 254       /* If busy retry each second for max_open_wait seconds */
 255       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 256          if (errno == EAGAIN) {
 257             continue;
 258          }
 259          if (errno == EBUSY && timeout-- > 0) {
 260             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 261             bmicrosleep(1, 0);
 262             continue;
 263          }
 264          dev->dev_errno = errno;
 265          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 266                dev->dev_name, strerror(dev->dev_errno));
 267          /* Stop any open timer we set */
 268          if (dev->tid) {
 269             stop_thread_timer(dev->tid);
 270             dev->tid = 0;
 271          }
 272          Emsg0(M_FATAL, 0, dev->errmsg);
 273          break;
 274       }
 275       if (dev->fd >= 0) {
 276          dev->dev_errno = 0;
 277          dev->state |= ST_OPENED;
 278          dev->use_count++;
 279          update_pos_dev(dev);             /* update position */
 280       }
 281       /* Stop any open() timer we started */
 282       if (dev->tid) {
 283          stop_thread_timer(dev->tid);
 284          dev->tid = 0;
 285       }
 286       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 287    } else {
 288       /*
 289        * Handle opening of File Archive (not a tape)
 290        */
 291       archive_name = get_pool_memory(PM_FNAME);
 292       pm_strcpy(&archive_name, dev->dev_name);
 293       if (archive_name[strlen(archive_name)] != '/') {
 294          pm_strcat(&archive_name, "/");
 295       }
 296       pm_strcat(&archive_name, VolName);
 297       Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
 298       if (mode == OPEN_READ_WRITE) {
 299          dev->mode = O_CREAT | O_RDWR | O_BINARY;
 300       } else if (mode == OPEN_READ_ONLY) {
 301          dev->mode = O_RDONLY | O_BINARY;
 302       } else if (mode == OPEN_WRITE_ONLY) {
 303          dev->mode = O_WRONLY | O_BINARY;
 304       } else {
 305          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 306       }
 307       /* If creating file, give 0640 permissions */
 308       if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
 309          dev->dev_errno = errno;
 310          Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
 311          Emsg0(M_FATAL, 0, dev->errmsg);
 312       } else {
 313          dev->dev_errno = 0;
 314          dev->state |= ST_OPENED;
 315          dev->use_count++;
 316          update_pos_dev(dev);                /* update position */
 317       }
 318       Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
 319       free_pool_memory(archive_name);
 320    }
 321    return dev->fd;
 322 }
 323
 324 /*
 325  * Rewind the device.
 326  *  Returns: 1 on success
 327  *           0 on failure
 328  */
 329 int rewind_dev(DEVICE *dev)
 330 {
 331    struct mtop mt_com;
 332    unsigned int i;
 333
 334    Dmsg0(29, "rewind_dev\n");
 335    if (dev->fd < 0) {
 336       dev->dev_errno = EBADF;
 337       Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
 338             dev->dev_name);
 339       Emsg0(M_FATAL, 0, dev->errmsg);
 340       return 0;
 341    }
 342    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT);  /* remove EOF/EOT flags */
 343    dev->block_num = dev->file = 0;
 344    dev->file_addr = 0;
 345    if (dev->state & ST_TAPE) {
 346       mt_com.mt_op = MTREW;
 347       mt_com.mt_count = 1;
 348       /* If we get an I/O error on rewind, it is probably because
 349        * the drive is actually busy. We loop for (about 5 minutes)
 350        * retrying every 5 seconds.
 351        */
 352       for (i=dev->max_rewind_wait; ; i -= 5) {
 353          if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 354             if (i == dev->max_rewind_wait) {
 355                Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
 356             }
 357             clrerror_dev(dev, MTREW);
 358             if (dev->dev_errno == EIO && i > 0) {
 359                Dmsg0(200, "Sleeping 5 seconds.\n");
 360                bmicrosleep(5, 0);
 361                continue;
 362             }
 363             Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
 364                dev->dev_name, strerror(dev->dev_errno));
 365             return 0;
 366          }
 367          break;
 368       }
 369    } else if (dev->state & ST_FILE) {
 370       if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
 371          dev->dev_errno = errno;
 372          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 373             dev->dev_name, strerror(dev->dev_errno));
 374          return 0;
 375       }
 376    }
 377    return 1;
 378 }
 379
 380 /*
 381  * Position device to end of medium (end of data)
 382  *  Returns: 1 on succes
 383  *           0 on error
 384  */
 385 int
 386 eod_dev(DEVICE *dev)
 387 {
 388    struct mtop mt_com;
 389    struct mtget mt_stat;
 390    int stat = 0;
 391    off_t pos;
 392
 393    Dmsg0(29, "eod_dev\n");
 394    if (dev->state & ST_EOT) {
 395       return 1;
 396    }
 397    dev->state &= ~(ST_EOF);  /* remove EOF flags */
 398    dev->block_num = dev->file = 0;
 399    dev->file_addr = 0;
 400    if (dev->state & (ST_FIFO | ST_PROG)) {
 401       return 1;
 402    }
 403    if (!(dev->state & ST_TAPE)) {
 404       pos = lseek(dev->fd, (off_t)0, SEEK_END);
 405 //    Dmsg1(000, "====== Seek to %lld\n", pos);
 406       if (pos >= 0) {
 407          update_pos_dev(dev);
 408          dev->state |= ST_EOT;
 409          return 1;
 410       }
 411       return 0;
 412    }
 413 #ifdef MTEOM
 414    if (dev_cap(dev, CAP_EOM)) {
 415       mt_com.mt_op = MTEOM;
 416       mt_com.mt_count = 1;
 417       if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
 418          Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
 419          clrerror_dev(dev, mt_com.mt_op);
 420          update_pos_dev(dev);
 421          Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
 422             dev->dev_name, strerror(dev->dev_errno));
 423          return 0;
 424       }
 425       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 426          dev->dev_errno = errno;
 427          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 428             dev->dev_name, strerror(dev->dev_errno));
 429          return 0;
 430       }
 431       Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 432       dev->file = mt_stat.mt_fileno;
 433
 434    /*
 435     * Rewind then use FSF until EOT reached
 436     */
 437    } else {
 438 #else
 439    {
 440 #endif
 441       if (!rewind_dev(dev)) {
 442          return 0;
 443       }
 444       while (!(dev->state & ST_EOT)) {
 445          Dmsg0(200, "Do fsf 1\n");
 446          if (!fsf_dev(dev, 1)) {
 447             Dmsg0(200, "fsf_dev error.\n");
 448             return 0;
 449          }
 450       }
 451    }
 452    /*
 453     * Some drivers leave us after second EOF when doing
 454     * MTEOM, so we must backup so that appending overwrites
 455     * the second EOF.
 456     */
 457    if (dev_cap(dev, CAP_BSFATEOM)) {
 458       stat =  (bsf_dev(dev, 1) == 0);
 459       dev->file++;                    /* keep same file */
 460    } else {
 461       update_pos_dev(dev);                   /* update position */
 462       stat = 1;
 463    }
 464    Dmsg1(200, "EOD dev->file=%d\n", dev->file);
 465    return stat;
 466 }
 467
 468 /*
 469  * Set the position of the device -- only for files
 470  *   For other devices, there is no generic way to do it.
 471  *  Returns: 1 on succes
 472  *           0 on error
 473  */
 474 int update_pos_dev(DEVICE *dev)
 475 {
 476    off_t pos;
 477    int stat = 0;
 478
 479    if (dev->fd < 0) {
 480       dev->dev_errno = EBADF;
 481       Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
 482       Emsg0(M_FATAL, 0, dev->errmsg);
 483       return 0;
 484    }
 485
 486    /* Find out where we are */
 487    if (dev->state & ST_FILE) {
 488       dev->file = 0;
 489       dev->file_addr = 0;
 490       pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
 491       if (pos < 0) {
 492          Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
 493          dev->dev_errno = errno;
 494          Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
 495             dev->dev_name, strerror(dev->dev_errno));
 496       } else {
 497          stat = 1;
 498          dev->file_addr = pos;
 499       }
 500       return stat;
 501    }
 502    return 1;
 503 }
 504
 505
 506 /*
 507  * Return the status of the device.  This was meant
 508  * to be a generic routine. Unfortunately, it doesn't
 509  * seem possible (at least I do not know how to do it
 510  * currently), which means that for the moment, this
 511  * routine has very little value.
 512  *
 513  *   Returns: 1 on success
 514  *            0 on error
 515  */
 516 int
 517 status_dev(DEVICE *dev, uint32_t *status)
 518 {
 519    struct mtget mt_stat;
 520    uint32_t stat = 0;
 521
 522    if (dev->state & (ST_EOT | ST_WEOT)) {
 523       stat |= BMT_EOD;
 524       Dmsg0(-20, " EOD-");
 525    }
 526    if (dev->state & ST_EOF) {
 527       stat |= BMT_EOF;
 528       Dmsg0(-20, " EOF");
 529    }
 530    if (dev->state & ST_TAPE) {
 531       stat |= BMT_TAPE;
 532       Dmsg0(-20," Driver status:");
 533       Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
 534       if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
 535          dev->dev_errno = errno;
 536          Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
 537             dev->dev_name, strerror(dev->dev_errno));
 538          return 0;
 539       }
 540       Dmsg0(-20, " Device status:");
 541
 542 #if defined(HAVE_LINUX_OS)
 543       if (GMT_EOF(mt_stat.mt_gstat)) {
 544          stat |= BMT_EOF;
 545          Dmsg0(-20, " EOF");
 546       }
 547       if (GMT_BOT(mt_stat.mt_gstat)) {
 548          stat |= BMT_BOT;
 549          Dmsg0(-20, " BOT");
 550       }
 551       if (GMT_EOT(mt_stat.mt_gstat)) {
 552          stat |= BMT_EOT;
 553          Dmsg0(-20, " EOT");
 554       }
 555       if (GMT_SM(mt_stat.mt_gstat)) {
 556          stat |= BMT_SM;
 557          Dmsg0(-20, " SM");
 558       }
 559       if (GMT_EOD(mt_stat.mt_gstat)) {
 560          stat |= BMT_EOD;
 561          Dmsg0(-20, " EOD+");
 562       }
 563       if (GMT_WR_PROT(mt_stat.mt_gstat)) {
 564          stat |= BMT_WR_PROT;
 565          Dmsg0(-20, " WR_PROT");
 566       }
 567       if (GMT_ONLINE(mt_stat.mt_gstat)) {
 568          stat |= BMT_ONLINE;
 569          Dmsg0(-20, " ONLINE");
 570       }
 571       if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
 572          stat |= BMT_DR_OPEN;
 573          Dmsg0(-20, " DR_OPEN");
 574       }
 575       if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
 576          stat |= BMT_IM_REP_EN;
 577          Dmsg0(-20, " IM_REP_EN");
 578       }
 579 #endif /* !SunOS && !OSF */
 580       Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
 581    } else {
 582       stat |= BMT_ONLINE | BMT_BOT;
 583    }
 584    *status = stat;
 585    return 1;
 586 }
 587
 588
 589 /*
 590  * Load medium in device
 591  *  Returns: 1 on success
 592  *           0 on failure
 593  */
 594 int load_dev(DEVICE *dev)
 595 {
 596 #ifdef MTLOAD
 597    struct mtop mt_com;
 598 #endif
 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 #ifndef MTLOAD
 610    Dmsg0(200, "stored: MTLOAD command not available\n");
 611    dev->dev_errno = ENOTTY;           /* function not available */
 612    Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 613          dev->dev_name, strerror(dev->dev_errno));      return 0;
 614    return 0;
 615 #else
 616
 617    dev->block_num = dev->file = 0;
 618    dev->file_addr = 0;
 619    mt_com.mt_op = MTLOAD;
 620    mt_com.mt_count = 1;
 621    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 622       dev->dev_errno = errno;
 623       Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
 624          dev->dev_name, strerror(dev->dev_errno));      return 0;
 625    }
 626    return 1;
 627 #endif
 628 }
 629
 630 /*
 631  * Rewind device and put it offline
 632  *  Returns: 1 on success
 633  *           0 on failure
 634  */
 635 int offline_dev(DEVICE *dev)
 636 {
 637    struct mtop mt_com;
 638
 639    if (dev->fd < 0) {
 640       dev->dev_errno = EBADF;
 641       Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
 642       Emsg0(M_FATAL, 0, dev->errmsg);
 643       return 0;
 644    }
 645    if (!(dev->state & ST_TAPE)) {
 646       return 1;
 647    }
 648
 649    dev->block_num = dev->file = 0;
 650    dev->file_addr = 0;
 651 #ifdef MTUNLOCK
 652    mt_com.mt_op = MTUNLOCK;
 653    mt_com.mt_count = 1;
 654    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 655 #endif
 656    mt_com.mt_op = MTOFFL;
 657    mt_com.mt_count = 1;
 658    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 659       dev->dev_errno = errno;
 660       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 661          dev->dev_name, strerror(dev->dev_errno));
 662       return 0;
 663    }
 664    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 665    return 1;
 666 }
 667
 668
 669 /*
 670  * Foward space a file
 671  *   Returns: 1 on success
 672  *            0 on failure
 673  */
 674 int
 675 fsf_dev(DEVICE *dev, int num)
 676 {
 677    struct mtop mt_com;
 678    int stat = 0;
 679
 680    if (dev->fd < 0) {
 681       dev->dev_errno = EBADF;
 682       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 683       Emsg0(M_FATAL, 0, dev->errmsg);
 684       return 0;
 685    }
 686
 687    if (!(dev->state & ST_TAPE)) {
 688       return 1;
 689    }
 690    if (dev->state & ST_EOT) {
 691       dev->dev_errno = 0;
 692       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 693       return 0;
 694    }
 695    if (dev->state & ST_EOF) {
 696       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 697    }
 698    if (dev->state & ST_EOT) {
 699       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 700    }
 701
 702    Dmsg0(29, "fsf_dev\n");
 703    dev->block_num = 0;
 704    if (dev_cap(dev, CAP_FSF)) {
 705       POOLMEM *rbuf;
 706       int rbuf_len;
 707       Dmsg0(200, "FSF has cap_fsf\n");
 708       if (dev->max_block_size == 0) {
 709          rbuf_len = DEFAULT_BLOCK_SIZE;
 710       } else {
 711          rbuf_len = dev->max_block_size;
 712       }
 713       rbuf = get_memory(rbuf_len);
 714       mt_com.mt_op = MTFSF;
 715       mt_com.mt_count = 1;
 716       while (num-- && !(dev->state & ST_EOT)) {
 717          Dmsg0(200, "Doing read before fsf\n");
 718          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
 719             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 720                stat = rbuf_len;        /* This is OK */
 721             } else {
 722                dev->state |= ST_EOT;
 723                clrerror_dev(dev, -1);
 724                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
 725                   strerror(dev->dev_errno));
 726                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 727                   dev->dev_name, strerror(dev->dev_errno));
 728                Dmsg1(200, "%s", dev->errmsg);
 729                break;
 730             }
 731          }
 732          if (stat == 0) {                /* EOF */
 733             update_pos_dev(dev);
 734             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 735             /* Two reads of zero means end of tape */
 736             if (dev->state & ST_EOF) {
 737                dev->state |= ST_EOT;
 738                Dmsg0(200, "Set ST_EOT\n");
 739                break;
 740             } else {
 741                dev->state |= ST_EOF;
 742                dev->file++;
 743                dev->file_addr = 0;
 744                continue;
 745             }
 746          } else {                        /* Got data */
 747             dev->state &= ~(ST_EOF|ST_EOT);
 748          }
 749
 750          Dmsg0(200, "Doing MTFSF\n");
 751          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 752          if (stat < 0) {                 /* error => EOT */
 753             dev->state |= ST_EOT;
 754             Dmsg0(200, "Set ST_EOT\n");
 755             clrerror_dev(dev, MTFSF);
 756             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 757                dev->dev_name, strerror(dev->dev_errno));
 758             Dmsg0(200, "Got < 0 for MTFSF\n");
 759             Dmsg1(200, "%s", dev->errmsg);
 760          } else {
 761             dev->state |= ST_EOF;     /* just read EOF */
 762             dev->file++;
 763             dev->file_addr = 0;
 764          }
 765       }
 766       free_memory(rbuf);
 767
 768    /*
 769     * No FSF, so use FSR to simulate it
 770     */
 771    } else {
 772       Dmsg0(200, "Doing FSR for FSF\n");
 773       while (num-- && !(dev->state & ST_EOT)) {
 774          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 775       }
 776       if (dev->state & ST_EOT) {
 777          dev->dev_errno = 0;
 778          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 779          stat = -1;
 780       } else {
 781          stat = 0;
 782       }
 783    }
 784    update_pos_dev(dev);
 785    Dmsg1(200, "Return %d from FSF\n", stat);
 786    if (dev->state & ST_EOF)
 787       Dmsg0(200, "ST_EOF set on exit FSF\n");
 788    if (dev->state & ST_EOT)
 789       Dmsg0(200, "ST_EOT set on exit FSF\n");
 790    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 791    return stat == 0 ? 1 : 0;
 792 }
 793
 794 /*
 795  * Backward space a file
 796  */
 797 int
 798 bsf_dev(DEVICE *dev, int num)
 799 {
 800    struct mtop mt_com;
 801    int stat;
 802
 803    if (dev->fd < 0) {
 804       dev->dev_errno = EBADF;
 805       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 806       Emsg0(M_FATAL, 0, dev->errmsg);
 807       return -1;
 808    }
 809
 810    if (!(dev->state & ST_TAPE)) {
 811       return 0;
 812    }
 813    Dmsg0(29, "bsf_dev\n");
 814    dev->state &= ~(ST_EOT|ST_EOF);
 815    dev->file -= num;
 816    dev->file_addr = 0;
 817    mt_com.mt_op = MTBSF;
 818    mt_com.mt_count = num;
 819    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 820    if (stat < 0) {
 821       clrerror_dev(dev, MTBSF);
 822       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 823          dev->dev_name, strerror(dev->dev_errno));
 824    }
 825    update_pos_dev(dev);
 826    return stat;
 827 }
 828
 829
 830 /*
 831  * Foward space a record
 832  */
 833 int
 834 fsr_dev(DEVICE *dev, int num)
 835 {
 836    struct mtop mt_com;
 837    int stat;
 838
 839    if (dev->fd < 0) {
 840       dev->dev_errno = EBADF;
 841       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 842       Emsg0(M_FATAL, 0, dev->errmsg);
 843       return -1;
 844    }
 845
 846    if (!(dev->state & ST_TAPE)) {
 847       return 0;
 848    }
 849    Dmsg0(29, "fsr_dev\n");
 850    dev->block_num += num;
 851    mt_com.mt_op = MTFSR;
 852    mt_com.mt_count = num;
 853    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 854    if (stat == 0) {
 855       dev->state &= ~ST_EOF;
 856    } else {
 857       if (dev->state & ST_EOF) {
 858          dev->state |= ST_EOT;
 859       } else {
 860          dev->state |= ST_EOF;           /* assume EOF */
 861          dev->file++;
 862          dev->file_addr = 0;
 863       }
 864       clrerror_dev(dev, MTFSR);
 865       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 866          dev->dev_name, strerror(dev->dev_errno));
 867    }
 868    update_pos_dev(dev);
 869    return stat;
 870 }
 871
 872 /*
 873  * Backward space a record
 874  *   Returns:  0 on success
 875  *            -1 on failure
 876  */
 877 int
 878 bsr_dev(DEVICE *dev, int num)
 879 {
 880    struct mtop mt_com;
 881    int stat;
 882
 883    if (dev->fd < 0) {
 884       dev->dev_errno = EBADF;
 885       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 886       Emsg0(M_FATAL, 0, dev->errmsg);
 887       return -1;
 888    }
 889
 890    if (!(dev->state & ST_TAPE)) {
 891       return 0;
 892    }
 893
 894    if (!dev_cap(dev, CAP_BSR)) {
 895       Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
 896          dev->dev_name);
 897       return 0;
 898    }
 899
 900    Dmsg0(29, "bsr_dev\n");
 901    dev->block_num -= num;
 902    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 903    mt_com.mt_op = MTBSR;
 904    mt_com.mt_count = num;
 905    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 906    if (stat < 0) {
 907       clrerror_dev(dev, MTBSR);
 908       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 909          dev->dev_name, strerror(dev->dev_errno));
 910    }
 911    update_pos_dev(dev);
 912    return stat;
 913 }
 914
 915
 916
 917 /*
 918  * Write an end of file on the device
 919  *   Returns: 0 on success
 920  *            non-zero on failure
 921  */
 922 int
 923 weof_dev(DEVICE *dev, int num)
 924 {
 925    struct mtop mt_com;
 926    int stat;
 927
 928    if (dev->fd < 0) {
 929       dev->dev_errno = EBADF;
 930       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 931       Emsg0(M_FATAL, 0, dev->errmsg);
 932       return -1;
 933    }
 934
 935    if (!(dev->state & ST_TAPE)) {
 936       return 0;
 937    }
 938    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
 939    dev->block_num = 0;
 940    Dmsg0(29, "weof_dev\n");
 941    mt_com.mt_op = MTWEOF;
 942    mt_com.mt_count = num;
 943    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 944    if (stat == 0) {
 945       dev->file++;
 946       dev->file_addr = 0;
 947    } else {
 948       clrerror_dev(dev, MTWEOF);
 949       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
 950          dev->dev_name, strerror(dev->dev_errno));
 951    }
 952    return stat;
 953 }
 954
 955 /*
 956  * Return string message with last error in English
 957  *  Be careful not to call this routine from within dev.c
 958  *  while editing an Mmsg(&) or you will end up in a recursive
 959  *  loop creating a Segmentation Violation.
 960  */
 961 char *
 962 strerror_dev(DEVICE *dev)
 963 {
 964    return dev->errmsg;
 965 }
 966
 967
 968 /*
 969  * If implemented in system, clear the tape
 970  * error status.
 971  */
 972 void
 973 clrerror_dev(DEVICE *dev, int func)
 974 {
 975    char *msg = NULL;
 976
 977    dev->dev_errno = errno;         /* save errno */
 978    if (errno == EIO) {
 979       dev->VolCatInfo.VolCatErrors++;
 980    }
 981
 982    if (!(dev->state & ST_TAPE)) {
 983       return;
 984    }
 985    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
 986       switch (func) {
 987          case -1:
 988             Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
 989             break;
 990          case MTWEOF:
 991             msg = "WTWEOF";
 992             dev->capabilities &= ~CAP_EOF; /* turn off feature */
 993             break;
 994 #ifdef MTEOM
 995          case MTEOM:
 996             msg = "WTEOM";
 997             dev->capabilities &= ~CAP_EOM; /* turn off feature */
 998             break;
 999 #endif
1000          case MTFSF:
1001             msg = "MTFSF";
1002             dev->capabilities &= ~CAP_FSF; /* turn off feature */
1003             break;
1004          case MTBSF:
1005             msg = "MTBSF";
1006             dev->capabilities &= ~CAP_BSF; /* turn off feature */
1007             break;
1008          case MTFSR:
1009             msg = "MTFSR";
1010             dev->capabilities &= ~CAP_FSR; /* turn off feature */
1011             break;
1012          case MTBSR:
1013             msg = "MTBSR";
1014             dev->capabilities &= ~CAP_BSR; /* turn off feature */
1015             break;
1016          default:
1017             msg = "Unknown";
1018             break;
1019       }
1020       if (msg != NULL) {
1021          dev->dev_errno = ENOSYS;
1022          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1023          Emsg0(M_ERROR, 0, dev->errmsg);
1024       }
1025    }
1026 /* Found on Linux */
1027 #ifdef MTIOCLRERR
1028 {
1029    struct mtop mt_com;
1030    mt_com.mt_op = MTIOCLRERR;
1031    mt_com.mt_count = 1;
1032    /* Clear any error condition on the tape */
1033    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1034    Dmsg0(200, "Did MTIOCLRERR\n");
1035 }
1036 #endif
1037
1038 /* Typically on FreeBSD */
1039 #ifdef MTIOCERRSTAT
1040 {
1041    /* Read and clear SCSI error status */
1042    union mterrstat mt_errstat;
1043    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1044 }
1045 #endif
1046 }
1047
1048 /*
1049  * Flush buffer contents
1050  *  No longer used.
1051  */
1052 int flush_dev(DEVICE *dev)
1053 {
1054    return 1;
1055 }
1056
1057 static void do_close(DEVICE *dev)
1058 {
1059
1060    Dmsg0(29, "really close_dev\n");
1061    close(dev->fd);
1062    /* Clean up device packet so it can be reused */
1063    dev->fd = -1;
1064    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1065    dev->file = dev->block_num = 0;
1066    dev->file_addr = 0;
1067    dev->EndFile = dev->EndBlock = 0;
1068    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1069    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1070    dev->use_count--;
1071    if (dev->tid) {
1072       stop_thread_timer(dev->tid);
1073       dev->tid = 0;
1074    }
1075 }
1076
1077 /*
1078  * Close the device
1079  */
1080 void
1081 close_dev(DEVICE *dev)
1082 {
1083    if (!dev) {
1084       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1085       Emsg0(M_FATAL, 0, dev->errmsg);
1086       return;
1087    }
1088    if (dev->fd >= 0 && dev->use_count == 1) {
1089       do_close(dev);
1090    } else {
1091       Dmsg0(29, "close_dev but in use so leave open.\n");
1092       dev->use_count--;
1093    }
1094 }
1095
1096 /*
1097  * Used when unmounting the device
1098  */
1099 void force_close_dev(DEVICE *dev)
1100 {
1101    if (!dev) {
1102       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1103       Emsg0(M_FATAL, 0, dev->errmsg);
1104       return;
1105    }
1106    Dmsg0(29, "really close_dev\n");
1107    do_close(dev);
1108 }
1109
1110 int truncate_dev(DEVICE *dev)
1111 {
1112    if (dev->state & ST_TAPE) {
1113       return 1;
1114    }
1115    if (ftruncate(dev->fd, 0) != 0) {
1116       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1117       return 0;
1118    }
1119    return 1;
1120 }
1121
1122 int
1123 dev_is_tape(DEVICE *dev)
1124 {
1125    return (dev->state & ST_TAPE) ? 1 : 0;
1126 }
1127
1128
1129 /*
1130  * return 1 if the device is read for write, and 0 otherwise
1131  *   This is meant for checking at the end of a job to see
1132  *   if we still have a tape (perhaps not if at end of tape
1133  *   and the job is canceled).
1134  */
1135 int
1136 dev_can_write(DEVICE *dev)
1137 {
1138    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1139        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1140       return 1;
1141    } else {
1142       return 0;
1143    }
1144 }
1145
1146 char *
1147 dev_name(DEVICE *dev)
1148 {
1149    return dev->dev_name;
1150 }
1151
1152 char *
1153 dev_vol_name(DEVICE *dev)
1154 {
1155    return dev->VolCatInfo.VolCatName;
1156 }
1157
1158 uint32_t dev_block(DEVICE *dev)
1159 {
1160    update_pos_dev(dev);
1161    return dev->block_num;
1162 }
1163
1164 uint32_t dev_file(DEVICE *dev)
1165 {
1166    update_pos_dev(dev);
1167    return dev->file;
1168 }
1169
1170 /*
1171  * Free memory allocated for the device
1172  */
1173 void
1174 term_dev(DEVICE *dev)
1175 {
1176    if (!dev) {
1177       dev->dev_errno = EBADF;
1178       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1179       Emsg0(M_FATAL, 0, dev->errmsg);
1180       return;
1181    }
1182    do_close(dev);
1183    Dmsg0(29, "term_dev\n");
1184    if (dev->dev_name) {
1185       free_memory(dev->dev_name);
1186       dev->dev_name = NULL;
1187    }
1188    if (dev->errmsg) {
1189       free_pool_memory(dev->errmsg);
1190       dev->errmsg = NULL;
1191    }
1192    pthread_mutex_destroy(&dev->mutex);
1193    pthread_cond_destroy(&dev->wait);
1194    pthread_cond_destroy(&dev->wait_next_vol);
1195    if (dev->state & ST_MALLOC) {
1196       free_pool_memory((POOLMEM *)dev);
1197    }
1198 }
1199
1200
1201
1202 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1203 {
1204    jcr->prev_dev = (JCR *)NULL;
1205    jcr->next_dev = dev->attached_jcrs;
1206    if (dev->attached_jcrs) {
1207       dev->attached_jcrs->prev_dev = jcr;
1208    }
1209    dev->attached_jcrs = jcr;
1210    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1211 }
1212
1213 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1214 {
1215    if (!jcr->prev_dev) {
1216       dev->attached_jcrs = jcr->next_dev;
1217    } else {
1218       jcr->prev_dev->next_dev = jcr->next_dev;
1219    }
1220    if (jcr->next_dev) {
1221       jcr->next_dev->prev_dev = jcr->prev_dev;
1222    }
1223    jcr->next_dev = jcr->prev_dev = NULL;
1224    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1225 }
1226
1227 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1228 {
1229    if (jcr == (JCR *)NULL) {
1230       return dev->attached_jcrs;
1231    }
1232    return jcr->next_dev;
1233 }