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