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

   1 /*
   2  *
   3  *  Higher Level Device routines.
   4  *  Knows about Bacula tape labels and such
   5  *
   6  *  NOTE! In general, subroutines that have the word
   7  *        "device" in the name do locking.  Subroutines
   8  *        that have the word "dev" in the name do not
   9  *        do locking.  Thus if xxx_device() calls
  10  *        yyy_dev(), all is OK, but if xxx_device()
  11  *        calls yyy_device(), everything will hang.
  12  *        Obviously, no zzz_dev() is allowed to call
  13  *        a www_device() or everything falls apart.
  14  *
  15  * Concerning the routines lock_device() and block_device()
  16  *  see the end of this module for details.  In general,
  17  *  blocking a device leaves it in a state where all threads
  18  *  other than the current thread block when they attempt to
  19  *  lock the device. They remain suspended (blocked) until the device
  20  *  is unblocked. So, a device is blocked during an operation
  21  *  that takes a long time (initialization, mounting a new
  22  *  volume, ...) locking a device is done for an operation
  23  *  that takes a short time such as writing data to the
  24  *  device.
  25  *
  26  *
  27  *   Kern Sibbald, MM, MMI
  28  *
  29  *   Version $Id$
  30  */
  31 /*
  32    Copyright (C) 2000-2005 Kern Sibbald
  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 #include "bacula.h"                   /* pull in global headers */
  52 #include "stored.h"                   /* pull in Storage Deamon headers */
  53
  54 /* Forward referenced functions */
  55
  56 extern char my_name[];
  57 extern int debug_level;
  58
  59 /*
  60  * This is the dreaded moment. We either have an end of
  61  * medium condition or worse, and error condition.
  62  * Attempt to "recover" by obtaining a new Volume.
  63  *
  64  * Here are a few things to know:
  65  *  dcr->VolCatInfo contains the info on the "current" tape for this job.
  66  *  dev->VolCatInfo contains the info on the tape in the drive.
  67  *    The tape in the drive could have changed several times since
  68  *    the last time the job used it (jcr->VolCatInfo).
  69  *  dcr->VolumeName is the name of the current/desired tape in the drive.
  70  *
  71  * We enter with device locked, and
  72  *     exit with device locked.
  73  *
  74  * Note, we are called only from one place in block.c
  75  *
  76  *  Returns: true  on success
  77  *           false on failure
  78  */
  79 bool fixup_device_block_write_error(DCR *dcr)
  80 {
  81    uint32_t stat;
  82    char PrevVolName[MAX_NAME_LENGTH];
  83    DEV_BLOCK *label_blk;
  84    DEV_BLOCK *block = dcr->block;
  85    char b1[30], b2[30];
  86    time_t wait_time;
  87    char dt[MAX_TIME_LENGTH];
  88    JCR *jcr = dcr->jcr;
  89    DEVICE *dev = dcr->dev;
  90
  91    wait_time = time(NULL);
  92    stat = status_dev(dev);
  93    if (!(stat & BMT_EOD)) {
  94       return false;                    /* this really shouldn't happen */
  95    }
  96
  97    Dmsg0(100, "======= Got EOD ========\n");
  98
  99    block_device(dev, BST_DOING_ACQUIRE);
 100    /* Unlock, but leave BLOCKED */
 101    unlock_device(dev);
 102
 103    bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
 104    Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
 105       dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
 106    dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
 107    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
 108    if (!dir_update_volume_info(dcr, false)) {    /* send Volume info to Director */
 109       P(dev->mutex);
 110       unblock_device(dev);
 111       return false;                /* device locked */
 112    }
 113    Dmsg0(100, "Back from update_vol_info\n");
 114
 115    bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
 116    bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
 117
 118    label_blk = new_block(dev);
 119    dcr->block = label_blk;
 120
 121    /* Inform User about end of medium */
 122    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
 123         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 124         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
 125         bstrftime(dt, sizeof(dt), time(NULL)));
 126
 127    if (!mount_next_write_volume(dcr, 1)) {
 128       free_block(label_blk);
 129       dcr->block = block;
 130       P(dev->mutex);
 131       unblock_device(dev);
 132       return false;                /* device locked */
 133    }
 134    P(dev->mutex);                  /* lock again */
 135
 136    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
 137       dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
 138
 139    /*
 140     * If this is a new tape, the label_blk will contain the
 141     *  label, so write it now. If this is a previously
 142     *  used tape, mount_next_write_volume() will return an
 143     *  empty label_blk, and nothing will be written.
 144     */
 145    Dmsg0(190, "write label block to dev\n");
 146    if (!write_block_to_dev(dcr)) {
 147       berrno be;
 148       Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
 149         be.strerror(dev->dev_errno));
 150       free_block(label_blk);
 151       dcr->block = block;
 152       unblock_device(dev);
 153       return false;                /* device locked */
 154    }
 155    free_block(label_blk);
 156    dcr->block = block;
 157
 158    /*
 159     * Walk through all attached jcrs indicating the volume has changed
 160     */
 161    Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
 162 // for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 163    DCR *mdcr;
 164    foreach_dlist(mdcr, dev->attached_dcrs) {
 165       JCR *mjcr = mdcr->jcr;
 166       if (mjcr->JobId == 0) {
 167          continue;                 /* ignore console */
 168       }
 169       mdcr->NewVol = true;
 170       if (jcr != mjcr) {
 171          bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
 172       }
 173    }
 174
 175    /* Clear NewVol now because dir_get_volume_info() already done */
 176    jcr->dcr->NewVol = false;
 177    set_new_volume_parameters(dcr);
 178
 179    jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
 180
 181    /* Write overflow block to device */
 182    Dmsg0(190, "Write overflow block to dev\n");
 183    if (!write_block_to_dev(dcr)) {
 184       berrno be;
 185       Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
 186         be.strerror(dev->dev_errno));
 187       unblock_device(dev);
 188       return false;                /* device locked */
 189    }
 190
 191    unblock_device(dev);
 192    return true;                             /* device locked */
 193 }
 194
 195 /*
 196  * We have a new Volume mounted, so reset the Volume parameters
 197  *  concerning this job.  The global changes were made earlier
 198  *  in the dev structure.
 199  */
 200 void set_new_volume_parameters(DCR *dcr)
 201 {
 202    JCR *jcr = dcr->jcr;
 203    DEVICE *dev = dcr->dev;
 204    if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
 205       Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
 206    }
 207    /* Set new start/end positions */
 208    if (dev_state(dev, ST_TAPE)) {
 209       dcr->StartBlock = dev->block_num;
 210       dcr->StartFile = dev->file;
 211    } else {
 212       dcr->StartBlock = (uint32_t)dev->file_addr;
 213       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 214    }
 215    /* Reset indicies */
 216    dcr->VolFirstIndex = 0;
 217    dcr->VolLastIndex = 0;
 218    jcr->NumVolumes++;
 219    dcr->NewVol = false;
 220    dcr->WroteVol = false;
 221 }
 222
 223 /*
 224  * We are now in a new Volume file, so reset the Volume parameters
 225  *  concerning this job.  The global changes were made earlier
 226  *  in the dev structure.
 227  */
 228 void set_new_file_parameters(DCR *dcr)
 229 {
 230    DEVICE *dev = dcr->dev;
 231
 232    /* Set new start/end positions */
 233    if (dev_state(dev, ST_TAPE)) {
 234       dcr->StartBlock = dev->block_num;
 235       dcr->StartFile = dev->file;
 236    } else {
 237       dcr->StartBlock = (uint32_t)dev->file_addr;
 238       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 239    }
 240    /* Reset indicies */
 241    dcr->VolFirstIndex = 0;
 242    dcr->VolLastIndex = 0;
 243    dcr->NewFile = false;
 244    dcr->WroteVol = false;
 245 }
 246
 247
 248
 249 /*
 250  *   First Open of the device. Expect dev to already be initialized.
 251  *
 252  *   This routine is used only when the Storage daemon starts
 253  *   and always_open is set, and in the stand-alone utility
 254  *   routines such as bextract.
 255  *
 256  *   Note, opening of a normal file is deferred to later so
 257  *    that we can get the filename; the device_name for
 258  *    a file is the directory only.
 259  *
 260  *   Returns: false on failure
 261  *            true  on success
 262  */
 263 bool first_open_device(DEVICE *dev)
 264 {
 265    Dmsg0(120, "start open_output_device()\n");
 266    if (!dev) {
 267       return false;
 268    }
 269
 270    lock_device(dev);
 271
 272    /* Defer opening files */
 273    if (!dev_is_tape(dev)) {
 274       Dmsg0(129, "Device is file, deferring open.\n");
 275       unlock_device(dev);
 276       return true;
 277    }
 278
 279    if (!dev->is_open()) {
 280        int mode;
 281        if (dev_cap(dev, CAP_STREAM)) {
 282           mode = OPEN_WRITE_ONLY;
 283        } else {
 284           mode = OPEN_READ_WRITE;
 285        }
 286       Dmsg0(129, "Opening device.\n");
 287       if (open_dev(dev, NULL, mode) < 0) {
 288          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 289          unlock_device(dev);
 290          return false;
 291       }
 292    }
 293    Dmsg1(129, "open_dev %s OK\n", dev->print_name());
 294
 295    unlock_device(dev);
 296    return true;
 297 }
 298
 299 /*
 300  * Make sure device is open, if not do so
 301  */
 302 bool open_device(DCR *dcr)
 303 {
 304    DEVICE *dev = dcr->dev;
 305    /* Open device */
 306    if  (!dev->is_open()) {
 307       int mode;
 308       if (dev_cap(dev, CAP_STREAM)) {
 309          mode = OPEN_WRITE_ONLY;
 310       } else {
 311          mode = OPEN_READ_WRITE;
 312       }
 313       if (open_dev(dev, dcr->VolCatInfo.VolCatName, mode) < 0) {
 314          /* If polling, ignore the error */
 315          if (!dev->poll) {
 316             Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
 317                dev->print_name(), strerror_dev(dev));
 318             Pmsg2(000, "Unable to open archive %s: ERR=%s\n",
 319                dev->print_name(), strerror_dev(dev));
 320          }
 321          return false;
 322       }
 323    }
 324    return true;
 325 }
 326
 327 void dev_lock(DEVICE *dev)
 328 {
 329    int errstat;
 330    if ((errstat=rwl_writelock(&dev->lock))) {
 331       Emsg1(M_ABORT, 0, "Device write lock failure. ERR=%s\n", strerror(errstat));
 332    }
 333 }
 334
 335 void dev_unlock(DEVICE *dev)
 336 {
 337    int errstat;
 338    if ((errstat=rwl_writeunlock(&dev->lock))) {
 339       Emsg1(M_ABORT, 0, "Device write unlock failure. ERR=%s\n", strerror(errstat));
 340    }
 341 }
 342
 343 /*
 344  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
 345  * must wait. The no_wait_id thread is out obtaining a new volume
 346  * and preparing the label.
 347  */
 348 void _lock_device(const char *file, int line, DEVICE *dev)
 349 {
 350    int stat;
 351    Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
 352    P(dev->mutex);
 353    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
 354       dev->num_waiting++;             /* indicate that I am waiting */
 355       while (dev->dev_blocked) {
 356          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
 357             V(dev->mutex);
 358             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
 359                strerror(stat));
 360          }
 361       }
 362       dev->num_waiting--;             /* no longer waiting */
 363    }
 364 }
 365
 366 /*
 367  * Check if the device is blocked or not
 368  */
 369 bool device_is_unmounted(DEVICE *dev)
 370 {
 371    bool stat;
 372    int blocked = dev->dev_blocked;
 373    stat = (blocked == BST_UNMOUNTED) ||
 374           (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 375    return stat;
 376 }
 377
 378 const char *edit_blocked_reason(DEVICE *dev)
 379 {
 380    switch (dev->dev_blocked) {
 381    case BST_NOT_BLOCKED:
 382       return "not blocked";
 383    case BST_UNMOUNTED:
 384       return "user unmounted device";
 385    case BST_WAITING_FOR_SYSOP:
 386       return "waiting for operator action";
 387    case BST_DOING_ACQUIRE:
 388       return "opening, validating, or positioning tape";
 389    case BST_WRITING_LABEL:
 390       return "labeling tape";
 391    case BST_UNMOUNTED_WAITING_FOR_SYSOP:
 392       return "closed by user during mount request";
 393    case BST_MOUNT:
 394       return "mount request";
 395    default:
 396       return "unknown blocked code";
 397    }
 398 }
 399
 400 void _unlock_device(const char *file, int line, DEVICE *dev)
 401 {
 402    Dmsg2(500, "unlock from %s:%d\n", file, line);
 403    V(dev->mutex);
 404 }
 405
 406 /*
 407  * Block all other threads from using the device
 408  *  Device must already be locked.  After this call,
 409  *  the device is blocked to any thread calling lock_device(),
 410  *  but the device is not locked (i.e. no P on device).  Also,
 411  *  the current thread can do slip through the lock_device()
 412  *  calls without blocking.
 413  */
 414 void _block_device(const char *file, int line, DEVICE *dev, int state)
 415 {
 416    Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
 417    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
 418    dev->dev_blocked = state;          /* make other threads wait */
 419    dev->no_wait_id = pthread_self();  /* allow us to continue */
 420 }
 421
 422
 423
 424 /*
 425  * Unblock the device, and wake up anyone who went to sleep.
 426  */
 427 void _unblock_device(const char *file, int line, DEVICE *dev)
 428 {
 429    Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
 430    ASSERT(dev->dev_blocked);
 431    dev->dev_blocked = BST_NOT_BLOCKED;
 432    dev->no_wait_id = 0;
 433    if (dev->num_waiting > 0) {
 434       pthread_cond_broadcast(&dev->wait); /* wake them up */
 435    }
 436 }
 437
 438 /*
 439  * Enter with device locked and blocked
 440  * Exit with device unlocked and blocked by us.
 441  */
 442 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
 443 {
 444    Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
 445       file, line);
 446    hold->dev_blocked = dev->dev_blocked;
 447    hold->dev_prev_blocked = dev->dev_prev_blocked;
 448    hold->no_wait_id = dev->no_wait_id;
 449    dev->dev_blocked = state;
 450    dev->no_wait_id = pthread_self();
 451    V(dev->mutex);
 452 }
 453
 454 /*
 455  * Enter with device blocked by us but not locked
 456  * Exit with device locked, and blocked by previous owner
 457  */
 458 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
 459 {
 460    Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n",
 461       dev->dev_blocked, hold->dev_blocked, file, line);
 462    P(dev->mutex);
 463    dev->dev_blocked = hold->dev_blocked;
 464    dev->dev_prev_blocked = hold->dev_prev_blocked;
 465    dev->no_wait_id = hold->no_wait_id;
 466    if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
 467       pthread_cond_broadcast(&dev->wait); /* wake them up */
 468    }
 469 }