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(100, "======= Got EOD ========\n");
  84
  85       block_device(dev, BST_DOING_ACQUIRE);
  86       /* Unlock, but leave BLOCKED */
  87       unlock_device(dev);
  88
  89       /*
  90        * Walk through all attached jcrs creating a jobmedia_record()
  91        */
  92       Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
  93       for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
  94          Dmsg1(100, "create JobMedia for Job %s\n", mjcr->Job);
  95          mjcr->end_block = dev->block_num;
  96          mjcr->end_file = dev->file;
  97          if (!dir_create_jobmedia_record(mjcr)) {
  98             Jmsg(mjcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=%s Job=%s\n"),
  99                dev->VolCatInfo.VolCatName, mjcr->Job);
 100             P(dev->mutex);
 101             unblock_device(dev);
 102             return 0;
 103          }
 104       }
 105
 106       strcpy(dev->VolCatInfo.VolCatStatus, "Full");
 107       Dmsg2(100, "Call update_vol_info Stat=%s Vol=%s\n",
 108          dev->VolCatInfo.VolCatStatus, dev->VolCatInfo.VolCatName);
 109       if (!dir_update_volume_info(jcr, &dev->VolCatInfo, 0)) {    /* send Volume info to Director */
 110          Jmsg(jcr, M_ERROR, 0, _("Could not update Volume info Volume=%s Job=%s\n"),
 111             dev->VolCatInfo.VolCatName, jcr->Job);
 112          P(dev->mutex);
 113          unblock_device(dev);
 114          return 0;                    /* device locked */
 115       }
 116       Dmsg0(190, "Back from update_vol_info\n");
 117
 118       strcpy(PrevVolName, dev->VolCatInfo.VolCatName);
 119       strcpy(dev->VolHdr.PrevVolName, PrevVolName);
 120
 121       label_blk = new_block(dev);
 122
 123       /* Inform User about end of media */
 124       Jmsg(jcr, M_INFO, 0, _("End of media on Volume %s Bytes=%s Blocks=%s.\n"),
 125            PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 126            edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2));
 127
 128       if (!mount_next_write_volume(jcr, dev, label_blk, 1)) {
 129          P(dev->mutex);
 130          unblock_device(dev);
 131          return 0;                    /* device locked */
 132       }
 133       P(dev->mutex);                  /* lock again */
 134
 135       Jmsg(jcr, M_INFO, 0, _("New volume %s mounted on device %s\n"),
 136          jcr->VolumeName, dev_name(dev));
 137
 138       /*
 139        * If this is a new tape, the label_blk will contain the
 140        *  label, so write it now. If this is a previously
 141        *  used tape, mount_next_write_volume() will return an
 142        *  empty label_blk, and nothing will be written.
 143        */
 144       Dmsg0(190, "write label block to dev\n");
 145       if (!write_block_to_dev(dev, label_blk)) {
 146          Pmsg1(0, "write_block_to_device Volume label failed. ERR=%s",
 147            strerror_dev(dev));
 148          free_block(label_blk);
 149          unblock_device(dev);
 150          return 0;                    /* device locked */
 151       }
 152
 153       /* Write overflow block to tape */
 154       Dmsg0(190, "Write overflow block to dev\n");
 155       if (!write_block_to_dev(dev, block)) {
 156          Pmsg1(0, "write_block_to_device overflow block failed. ERR=%s",
 157            strerror_dev(dev));
 158          free_block(label_blk);
 159          unblock_device(dev);
 160          return 0;                    /* device locked */
 161       }
 162
 163       jcr->NumVolumes++;
 164       Dmsg0(190, "Wake up any waiting threads.\n");
 165       free_block(label_blk);
 166       for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 167          /* Set new start/end positions */
 168          mjcr->start_block = dev->block_num;
 169          mjcr->start_file = dev->file;
 170          mjcr->VolFirstFile = mjcr->JobFiles;
 171          mjcr->run_time += time(NULL) - wait_time; /* correct run time */
 172       }
 173       unblock_device(dev);
 174       return 1;                                /* device locked */
 175    }
 176    if (label_blk) {
 177       free_block(label_blk);
 178    }
 179    return 0;                          /* device locked */
 180 }
 181
 182
 183 /*
 184  *   Open the device. Expect dev to already be initialized.
 185  *
 186  *   This routine is used only when the Storage daemon starts
 187  *   and always_open is set, and in the stand-alone utility
 188  *   routines such as bextract.
 189  *
 190  *   Note, opening of a normal file is deferred to later so
 191  *    that we can get the filename; the device_name for
 192  *    a file is the directory only.
 193  *
 194  *   Retuns: 0 on failure
 195  *           1 on success
 196  */
 197 int open_device(DEVICE *dev)
 198 {
 199    Dmsg0(120, "start open_output_device()\n");
 200    if (!dev) {
 201       return 0;
 202    }
 203
 204    lock_device(dev);
 205
 206    /* Defer opening files */
 207    if (!dev_is_tape(dev)) {
 208       Dmsg0(129, "Device is file, deferring open.\n");
 209       unlock_device(dev);
 210       return 1;
 211    }
 212
 213    if (!(dev->state & ST_OPENED)) {
 214       Dmsg0(129, "Opening device.\n");
 215       if (open_dev(dev, NULL, READ_WRITE) < 0) {
 216          Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 217          unlock_device(dev);
 218          return 0;
 219       }
 220    }
 221    Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
 222
 223    unlock_device(dev);
 224    return 1;
 225 }
 226
 227 /*
 228  * When dev_blocked is set, all threads EXCEPT thread with id no_wait_id
 229  * must wait. The no_wait_id thread is out obtaining a new volume
 230  * and preparing the label.
 231  */
 232 void _lock_device(char *file, int line, DEVICE *dev)
 233 {
 234    int stat;
 235    Dmsg3(100, "lock %d from %s:%d\n", dev->dev_blocked, file, line);
 236    P(dev->mutex);
 237    if (dev->dev_blocked && !pthread_equal(dev->no_wait_id, pthread_self())) {
 238       dev->num_waiting++;             /* indicate that I am waiting */
 239       while (dev->dev_blocked) {
 240          if ((stat = pthread_cond_wait(&dev->wait, &dev->mutex)) != 0) {
 241             V(dev->mutex);
 242             Emsg1(M_ABORT, 0, _("pthread_cond_wait failure. ERR=%s\n"),
 243                strerror(stat));
 244          }
 245       }
 246       dev->num_waiting--;             /* no longer waiting */
 247    }
 248 }
 249
 250 void _unlock_device(char *file, int line, DEVICE *dev)
 251 {
 252    Dmsg2(100, "unlock from %s:%d\n", file, line);
 253    V(dev->mutex);
 254 }
 255
 256 /*
 257  * Block all other threads from using the device
 258  *  Device must already be locked.  After this call,
 259  *  the device is blocked to any thread calling lock_device(),
 260  *  but the device is not locked (i.e. no P on device).  Also,
 261  *  the current thread can do slip through the lock_device()
 262  *  calls without blocking.
 263  */
 264 void _block_device(char *file, int line, DEVICE *dev, int state)
 265 {
 266    Dmsg3(100, "block set %d from %s:%d\n", state, file, line);
 267    ASSERT(dev->dev_blocked == BST_NOT_BLOCKED);
 268    dev->dev_blocked = state;          /* make other threads wait */
 269    dev->no_wait_id = pthread_self();  /* allow us to continue */
 270 }
 271
 272 /*
 273  * Unblock the device, and wake up anyone who went to sleep.
 274  */
 275 void _unblock_device(char *file, int line, DEVICE *dev)
 276 {
 277    Dmsg3(100, "unblock %d from %s:%d\n", dev->dev_blocked, file, line);
 278    ASSERT(dev->dev_blocked);
 279    dev->dev_blocked = BST_NOT_BLOCKED;
 280    if (dev->num_waiting > 0) {
 281       pthread_cond_broadcast(&dev->wait); /* wake them up */
 282    }
 283 }
 284
 285 void _steal_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold, int state)
 286 {
 287    Dmsg4(100, "steal lock. old=%d new=%d from %s:%d\n", dev->dev_blocked, state,
 288       file, line);
 289    hold->dev_blocked = dev->dev_blocked;
 290    hold->no_wait_id = dev->no_wait_id;
 291    dev->dev_blocked = state;
 292    dev->no_wait_id = pthread_self();
 293    V(dev->mutex);
 294 }
 295
 296 void _return_device_lock(char *file, int line, DEVICE *dev, bsteal_lock_t *hold)
 297 {
 298    Dmsg4(100, "return lock. old=%d new=%d from %s:%d\n",
 299       dev->dev_blocked, hold->dev_blocked, file, line);
 300    P(dev->mutex);
 301    dev->dev_blocked = hold->dev_blocked;
 302    dev->no_wait_id = hold->no_wait_id;
 303 }
 304
 305
 306
 307 /* ==================================================================
 308  *  New device locking code.  It is not currently used.
 309  * ==================================================================
 310  */
 311
 312 /*
 313  * New device locking scheme
 314  */
 315 void _new_lock_device(char *file, int line, DEVICE *dev)
 316 {
 317 #ifdef NEW_LOCK
 318    int errstat;
 319    if ((errstat=rwl_writelock(&dev->lock)) != 0) {
 320       e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
 321            strerror(errstat));
 322    }
 323 #endif
 324 }
 325
 326 void _new_lock_device(char *file, int line, DEVICE *dev, int state)
 327 {
 328 #ifdef NEW_LOCK
 329    int errstat;
 330    if ((errstat=rwl_writelock(&dev->lock)) != 0) {
 331       e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
 332            strerror(errstat));
 333    }
 334    dev->dev_blocked = state;
 335 #endif
 336 }
 337
 338 void _new_unlock_device(char *file, int line, DEVICE *dev)
 339 {
 340 #ifdef NEW_LOCK
 341    int errstat;
 342    if (dev->lock.w_active == 1) {
 343       dev->dev_blocked = BST_NOT_BLOCKED;
 344    }
 345    if ((errstat=rwl_writeunlock(&dev->lock)) != 0) {
 346       e_msg(file, line, M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
 347            strerror(errstat));
 348    }
 349 #endif
 350 }
 351
 352 void new_steal_device_lock(DEVICE *dev, brwsteal_t *hold, int state)
 353 {
 354 #ifdef NEW_LOCK
 355    hold->state = dev->dev_blocked;
 356    hold->writer_id = dev->lock.writer_id;
 357    dev->dev_blocked = state;
 358    dev->lock.writer_id = pthread_self();
 359    V(dev->lock.mutex);
 360 #endif
 361 }
 362
 363 void new_return_device_lock(DEVICE *dev, brwsteal_t *hold)
 364 {
 365 #ifdef NEW_LOCK
 366    P(dev->lock.mutex);
 367    dev->dev_blocked = hold->state;
 368    dev->lock.writer_id = hold->writer_id;
 369 #endif
 370 }