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: 0 if failed for any reason
  84  *           1 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    pm_strcpy(&jcr->VolumeName, vol->VolumeName);
 133    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
 134
 135    for (i=0; i<5; i++) {
 136       if (job_canceled(jcr)) {
 137          Mmsg1(dev->errmsg, _("Job %d canceled.\n"), jcr->JobId);
 138          goto get_out;                /* error return */
 139       }
 140       /*
 141        * This code ensures that the device is ready for
 142        * reading. If it is a file, it opens it.
 143        * If it is a tape, it checks the volume name
 144        */
 145       for ( ; !(dev->state & ST_OPENED); ) {
 146          Dmsg1(120, "bstored: open vol=%s\n", jcr->VolumeName);
 147          if (open_dev(dev, dcr->VolumeName, OPEN_READ_ONLY) < 0) {
 148             Jmsg(jcr, M_FATAL, 0, _("Open device %s volume %s failed, ERR=%s\n"),
 149                 dev_name(dev), dcr->VolumeName, strerror_dev(dev));
 150             goto get_out;
 151          }
 152          Dmsg1(129, "open_dev %s OK\n", dev_name(dev));
 153       }
 154       /****FIXME***** do not reread label if ioctl() says we are
 155        *  correctly possitioned.  Possibly have way user can turn
 156        *  this optimization (to be implemented) off.
 157        */
 158       dcr->dev->state &= ~ST_LABEL;           /* force reread of label */
 159       Dmsg0(200, "calling read-vol-label\n");
 160       switch (read_dev_volume_label(dcr, dcr->block)) {
 161       case VOL_OK:
 162          vol_ok = true;
 163          break;                    /* got it */
 164       case VOL_IO_ERROR:
 165          /*
 166           * Send error message generated by read_dev_volume_label()
 167           *  only we really had a tape mounted. This supresses superfluous
 168           *  error messages when nothing is mounted.
 169           */
 170          if (tape_previously_mounted) {
 171             Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 172          }
 173          goto default_path;
 174       case VOL_NAME_ERROR:
 175          if (tape_initially_mounted) {
 176             tape_initially_mounted = false;
 177             goto default_path;
 178          }
 179          /* Fall through */
 180       default:
 181          Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 182 default_path:
 183          tape_previously_mounted = true;
 184          Dmsg0(200, "dir_get_volume_info\n");
 185          if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
 186             Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 187          }
 188          /* Call autochanger only once unless ask_sysop called */
 189          if (try_autochanger) {
 190             int stat;
 191             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
 192                jcr->VolumeName, jcr->VolCatInfo.Slot);
 193             stat = autoload_device(dcr, 0, NULL);
 194             if (stat > 0) {
 195                try_autochanger = false;
 196                continue;
 197             }
 198          }
 199          /* Mount a specific volume and no other */
 200          Dmsg0(200, "calling dir_ask_sysop\n");
 201          if (!dir_ask_sysop_to_mount_volume(dcr)) {
 202             goto get_out;             /* error return */
 203          }
 204          try_autochanger = true;      /* permit using autochanger again */
 205          continue;                    /* try reading again */
 206       } /* end switch */
 207       break;
 208    } /* end for loop */
 209    if (!vol_ok) {
 210       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device \"%s\".\n"),
 211             dev_name(dev));
 212       goto get_out;
 213    }
 214
 215    dev->state &= ~ST_APPEND;          /* clear any previous append mode */
 216    dev->state |= ST_READ;             /* set read mode */
 217 // attach_jcr_to_device(dev, jcr);    /* attach jcr to device */
 218    set_jcr_job_status(jcr, JS_Running);
 219    dir_send_job_status(jcr);
 220    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
 221       jcr->VolumeName, dev_name(dev));
 222
 223 get_out:
 224    P(dev->mutex);
 225    unblock_device(dev);
 226    V(dev->mutex);
 227    if (!vol_ok) {
 228       free_dcr(dcr);
 229       dcr = NULL;
 230    }
 231    return dcr;
 232 }
 233
 234 /*
 235  * Acquire device for writing. We permit multiple writers.
 236  *  If this is the first one, we read the label.
 237  *
 238  *  Returns: NULL if failed for any reason
 239  *           dev if successful (may change if new dev opened)
 240  *  This routine must be single threaded because we may create
 241  *   multiple devices (for files), thus we have our own mutex
 242  *   on top of the device mutex.
 243  */
 244 DCR *acquire_device_for_append(JCR *jcr)
 245 {
 246    bool release = false;
 247    bool recycle = false;
 248    bool do_mount = false;
 249    DCR *dcr;
 250    DEVICE *dev = jcr->device->dev;
 251
 252    dcr = new_dcr(jcr, dev);
 253    if (device_is_unmounted(dev)) {
 254       Jmsg(jcr, M_WARNING, 0, _("device %s is BLOCKED due to user unmount.\n"),
 255          dev_name(dev));
 256    }
 257    lock_device(dev);
 258    block_device(dev, BST_DOING_ACQUIRE);
 259    unlock_device(dev);
 260    P(mutex);                         /* lock all devices */
 261    Dmsg1(190, "acquire_append device is %s\n", dev_is_tape(dev)?"tape":"disk");
 262
 263
 264    if (dev_state(dev, ST_APPEND)) {
 265       /*
 266        * Device already in append mode
 267        *
 268        * Check if we have the right Volume mounted
 269        *   OK if current volume info OK
 270        *   OK if next volume matches current volume
 271        *   otherwise mount desired volume obtained from
 272        *    dir_find_next_appendable_volume
 273        */
 274       pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
 275       bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
 276       if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE) &&
 277           !(dir_find_next_appendable_volume(dcr) &&
 278             strcmp(dev->VolHdr.VolName, jcr->VolumeName) == 0)) { /* wrong tape mounted */
 279          if (dev->num_writers != 0) {
 280             DEVICE *d = ((DEVRES *)dev->device)->dev;
 281             uint32_t open_vols = 0;
 282             for ( ; d; d=d->next) {
 283                open_vols++;
 284             }
 285             if (dev_state(dev, ST_FILE) && dev->max_open_vols > open_vols) {
 286                d = init_dev(NULL, (DEVRES *)dev->device); /* init new device */
 287                d->prev = dev;                   /* chain in new device */
 288                d->next = dev->next;
 289                dev->next = d;
 290                /* Release old device */
 291                P(dev->mutex);
 292                unblock_device(dev);
 293                V(dev->mutex);
 294                free_dcr(dcr);         /* release dcr pointing to old dev */
 295                /* Make new device current device and lock it */
 296                dev = d;
 297                dcr = new_dcr(jcr, dev); /* get new dcr for new device */
 298                lock_device(dev);
 299                block_device(dev, BST_DOING_ACQUIRE);
 300                unlock_device(dev);
 301             } else {
 302                Jmsg(jcr, M_FATAL, 0, _("Device %s is busy writing on another Volume.\n"), dev_name(dev));
 303                goto get_out;
 304             }
 305          }
 306          /* Wrong tape mounted, release it, then fall through to get correct one */
 307          release = true;
 308          do_mount = true;
 309       } else {
 310          /*
 311           * At this point, the correct tape is already mounted, so
 312           *   we do not need to do mount_next_write_volume(), unless
 313           *   we need to recycle the tape.
 314           */
 315           recycle = strcmp(jcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
 316           if (recycle && dev->num_writers != 0) {
 317              Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
 318                   " because it is in use by another job.\n"));
 319              goto get_out;
 320           }
 321        }
 322    } else {
 323       /* Not already in append mode, so mount the device */
 324       if (dev_state(dev, ST_READ)) {
 325          Jmsg(jcr, M_FATAL, 0, _("Device %s is busy reading.\n"), dev_name(dev));
 326          goto get_out;
 327       }
 328       ASSERT(dev->num_writers == 0);
 329       do_mount = true;
 330    }
 331
 332    if (do_mount || recycle) {
 333       if (!mount_next_write_volume(dcr, dcr->block, release)) {
 334          if (!job_canceled(jcr)) {
 335             /* Reduce "noise" -- don't print if job canceled */
 336             Jmsg(jcr, M_FATAL, 0, _("Could not ready device \"%s\" for append.\n"),
 337                dev_name(dev));
 338          }
 339          goto get_out;
 340       }
 341    }
 342
 343    dev->num_writers++;
 344    if (jcr->NumVolumes == 0) {
 345       jcr->NumVolumes = 1;
 346    }
 347 // attach_jcr_to_device(dev, jcr);    /* attach jcr to device */
 348    set_jcr_job_status(jcr, JS_Running);
 349    dir_send_job_status(jcr);
 350    goto ok_out;
 351
 352 /*
 353  * If we jump here, it is an error return because
 354  *  rtn_dev will still be NULL
 355  */
 356 get_out:
 357    free_dcr(dcr);
 358    dcr = NULL;
 359 ok_out:
 360    P(dev->mutex);
 361    unblock_device(dev);
 362    V(dev->mutex);
 363    V(mutex);                          /* unlock other threads */
 364    return dcr;
 365 }
 366
 367 /*
 368  * This job is done, so release the device. From a Unix standpoint,
 369  *  the device remains open.
 370  *
 371  */
 372 bool release_device(JCR *jcr)
 373 {
 374    DCR *dcr = jcr->dcr;
 375    DEVICE *dev = dcr->dev;
 376    lock_device(dev);
 377    Dmsg1(100, "release_device device is %s\n", dev_is_tape(dev)?"tape":"disk");
 378    if (dev_state(dev, ST_READ)) {
 379       dev->state &= ~ST_READ;         /* clear read bit */
 380       if (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN)) {
 381          offline_or_rewind_dev(dev);
 382          close_dev(dev);
 383       }
 384       /******FIXME**** send read volume usage statistics to director */
 385
 386    } else if (dev->num_writers > 0) {
 387       dev->num_writers--;
 388       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
 389       if (dev_state(dev, ST_LABEL)) {
 390          Dmsg0(100, "dir_create_jobmedia_record. Release\n");
 391          if (!dir_create_jobmedia_record(dcr)) {
 392             Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 393             jcr->VolCatInfo.VolCatName, jcr->Job);
 394          }
 395          /* If no more writers, write an EOF */
 396          if (!dev->num_writers && dev_can_write(dev)) {
 397             weof_dev(dev, 1);
 398          }
 399          dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
 400          dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs */
 401          /* Note! do volume update before close, which zaps VolCatInfo */
 402          Dmsg0(100, "dir_update_vol_info. Release0\n");
 403          dir_update_volume_info(dcr, false); /* send Volume info to Director */
 404       }
 405
 406       if (!dev->num_writers && (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
 407          offline_or_rewind_dev(dev);
 408          close_dev(dev);
 409       }
 410    } else {
 411       Jmsg2(jcr, M_ERROR, 0, _("BAD ERROR: release_device %s, Volume \"%s\" not in use.\n"),
 412             dev_name(dev), NPRT(jcr->VolumeName));
 413       Jmsg2(jcr, M_ERROR, 0, _("num_writers=%d state=%x\n"), dev->num_writers, dev->state);
 414    }
 415
 416    /* Fire off Alert command and include any output */
 417    if (jcr->device->alert_command) {
 418       POOLMEM *alert;
 419       int status = 1;
 420       BPIPE *bpipe;
 421       char line[MAXSTRING];
 422       alert = get_pool_memory(PM_FNAME);
 423       alert = edit_device_codes(jcr, alert, jcr->device->alert_command, "");
 424       bpipe = open_bpipe(alert, 0, "r");
 425       if (bpipe) {
 426          free_pool_memory(alert);
 427          while (fgets(line, sizeof(line), bpipe->rfd)) {
 428             Jmsg(jcr, M_INFO, 0, _("Alert: %s"), line);
 429          }
 430          status = close_bpipe(bpipe);
 431       }
 432       if (status != 0) {
 433          berrno be;
 434          be.set_errno(status);
 435          Jmsg(jcr, M_INFO, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
 436               alert, be.strerror());
 437       }
 438
 439       Dmsg1(400, "alert status=%d\n", status);
 440
 441    }
 442    if (dev->prev && !dev_state(dev, ST_READ) && !dev->num_writers) {
 443       P(mutex);
 444       unlock_device(dev);
 445       dev->prev->next = dev->next;    /* dechain */
 446       term_dev(dev);
 447       V(mutex);
 448    } else {
 449       unlock_device(dev);
 450    }
 451    free_dcr(jcr->dcr);
 452    jcr->dcr = NULL;
 453    return true;
 454 }