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