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