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

   1 /*
   2  *  Routines to acquire and release a device for read/write
   3  *
   4  *   Kern Sibbald, August MMII
   5  *
   6  *   Version $Id$
   7  */
   8 /*
   9    Copyright (C) 2002-2004 Kern Sibbald and John Walker
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License as
  13    published by the Free Software Foundation; either version 2 of
  14    the License, or (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19    General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public
  22    License along with this program; if not, write to the Free
  23    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  24    MA 02111-1307, USA.
  25
  26  */
  27
  28 #include "bacula.h"                   /* pull in global headers */
  29 #include "stored.h"                   /* pull in Storage Deamon headers */
  30
  31 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  32
  33 DCR *new_dcr(JCR *jcr, DEVICE *dev)
  34 {
  35    if (jcr && jcr->dcr) {
  36       return jcr->dcr;
  37    }
  38    DCR *dcr = (DCR *)malloc(sizeof(DCR));
  39    memset(dcr, 0, sizeof(DCR));
  40    if (jcr) {
  41       jcr->dcr = dcr;
  42    }
  43    dcr->jcr = jcr;
  44    dcr->dev = dev;
  45    dcr->block = new_block(dev);
  46    dcr->rec = new_record();
  47    dcr->spool_fd = -1;
  48    dcr->max_spool_size = dev->device->max_spool_size;
  49    /* Attach this dcr only if dev is initialized */
  50    if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
  51       dev->attached_dcrs->append(dcr);
  52    }
  53    return dcr;
  54 }
  55
  56 void free_dcr(DCR *dcr)
  57 {
  58    JCR *jcr = dcr->jcr;
  59    DEVICE *dev = dcr->dev;
  60
  61    /* Detach this dcr only if the dev is initialized */
  62    if (dev->fd != 0 && jcr && jcr->JobType != JT_SYSTEM) {
  63       dcr->dev->attached_dcrs->remove(dcr);
  64    }
  65    if (dcr->block) {
  66       free_block(dcr->block);
  67    }
  68    if (dcr->rec) {
  69       free_record(dcr->rec);
  70    }
  71    if (dcr->jcr) {
  72       dcr->jcr->dcr = NULL;
  73    }
  74    free(dcr);
  75 }
  76
  77
  78 /*********************************************************************
  79  * Acquire device for reading.  We permit (for the moment)
  80  *  only one reader.  We read the Volume label from the block and
  81  *  leave the block pointers just after the label.
  82  *
  83  *  Returns: NULL if failed for any reason
  84  *           dcr  if successful
  85  */
  86 DCR *acquire_device_for_read(JCR *jcr)
  87 {
  88    bool vol_ok = false;
  89    bool tape_previously_mounted;
  90    bool tape_initially_mounted;
  91    VOL_LIST *vol;
  92    bool try_autochanger = true;
  93    int i;
  94    DCR *dcr = jcr->dcr;
  95    DEVICE *dev;
  96
  97    /* Called for each volume */
  98    if (!dcr) {
  99       dcr = new_dcr(jcr, jcr->device->dev);
 100    }
 101    dev = dcr->dev;
 102    if (device_is_unmounted(dev)) {
 103       Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
 104          dev_name(dev));
 105    }
 106    lock_device(dev);
 107    block_device(dev, BST_DOING_ACQUIRE);
 108    unlock_device(dev);
 109
 110    init_dev_wait_timers(dev);
 111    if (dev_state(dev, ST_READ) || dev->num_writers > 0) {
 112       Jmsg2(jcr, M_FATAL, 0, _("Device %s is busy. Job %d canceled.\n"),
 113             dev_name(dev), jcr->JobId);
 114       goto get_out;
 115    }
 116
 117    tape_previously_mounted = dev_state(dev, ST_READ) ||
 118                              dev_state(dev, ST_APPEND) ||
 119                              dev_state(dev, ST_LABEL);
 120    tape_initially_mounted = tape_previously_mounted;
 121
 122    /* Find next Volume, if any */
 123    vol = jcr->VolList;
 124    if (!vol) {
 125       Jmsg(jcr, M_FATAL, 0, _("No volumes specified. Job %d canceled.\n"), jcr->JobId);
 126       goto get_out;
 127    }
 128    jcr->CurVolume++;
 129    for (i=1; i<jcr->CurVolume; i++) {
 130       vol = vol->next;
 131    }
 132    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
 133
 134    for (i=0; i<5; i++) {
 135       if (job_canceled(jcr)) {
 136          Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
 137          goto get_out;                /* error return */
 138       }
 139       /*
 140        * This code ensures that the device is ready for
 141        * reading. If it is a file, it opens it.
 142        * If it is a tape, it checks the volume name
 143        */
 144       for ( ; !(dev->state & ST_OPENED); ) {
 145          Dmsg1(120, "bstored: open vol=%s\n", dcr->VolumeName);
 146          if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
 147             Jmsg(jcr, M_FATAL, 0, _("Open device %s volume %s failed, ERR=%s\n"),
 148                 dev_name(dev), dcr->VolumeName, strerror_dev(dev));
 149             goto get_out;
 150          }
 151          Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
 152       }
 153       /****FIXME***** do not reread label if ioctl() says we are
 154        *  correctly possitioned.  Possibly have way user can turn
 155        *  this optimization (to be implemented) off.
 156        */
 157       dcr->dev->state &= ~ST_LABEL;           /* force reread of label */
 158       Dmsg0(200, "calling read-vol-label\n");
 159       switch (read_dev_volume_label(dcr)) {
 160       case VOL_OK:
 161          vol_ok = true;
 162          break;                    /* got it */
 163       case VOL_IO_ERROR:
 164          /*
 165           * Send error message generated by read_dev_volume_label()
 166           *  only we really had a tape mounted. This supresses superfluous
 167           *  error messages when nothing is mounted.
 168           */
 169          if (tape_previously_mounted) {
 170             Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 171          }
 172          goto default_path;
 173       case VOL_NAME_ERROR:
 174          if (tape_initially_mounted) {
 175             tape_initially_mounted = false;
 176             goto default_path;
 177          }
 178          /* Fall through */
 179       default:
 180          Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 181 default_path:
 182          tape_previously_mounted = true;
 183          Dmsg0(200, "dir_get_volume_info\n");
 184          if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
 185             Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 186          }
 187          /* Call autochanger only once unless ask_sysop called */
 188          if (try_autochanger) {
 189             int stat;
 190             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
 191                dcr->VolumeName, dcr->VolCatInfo.Slot);
 192             stat = autoload_device(dcr, 0, NULL);
 193             if (stat > 0) {
 194                try_autochanger = false;
 195                continue;
 196             }
 197          }
 198          /* Mount a specific volume and no other */
 199          Dmsg0(200, "calling dir_ask_sysop\n");
 200          if (!dir_ask_sysop_to_mount_volume(dcr)) {
 201             goto get_out;             /* error return */
 202          }
 203          try_autochanger = true;      /* permit using autochanger again */
 204          continue;                    /* try reading again */
 205       } /* end switch */
 206       break;
 207    } /* end for loop */
 208    if (!vol_ok) {
 209       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device \"%s\".\n"),
 210             dev_name(dev));
 211       goto get_out;
 212    }
 213
 214    dev->state &= ~ST_APPEND;          /* clear any previous append mode */
 215    dev->state |= ST_READ;             /* set read mode */
 216    set_jcr_job_status(jcr, JS_Running);
 217    dir_send_job_status(jcr);
 218    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
 219       dcr->VolumeName, dev_name(dev));
 220
 221 get_out:
 222    P(dev->mutex);
 223    unblock_device(dev);
 224    V(dev->mutex);
 225    if (!vol_ok) {
 226       free_dcr(dcr);
 227       dcr = NULL;
 228    }
 229    return dcr;
 230 }
 231
 232 /*
 233  * Acquire device for writing. We permit multiple writers.
 234  *  If this is the first one, we read the label.
 235  *
 236  *  Returns: NULL if failed for any reason
 237  *           dev if successful (may change if new dev opened)
 238  *  This routine must be single threaded because we may create
 239  *   multiple devices (for files), thus we have our own mutex
 240  *   on top of the device mutex.
 241  */
 242 DCR *acquire_device_for_append(JCR *jcr)
 243 {
 244    bool release = false;
 245    bool recycle = false;
 246    bool do_mount = false;
 247    DCR *dcr;
 248    DEVICE *dev = jcr->device->dev;
 249
 250    dcr = new_dcr(jcr, dev);
 251    if (device_is_unmounted(dev)) {
 252       Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
 253          dev_name(dev));
 254    }
 255    lock_device(dev);
 256    block_device(dev, BST_DOING_ACQUIRE);
 257    unlock_device(dev);
 258    P(mutex);                         /* lock all devices */
 259    Dmsg1(190, "acquire_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
 260
 261
 262    if (dev_state(dev, ST_APPEND)) {
 263       /*
 264        * Device already in append mode
 265        *
 266        * Check if we have the right Volume mounted
 267        *   OK if current volume info OK
 268        *   OK if next volume matches current volume
 269        *   otherwise mount desired volume obtained from
 270        *    dir_find_next_appendable_volume
 271        */
 272       bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
 273       if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
 274           !(dir_find_next_appendable_volume(dcr) &&
 275             strcmp(dev->VolHdr.VolName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
 276          if (dev->num_writers != 0) {
 277             DEVICE *d = ((DEVRES *)dev->device)->dev;
 278             uint32_t open_vols = 0;
 279             for ( ; d; d=d->next) {
 280                open_vols++;
 281             }
 282             if (dev_state(dev, ST_FILE) && dev->max_open_vols > open_vols) {
 283                d = init_dev(NULL, (DEVRES *)dev->device); /* init new device */
 284                d->prev = dev;                   /* chain in new device */
 285                d->next = dev->next;
 286                dev->next = d;
 287                /* Release old device */
 288                P(dev->mutex);
 289                unblock_device(dev);
 290                V(dev->mutex);
 291                free_dcr(dcr);         /* release dcr pointing to old dev */
 292                /* Make new device current device and lock it */
 293                dev = d;
 294                dcr = new_dcr(jcr, dev); /* get new dcr for new device */
 295                lock_device(dev);
 296                block_device(dev, BST_DOING_ACQUIRE);
 297                unlock_device(dev);
 298             } else {
 299                Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev_name(dev));
 300                goto get_out;
 301             }
 302          }
 303          /* Wrong tape mounted, release it, then fall through to get correct one */
 304          release = true;
 305          do_mount = true;
 306       } else {
 307          /*
 308           * At this point, the correct tape is already mounted, so
 309           *   we do not need to do mount_next_write_volume(), unless
 310           *   we need to recycle the tape.
 311           */
 312           recycle = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
 313           if (recycle && dev->num_writers != 0) {
 314              Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
 315                   " because it is in use by another job.\n"));
 316              goto get_out;
 317           }
 318        }
 319    } else {
 320       /* Not already in append mode, so mount the device */
 321       if (dev_state(dev, ST_READ)) {
 322          Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev_name(dev));
 323          goto get_out;
 324       }
 325       ASSERT(dev->num_writers == 0);
 326       do_mount = true;
 327    }
 328
 329    if (do_mount || recycle) {
 330       if (!mount_next_write_volume(dcr, release)) {
 331          if (!job_canceled(jcr)) {
 332             /* Reduce "noise" -- don't print if job canceled */
 333             Jmsg(jcr, M_FATAL, 0, _("Could not ready device \"%s\" for append.\n"),
 334                dev_name(dev));
 335          }
 336          goto get_out;
 337       }
 338    }
 339
 340    dev->num_writers++;
 341    if (jcr->NumVolumes == 0) {
 342       jcr->NumVolumes = 1;
 343    }
 344    set_jcr_job_status(jcr, JS_Running);
 345    dir_send_job_status(jcr);
 346    goto ok_out;
 347
 348 /*
 349  * If we jump here, it is an error return because
 350  *  rtn_dev will still be NULL
 351  */
 352 get_out:
 353    free_dcr(dcr);
 354    dcr = NULL;
 355 ok_out:
 356    P(dev->mutex);
 357    unblock_device(dev);
 358    V(dev->mutex);
 359    V(mutex);                          /* unlock other threads */
 360    return dcr;
 361 }
 362
 363 /*
 364  * This job is done, so release the device. From a Unix standpoint,
 365  *  the device remains open.
 366  *
 367  */
 368 bool release_device(JCR *jcr)
 369 {
 370    DCR *dcr = jcr->dcr;
 371    DEVICE *dev = dcr->dev;
 372    lock_device(dev);
 373    Dmsg1(100, "release_device device is %s\n", dev_is_tape(dev)?"tape":"disk");
 374    if (dev_state(dev, ST_READ)) {
 375       dev->state &= ~ST_READ;         /* clear read bit */
 376       if (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN)) {
 377          offline_or_rewind_dev(dev);
 378          close_dev(dev);
 379       }
 380       /******FIXME**** send read volume usage statistics to director */
 381
 382    } else if (dev->num_writers > 0) {
 383       dev->num_writers--;
 384       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
 385       if (dev_state(dev, ST_LABEL)) {
 386          Dmsg0(100, "dir_create_jobmedia_record. Release\n");
 387          if (!dir_create_jobmedia_record(dcr)) {
 388             Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 389                dcr->VolCatInfo.VolCatName, jcr->Job);
 390          }
 391          /* If no more writers, write an EOF */
 392          if (!dev->num_writers && dev_can_write(dev)) {
 393             weof_dev(dev, 1);
 394          }
 395          dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
 396          dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
 397          /* Note! do volume update before close, which zaps VolCatInfo */
 398          Dmsg0(100, "dir_update_vol_info. Release0\n");
 399          dir_update_volume_info(dcr, false); /* send Volume info to Director */
 400       }
 401
 402       if (!dev->num_writers && (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
 403          offline_or_rewind_dev(dev);
 404          close_dev(dev);
 405       }
 406    } else {
 407       Jmsg2(jcr, M_FATAL, 0, _("BAD ERROR: release_device %s, Volume \"%s\" not in use.\n"),
 408             dev_name(dev), NPRT(dcr->VolumeName));
 409       Jmsg2(jcr, M_ERROR, 0, _("num_writers=%d state=%x\n"), dev->num_writers, dev->state);
 410    }
 411
 412    /* Fire off Alert command and include any output */
 413    if (jcr->device->alert_command) {
 414       POOLMEM *alert;
 415       int status = 1;
 416       BPIPE *bpipe;
 417       char line[MAXSTRING];
 418       alert = get_pool_memory(PM_FNAME);
 419       alert = edit_device_codes(jcr, alert, jcr->device->alert_command, "");
 420       bpipe = open_bpipe(alert, 0, "r");
 421       if (bpipe) {
 422          while (fgets(line, sizeof(line), bpipe->rfd)) {
 423             Jmsg(jcr, M_INFO, 0, _("Alert: %s"), line);
 424          }
 425          status = close_bpipe(bpipe);
 426       } else {
 427          status = errno;
 428       }
 429       if (status != 0) {
 430          berrno be(status);
 431          Jmsg(jcr, M_INFO, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
 432               alert, be.strerror());
 433       }
 434
 435       Dmsg1(400, "alert status=%d\n", status);
 436       free_pool_memory(alert);
 437    }
 438    if (dev->prev && !dev_state(dev, ST_READ) && !dev->num_writers) {
 439       P(mutex);
 440       unlock_device(dev);
 441       dev->prev->next = dev->next;    /* dechain */
 442       term_dev(dev);
 443       V(mutex);
 444    } else {
 445       unlock_device(dev);
 446    }
 447    free_dcr(jcr->dcr);
 448    jcr->dcr = NULL;
 449    return true;
 450 }