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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2002-2009 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  *  Routines to acquire and release a device for read/write
  30  *
  31  *   Kern Sibbald, August MMII
  32  *
  33  *   Version $Id$
  34  */
  35
  36 #include "bacula.h"                   /* pull in global headers */
  37 #include "stored.h"                   /* pull in Storage Deamon headers */
  38
  39 /* Forward referenced functions */
  40 static void attach_dcr_to_dev(DCR *dcr);
  41 static void set_dcr_from_vol(DCR *dcr, VOL_LIST *vol);
  42
  43
  44 /*********************************************************************
  45  * Acquire device for reading.
  46  *  The drive should have previously been reserved by calling
  47  *  reserve_device_for_read(). We read the Volume label from the block and
  48  *  leave the block pointers just after the label.
  49  *
  50  *  Returns: NULL if failed for any reason
  51  *           dcr  if successful
  52  */
  53 bool acquire_device_for_read(DCR *dcr)
  54 {
  55    DEVICE *dev = dcr->dev;
  56    JCR *jcr = dcr->jcr;
  57    bool ok = false;
  58    bool tape_previously_mounted;
  59    bool tape_initially_mounted;
  60    VOL_LIST *vol;
  61    bool try_autochanger = true;
  62    int i;
  63    int vol_label_status;
  64    int retry = 0;
  65
  66    Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
  67    dev->dblock(BST_DOING_ACQUIRE);
  68
  69    if (dev->num_writers > 0) {
  70       Jmsg2(jcr, M_FATAL, 0, _("Acquire read: num_writers=%d not zero. Job %d canceled.\n"),
  71          dev->num_writers, jcr->JobId);
  72       goto get_out;
  73    }
  74
  75    /* Find next Volume, if any */
  76    vol = jcr->VolList;
  77    if (!vol) {
  78       char ed1[50];
  79       Jmsg(jcr, M_FATAL, 0, _("No volumes specified for reading. Job %s canceled.\n"),
  80          edit_int64(jcr->JobId, ed1));
  81       goto get_out;
  82    }
  83    jcr->CurReadVolume++;
  84    for (i=1; i<jcr->CurReadVolume; i++) {
  85       vol = vol->next;
  86    }
  87    if (!vol) {
  88       Jmsg(jcr, M_FATAL, 0, _("Logic error: no next volume to read. Numvol=%d Curvol=%d\n"),
  89          jcr->NumReadVolumes, jcr->CurReadVolume);
  90       goto get_out;                   /* should not happen */
  91    }
  92    set_dcr_from_vol(dcr, vol);
  93
  94    Dmsg2(100, "Want Vol=%s Slot=%d\n", vol->VolumeName, vol->Slot);
  95
  96    /*
  97     * If the MediaType requested for this volume is not the
  98     *  same as the current drive, we attempt to find the same
  99     *  device that was used to write the orginal volume.  If
 100     *  found, we switch to using that device.
 101     *
 102     *  N.B. A lot of routines rely on the dcr pointer not changing
 103     *    read_records.c even has multiple dcrs cached, so we take care
 104     *    here to release all important parts of the dcr and re-acquire
 105     *    them such as the block pointer (size may change), but we do
 106     *    not release the dcr.
 107     */
 108    Dmsg2(50, "MediaType dcr=%s dev=%s\n", dcr->media_type, dev->device->media_type);
 109    if (dcr->media_type[0] && strcmp(dcr->media_type, dev->device->media_type) != 0) {
 110       RCTX rctx;
 111       DIRSTORE *store;
 112       int stat;
 113
 114       Jmsg3(jcr, M_INFO, 0, _("Changing read device. Want Media Type=\"%s\" have=\"%s\"\n"
 115                               "  device=%s\n"),
 116             dcr->media_type, dev->device->media_type, dev->print_name());
 117       Dmsg3(50, "Changing read device. Want Media Type=\"%s\" have=\"%s\"\n"
 118                               "  device=%s\n",
 119             dcr->media_type, dev->device->media_type, dev->print_name());
 120
 121       dev->dunblock(DEV_UNLOCKED);
 122
 123       lock_reservations();
 124       memset(&rctx, 0, sizeof(RCTX));
 125       rctx.jcr = jcr;
 126       jcr->reserve_msgs = New(alist(10, not_owned_by_alist));
 127       rctx.any_drive = true;
 128       rctx.device_name = vol->device;
 129       store = new DIRSTORE;
 130       memset(store, 0, sizeof(DIRSTORE));
 131       store->name[0] = 0; /* No dir name */
 132       bstrncpy(store->media_type, vol->MediaType, sizeof(store->media_type));
 133       bstrncpy(store->pool_name, dcr->pool_name, sizeof(store->pool_name));
 134       bstrncpy(store->pool_type, dcr->pool_type, sizeof(store->pool_type));
 135       store->append = false;
 136       rctx.store = store;
 137       clean_device(dcr);                     /* clean up the dcr */
 138
 139       /*
 140        * Search for a new device
 141        */
 142       stat = search_res_for_device(rctx);
 143       release_reserve_messages(jcr);         /* release queued messages */
 144       unlock_reservations();
 145
 146       if (stat == 1) {
 147          dev = dcr->dev;                     /* get new device pointer */
 148          dev->dblock(BST_DOING_ACQUIRE);
 149          dcr->VolumeName[0] = 0;
 150          Jmsg(jcr, M_INFO, 0, _("Media Type change.  New read device %s chosen.\n"),
 151             dev->print_name());
 152          Dmsg1(50, "Media Type change.  New read device %s chosen.\n", dev->print_name());
 153
 154          bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
 155          bstrncpy(dcr->VolCatInfo.VolCatName, vol->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
 156          bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
 157          dcr->VolCatInfo.Slot = vol->Slot;
 158          dcr->VolCatInfo.InChanger = vol->Slot > 0;
 159          bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
 160          bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
 161       } else {
 162          /* error */
 163          Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
 164             vol->VolumeName);
 165          Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
 166          goto get_out;
 167       }
 168    }
 169
 170    dev->clear_unload();
 171
 172    if (dev->vol && dev->vol->is_swapping()) {
 173       dev->vol->set_slot(vol->Slot);
 174       Dmsg3(100, "swapping: slot=%d Vol=%s dev=%s\n", dev->vol->get_slot(),
 175          dev->vol->vol_name, dev->print_name());
 176    }
 177
 178    init_device_wait_timers(dcr);
 179
 180    tape_previously_mounted = dev->can_read() || dev->can_append() ||
 181                              dev->is_labeled();
 182    tape_initially_mounted = tape_previously_mounted;
 183
 184
 185    /* Volume info is always needed because of VolParts */
 186    Dmsg1(150, "dir_get_volume_info vol=%s\n", dcr->VolumeName);
 187    if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
 188       Dmsg2(150, "dir_get_vol_info failed for vol=%s: %s\n",
 189          dcr->VolumeName, jcr->errmsg);
 190       Jmsg1(jcr, M_WARNING, 0, "Read acquire: %s", jcr->errmsg);
 191    }
 192    dev->set_load();                /* set to load volume */
 193
 194    for ( ;; ) {
 195       /* If not polling limit retries */
 196       if (!dev->poll && retry++ > 10) {
 197          break;
 198       }
 199       dev->clear_labeled();              /* force reread of label */
 200       if (job_canceled(jcr)) {
 201          char ed1[50];
 202          Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
 203          Jmsg(jcr, M_INFO, 0, dev->errmsg);
 204          goto get_out;                /* error return */
 205       }
 206
 207       dcr->do_unload();
 208       dcr->do_swapping(false/*!is_writing*/);
 209       dcr->do_load(false /*!is_writing*/);
 210       set_dcr_from_vol(dcr, vol);          /* refresh dcr with desired volume info */
 211
 212       /*
 213        * This code ensures that the device is ready for
 214        * reading. If it is a file, it opens it.
 215        * If it is a tape, it checks the volume name
 216        */
 217       Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
 218       if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
 219          if (!dev->poll) {
 220             Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
 221                   dev->print_name(), dcr->VolumeName, dev->bstrerror());
 222          }
 223          goto default_path;
 224       }
 225       Dmsg1(50, "opened dev %s OK\n", dev->print_name());
 226
 227       /* Read Volume Label */
 228       Dmsg0(50, "calling read-vol-label\n");
 229       vol_label_status = read_dev_volume_label(dcr);
 230       switch (vol_label_status) {
 231       case VOL_OK:
 232          Dmsg0(50, "Got correct volume.\n");
 233          ok = true;
 234          dev->VolCatInfo = dcr->VolCatInfo;     /* structure assignment */
 235          break;                    /* got it */
 236       case VOL_IO_ERROR:
 237          Dmsg0(50, "IO Error\n");
 238          /*
 239           * Send error message generated by read_dev_volume_label()
 240           *  only we really had a tape mounted. This supresses superfluous
 241           *  error messages when nothing is mounted.
 242           */
 243          if (tape_previously_mounted) {
 244             Jmsg(jcr, M_WARNING, 0, "Read acquire: %s", jcr->errmsg);
 245          }
 246          goto default_path;
 247       case VOL_NAME_ERROR:
 248          Dmsg0(50, "Vol name error.\n");
 249          if (dev->is_volume_to_unload()) {
 250             goto default_path;
 251          }
 252          dev->set_unload();              /* force unload of unwanted tape */
 253          if (!unload_autochanger(dcr, -1)) {
 254             /* at least free the device so we can re-open with correct volume */
 255             dev->close();
 256          }
 257          dev->set_load();
 258          /* Fall through */
 259       default:
 260          Jmsg1(jcr, M_WARNING, 0, "Read acquire: %s", jcr->errmsg);
 261 default_path:
 262          Dmsg0(50, "default path\n");
 263          tape_previously_mounted = true;
 264
 265          /*
 266           * If the device requires mount, close it, so the device can be ejected.
 267           */
 268          if (dev->requires_mount()) {
 269             dev->close();
 270          }
 271
 272          /* Call autochanger only once unless ask_sysop called */
 273          if (try_autochanger) {
 274             int stat;
 275             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
 276                dcr->VolumeName, dcr->VolCatInfo.Slot);
 277             stat = autoload_device(dcr, 0, NULL);
 278             if (stat > 0) {
 279                try_autochanger = false;
 280                continue;              /* try reading volume mounted */
 281             }
 282          }
 283
 284          /* Mount a specific volume and no other */
 285          Dmsg0(200, "calling dir_ask_sysop\n");
 286          if (!dir_ask_sysop_to_mount_volume(dcr, ST_READ)) {
 287             goto get_out;             /* error return */
 288          }
 289
 290          /* Volume info is always needed because of VolParts */
 291          Dmsg1(150, "dir_get_volume_info vol=%s\n", dcr->VolumeName);
 292          if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
 293             Dmsg2(150, "dir_get_vol_info failed for vol=%s: %s\n",
 294                   dcr->VolumeName, jcr->errmsg);
 295             Jmsg1(jcr, M_WARNING, 0, "Read acquire: %s", jcr->errmsg);
 296          }
 297          dev->set_load();                /* set to load volume */
 298
 299          try_autochanger = true;      /* permit trying the autochanger again */
 300
 301          continue;                    /* try reading again */
 302       } /* end switch */
 303       break;
 304    } /* end for loop */
 305
 306    if (!ok) {
 307       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
 308             dev->print_name());
 309       goto get_out;
 310    }
 311
 312    dev->clear_append();
 313    dev->set_read();
 314    set_jcr_job_status(jcr, JS_Running);
 315    dir_send_job_status(jcr);
 316    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
 317       dcr->VolumeName, dev->print_name());
 318
 319 get_out:
 320    dev->dlock();
 321    dcr->clear_reserved();
 322    /*
 323     * Normally we are blocked, but in at least one error case above
 324     *   we are not blocked because we unsuccessfully tried changing
 325     *   devices.
 326     */
 327    if (dev->is_blocked()) {
 328       dev->dunblock(DEV_LOCKED);
 329    } else {
 330       dev->dunlock();               /* dunblock() unlock the device too */
 331    }
 332    Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
 333    return ok;
 334 }
 335
 336 static pthread_mutex_t acquire_lock = PTHREAD_MUTEX_INITIALIZER;
 337
 338 /*
 339  * Acquire device for writing. We permit multiple writers.
 340  *  If this is the first one, we read the label.
 341  *
 342  *  Returns: NULL if failed for any reason
 343  *           dcr if successful.
 344  *   Note, normally reserve_device_for_append() is called
 345  *   before this routine.
 346  */
 347 DCR *acquire_device_for_append(DCR *dcr)
 348 {
 349    DEVICE *dev = dcr->dev;
 350    JCR *jcr = dcr->jcr;
 351    bool ok = false;
 352    bool have_vol = false;
 353
 354    init_device_wait_timers(dcr);
 355
 356    P(acquire_lock);                   /* only one job at a time */
 357    dev->dlock();
 358    Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
 359         (dev->is_dvd()?"DVD":"disk"));
 360
 361    /*
 362     * With the reservation system, this should not happen
 363     */
 364    if (dev->can_read()) {
 365       Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
 366       Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
 367       goto get_out;
 368    }
 369
 370    dev->clear_unload();
 371
 372    /*
 373     * have_vol defines whether or not mount_next_write_volume should
 374     *   ask the Director again about what Volume to use.
 375     */
 376    if (dev->can_append() && dcr->is_suitable_volume_mounted() &&
 377        strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") != 0) {
 378       Dmsg0(190, "device already in append.\n");
 379       /*
 380        * At this point, the correct tape is already mounted, so
 381        *   we do not need to do mount_next_write_volume(), unless
 382        *   we need to recycle the tape.
 383        */
 384        if (dev->num_writers == 0) {
 385           memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
 386        }
 387        have_vol = dcr->is_tape_position_ok();
 388    }
 389
 390    if (!have_vol) {
 391       dev->r_dlock(true);
 392       block_device(dev, BST_DOING_ACQUIRE);
 393       dev->dunlock();
 394       Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
 395       if (!dcr->mount_next_write_volume()) {
 396          if (!job_canceled(jcr)) {
 397             /* Reduce "noise" -- don't print if job canceled */
 398             Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
 399                dev->print_name());
 400             Dmsg1(200, "Could not ready device %s for append.\n",
 401                dev->print_name());
 402          }
 403          dev->dlock();
 404          unblock_device(dev);
 405          goto get_out;
 406       }
 407       Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
 408       dev->dlock();
 409       unblock_device(dev);
 410    }
 411
 412    dev->num_writers++;                /* we are now a writer */
 413    if (jcr->NumWriteVolumes == 0) {
 414       jcr->NumWriteVolumes = 1;
 415    }
 416    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs on vol */
 417    Dmsg4(100, "=== nwriters=%d nres=%d vcatjob=%d dev=%s\n",
 418       dev->num_writers, dev->num_reserved(), dev->VolCatInfo.VolCatJobs,
 419       dev->print_name());
 420    dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 421    ok = true;
 422
 423 get_out:
 424    dcr->clear_reserved();
 425    dev->dunlock();
 426    V(acquire_lock);
 427    return ok ? dcr : NULL;
 428 }
 429
 430 /*
 431  * This job is done, so release the device. From a Unix standpoint,
 432  *  the device remains open.
 433  *
 434  * Note, if we are spooling, we may enter with the device locked.
 435  * However, in all cases, unlock the device when leaving.
 436  *
 437  */
 438 bool release_device(DCR *dcr)
 439 {
 440    JCR *jcr = dcr->jcr;
 441    DEVICE *dev = dcr->dev;
 442    bool ok = true;
 443    char tbuf[100];
 444
 445    /* lock only if not already locked by this thread */
 446    if (!dcr->is_dev_locked()) {
 447       dev->r_dlock();
 448    }
 449    lock_volumes();
 450    Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
 451
 452    /* if device is reserved, job never started, so release the reserve here */
 453    dcr->clear_reserved();
 454
 455    if (dev->can_read()) {
 456       VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
 457       dev->clear_read();              /* clear read bit */
 458       Dmsg2(150, "dir_update_vol_info. label=%d Vol=%s\n",
 459          dev->is_labeled(), vol->VolCatName);
 460       if (dev->is_labeled() && vol->VolCatName[0] != 0) {
 461          dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 462          remove_read_volume(jcr, dcr->VolumeName);
 463          volume_unused(dcr);
 464       }
 465    } else if (dev->num_writers > 0) {
 466       /*
 467        * Note if WEOT is set, we are at the end of the tape
 468        *   and may not be positioned correctly, so the
 469        *   job_media_record and update_vol_info have already been
 470        *   done, which means we skip them here.
 471        */
 472       dev->num_writers--;
 473       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
 474       if (dev->is_labeled()) {
 475          Dmsg2(200, "dir_create_jobmedia. Release vol=%s dev=%s\n",
 476                dev->VolCatInfo.VolCatName, dev->print_name());
 477          if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
 478             Jmsg2(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 479                dcr->VolCatInfo.VolCatName, jcr->Job);
 480          }
 481          /* If no more writers, and no errors, and wrote something, write an EOF */
 482          if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
 483             dev->weof(1);
 484             write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
 485          }
 486          if (!dev->at_weot()) {
 487             dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
 488             /* Note! do volume update before close, which zaps VolCatInfo */
 489             dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 490             Dmsg2(200, "dir_update_vol_info. Release vol=%s dev=%s\n",
 491                   dev->VolCatInfo.VolCatName, dev->print_name());
 492          }
 493          if (dev->num_writers == 0) {         /* if not being used */
 494             volume_unused(dcr);               /*  we obviously are not using the volume */
 495          }
 496       }
 497
 498    } else {
 499       /*
 500        * If we reach here, it is most likely because the job
 501        *   has failed, since the device is not in read mode and
 502        *   there are no writers. It was probably reserved.
 503        */
 504       volume_unused(dcr);
 505    }
 506    unlock_volumes();
 507    Dmsg3(100, "%d writers, %d reserve, dev=%s\n", dev->num_writers, dev->num_reserved(),
 508          dev->print_name());
 509    debug_list_volumes("acquire:release_device()");
 510
 511
 512    /* If no writers, close if file or !CAP_ALWAYS_OPEN */
 513    if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
 514       dvd_remove_empty_part(dcr);        /* get rid of any empty spool part */
 515       dev->close();
 516    }
 517
 518    /* Fire off Alert command and include any output */
 519    if (!job_canceled(jcr) && dcr->device->alert_command) {
 520       POOLMEM *alert;
 521       int status = 1;
 522       BPIPE *bpipe;
 523       char line[MAXSTRING];
 524       alert = get_pool_memory(PM_FNAME);
 525       alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
 526       bpipe = open_bpipe(alert, 0, "r");
 527       if (bpipe) {
 528          while (fgets(line, sizeof(line), bpipe->rfd)) {
 529             Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
 530          }
 531          status = close_bpipe(bpipe);
 532       } else {
 533          status = errno;
 534       }
 535       if (status != 0) {
 536          berrno be;
 537          Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
 538               alert, be.bstrerror(status));
 539       }
 540
 541       Dmsg1(400, "alert status=%d\n", status);
 542       free_pool_memory(alert);
 543    }
 544    pthread_cond_broadcast(&dev->wait_next_vol);
 545    Dmsg2(100, "JobId=%u broadcast wait_device_release at %s\n",
 546          (uint32_t)jcr->JobId, bstrftimes(tbuf, sizeof(tbuf), (utime_t)time(NULL)));
 547    pthread_cond_broadcast(&wait_device_release);
 548    dev->dunlock();
 549    if (dcr->keep_dcr) {
 550       detach_dcr_from_dev(dcr);
 551    } else {
 552       if (jcr->read_dcr == dcr) {
 553          jcr->read_dcr = NULL;
 554       }
 555       if (jcr->dcr == dcr) {
 556          jcr->dcr = NULL;
 557       }
 558       free_dcr(dcr);
 559    }
 560    Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
 561          (uint32_t)jcr->JobId);
 562    return ok;
 563 }
 564
 565 /*
 566  * Clean up the device for reuse without freeing the memory
 567  */
 568 bool clean_device(DCR *dcr)
 569 {
 570    bool ok;
 571    dcr->keep_dcr = true;                  /* do not free the dcr */
 572    ok = release_device(dcr);
 573    dcr->keep_dcr = false;
 574    return ok;
 575 }
 576
 577 /*
 578  * Create a new Device Control Record and attach
 579  *   it to the device (if this is a real job).
 580  * Note, this has been updated so that it can be called first
 581  *   without a DEVICE, then a second or third time with a DEVICE,
 582  *   and each time, it should cleanup and point to the new device.
 583  *   This should facilitate switching devices.
 584  * Note, each dcr must point to the controlling job (jcr).  However,
 585  *   a job can have multiple dcrs, so we must not store in the jcr's
 586  *   structure as previously. The higher level routine must store
 587  *   this dcr in the right place
 588  *
 589  */
 590 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
 591 {
 592    if (!dcr) {
 593       dcr = (DCR *)malloc(sizeof(DCR));
 594       memset(dcr, 0, sizeof(DCR));
 595       dcr->tid = pthread_self();
 596       dcr->spool_fd = -1;
 597    }
 598    dcr->jcr = jcr;                 /* point back to jcr */
 599    /* Set device information, possibly change device */
 600    if (dev) {
 601       if (dcr->block) {
 602          free_block(dcr->block);
 603       }
 604       dcr->block = new_block(dev);
 605       if (dcr->rec) {
 606          free_record(dcr->rec);
 607       }
 608       dcr->rec = new_record();
 609       if (dcr->attached_to_dev) {
 610          detach_dcr_from_dev(dcr);
 611       }
 612       /* Use job spoolsize prior to device spoolsize */
 613       if (jcr->spool_size) {
 614          dcr->max_job_spool_size = jcr->spool_size;
 615       } else {
 616          dcr->max_job_spool_size = dev->device->max_job_spool_size;
 617       }
 618       dcr->device = dev->device;
 619       dcr->dev = dev;
 620       attach_dcr_to_dev(dcr);
 621    }
 622    return dcr;
 623 }
 624
 625 /*
 626  * Search the dcrs list for the given dcr. If it is found,
 627  *  as it should be, then remove it. Also zap the jcr pointer
 628  *  to the dcr if it is the same one.
 629  *
 630  * Note, this code will be turned on when we can write to multiple
 631  *  dcrs at the same time.
 632  */
 633 #ifdef needed
 634 static void remove_dcr_from_dcrs(DCR *dcr)
 635 {
 636    JCR *jcr = dcr->jcr;
 637    if (jcr->dcrs) {
 638       int i = 0;
 639       DCR *ldcr;
 640       int num = jcr->dcrs->size();
 641       for (i=0; i < num; i++) {
 642          ldcr = (DCR *)jcr->dcrs->get(i);
 643          if (ldcr == dcr) {
 644             jcr->dcrs->remove(i);
 645             if (jcr->dcr == dcr) {
 646                jcr->dcr = NULL;
 647             }
 648          }
 649       }
 650    }
 651 }
 652 #endif
 653
 654 static void attach_dcr_to_dev(DCR *dcr)
 655 {
 656    DEVICE *dev = dcr->dev;
 657    JCR *jcr = dcr->jcr;
 658
 659    if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
 660    if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->get_JobType() != JT_SYSTEM) {
 661       dev->attached_dcrs->append(dcr);  /* attach dcr to device */
 662       dcr->attached_to_dev = true;
 663       Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
 664    }
 665 }
 666
 667 void detach_dcr_from_dev(DCR *dcr)
 668 {
 669    DEVICE *dev = dcr->dev;
 670    Dmsg0(500, "Enter detach_dcr_from_dev\n"); /* jcr is NULL in some cases */
 671
 672    /* Detach this dcr only if attached */
 673    if (dcr->attached_to_dev && dev) {
 674       dev->dlock();
 675       dcr->unreserve_device();
 676       dcr->dev->attached_dcrs->remove(dcr);  /* detach dcr from device */
 677       dcr->attached_to_dev = false;
 678 //    remove_dcr_from_dcrs(dcr);      /* remove dcr from jcr list */
 679       dev->dunlock();
 680    }
 681 }
 682
 683 /*
 684  * Free up all aspects of the given dcr -- i.e. dechain it,
 685  *  release allocated memory, zap pointers, ...
 686  */
 687 void free_dcr(DCR *dcr)
 688 {
 689    JCR *jcr = dcr->jcr;
 690
 691    detach_dcr_from_dev(dcr);
 692
 693    if (dcr->block) {
 694       free_block(dcr->block);
 695    }
 696    if (dcr->rec) {
 697       free_record(dcr->rec);
 698    }
 699    if (jcr && jcr->dcr == dcr) {
 700       jcr->dcr = NULL;
 701    }
 702    free(dcr);
 703 }
 704
 705 static void set_dcr_from_vol(DCR *dcr, VOL_LIST *vol)
 706 {
 707    /*
 708     * Note, if we want to be able to work from a .bsr file only
 709     *  for disaster recovery, we must "simulate" reading the catalog
 710     */
 711    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
 712    bstrncpy(dcr->VolCatInfo.VolCatName, vol->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
 713    bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
 714    dcr->VolCatInfo.Slot = vol->Slot;
 715    dcr->VolCatInfo.InChanger = vol->Slot > 0;
 716 }