git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/device.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *
  30  *  Higher Level Device routines.
  31  *  Knows about Bacula tape labels and such
  32  *
  33  *  NOTE! In general, subroutines that have the word
  34  *        "device" in the name do locking.  Subroutines
  35  *        that have the word "dev" in the name do not
  36  *        do locking.  Thus if xxx_device() calls
  37  *        yyy_dev(), all is OK, but if xxx_device()
  38  *        calls yyy_device(), everything will hang.
  39  *        Obviously, no zzz_dev() is allowed to call
  40  *        a www_device() or everything falls apart.
  41  *
  42  * Concerning the routines dev->r_lock()() and block_device()
  43  *  see the end of this module for details.  In general,
  44  *  blocking a device leaves it in a state where all threads
  45  *  other than the current thread block when they attempt to
  46  *  lock the device. They remain suspended (blocked) until the device
  47  *  is unblocked. So, a device is blocked during an operation
  48  *  that takes a long time (initialization, mounting a new
  49  *  volume, ...) locking a device is done for an operation
  50  *  that takes a short time such as writing data to the
  51  *  device.
  52  *
  53  *
  54  *   Kern Sibbald, MM, MMI
  55  *
  56  *   Version $Id$
  57  */
  58
  59 #include "bacula.h"                   /* pull in global headers */
  60 #include "stored.h"                   /* pull in Storage Deamon headers */
  61
  62 /* Forward referenced functions */
  63
  64 /*
  65  * This is the dreaded moment. We either have an end of
  66  * medium condition or worse, and error condition.
  67  * Attempt to "recover" by obtaining a new Volume.
  68  *
  69  * Here are a few things to know:
  70  *  dcr->VolCatInfo contains the info on the "current" tape for this job.
  71  *  dev->VolCatInfo contains the info on the tape in the drive.
  72  *    The tape in the drive could have changed several times since
  73  *    the last time the job used it (jcr->VolCatInfo).
  74  *  dcr->VolumeName is the name of the current/desired tape in the drive.
  75  *
  76  * We enter with device locked, and
  77  *     exit with device locked.
  78  *
  79  * Note, we are called only from one place in block.c for the daemons.
  80  *     The btape utility calls it from btape.c.
  81  *
  82  *  Returns: true  on success
  83  *           false on failure
  84  */
  85 bool fixup_device_block_write_error(DCR *dcr)
  86 {
  87    char PrevVolName[MAX_NAME_LENGTH];
  88    DEV_BLOCK *label_blk;
  89    DEV_BLOCK *block = dcr->block;
  90    char b1[30], b2[30];
  91    time_t wait_time;
  92    char dt[MAX_TIME_LENGTH];
  93    JCR *jcr = dcr->jcr;
  94    DEVICE *dev = dcr->dev;
  95    int blocked = dev->blocked();         /* save any previous blocked status */
  96    bool ok = false;
  97
  98    wait_time = time(NULL);
  99
 100    Dmsg0(100, "Enter fixup_device_block_write_error\n");
 101
 102    /*
 103     * If we are blocked at entry, unblock it, and set our own block status
 104     */
 105    if (blocked != BST_NOT_BLOCKED) {
 106       unblock_device(dev);
 107    }
 108    block_device(dev, BST_DOING_ACQUIRE);
 109
 110    /* Continue unlocked, but leave BLOCKED */
 111    dev->dunlock();
 112
 113    bstrncpy(PrevVolName, dev->VolCatInfo.VolCatName, sizeof(PrevVolName));
 114    bstrncpy(dev->VolHdr.PrevVolumeName, PrevVolName, sizeof(dev->VolHdr.PrevVolumeName));
 115
 116    label_blk = new_block(dev);
 117    dcr->block = label_blk;
 118
 119    /* Inform User about end of medium */
 120    Jmsg(jcr, M_INFO, 0, _("End of medium on Volume \"%s\" Bytes=%s Blocks=%s at %s.\n"),
 121         PrevVolName, edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
 122         edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
 123         bstrftime(dt, sizeof(dt), time(NULL)));
 124
 125    Dmsg0(050, "set_unload\n");
 126    dev->set_unload();
 127    if (!dcr->mount_next_write_volume()) {
 128       free_block(label_blk);
 129       dcr->block = block;
 130       dev->dlock();
 131       goto bail_out;
 132    }
 133    Dmsg1(050, "must_unload=%d\n", dev->must_unload());
 134    dev->dlock();                    /* lock again */
 135
 136    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs on vol */
 137    dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 138
 139    Jmsg(jcr, M_INFO, 0, _("New volume \"%s\" mounted on device %s at %s.\n"),
 140       dcr->VolumeName, dev->print_name(), bstrftime(dt, sizeof(dt), time(NULL)));
 141
 142    /*
 143     * If this is a new tape, the label_blk will contain the
 144     *  label, so write it now. If this is a previously
 145     *  used tape, mount_next_write_volume() will return an
 146     *  empty label_blk, and nothing will be written.
 147     */
 148    Dmsg0(190, "write label block to dev\n");
 149    if (!write_block_to_dev(dcr)) {
 150       berrno be;
 151       Pmsg1(0, _("write_block_to_device Volume label failed. ERR=%s"),
 152         be.bstrerror(dev->dev_errno));
 153       free_block(label_blk);
 154       dcr->block = block;
 155       goto bail_out;
 156    }
 157    free_block(label_blk);
 158    dcr->block = block;
 159
 160    /*
 161     * Walk through all attached jcrs indicating the volume has changed
 162     */
 163    Dmsg1(100, "Notify vol change. Volume=%s\n", dev->VolCatInfo.VolCatName);
 164    DCR *mdcr;
 165    foreach_dlist(mdcr, dev->attached_dcrs) {
 166       JCR *mjcr = mdcr->jcr;
 167       if (mjcr->JobId == 0) {
 168          continue;                 /* ignore console */
 169       }
 170       mdcr->NewVol = true;
 171       if (jcr != mjcr) {
 172          bstrncpy(mdcr->VolumeName, dcr->VolumeName, sizeof(mdcr->VolumeName));
 173       }
 174    }
 175
 176    /* Clear NewVol now because dir_get_volume_info() already done */
 177    jcr->dcr->NewVol = false;
 178    set_new_volume_parameters(dcr);
 179
 180    jcr->run_time += time(NULL) - wait_time; /* correct run time for mount wait */
 181
 182    /* Write overflow block to device */
 183    Dmsg0(190, "Write overflow block to dev\n");
 184    if (!write_block_to_dev(dcr)) {
 185       berrno be;
 186       Pmsg1(0, _("write_block_to_device overflow block failed. ERR=%s"),
 187         be.bstrerror(dev->dev_errno));
 188       goto bail_out;
 189    }
 190    ok = true;
 191
 192 bail_out:
 193    /*
 194     * At this point, the device is locked and blocked.
 195     * Unblock the device, restore any entry blocked condition, then
 196     *   return leaving the device locked (as it was on entry).
 197     */
 198    unblock_device(dev);
 199    if (blocked != BST_NOT_BLOCKED) {
 200       block_device(dev, blocked);
 201    }
 202    return ok;                               /* device locked */
 203 }
 204
 205 void set_start_vol_position(DCR *dcr)
 206 {
 207    DEVICE *dev = dcr->dev;
 208    /* Set new start position */
 209    if (dev->is_tape()) {
 210       dcr->StartBlock = dev->block_num;
 211       dcr->StartFile = dev->file;
 212    } else {
 213       dcr->StartBlock = (uint32_t)dev->file_addr;
 214       dcr->StartFile  = (uint32_t)(dev->file_addr >> 32);
 215    }
 216 }
 217
 218 /*
 219  * We have a new Volume mounted, so reset the Volume parameters
 220  *  concerning this job.  The global changes were made earlier
 221  *  in the dev structure.
 222  */
 223 void set_new_volume_parameters(DCR *dcr)
 224 {
 225    JCR *jcr = dcr->jcr;
 226    if (dcr->NewVol && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
 227       Jmsg1(jcr, M_ERROR, 0, "%s", jcr->errmsg);
 228    }
 229    set_new_file_parameters(dcr);
 230    jcr->NumWriteVolumes++;
 231    dcr->NewVol = false;
 232 }
 233
 234 /*
 235  * We are now in a new Volume file, so reset the Volume parameters
 236  *  concerning this job.  The global changes were made earlier
 237  *  in the dev structure.
 238  */
 239 void set_new_file_parameters(DCR *dcr)
 240 {
 241    set_start_vol_position(dcr);
 242
 243    /* Reset indicies */
 244    dcr->VolFirstIndex = 0;
 245    dcr->VolLastIndex = 0;
 246    dcr->NewFile = false;
 247    dcr->WroteVol = false;
 248 }
 249
 250
 251
 252 /*
 253  *   First Open of the device. Expect dev to already be initialized.
 254  *
 255  *   This routine is used only when the Storage daemon starts
 256  *   and always_open is set, and in the stand-alone utility
 257  *   routines such as bextract.
 258  *
 259  *   Note, opening of a normal file is deferred to later so
 260  *    that we can get the filename; the device_name for
 261  *    a file is the directory only.
 262  *
 263  *   Returns: false on failure
 264  *            true  on success
 265  */
 266 bool first_open_device(DCR *dcr)
 267 {
 268    DEVICE *dev = dcr->dev;
 269    bool ok = true;
 270
 271    Dmsg0(120, "start open_output_device()\n");
 272    if (!dev) {
 273       return false;
 274    }
 275
 276    dev->r_dlock();
 277
 278    /* Defer opening files */
 279    if (!dev->is_tape()) {
 280       Dmsg0(129, "Device is file, deferring open.\n");
 281       goto bail_out;
 282    }
 283
 284     int mode;
 285     if (dev->has_cap(CAP_STREAM)) {
 286        mode = OPEN_WRITE_ONLY;
 287     } else {
 288        mode = OPEN_READ_ONLY;
 289     }
 290    Dmsg0(129, "Opening device.\n");
 291    if (dev->open(dcr, mode) < 0) {
 292       Emsg1(M_FATAL, 0, _("dev open failed: %s\n"), dev->errmsg);
 293       ok = false;
 294       goto bail_out;
 295    }
 296    Dmsg1(129, "open dev %s OK\n", dev->print_name());
 297
 298 bail_out:
 299    dev->dunlock();
 300    return ok;
 301 }
 302
 303 /*
 304  * Make sure device is open, if not do so
 305  */
 306 bool open_device(DCR *dcr)
 307 {
 308    DEVICE *dev = dcr->dev;
 309    /* Open device */
 310    int mode;
 311    if (dev->has_cap(CAP_STREAM)) {
 312       mode = OPEN_WRITE_ONLY;
 313    } else {
 314       mode = OPEN_READ_WRITE;
 315    }
 316    if (dev->open(dcr, mode) < 0) {
 317       /* If polling, ignore the error */
 318       /* If DVD, also ignore the error, very often you cannot open the device
 319        * (when there is no DVD, or when the one inserted is a wrong one) */
 320       if (!dev->poll && !dev->is_dvd() && !dev->is_removable()) {
 321          Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device %s: ERR=%s\n"),
 322             dev->print_name(), dev->bstrerror());
 323          Pmsg2(000, _("Unable to open archive %s: ERR=%s\n"),
 324             dev->print_name(), dev->bstrerror());
 325       }
 326       return false;
 327    }
 328    return true;
 329 }