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
  87 /*
  88  * Allocate and initialize the DEVICE structure
  89  * Note, if dev is non-NULL, it is already allocated,
  90  * thus we neither allocate it nor free it. This allows
  91  * the caller to put the packet in shared memory.
  92  *
  93  *  Note, for a tape, the device->device_name is the device name
  94  *     (e.g. /dev/nst0), and for a file, the device name
  95  *     is the directory in which the file will be placed.
  96  *
  97  */
  98 DEVICE *
  99 init_dev(DEVICE *dev, DEVRES *device)
 100 {
 101    struct stat statp;
 102    int tape, fifo;
 103    int errstat;
 104
 105    /* Check that device is available */
 106    if (stat(device->device_name, &statp) < 0) {
 107       if (dev) {
 108          dev->dev_errno = errno;
 109       }
 110       Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
 111             strerror(errno));
 112       return NULL;
 113    }
 114    tape = FALSE;
 115    fifo = FALSE;
 116    if (S_ISDIR(statp.st_mode)) {
 117       tape = FALSE;
 118    } else if (S_ISCHR(statp.st_mode)) {
 119       tape = TRUE;
 120    } else if (S_ISFIFO(statp.st_mode)) {
 121       fifo = TRUE;
 122    } else {
 123       if (dev) {
 124          dev->dev_errno = ENODEV;
 125       }
 126       Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
 127          dev_name, statp.st_mode);
 128       return NULL;
 129    }
 130    if (!dev) {
 131       dev = (DEVICE *)get_memory(sizeof(DEVICE));
 132       memset(dev, 0, sizeof(DEVICE));
 133       dev->state = ST_MALLOC;
 134    } else {
 135       memset(dev, 0, sizeof(DEVICE));
 136    }
 137
 138    /* Copy user supplied device parameters from Resource */
 139    dev->dev_name = get_memory(strlen(device->device_name)+1);
 140    strcpy(dev->dev_name, device->device_name);
 141    dev->capabilities = device->cap_bits;
 142    dev->min_block_size = device->min_block_size;
 143    dev->max_block_size = device->max_block_size;
 144    dev->max_volume_size = device->max_volume_size;
 145    dev->max_file_size = device->max_file_size;
 146    dev->volume_capacity = device->volume_capacity;
 147    dev->max_rewind_wait = device->max_rewind_wait;
 148    dev->max_open_wait = device->max_open_wait;
 149    dev->max_open_vols = device->max_open_vols;
 150    dev->device = device;
 151
 152    if (tape) {
 153       dev->state |= ST_TAPE;
 154    } else if (fifo) {
 155       dev->state |= ST_FIFO;
 156       dev->capabilities |= CAP_STREAM; /* set stream device */
 157    } else {
 158       dev->state |= ST_FILE;
 159    }
 160
 161    if (dev->max_block_size > 1000000) {
 162       Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
 163          dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
 164       dev->max_block_size = 0;
 165    }
 166    if (dev->max_block_size % TAPE_BSIZE != 0) {
 167       Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
 168          dev->max_block_size, dev->dev_name);
 169    }
 170
 171    dev->errmsg = get_pool_memory(PM_EMSG);
 172    *dev->errmsg = 0;
 173
 174    if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
 175       dev->dev_errno = errstat;
 176       Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
 177       Emsg0(M_FATAL, 0, dev->errmsg);
 178    }
 179    if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
 180       dev->dev_errno = errstat;
 181       Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
 182       Emsg0(M_FATAL, 0, dev->errmsg);
 183    }
 184    if ((errstat = pthread_cond_init(&dev->wait_next_vol, 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    dev->fd = -1;
 190    Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
 191    return dev;
 192 }
 193
 194 /* Open the device with the operating system and
 195  * initialize buffer pointers.
 196  *
 197  * Note, for a tape, the VolName is the name we give to the
 198  *    volume (not really used here), but for a file, the
 199  *    VolName represents the name of the file to be created/opened.
 200  *    In the case of a file, the full name is the device name
 201  *    (archive_name) with the VolName concatenated.
 202  */
 203 int
 204 open_dev(DEVICE *dev, char *VolName, int mode)
 205 {
 206    POOLMEM *archive_name;
 207
 208    if (dev->state & ST_OPENED) {
 209       /*
 210        *  *****FIXME***** how to handle two threads wanting
 211        *  different volumes mounted???? E.g. one is waiting
 212        *  for the next volume to be mounted, and a new job
 213        *  starts and snatches up the device.
 214        */
 215       if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
 216          return -1;
 217       }
 218       dev->use_count++;
 219       Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
 220             dev->dev_name, dev->use_count);
 221       Emsg1(M_WARNING, 0, "%s", dev->errmsg);
 222       return dev->fd;
 223    }
 224    if (VolName) {
 225       bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
 226    }
 227
 228    Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
 229          dev->dev_name, dev->VolCatInfo.VolCatName);
 230    dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 231    if (dev->state & (ST_TAPE|ST_FIFO)) {
 232       int timeout;
 233       Dmsg0(29, "open_dev: device is tape\n");
 234       if (mode == OPEN_READ_WRITE) {
 235          dev->mode = O_RDWR | O_BINARY;
 236       } else if (mode == OPEN_READ_ONLY) {
 237          dev->mode = O_RDONLY | O_BINARY;
 238       } else if (mode == OPEN_WRITE_ONLY) {
 239          dev->mode = O_WRONLY | O_BINARY;
 240       } else {
 241          Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
 242       }
 243       timeout = dev->max_open_wait;
 244       errno = 0;
 245       if (dev->state & ST_FIFO && timeout) {
 246          /* Set open timer */
 247          dev->tid = start_thread_timer(pthread_self(), timeout);
 248       }
 249       /* If busy retry each second for max_open_wait seconds */
 250       while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
 251          if (errno == EAGAIN) {
 252             continue;
 253          }
 254          if (errno == EBUSY && timeout-- > 0) {
 255             Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
 256             bmicrosleep(1, 0);
 257             continue;
 258          }
 259          dev->dev_errno = errno;
 260          Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
 261                dev->dev_name, strerror(dev->dev_errno));
 262          /* Stop any open timer we set */
 263          if (dev->tid) {
 264             stop_thread_timer(dev->tid);
 265             dev->tid = 0;
 266          }
 267          Emsg0(M_FATAL, 0, dev->errmsg);
 268          break;
 269       }
 270       if (dev->fd >= 0) {
 271          dev->dev_errno = 0;
 272          dev->state |= ST_OPENED;
 273          dev->use_count = 1;
 274          update_pos_dev(dev);             /* update position */
 275       }
 276       /* Stop any open() timer we started */
 277       if (dev->tid) {
 278          stop_thread_timer(dev->tid);
 279          dev->tid = 0;
 280       }
 281       Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
 282    } else {
 283       /*
 284        * Handle opening of File Archive (not a tape)
 285        */
 286       if (VolName == NULL || *VolName == 0) {
 287          Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
 288             dev->dev_name);
 289          return -1;
 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 = 1;
 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->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT);  /* remove EOF/EOT flags */
 650    dev->block_num = dev->file = 0;
 651    dev->file_addr = 0;
 652 #ifdef MTUNLOCK
 653    mt_com.mt_op = MTUNLOCK;
 654    mt_com.mt_count = 1;
 655    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 656 #endif
 657    mt_com.mt_op = MTOFFL;
 658    mt_com.mt_count = 1;
 659    if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
 660       dev->dev_errno = errno;
 661       Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
 662          dev->dev_name, strerror(dev->dev_errno));
 663       return 0;
 664    }
 665    Dmsg1(100, "Offlined device %s\n", dev->dev_name);
 666    return 1;
 667 }
 668
 669 int offline_or_rewind_dev(DEVICE *dev)
 670 {
 671    if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
 672       return offline_dev(dev);
 673    } else {
 674    /*
 675     * Note, this rewind probably should not be here (it wasn't
 676     *  in prior versions of Bacula), but on FreeBSD, this is
 677     *  needed in the case the tape was "frozen" due to an error
 678     *  such as backspacing after writing and EOF. If it is not
 679     *  done, all future references to the drive get and I/O error.
 680     */
 681       return rewind_dev(dev);
 682    }
 683 }
 684
 685 /*
 686  * Foward space a file
 687  *   Returns: 1 on success
 688  *            0 on failure
 689  */
 690 int
 691 fsf_dev(DEVICE *dev, int num)
 692 {
 693    struct mtop mt_com;
 694    int stat = 0;
 695
 696    if (dev->fd < 0) {
 697       dev->dev_errno = EBADF;
 698       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 699       Emsg0(M_FATAL, 0, dev->errmsg);
 700       return 0;
 701    }
 702
 703    if (!(dev->state & ST_TAPE)) {
 704       return 1;
 705    }
 706    if (dev->state & ST_EOT) {
 707       dev->dev_errno = 0;
 708       Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 709       return 0;
 710    }
 711    if (dev->state & ST_EOF) {
 712       Dmsg0(200, "ST_EOF set on entry to FSF\n");
 713    }
 714    if (dev->state & ST_EOT) {
 715       Dmsg0(200, "ST_EOT set on entry to FSF\n");
 716    }
 717
 718    Dmsg0(29, "fsf_dev\n");
 719    dev->block_num = 0;
 720    if (dev_cap(dev, CAP_FSF)) {
 721       POOLMEM *rbuf;
 722       int rbuf_len;
 723       Dmsg0(200, "FSF has cap_fsf\n");
 724       if (dev->max_block_size == 0) {
 725          rbuf_len = DEFAULT_BLOCK_SIZE;
 726       } else {
 727          rbuf_len = dev->max_block_size;
 728       }
 729       rbuf = get_memory(rbuf_len);
 730       mt_com.mt_op = MTFSF;
 731       mt_com.mt_count = 1;
 732       while (num-- && !(dev->state & ST_EOT)) {
 733          Dmsg0(200, "Doing read before fsf\n");
 734          if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
 735             if (errno == ENOMEM) {     /* tape record exceeds buf len */
 736                stat = rbuf_len;        /* This is OK */
 737             } else {
 738                dev->state |= ST_EOT;
 739                clrerror_dev(dev, -1);
 740                Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
 741                   strerror(dev->dev_errno));
 742                Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
 743                   dev->dev_name, strerror(dev->dev_errno));
 744                Dmsg1(200, "%s", dev->errmsg);
 745                break;
 746             }
 747          }
 748          if (stat == 0) {                /* EOF */
 749             update_pos_dev(dev);
 750             Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
 751             /* Two reads of zero means end of tape */
 752             if (dev->state & ST_EOF) {
 753                dev->state |= ST_EOT;
 754                Dmsg0(200, "Set ST_EOT\n");
 755                break;
 756             } else {
 757                dev->state |= ST_EOF;
 758                dev->file++;
 759                dev->file_addr = 0;
 760                continue;
 761             }
 762          } else {                        /* Got data */
 763             dev->state &= ~(ST_EOF|ST_EOT);
 764          }
 765
 766          Dmsg0(200, "Doing MTFSF\n");
 767          stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 768          if (stat < 0) {                 /* error => EOT */
 769             dev->state |= ST_EOT;
 770             Dmsg0(200, "Set ST_EOT\n");
 771             clrerror_dev(dev, MTFSF);
 772             Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
 773                dev->dev_name, strerror(dev->dev_errno));
 774             Dmsg0(200, "Got < 0 for MTFSF\n");
 775             Dmsg1(200, "%s", dev->errmsg);
 776          } else {
 777             dev->state |= ST_EOF;     /* just read EOF */
 778             dev->file++;
 779             dev->file_addr = 0;
 780          }
 781       }
 782       free_memory(rbuf);
 783
 784    /*
 785     * No FSF, so use FSR to simulate it
 786     */
 787    } else {
 788       Dmsg0(200, "Doing FSR for FSF\n");
 789       while (num-- && !(dev->state & ST_EOT)) {
 790          fsr_dev(dev, INT32_MAX);    /* returns -1 on EOF or EOT */
 791       }
 792       if (dev->state & ST_EOT) {
 793          dev->dev_errno = 0;
 794          Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
 795          stat = -1;
 796       } else {
 797          stat = 0;
 798       }
 799    }
 800    update_pos_dev(dev);
 801    Dmsg1(200, "Return %d from FSF\n", stat);
 802    if (dev->state & ST_EOF)
 803       Dmsg0(200, "ST_EOF set on exit FSF\n");
 804    if (dev->state & ST_EOT)
 805       Dmsg0(200, "ST_EOT set on exit FSF\n");
 806    Dmsg1(200, "Return from FSF file=%d\n", dev->file);
 807    return stat == 0 ? 1 : 0;
 808 }
 809
 810 /*
 811  * Backward space a file
 812  */
 813 int
 814 bsf_dev(DEVICE *dev, int num)
 815 {
 816    struct mtop mt_com;
 817    int stat;
 818
 819    if (dev->fd < 0) {
 820       dev->dev_errno = EBADF;
 821       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 822       Emsg0(M_FATAL, 0, dev->errmsg);
 823       return -1;
 824    }
 825
 826    if (!(dev->state & ST_TAPE)) {
 827       return 0;
 828    }
 829    Dmsg0(29, "bsf_dev\n");
 830    dev->state &= ~(ST_EOT|ST_EOF);
 831    dev->file -= num;
 832    dev->file_addr = 0;
 833    mt_com.mt_op = MTBSF;
 834    mt_com.mt_count = num;
 835    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 836    if (stat < 0) {
 837       clrerror_dev(dev, MTBSF);
 838       Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
 839          dev->dev_name, strerror(dev->dev_errno));
 840    }
 841    update_pos_dev(dev);
 842    return stat;
 843 }
 844
 845
 846 /*
 847  * Foward space a record
 848  */
 849 int
 850 fsr_dev(DEVICE *dev, int num)
 851 {
 852    struct mtop mt_com;
 853    int stat;
 854
 855    if (dev->fd < 0) {
 856       dev->dev_errno = EBADF;
 857       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 858       Emsg0(M_FATAL, 0, dev->errmsg);
 859       return -1;
 860    }
 861
 862    if (!(dev->state & ST_TAPE)) {
 863       return 0;
 864    }
 865    Dmsg0(29, "fsr_dev\n");
 866    dev->block_num += num;
 867    mt_com.mt_op = MTFSR;
 868    mt_com.mt_count = num;
 869    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 870    if (stat == 0) {
 871       dev->state &= ~ST_EOF;
 872    } else {
 873       if (dev->state & ST_EOF) {
 874          dev->state |= ST_EOT;
 875       } else {
 876          dev->state |= ST_EOF;           /* assume EOF */
 877          dev->file++;
 878          dev->file_addr = 0;
 879       }
 880       clrerror_dev(dev, MTFSR);
 881       Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
 882          dev->dev_name, strerror(dev->dev_errno));
 883    }
 884    update_pos_dev(dev);
 885    return stat;
 886 }
 887
 888 /*
 889  * Backward space a record
 890  *   Returns:  0 on success
 891  *            -1 on failure
 892  */
 893 int
 894 bsr_dev(DEVICE *dev, int num)
 895 {
 896    struct mtop mt_com;
 897    int stat;
 898
 899    if (dev->fd < 0) {
 900       dev->dev_errno = EBADF;
 901       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 902       Emsg0(M_FATAL, 0, dev->errmsg);
 903       return -1;
 904    }
 905
 906    if (!(dev->state & ST_TAPE)) {
 907       return 0;
 908    }
 909
 910    if (!dev_cap(dev, CAP_BSR)) {
 911       Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
 912          dev->dev_name);
 913       return 0;
 914    }
 915
 916    Dmsg0(29, "bsr_dev\n");
 917    dev->block_num -= num;
 918    dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
 919    mt_com.mt_op = MTBSR;
 920    mt_com.mt_count = num;
 921    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 922    if (stat < 0) {
 923       clrerror_dev(dev, MTBSR);
 924       Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
 925          dev->dev_name, strerror(dev->dev_errno));
 926    }
 927    update_pos_dev(dev);
 928    return stat;
 929 }
 930
 931
 932
 933 /*
 934  * Write an end of file on the device
 935  *   Returns: 0 on success
 936  *            non-zero on failure
 937  */
 938 int
 939 weof_dev(DEVICE *dev, int num)
 940 {
 941    struct mtop mt_com;
 942    int stat;
 943
 944    if (dev->fd < 0) {
 945       dev->dev_errno = EBADF;
 946       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
 947       Emsg0(M_FATAL, 0, dev->errmsg);
 948       return -1;
 949    }
 950
 951    if (!(dev->state & ST_TAPE)) {
 952       return 0;
 953    }
 954    dev->state &= ~(ST_EOT | ST_EOF);  /* remove EOF/EOT flags */
 955    dev->block_num = 0;
 956    Dmsg0(29, "weof_dev\n");
 957    mt_com.mt_op = MTWEOF;
 958    mt_com.mt_count = num;
 959    stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
 960    if (stat == 0) {
 961       dev->file++;
 962       dev->file_addr = 0;
 963    } else {
 964       clrerror_dev(dev, MTWEOF);
 965       Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
 966          dev->dev_name, strerror(dev->dev_errno));
 967    }
 968    return stat;
 969 }
 970
 971 /*
 972  * Return string message with last error in English
 973  *  Be careful not to call this routine from within dev.c
 974  *  while editing an Mmsg(&) or you will end up in a recursive
 975  *  loop creating a Segmentation Violation.
 976  */
 977 char *
 978 strerror_dev(DEVICE *dev)
 979 {
 980    return dev->errmsg;
 981 }
 982
 983
 984 /*
 985  * If implemented in system, clear the tape
 986  * error status.
 987  */
 988 void
 989 clrerror_dev(DEVICE *dev, int func)
 990 {
 991    char *msg = NULL;
 992
 993    dev->dev_errno = errno;         /* save errno */
 994    if (errno == EIO) {
 995       dev->VolCatInfo.VolCatErrors++;
 996    }
 997
 998    if (!(dev->state & ST_TAPE)) {
 999       return;
1000    }
1001    if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1002       switch (func) {
1003       case -1:
1004          Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1005          break;
1006       case MTWEOF:
1007          msg = "WTWEOF";
1008          dev->capabilities &= ~CAP_EOF; /* turn off feature */
1009          break;
1010 #ifdef MTEOM
1011       case MTEOM:
1012          msg = "WTEOM";
1013          dev->capabilities &= ~CAP_EOM; /* turn off feature */
1014          break;
1015 #endif
1016       case MTFSF:
1017          msg = "MTFSF";
1018          dev->capabilities &= ~CAP_FSF; /* turn off feature */
1019          break;
1020       case MTBSF:
1021          msg = "MTBSF";
1022          dev->capabilities &= ~CAP_BSF; /* turn off feature */
1023          break;
1024       case MTFSR:
1025          msg = "MTFSR";
1026          dev->capabilities &= ~CAP_FSR; /* turn off feature */
1027          break;
1028       case MTBSR:
1029          msg = "MTBSR";
1030          dev->capabilities &= ~CAP_BSR; /* turn off feature */
1031          break;
1032       default:
1033          msg = "Unknown";
1034          break;
1035       }
1036       if (msg != NULL) {
1037          dev->dev_errno = ENOSYS;
1038          Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1039          Emsg0(M_ERROR, 0, dev->errmsg);
1040       }
1041    }
1042 /* Found on Linux */
1043 #ifdef MTIOCLRERR
1044 {
1045    struct mtop mt_com;
1046    mt_com.mt_op = MTIOCLRERR;
1047    mt_com.mt_count = 1;
1048    /* Clear any error condition on the tape */
1049    ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1050    Dmsg0(200, "Did MTIOCLRERR\n");
1051 }
1052 #endif
1053
1054 /* Typically on FreeBSD */
1055 #ifdef MTIOCERRSTAT
1056 {
1057    /* Read and clear SCSI error status */
1058    union mterrstat mt_errstat;
1059    Pmsg2(000, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1060       strerror(dev->dev_errno));
1061    ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1062 }
1063 #endif
1064 }
1065
1066 /*
1067  * Flush buffer contents
1068  *  No longer used.
1069  */
1070 int flush_dev(DEVICE *dev)
1071 {
1072    return 1;
1073 }
1074
1075 static void do_close(DEVICE *dev)
1076 {
1077
1078    Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1079    close(dev->fd);
1080    /* Clean up device packet so it can be reused */
1081    dev->fd = -1;
1082    dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1083    dev->file = dev->block_num = 0;
1084    dev->file_addr = 0;
1085    dev->EndFile = dev->EndBlock = 0;
1086    memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1087    memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1088    if (dev->tid) {
1089       stop_thread_timer(dev->tid);
1090       dev->tid = 0;
1091    }
1092    dev->use_count = 0;
1093 }
1094
1095 /*
1096  * Close the device
1097  */
1098 void
1099 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    if (dev->fd >= 0 && dev->use_count == 1) {
1107       do_close(dev);
1108    } else if (dev->use_count > 0) {
1109       dev->use_count--;
1110    }
1111
1112 #ifdef FULL_DEBUG
1113    ASSERT(dev->use_count >= 0);
1114 #endif
1115 }
1116
1117 /*
1118  * Used when unmounting the device
1119  */
1120 void force_close_dev(DEVICE *dev)
1121 {
1122    if (!dev) {
1123       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1124       Emsg0(M_FATAL, 0, dev->errmsg);
1125       return;
1126    }
1127    Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1128    do_close(dev);
1129
1130 #ifdef FULL_DEBUG
1131    ASSERT(dev->use_count >= 0);
1132 #endif
1133 }
1134
1135 int truncate_dev(DEVICE *dev)
1136 {
1137    if (dev->state & ST_TAPE) {
1138       return 1;
1139    }
1140    if (ftruncate(dev->fd, 0) != 0) {
1141       Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1142       return 0;
1143    }
1144    return 1;
1145 }
1146
1147 int
1148 dev_is_tape(DEVICE *dev)
1149 {
1150    return (dev->state & ST_TAPE) ? 1 : 0;
1151 }
1152
1153
1154 /*
1155  * return 1 if the device is read for write, and 0 otherwise
1156  *   This is meant for checking at the end of a job to see
1157  *   if we still have a tape (perhaps not if at end of tape
1158  *   and the job is canceled).
1159  */
1160 int
1161 dev_can_write(DEVICE *dev)
1162 {
1163    if ((dev->state & ST_OPENED) &&  (dev->state & ST_APPEND) &&
1164        (dev->state & ST_LABEL)  && !(dev->state & ST_WEOT)) {
1165       return 1;
1166    } else {
1167       return 0;
1168    }
1169 }
1170
1171 char *
1172 dev_name(DEVICE *dev)
1173 {
1174    return dev->dev_name;
1175 }
1176
1177 char *
1178 dev_vol_name(DEVICE *dev)
1179 {
1180    return dev->VolCatInfo.VolCatName;
1181 }
1182
1183 uint32_t dev_block(DEVICE *dev)
1184 {
1185    update_pos_dev(dev);
1186    return dev->block_num;
1187 }
1188
1189 uint32_t dev_file(DEVICE *dev)
1190 {
1191    update_pos_dev(dev);
1192    return dev->file;
1193 }
1194
1195 /*
1196  * Free memory allocated for the device
1197  */
1198 void
1199 term_dev(DEVICE *dev)
1200 {
1201    if (!dev) {
1202       dev->dev_errno = EBADF;
1203       Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1204       Emsg0(M_FATAL, 0, dev->errmsg);
1205       return;
1206    }
1207    do_close(dev);
1208    Dmsg0(29, "term_dev\n");
1209    if (dev->dev_name) {
1210       free_memory(dev->dev_name);
1211       dev->dev_name = NULL;
1212    }
1213    if (dev->errmsg) {
1214       free_pool_memory(dev->errmsg);
1215       dev->errmsg = NULL;
1216    }
1217    pthread_mutex_destroy(&dev->mutex);
1218    pthread_cond_destroy(&dev->wait);
1219    pthread_cond_destroy(&dev->wait_next_vol);
1220    if (dev->state & ST_MALLOC) {
1221       free_pool_memory((POOLMEM *)dev);
1222    }
1223 }
1224
1225 /*
1226  * We attach a jcr to the device so that when
1227  *   the Volume is full during writing, a
1228  *   JobMedia record will be created for this
1229  *   Job.
1230  */
1231 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1232 {
1233    jcr->prev_dev = (JCR *)NULL;
1234    jcr->next_dev = dev->attached_jcrs;
1235    if (dev->attached_jcrs) {
1236       dev->attached_jcrs->prev_dev = jcr;
1237    }
1238    dev->attached_jcrs = jcr;
1239    Dmsg1(100, "Attached Job %s\n", jcr->Job);
1240 }
1241
1242 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1243 {
1244    if (!jcr->prev_dev) {
1245       dev->attached_jcrs = jcr->next_dev;
1246    } else {
1247       jcr->prev_dev->next_dev = jcr->next_dev;
1248    }
1249    if (jcr->next_dev) {
1250       jcr->next_dev->prev_dev = jcr->prev_dev;
1251    }
1252    jcr->next_dev = jcr->prev_dev = NULL;
1253    Dmsg1(100, "Detached Job %s\n", jcr->Job);
1254 }
1255
1256 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1257 {
1258    if (jcr == (JCR *)NULL) {
1259       return dev->attached_jcrs;
1260    }
1261    return jcr->next_dev;
1262 }