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

   1 /*
   2  *
   3  *  Utility routines for "tool" programs such as bscan, bls,
   4  *    bextract, ...
   5  *
   6  *  Normally nothing in this file is called by the Storage
   7  *    daemon because we interact more directly with the user
   8  *    i.e. printf, ...
   9  *
  10  *   Version $Id$
  11  */
  12 /*
  13    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  14
  15    This program is free software; you can redistribute it and/or
  16    modify it under the terms of the GNU General Public License as
  17    published by the Free Software Foundation; either version 2 of
  18    the License, or (at your option) any later version.
  19
  20    This program is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  23    General Public License for more details.
  24
  25    You should have received a copy of the GNU General Public
  26    License along with this program; if not, write to the Free
  27    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  28    MA 02111-1307, USA.
  29
  30  */
  31
  32 #include "bacula.h"
  33 #include "stored.h"
  34
  35 /* Imported variables -- eliminate some day */
  36 extern char *configfile;
  37
  38 #ifdef DEBUG
  39 char *rec_state_to_str(DEV_RECORD *rec)
  40 {
  41    static char buf[200];
  42    buf[0] = 0;
  43    if (rec->state & REC_NO_HEADER) {
  44       strcat(buf, "Nohdr,");
  45    }
  46    if (is_partial_record(rec)) {
  47       strcat(buf, "partial,");
  48    }
  49    if (rec->state & REC_BLOCK_EMPTY) {
  50       strcat(buf, "empty,");
  51    }
  52    if (rec->state & REC_NO_MATCH) {
  53       strcat(buf, "Nomatch,");
  54    }
  55    if (rec->state & REC_CONTINUATION) {
  56       strcat(buf, "cont,");
  57    }
  58    if (buf[0]) {
  59       buf[strlen(buf)-1] = 0;
  60    }
  61    return buf;
  62 }
  63 #endif
  64
  65
  66 /*
  67  * Setup device, jcr, and prepare to access device.
  68  *   If the caller wants read access, acquire the device, otherwise,
  69  *     the caller will do it.
  70  */
  71 DEVICE *setup_to_access_device(JCR *jcr, int read_access)
  72 {
  73    DEVICE *dev;
  74    DEV_BLOCK *block;
  75    char *p;
  76    DEVRES *device;
  77
  78    /*
  79     * If no volume name already given and no bsr, and it is a file,
  80     * try getting name from Filename
  81     */
  82    if (!jcr->bsr && jcr->VolumeName[0] == 0) {
  83       if (strncmp(jcr->dev_name, "/dev/", 5) != 0) {
  84          /* Try stripping file part */
  85          p = jcr->dev_name + strlen(jcr->dev_name);
  86          while (p >= jcr->dev_name && *p != '/')
  87             p--;
  88          if (*p == '/') {
  89             strcpy(jcr->VolumeName, p+1);
  90             *p = 0;
  91          }
  92       }
  93    }
  94
  95    if ((device=find_device_res(jcr->dev_name, read_access)) == NULL) {
  96       Jmsg2(jcr, M_FATAL, 0, _("Cannot find device %s in config file %s.\n"),
  97            jcr->dev_name, configfile);
  98       return NULL;
  99    }
 100
 101    dev = init_dev(NULL, device);
 102    if (!dev || !open_device(dev)) {
 103       Jmsg1(jcr, M_FATAL, 0, _("Cannot open %s\n"), jcr->dev_name);
 104       return NULL;
 105    }
 106    Dmsg0(90, "Device opened for read.\n");
 107
 108    block = new_block(dev);
 109
 110    create_vol_list(jcr);
 111
 112    if (read_access) {
 113       if (!acquire_device_for_read(jcr, dev, block)) {
 114          free_block(block);
 115          return NULL;
 116       }
 117    }
 118    free_block(block);
 119    return dev;
 120 }
 121
 122
 123 /*
 124  * Search for device resource that corresponds to
 125  * device name on command line (or default).
 126  *
 127  * Returns: NULL on failure
 128  *          Device resource pointer on success
 129  */
 130 DEVRES *find_device_res(char *device_name, int read_access)
 131 {
 132    int found = 0;
 133    DEVRES *device;
 134
 135    LockRes();
 136    for (device=NULL; (device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device)); ) {
 137       if (strcmp(device->device_name, device_name) == 0) {
 138          found = 1;
 139          break;
 140       }
 141    }
 142    UnlockRes();
 143    if (!found) {
 144       Pmsg2(0, _("Could not find device %s in config file %s.\n"), device_name,
 145             configfile);
 146       return NULL;
 147    }
 148    Pmsg2(0, _("Using device: %s for %s.\n"), device_name,
 149              read_access?"reading":"writing");
 150    return device;
 151 }
 152
 153
 154
 155 /*
 156  * Called here when freeing JCR so that we can get rid
 157  *  of "daemon" specific memory allocated.
 158  */
 159 static void my_free_jcr(JCR *jcr)
 160 {
 161    if (jcr->pool_name) {
 162       free_pool_memory(jcr->pool_name);
 163       jcr->pool_name = NULL;
 164    }
 165    if (jcr->pool_type) {
 166       free_pool_memory(jcr->pool_type);
 167       jcr->pool_type = NULL;
 168    }
 169    if (jcr->job_name) {
 170       free_pool_memory(jcr->job_name);
 171       jcr->job_name = NULL;
 172    }
 173    if (jcr->client_name) {
 174       free_pool_memory(jcr->client_name);
 175       jcr->client_name = NULL;
 176    }
 177    if (jcr->fileset_name) {
 178       free_pool_memory(jcr->fileset_name);
 179       jcr->fileset_name = NULL;
 180    }
 181    if (jcr->fileset_md5) {
 182       free_pool_memory(jcr->fileset_md5);
 183       jcr->fileset_md5 = NULL;
 184    }
 185    if (jcr->dev_name) {
 186       free_pool_memory(jcr->dev_name);
 187       jcr->dev_name = NULL;
 188    }
 189    if (jcr->VolList) {
 190       free_vol_list(jcr);
 191    }
 192
 193    return;
 194 }
 195
 196 /*
 197  * Setup a "daemon" JCR for the various standalone
 198  *  tools (e.g. bls, bextract, bscan, ...)
 199  */
 200 JCR *setup_jcr(char *name, char *device, BSR *bsr, char *VolumeName)
 201 {
 202    JCR *jcr = new_jcr(sizeof(JCR), my_free_jcr);
 203    jcr->VolSessionId = 1;
 204    jcr->VolSessionTime = (uint32_t)time(NULL);
 205    jcr->bsr = bsr;
 206    jcr->NumVolumes = 0;
 207    jcr->pool_name = get_pool_memory(PM_FNAME);
 208    strcpy(jcr->pool_name, "Default");
 209    jcr->pool_type = get_pool_memory(PM_FNAME);
 210    strcpy(jcr->pool_type, "Backup");
 211    jcr->job_name = get_pool_memory(PM_FNAME);
 212    strcpy(jcr->job_name, "Dummy.Job.Name");
 213    jcr->client_name = get_pool_memory(PM_FNAME);
 214    strcpy(jcr->client_name, "Dummy.Client.Name");
 215    strcpy(jcr->Job, name);
 216    jcr->fileset_name = get_pool_memory(PM_FNAME);
 217    strcpy(jcr->fileset_name, "Dummy.fileset.name");
 218    jcr->fileset_md5 = get_pool_memory(PM_FNAME);
 219    strcpy(jcr->fileset_md5, "Dummy.fileset.md5");
 220    jcr->JobId = 1;
 221    jcr->JobType = JT_BACKUP;
 222    jcr->JobLevel = L_FULL;
 223    jcr->JobStatus = JS_Terminated;
 224    jcr->dev_name = get_pool_memory(PM_FNAME);
 225    pm_strcpy(&jcr->dev_name, device);
 226    if (!bsr && VolumeName) {
 227       pm_strcpy(&jcr->VolumeName, VolumeName);
 228    }
 229    jcr->where = bstrdup("");
 230    return jcr;
 231 }
 232
 233
 234 /*
 235  * Device got an error, attempt to analyse it
 236  */
 237 void display_tape_error_status(JCR *jcr, DEVICE *dev)
 238 {
 239    uint32_t status;
 240
 241    Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 242    status_dev(dev, &status);
 243    Dmsg1(20, "Device status: %x\n", status);
 244    if (status & BMT_EOD)
 245       Jmsg(jcr, M_ERROR, 0, _("Unexpected End of Data\n"));
 246    else if (status & BMT_EOT)
 247       Jmsg(jcr, M_ERROR, 0, _("Unexpected End of Tape\n"));
 248    else if (status & BMT_EOF)
 249       Jmsg(jcr, M_ERROR, 0, _("Unexpected End of File\n"));
 250    else if (status & BMT_DR_OPEN)
 251       Jmsg(jcr, M_ERROR, 0, _("Tape Door is Open\n"));
 252    else if (!(status & BMT_ONLINE))
 253       Jmsg(jcr, M_ERROR, 0, _("Unexpected Tape is Off-line\n"));
 254    else
 255       Jmsg(jcr, M_ERROR, 0, _("Read error on Record Header %s: %s\n"), dev_name(dev), strerror(errno));
 256 }