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-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 #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  * We enter with device locked, and
  65  *     exit with device locked.
  66  *
  67  * Note, we are called only from one place in block.c
  68  *
  69  *  Returns: 1 on success
  70  *           0 on failure
  71  */
  72 int fixup_device_block_write_error(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
  73 {
  74    uint32_t stat = 0;
  75    char PrevVolName[MAX_NAME_LENGTH];
  76    DEV_BLOCK *label_blk;
  77    char b1[30], b2[30];
  78    time_t wait_time;
  79
  80    wait_time = time(NULL);
  81    status_dev(dev, &stat);
  82    if (!(stat & BMT_EOD)) {
  83       return 0;                       /* this really shouldn't happen */
  84    }
  85
  86    Dmsg0(100, "======= Got EOD ========\n");
  87
  88    block_device(dev, BST_DOING_ACQUIRE);
  89    /* Unlock, but leave BLOCKED */
  90    unlock_device(dev);
  91
  92    /*
  93     * Walk through all attached jcrs creating a jobmedia_record()
  94     */
  95    Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
  96    for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
  97       if (mjcr->JobId == 0) {
  98          continue;                 /* ignore console */
  99       }
 100       Dmsg1(100, "create JobMedia for Job %s\n", mjcr->Job);
 101       if (dev->state & ST_TAPE) {
 102          mjcr->EndBlock = dev->EndBlock;
 103          mjcr->EndFile  = dev->EndFile;
 104          Dmsg2(200, "Fixup EndFile=%u EndBlock=%u\n", mjcr->EndFile, mjcr->EndBlock);
 105       } else {
 106          mjcr->EndBlock = (uint32_t)dev->file_addr;
 107          mjcr->EndFile = (uint32_t)(dev->file_addr >> 32);
 108       }
 109       if (!dir_create_jobmedia_record(mjcr)) {
 110          Jmsg(mjcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=%s Job=%s\n"),
 111             dev->VolCatInfo.VolCatName, mjcr->Job);
 112          P(dev->mutex);
 113          unblock_device(dev);
 114          return 0;
 115       }
 116       mjcr->VolFirstIndex = 0;      /* prevent writing jobmedia second time */
 117    }
 118
 119    strcpy(dev->VolCatInfo.VolCatStatus, "Full");
 120    Dmsg2(200, "Call update_vol_info Stat=%s Vol=%s\n",
 121       dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
 122    if (!dir_update_volume_info(jcr, &dev->VolCatInfo, 0)) {    /* send Volume info to Director */
 123       P(dev->mutex);
 124       unblock_device(dev);
 125       return 0;                    /* device locked */
 126    }
 127    Dmsg0(100, "Back from update_vol_info\n");
 128
 129    bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
 130    bstrncpy(dev->VolHdr.PrevVolName, PrevVolName, sizeof(dev->VolHdr.PrevVolName));
 131
 132    label_blk = new_block(dev);
 133
 134    /* Inform User about end of medium */
 135    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s.\n"),
 136         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 137         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2));
 138
 139    if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
 140       free_block(label_blk);
 141       P(dev->mutex);
 142       unblock_device(dev);
 143       return 0;                    /* device locked */
 144    }
 145    P(dev->mutex);                  /* lock again */
 146
 147    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s\n"),
 148       jcr->VolumeName, dev_name(dev));
 149
 150    /*
 151     * If this is a new tape, the label_blk will contain the
 152     *  label, so write it now. If this is a previously
 153     *  used tape, mount_next_write_volume() will return an
 154     *  empty label_blk, and nothing will be written.
 155     */
 156    Dmsg0(190, "write label block to dev\n");
 157    if (!write_block_to_dev(jcr, dev, label_blk)) {
 158       Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
 159         strerror_dev(dev));
 160       free_block(label_blk);
 161       unblock_device(dev);
 162       return 0;                    /* device locked */
 163    }
 164    free_block(label_blk);
 165
 166
 167    /* Update start block/file for overflow block */
 168    jcr->NumVolumes++;
 169    for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 170       /* Set new start/end positions */
 171       if (dev->state & ST_TAPE) {
 172          mjcr->StartBlock = dev->block_num;
 173          mjcr->StartFile = dev->file;
 174       } else {
 175          mjcr->StartBlock = (uint32_t)dev->file_addr;
 176          mjcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 177       }
 178       /* Set first FirstIndex for new Volume */
 179       mjcr->VolFirstIndex = mjcr->JobFiles;
 180       mjcr->run_time += time(NULL) - wait_time; /* correct run time */
 181    }
 182
 183    /* Write overflow block to tape */
 184    Dmsg0(190, "Write overflow block to dev\n");
 185    if (!write_block_to_dev(jcr, dev, block)) {
 186       Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
 187         strerror_dev(dev));
 188       unblock_device(dev);
 189       return 0;                    /* device locked */
 190    }
 191
 192    unblock_device(dev);
 193    return 1;                                /* device locked */
 194 }
 195
 196
 197 /*
 198  *   Open the device. Expect dev to already be initialized.
 199  *
 200  *   This routine is used only when the Storage daemon starts
 201  *   and always_open is set, and in the stand-alone utility
 202  *   routines such as bextract.
 203  *
 204  *   Note, opening of a normal file is deferred to later so
 205  *    that we can get the filename; the device_name for
 206  *    a file is the directory only.
 207  *
 208  *   Retuns: 0 on failure
 209  *           1 on success
 210  */
 211 int open_device(DEVICE *dev)
 212 {
 213    Dmsg0(120, "start open_output_device()\n");
 214    if (!dev) {
 215       return 0;
 216    }
 217
 218    lock_device(dev);
 219
 220    /* Defer opening files */
 221    if (!dev_is_tape(dev)) {
 222       Dmsg0(129, "Device is file, deferring open.\n");
 223       unlock_device(dev);
 224       return 1;
 225    }
 226
 227    if (!(dev->state & ST_OPENED)) {
 228       Dmsg0(129, "Opening device.\n");
 229       if (open_dev(dev, NULL, READ_WRITE) < 0) {
 230          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 231          unlock_device(dev);
 232          return 0;
 233       }
 234    }
 235    Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
 236
 237    unlock_device(dev);
 238    return 1;
 239 }
 240
 241 /*
 242  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
 243  * must wait. The no_wait_id thread is out obtaining a new volume
 244  * and preparing the label.
 245  */
 246 void _lock_device(char *file, int line, DEVICE *dev)
 247 {
 248    int stat;
 249    Dmsg3(100, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
 250    P(dev->mutex);
 251    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
 252       dev->num_waiting++;             /* indicate that I am waiting */
 253       while (dev->dev_blocked) {
 254          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
 255             V(dev->mutex);
 256             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
 257                strerror(stat));
 258          }
 259       }
 260       dev->num_waiting--;             /* no longer waiting */
 261    }
 262 }
 263
 264 void _unlock_device(char *file, int line, DEVICE *dev)
 265 {
 266    Dmsg2(100, "unlock from %s:%d\n", file, line);
 267    V(dev->mutex);
 268 }
 269
 270 /*
 271  * Block all other threads from using the device
 272  *  Device must already be locked.  After this call,
 273  *  the device is blocked to any thread calling lock_device(),
 274  *  but the device is not locked (i.e. no P on device).  Also,
 275  *  the current thread can do slip through the lock_device()
 276  *  calls without blocking.
 277  */
 278 void _block_device(char *file, int line, DEVICE *dev, int state)
 279 {
 280    Dmsg3(100, "block set %d from %s:%d\n", state, file, line);
 281    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
 282    dev->dev_blocked = state;          /* make other threads wait */
 283    dev->no_wait_id = pthread_self();  /* allow us to continue */
 284 }
 285
 286
 287
 288 /*
 289  * Unblock the device, and wake up anyone who went to sleep.
 290  */
 291 void _unblock_device(char *file, int line, DEVICE *dev)
 292 {
 293    Dmsg3(100, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
 294    ASSERT(dev->dev_blocked);
 295    dev->dev_blocked = BST_NOT_BLOCKED;
 296    dev->no_wait_id = 0;
 297    if (dev->num_waiting > 0) {
 298       pthread_cond_broadcast(&dev->wait); /* wake them up */
 299    }
 300 }
 301
 302 /*
 303  * Enter with device locked and blocked
 304  * Exit with device unlocked and blocked by us.
 305  */
 306 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
 307 {
 308    Dmsg4(100, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
 309       file, line);
 310    hold->dev_blocked = dev->dev_blocked;
 311    hold->no_wait_id = dev->no_wait_id;
 312    dev->dev_blocked = state;
 313    dev->no_wait_id = pthread_self();
 314    V(dev->mutex);
 315 }
 316
 317 /*
 318  * Enter with device blocked by us but not locked
 319  * Exit with device locked, and blocked by previous owner
 320  */
 321 void _give_back_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
 322 {
 323    Dmsg4(100, "return lock. old=%d new=%d from %s:%d\n",
 324       dev->dev_blocked, hold->dev_blocked, file, line);
 325    P(dev->mutex);
 326    dev->dev_blocked = hold->dev_blocked;
 327    dev->no_wait_id = hold->no_wait_id;
 328 }