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(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
 104    bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
 105
 106    label_blk = new_block(dev);
 107    dcr->block = label_blk;
 108
 109    /* Inform User about end of medium */
 110    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
 111         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 112         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
 113         bstrftime(dt, sizeof(dt), time(NULL)));
 114
 115    if (!mount_next_write_volume(dcr, 1)) {
 116       free_block(label_blk);
 117       dcr->block = block;
 118       P(dev->mutex);
 119       unblock_device(dev);
 120       return false;                /* device locked */
 121    }
 122    P(dev->mutex);                  /* lock again */
 123
 124    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
 125       dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
 126
 127    /*
 128     * If this is a new tape, the label_blk will contain the
 129     *  label, so write it now. If this is a previously
 130     *  used tape, mount_next_write_volume() will return an
 131     *  empty label_blk, and nothing will be written.
 132     */
 133    Dmsg0(190, "write label block to dev\n");
 134    if (!write_block_to_dev(dcr)) {
 135       berrno be;
 136       Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
 137         be.strerror(dev->dev_errno));
 138       free_block(label_blk);
 139       dcr->block = block;
 140       unblock_device(dev);
 141       return false;                /* device locked */
 142    }
 143    free_block(label_blk);
 144    dcr->block = block;
 145
 146    /*
 147     * Walk through all attached jcrs indicating the volume has changed
 148     */
 149    Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
 150 // for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 151    DCR *mdcr;
 152    foreach_dlist(mdcr, dev->attached_dcrs) {
 153       JCR *mjcr = mdcr->jcr;
 154       if (mjcr->JobId == 0) {
 155          continue;                 /* ignore console */
 156       }
 157       mdcr->NewVol = true;
 158       if (jcr != mjcr) {
 159          bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
 160       }
 161    }
 162
 163    /* Clear NewVol now because dir_get_volume_info() already done */
 164    jcr->dcr->NewVol = false;
 165    set_new_volume_parameters(dcr);
 166
 167    jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
 168
 169    /* Write overflow block to device */
 170    Dmsg0(190, "Write overflow block to dev\n");
 171    if (!write_block_to_dev(dcr)) {
 172       berrno be;
 173       Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
 174         be.strerror(dev->dev_errno));
 175       unblock_device(dev);
 176       return false;                /* device locked */
 177    }
 178
 179    unblock_device(dev);
 180    return true;                             /* device locked */
 181 }
 182
 183 /*
 184  * We have a new Volume mounted, so reset the Volume parameters
 185  *  concerning this job.  The global changes were made earlier
 186  *  in the dev structure.
 187  */
 188 void set_new_volume_parameters(DCR *dcr)
 189 {
 190    JCR *jcr = dcr->jcr;
 191    DEVICE *dev = dcr->dev;
 192    if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
 193       Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
 194    }
 195    /* Set new start/end positions */
 196    if (dev_state(dev, ST_TAPE)) {
 197       dcr->StartBlock = dev->block_num;
 198       dcr->StartFile = dev->file;
 199    } else {
 200       dcr->StartBlock = (uint32_t)dev->file_addr;
 201       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 202    }
 203    /* Reset indicies */
 204    dcr->VolFirstIndex = 0;
 205    dcr->VolLastIndex = 0;
 206    jcr->NumVolumes++;
 207    dcr->NewVol = false;
 208    dcr->WroteVol = false;
 209 }
 210
 211 /*
 212  * We are now in a new Volume file, so reset the Volume parameters
 213  *  concerning this job.  The global changes were made earlier
 214  *  in the dev structure.
 215  */
 216 void set_new_file_parameters(DCR *dcr)
 217 {
 218    DEVICE *dev = dcr->dev;
 219
 220    /* Set new start/end positions */
 221    if (dev_state(dev, ST_TAPE)) {
 222       dcr->StartBlock = dev->block_num;
 223       dcr->StartFile = dev->file;
 224    } else {
 225       dcr->StartBlock = (uint32_t)dev->file_addr;
 226       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 227    }
 228    /* Reset indicies */
 229    dcr->VolFirstIndex = 0;
 230    dcr->VolLastIndex = 0;
 231    dcr->NewFile = false;
 232    dcr->WroteVol = false;
 233 }
 234
 235
 236
 237 /*
 238  *   First Open of the device. Expect dev to already be initialized.
 239  *
 240  *   This routine is used only when the Storage daemon starts
 241  *   and always_open is set, and in the stand-alone utility
 242  *   routines such as bextract.
 243  *
 244  *   Note, opening of a normal file is deferred to later so
 245  *    that we can get the filename; the device_name for
 246  *    a file is the directory only.
 247  *
 248  *   Returns: false on failure
 249  *            true  on success
 250  */
 251 bool first_open_device(DEVICE *dev)
 252 {
 253    Dmsg0(120, "start open_output_device()\n");
 254    if (!dev) {
 255       return false;
 256    }
 257
 258    lock_device(dev);
 259
 260    /* Defer opening files */
 261    if (!dev->is_tape()) {
 262       Dmsg0(129, "Device is file, deferring open.\n");
 263       unlock_device(dev);
 264       return true;
 265    }
 266
 267     int mode;
 268     if (dev_cap(dev, CAP_STREAM)) {
 269        mode = OPEN_WRITE_ONLY;
 270     } else {
 271        mode = OPEN_READ_WRITE;
 272     }
 273    Dmsg0(129, "Opening device.\n");
 274    dev->open_nowait = true;
 275    if (open_dev(dev, NULL, mode) < 0) {
 276       Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 277       dev->open_nowait = false;
 278       unlock_device(dev);
 279       return false;
 280    }
 281    Dmsg1(129, "open_dev %s OK\n", dev->print_name());
 282    dev->open_nowait = false;
 283    unlock_device(dev);
 284    return true;
 285 }
 286
 287 /*
 288  * Make sure device is open, if not do so
 289  */
 290 bool open_device(DCR *dcr)
 291 {
 292    DEVICE *dev = dcr->dev;
 293    /* Open device */
 294    int mode;
 295    if (dev_cap(dev, CAP_STREAM)) {
 296       mode = OPEN_WRITE_ONLY;
 297    } else {
 298       mode = OPEN_READ_WRITE;
 299    }
 300    if (open_dev(dev, dcr->VolCatInfo.VolCatName, mode) < 0) {
 301       /* If polling, ignore the error */
 302       if (!dev->poll) {
 303          Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
 304             dev->print_name(), strerror_dev(dev));
 305          Pmsg2(000, "Unable to open archive %s: ERR=%s\n",
 306             dev->print_name(), strerror_dev(dev));
 307       }
 308       return false;
 309    }
 310    return true;
 311 }
 312
 313 void dev_lock(DEVICE *dev)
 314 {
 315    int errstat;
 316    if ((errstat=rwl_writelock(&dev->lock))) {
 317       Emsg1(M_ABORT, 0, "Device write lock failure. ERR=%s\n", strerror(errstat));
 318    }
 319 }
 320
 321 void dev_unlock(DEVICE *dev)
 322 {
 323    int errstat;
 324    if ((errstat=rwl_writeunlock(&dev->lock))) {
 325       Emsg1(M_ABORT, 0, "Device write unlock failure. ERR=%s\n", strerror(errstat));
 326    }
 327 }
 328
 329 /*
 330  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
 331  * must wait. The no_wait_id thread is out obtaining a new volume
 332  * and preparing the label.
 333  */
 334 void _lock_device(const char *file, int line, DEVICE *dev)
 335 {
 336    int stat;
 337    Dmsg3(500, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
 338    P(dev->mutex);
 339    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
 340       dev->num_waiting++;             /* indicate that I am waiting */
 341       while (dev->dev_blocked) {
 342          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
 343             V(dev->mutex);
 344             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
 345                strerror(stat));
 346          }
 347       }
 348       dev->num_waiting--;             /* no longer waiting */
 349    }
 350 }
 351
 352 /*
 353  * Check if the device is blocked or not
 354  */
 355 bool device_is_unmounted(DEVICE *dev)
 356 {
 357    bool stat;
 358    int blocked = dev->dev_blocked;
 359    stat = (blocked == BST_UNMOUNTED) ||
 360           (blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 361    return stat;
 362 }
 363
 364 const char *edit_blocked_reason(DEVICE *dev)
 365 {
 366    switch (dev->dev_blocked) {
 367    case BST_NOT_BLOCKED:
 368       return "not blocked";
 369    case BST_UNMOUNTED:
 370       return "user unmounted device";
 371    case BST_WAITING_FOR_SYSOP:
 372       return "waiting for operator action";
 373    case BST_DOING_ACQUIRE:
 374       return "opening, validating, or positioning tape";
 375    case BST_WRITING_LABEL:
 376       return "labeling tape";
 377    case BST_UNMOUNTED_WAITING_FOR_SYSOP:
 378       return "closed by user during mount request";
 379    case BST_MOUNT:
 380       return "mount request";
 381    default:
 382       return "unknown blocked code";
 383    }
 384 }
 385
 386 void _unlock_device(const char *file, int line, DEVICE *dev)
 387 {
 388    Dmsg2(500, "unlock from %s:%d\n", file, line);
 389    V(dev->mutex);
 390 }
 391
 392 /*
 393  * Block all other threads from using the device
 394  *  Device must already be locked.  After this call,
 395  *  the device is blocked to any thread calling lock_device(),
 396  *  but the device is not locked (i.e. no P on device).  Also,
 397  *  the current thread can do slip through the lock_device()
 398  *  calls without blocking.
 399  */
 400 void _block_device(const char *file, int line, DEVICE *dev, int state)
 401 {
 402    Dmsg3(500, "block set %d from %s:%d\n", state, file, line);
 403    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
 404    dev->dev_blocked = state;          /* make other threads wait */
 405    dev->no_wait_id = pthread_self();  /* allow us to continue */
 406 }
 407
 408
 409
 410 /*
 411  * Unblock the device, and wake up anyone who went to sleep.
 412  */
 413 void _unblock_device(const char *file, int line, DEVICE *dev)
 414 {
 415    Dmsg3(500, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
 416    ASSERT(dev->dev_blocked);
 417    dev->dev_blocked = BST_NOT_BLOCKED;
 418    dev->no_wait_id = 0;
 419    if (dev->num_waiting > 0) {
 420       pthread_cond_broadcast(&dev->wait); /* wake them up */
 421    }
 422 }
 423
 424 /*
 425  * Enter with device locked and blocked
 426  * Exit with device unlocked and blocked by us.
 427  */
 428 void _steal_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
 429 {
 430    Dmsg4(500, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
 431       file, line);
 432    hold->dev_blocked = dev->dev_blocked;
 433    hold->dev_prev_blocked = dev->dev_prev_blocked;
 434    hold->no_wait_id = dev->no_wait_id;
 435    dev->dev_blocked = state;
 436    dev->no_wait_id = pthread_self();
 437    V(dev->mutex);
 438 }
 439
 440 /*
 441  * Enter with device blocked by us but not locked
 442  * Exit with device locked, and blocked by previous owner
 443  */
 444 void _give_back_device_lock(const char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
 445 {
 446    Dmsg4(500, "return lock. old=%d new=%d from %s:%d\n",
 447       dev->dev_blocked, hold->dev_blocked, file, line);
 448    P(dev->mutex);
 449    dev->dev_blocked = hold->dev_blocked;
 450    dev->dev_prev_blocked = hold->dev_prev_blocked;
 451    dev->no_wait_id = hold->no_wait_id;
 452    if (dev->dev_blocked == BST_NOT_BLOCKED && dev->num_waiting > 0) {
 453       pthread_cond_broadcast(&dev->wait); /* wake them up */
 454    }
 455 }