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, 2001, 2002 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 = NULL;
  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 & MT_EOD) {
  83       Dmsg0(190, "======= Got EOD ========\n");
  84
  85       block_device(dev, BST_DOING_ACQUIRE);
  86
  87       /*
  88        * Walk through all attached jcrs creating a jobmedia_record()
  89        */
  90       Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
  91       for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
  92          Dmsg1(100, "create JobMedia for Job %s\n", mjcr->Job);
  93          mjcr->end_block = dev->block_num;
  94          mjcr->end_file = dev->file;
  95          if (!dir_create_jobmedia_record(mjcr)) {
  96             Jmsg(mjcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=%s Job=%s\n"),
  97                dev->VolCatInfo.VolCatName, mjcr->Job);
  98             return 0;
  99          }
 100       }
 101
 102       strcpy(dev->VolCatInfo.VolCatStatus, "Full");
 103       Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
 104          dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
 105       if (!dir_update_volume_info(jcr, &dev->VolCatInfo, 0)) {    /* send Volume info to Director */
 106          Jmsg(jcr, M_ERROR, 0, _("Could not update Volume info Volume=%s Job=%s\n"),
 107             dev->VolCatInfo.VolCatName, jcr->Job);
 108          return 0;                    /* device locked */
 109       }
 110       Dmsg0(190, "Back from update_vol_info\n");
 111
 112       strcpy(PrevVolName, dev->VolCatInfo.VolCatName);
 113       strcpy(dev->VolHdr.PrevVolName, PrevVolName);
 114
 115       label_blk = new_block(dev);
 116
 117       /* Inform User about end of media */
 118       Jmsg(jcr, M_INFO, 0, _("End of media on Volume %s Bytes=%s Blocks=%s.\n"),
 119            PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 120            edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2));
 121
 122       /* Unlock, but leave BLOCKED */
 123       unlock_device(dev);
 124       if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
 125          P(dev->mutex);
 126          unblock_device(dev);
 127          return 0;                    /* device locked */
 128       }
 129
 130       P(dev->mutex);                  /* lock again */
 131
 132       Jmsg(jcr, M_INFO, 0, _("New volume %s mounted on device %s\n"),
 133          jcr->VolumeName, dev_name(dev));
 134
 135       /*
 136        * If this is a new tape, the label_blk will contain the
 137        *  label, so write it now. If this is a previously
 138        *  used tape, mount_next_write_volume() will return an
 139        *  empty label_blk, and nothing will be written.
 140        */
 141       Dmsg0(190, "write label block to dev\n");
 142       if (!write_block_to_dev(dev, label_blk)) {
 143          Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
 144            strerror_dev(dev));
 145          free_block(label_blk);
 146          unblock_device(dev);
 147          return 0;                    /* device locked */
 148       }
 149
 150       /* Write overflow block to tape */
 151       Dmsg0(190, "Write overflow block to dev\n");
 152       if (!write_block_to_dev(dev, block)) {
 153          Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
 154            strerror_dev(dev));
 155          free_block(label_blk);
 156          unblock_device(dev);
 157          return 0;                    /* device locked */
 158       }
 159
 160       jcr->NumVolumes++;
 161       Dmsg0(190, "Wake up any waiting threads.\n");
 162       free_block(label_blk);
 163       for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 164          /* Set new start/end positions */
 165          mjcr->start_block = dev->block_num;
 166          mjcr->start_file = dev->file;
 167          mjcr->VolFirstFile = mjcr->JobFiles;
 168          mjcr->run_time += time(NULL) - wait_time; /* correct run time */
 169       }
 170       unblock_device(dev);
 171       return 1;                                /* device locked */
 172    }
 173    if (label_blk) {
 174       free_block(label_blk);
 175    }
 176    return 0;                          /* device locked */
 177 }
 178
 179
 180 /*
 181  *   Open the device. Expect dev to already be initialized.
 182  *
 183  *   This routine is used only when the Storage daemon starts
 184  *   and always_open is set, and in the stand-alone utility
 185  *   routines such as bextract.
 186  *
 187  *   Note, opening of a normal file is deferred to later so
 188  *    that we can get the filename; the device_name for
 189  *    a file is the directory only.
 190  *
 191  *   Retuns: 0 on failure
 192  *           1 on success
 193  */
 194 int open_device(DEVICE *dev)
 195 {
 196    Dmsg0(120, "start open_output_device()\n");
 197    if (!dev) {
 198       return 0;
 199    }
 200
 201    lock_device(dev);
 202
 203    /* Defer opening files */
 204    if (!dev_is_tape(dev)) {
 205       Dmsg0(129, "Device is file, deferring open.\n");
 206       unlock_device(dev);
 207       return 1;
 208    }
 209
 210    if (!(dev->state & ST_OPENED)) {
 211       Dmsg0(129, "Opening device.\n");
 212       if (open_dev(dev, NULL, READ_WRITE) < 0) {
 213          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 214          unlock_device(dev);
 215          return 0;
 216       }
 217    }
 218    Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
 219
 220    unlock_device(dev);
 221    return 1;
 222 }
 223
 224
 225 /*
 226  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
 227  * must wait. The no_wait_id thread is out obtaining a new volume
 228  * and preparing the label.
 229  */
 230 void lock_device(DEVICE *dev)
 231 {
 232    int stat;
 233
 234    Dmsg1(190, "lock %d\n", dev->dev_blocked);
 235    P(dev->mutex);
 236    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
 237       dev->num_waiting++;             /* indicate that I am waiting */
 238       while (dev->dev_blocked) {
 239          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
 240             V(dev->mutex);
 241             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
 242                strerror(stat));
 243          }
 244       }
 245       dev->num_waiting--;             /* no longer waiting */
 246    }
 247 }
 248
 249 void unlock_device(DEVICE *dev)
 250 {
 251    Dmsg0(190, "unlock\n");
 252    V(dev->mutex);
 253 }
 254
 255 /*
 256  * Block all other threads from using the device
 257  *  Device must already be locked.  After this call,
 258  *  the device is blocked to any thread calling lock_device(),
 259  *  but the device is not locked (i.e. no P on device).  Also,
 260  *  the current thread can do slip through the lock_device()
 261  *  calls without blocking.
 262  */
 263 void block_device(DEVICE *dev, int state)
 264 {
 265    Dmsg1(190, "block set %d\n", state);
 266    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
 267    dev->dev_blocked = state;          /* make other threads wait */
 268    dev->no_wait_id = pthread_self();  /* allow us to continue */
 269 }
 270
 271 /*
 272  * Unblock the device, and wake up anyone who went to sleep.
 273  */
 274 void unblock_device(DEVICE *dev)
 275 {
 276    Dmsg1(190, "unblock %d\n", dev->dev_blocked);
 277    ASSERT(dev->dev_blocked);
 278    dev->dev_blocked = BST_NOT_BLOCKED;
 279    if (dev->num_waiting > 0) {
 280       pthread_cond_broadcast(&dev->wait); /* wake them up */
 281    }
 282 }