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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2002-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 John Walker.
  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 bool is_suitable_volume_mounted(DCR *dcr);
  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    bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
  93    bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
  94    dcr->VolCatInfo.Slot = 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 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 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 device %s chosen.\n"),
 151             dev->print_name());
 152          Dmsg1(50, "Media Type change.  New device %s chosen.\n", dev->print_name());
 153
 154          bstrncpy(dcr->VolumeName, vol->VolumeName, sizeof(dcr->VolumeName));
 155          bstrncpy(dcr->media_type, vol->MediaType, sizeof(dcr->media_type));
 156          dcr->VolCatInfo.Slot = vol->Slot;
 157          bstrncpy(dcr->pool_name, store->pool_name, sizeof(dcr->pool_name));
 158          bstrncpy(dcr->pool_type, store->pool_type, sizeof(dcr->pool_type));
 159       } else {
 160          /* error */
 161          Jmsg1(jcr, M_FATAL, 0, _("No suitable device found to read Volume \"%s\"\n"),
 162             vol->VolumeName);
 163          Dmsg1(50, "No suitable device found to read Volume \"%s\"\n", vol->VolumeName);
 164          goto get_out;
 165       }
 166    }
 167
 168
 169    init_device_wait_timers(dcr);
 170
 171    tape_previously_mounted = dev->can_read() || dev->can_append() ||
 172                              dev->is_labeled();
 173    tape_initially_mounted = tape_previously_mounted;
 174
 175
 176    /* Volume info is always needed because of VolParts */
 177    Dmsg0(200, "dir_get_volume_info\n");
 178    if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
 179       Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 180    }
 181
 182    for ( ;; ) {
 183       /* If not polling limit retries */
 184       if (!dev->poll && retry++ > 10) {
 185          break;
 186       }
 187       dev->clear_labeled();              /* force reread of label */
 188       if (job_canceled(jcr)) {
 189          char ed1[50];
 190          Mmsg1(dev->errmsg, _("Job %s canceled.\n"), edit_int64(jcr->JobId, ed1));
 191          Jmsg(jcr, M_INFO, 0, dev->errmsg);
 192          goto get_out;                /* error return */
 193       }
 194
 195       autoload_device(dcr, 0, NULL);
 196
 197       /*
 198        * This code ensures that the device is ready for
 199        * reading. If it is a file, it opens it.
 200        * If it is a tape, it checks the volume name
 201        */
 202       Dmsg1(100, "bstored: open vol=%s\n", dcr->VolumeName);
 203       if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
 204         Jmsg3(jcr, M_WARNING, 0, _("Read open device %s Volume \"%s\" failed: ERR=%s\n"),
 205               dev->print_name(), dcr->VolumeName, dev->bstrerror());
 206          goto default_path;
 207       }
 208       Dmsg1(50, "opened dev %s OK\n", dev->print_name());
 209
 210       /* Read Volume Label */
 211       Dmsg0(50, "calling read-vol-label\n");
 212       vol_label_status = read_dev_volume_label(dcr);
 213       switch (vol_label_status) {
 214       case VOL_OK:
 215          ok = true;
 216          memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
 217          break;                    /* got it */
 218       case VOL_IO_ERROR:
 219          /*
 220           * Send error message generated by read_dev_volume_label()
 221           *  only we really had a tape mounted. This supresses superfluous
 222           *  error messages when nothing is mounted.
 223           */
 224          if (tape_previously_mounted) {
 225             Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 226          }
 227          goto default_path;
 228       case VOL_NAME_ERROR:
 229          if (tape_initially_mounted) {
 230             tape_initially_mounted = false;
 231             goto default_path;
 232          }
 233          /* If polling and got a previous bad name, ignore it */
 234          if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
 235             goto default_path;
 236          } else {
 237              bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
 238          }
 239          /* Fall through */
 240       default:
 241          Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 242 default_path:
 243          tape_previously_mounted = true;
 244
 245          /*
 246           * If the device requires mount, close it, so the device can be ejected.
 247           */
 248          if (dev->requires_mount()) {
 249             dev->close();
 250          }
 251
 252          /* Call autochanger only once unless ask_sysop called */
 253          if (try_autochanger) {
 254             int stat;
 255             Dmsg2(200, "calling autoload Vol=%s Slot=%d\n",
 256                dcr->VolumeName, dcr->VolCatInfo.Slot);
 257             stat = autoload_device(dcr, 0, NULL);
 258             if (stat > 0) {
 259                try_autochanger = false;
 260                continue;              /* try reading volume mounted */
 261             }
 262          }
 263
 264          /* Mount a specific volume and no other */
 265          Dmsg0(200, "calling dir_ask_sysop\n");
 266          if (!dir_ask_sysop_to_mount_volume(dcr)) {
 267             goto get_out;             /* error return */
 268          }
 269          try_autochanger = true;      /* permit using autochanger again */
 270          continue;                    /* try reading again */
 271       } /* end switch */
 272       break;
 273    } /* end for loop */
 274    if (!ok) {
 275       Jmsg1(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s for reading.\n"),
 276             dev->print_name());
 277       goto get_out;
 278    }
 279
 280    dev->clear_append();
 281    dev->set_read();
 282    set_jcr_job_status(jcr, JS_Running);
 283    dir_send_job_status(jcr);
 284    Jmsg(jcr, M_INFO, 0, _("Ready to read from volume \"%s\" on device %s.\n"),
 285       dcr->VolumeName, dev->print_name());
 286
 287 get_out:
 288    dev->dlock();
 289    if (dcr && dcr->reserved_device) {
 290       dev->reserved_device--;
 291       Dmsg2(50, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
 292       dcr->reserved_device = false;
 293    }
 294    /*
 295     * Normally we are blocked, but in at least one error case above
 296     *   we are not blocked because we unsuccessfully tried changing
 297     *   devices.
 298     */
 299    if (dev->is_blocked()) {
 300       dev->dunblock(DEV_LOCKED);
 301    }
 302    Dmsg1(950, "jcr->dcr=%p\n", jcr->dcr);
 303    return ok;
 304 }
 305
 306
 307 /*
 308  * Acquire device for writing. We permit multiple writers.
 309  *  If this is the first one, we read the label.
 310  *
 311  *  Returns: NULL if failed for any reason
 312  *           dcr if successful.
 313  *   Note, normally reserve_device_for_append() is called
 314  *   before this routine.
 315  */
 316 DCR *acquire_device_for_append(DCR *dcr)
 317 {
 318    bool do_mount = false;
 319    bool release = false;
 320    bool have_vol;
 321    DEVICE *dev = dcr->dev;
 322    JCR *jcr = dcr->jcr;
 323
 324    init_device_wait_timers(dcr);
 325
 326    dev->dblock(BST_DOING_ACQUIRE);
 327    Dmsg1(100, "acquire_append device is %s\n", dev->is_tape()?"tape":
 328         (dev->is_dvd()?"DVD":"disk"));
 329
 330    /*
 331     * With the reservation system, this should not happen
 332     */
 333    if (dev->can_read()) {
 334       Jmsg1(jcr, M_FATAL, 0, _("Want to append, but device %s is busy reading.\n"), dev->print_name());
 335       Dmsg1(200, "Want to append but device %s is busy reading.\n", dev->print_name());
 336       goto get_out;
 337    }
 338
 339    /*
 340     * have_vol defines whether or not mount_next_write_volume should
 341     *   ask the Director again about what Volume to use.
 342     */
 343    have_vol = is_suitable_volume_mounted(dcr);
 344    if (dev->can_append()) {
 345       Dmsg0(190, "device already in append.\n");
 346       /*
 347        * Device already in append mode
 348        *
 349        * Check if we have the right Volume mounted
 350        *   OK if current volume info OK
 351        *   OK if next volume matches current volume
 352        *   otherwise mount desired volume obtained from
 353        *    dir_find_next_appendable_volume
 354        *  dev->VolHdr.VolumeName is what is in the drive
 355        *  dcr->VolumeName is what we pass into the routines, or
 356        *    get back from the subroutines.
 357        */
 358       if (!have_vol &&
 359           !(dir_find_next_appendable_volume(dcr) &&
 360             strcmp(dev->VolHdr.VolumeName, dcr->VolumeName) == 0)) { /* wrong tape mounted */
 361          /* Wrong tape mounted, release it, then fall through to get correct one */
 362          Dmsg0(50, "Wrong tape mounted, release and try mount.\n");
 363          release = true;
 364          do_mount = true;
 365       } else {
 366          /*
 367           * At this point, the correct tape is already mounted, so
 368           *   we do not need to do mount_next_write_volume(), unless
 369           *   we need to recycle the tape.
 370           */
 371           do_mount = strcmp(dcr->VolCatInfo.VolCatStatus, "Recycle") == 0;
 372           Dmsg2(190, "jid=%u Correct tape mounted. recycle=%d\n",
 373                 (uint32_t)jcr->JobId, do_mount);
 374 #ifdef xxx
 375           if (do_mount && dev->num_writers != 0) {
 376              Jmsg(jcr, M_FATAL, 0, _("Cannot recycle volume \"%s\""
 377                   " on device %s because it is in use by another job.\n"),
 378                   dev->VolHdr.VolumeName, dev->print_name());
 379              goto get_out;
 380           }
 381 #endif
 382           if (dev->num_writers == 0) {
 383              memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
 384           }
 385
 386           /*
 387            *      Insanity check
 388            *
 389            * Check to see if the tape position as defined by the OS is
 390            *  the same as our concept.  If it is not, we bail out, because
 391            *  it means the user has probably manually rewound the tape.
 392            * Note, we check only if num_writers == 0, but this code will
 393            *  also work fine for any number of writers. If num_writers > 0,
 394            *  we probably should cancel all jobs using this device, or
 395            *  perhaps even abort the SD, or at a minimum, mark the tape
 396            *  in error.  Another strategy with num_writers == 0, would be
 397            *  to rewind the tape and do a new eod() request.
 398            */
 399           if (dev->is_tape() && dev->num_writers == 0) {
 400              int32_t file = dev->get_os_tape_file();
 401              if (file >= 0 && file != (int32_t)dev->get_file()) {
 402                 Jmsg(jcr, M_FATAL, 0, _("Invalid tape position on volume \"%s\""
 403                      " on device %s. Expected %d, got %d\n"),
 404                      dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
 405                 goto get_out;
 406              }
 407           }
 408       }
 409    } else {
 410       /* Not already in append mode, so mount the device */
 411       Dmsg2(190, "jid=%u Not in append mode, try mount have_vol=%d\n",
 412             (uint32_t)jcr->JobId, have_vol);
 413
 414       ASSERT(dev->num_writers == 0);
 415       do_mount = true;
 416    }
 417
 418    if (do_mount || !have_vol) {
 419       Dmsg1(190, "jid=%u Do mount_next_write_vol\n", (uint32_t)jcr->JobId);
 420       bool mounted = mount_next_write_volume(dcr, have_vol, release);
 421       if (!mounted) {
 422          if (!job_canceled(jcr)) {
 423             /* Reduce "noise" -- don't print if job canceled */
 424             Jmsg(jcr, M_FATAL, 0, _("Could not ready device %s for append.\n"),
 425                dev->print_name());
 426             Dmsg2(200, "jid=%u Could not ready device %s for append.\n",
 427                (uint32_t)jcr->JobId, dev->print_name());
 428          }
 429          goto get_out;
 430       }
 431       Dmsg2(190, "Output pos=%u:%u\n", dcr->dev->file, dcr->dev->block_num);
 432    }
 433
 434    dev->num_writers++;                /* we are now a writer */
 435    if (jcr->NumWriteVolumes == 0) {
 436       jcr->NumWriteVolumes = 1;
 437    }
 438    dev->VolCatInfo.VolCatJobs++;              /* increment number of jobs on vol */
 439    dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 440    dev->dlock();
 441    if (dcr->reserved_device) {
 442       dev->reserved_device--;
 443       Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
 444             dev->reserved_device, dev->print_name());
 445       dcr->reserved_device = false;
 446    }
 447    dev->dunblock(DEV_LOCKED);
 448    return dcr;
 449
 450 /*
 451  * Error return
 452  */
 453 get_out:
 454    dev->dlock();
 455    if (dcr->reserved_device) {
 456       dev->reserved_device--;
 457       Dmsg3(100, "jid=%u Dec reserve=%d dev=%s\n", (uint32_t)jcr->JobId,
 458             dev->reserved_device, dev->print_name());
 459       dcr->reserved_device = false;
 460    }
 461    dev->dunblock(DEV_LOCKED);
 462    return NULL;
 463 }
 464
 465
 466 static bool is_suitable_volume_mounted(DCR *dcr)
 467 {
 468    DEVICE *dev = dcr->dev;
 469
 470    /* Volume mounted? */
 471    if (dev->VolHdr.VolumeName[0] == 0) {
 472       return false;                      /* no */
 473    }
 474    bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
 475    return dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE);
 476 }
 477
 478 /*
 479  * This job is done, so release the device. From a Unix standpoint,
 480  *  the device remains open.
 481  *
 482  * Note, if we are spooling, we may enter with the device locked.
 483  * However, in all cases, unlock the device when leaving.
 484  *
 485  */
 486 bool release_device(DCR *dcr)
 487 {
 488    JCR *jcr = dcr->jcr;
 489    DEVICE *dev = dcr->dev;
 490    bool ok = true;
 491
 492    /* lock only if not already locked by this thread */
 493    if (!dcr->is_dev_locked()) {
 494       dev->r_dlock();
 495    }
 496    Dmsg2(100, "release_device device %s is %s\n", dev->print_name(), dev->is_tape()?"tape":"disk");
 497
 498    /* if device is reserved, job never started, so release the reserve here */
 499    if (dcr->reserved_device) {
 500       dev->reserved_device--;
 501       Dmsg2(100, "Dec reserve=%d dev=%s\n", dev->reserved_device, dev->print_name());
 502       dcr->reserved_device = false;
 503    }
 504
 505    if (dev->can_read()) {
 506       dev->clear_read();              /* clear read bit */
 507       Dmsg0(100, "dir_update_vol_info. Release0\n");
 508       dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 509       volume_unused(dcr);
 510
 511    } else if (dev->num_writers > 0) {
 512       /*
 513        * Note if WEOT is set, we are at the end of the tape
 514        *   and may not be positioned correctly, so the
 515        *   job_media_record and update_vol_info have already been
 516        *   done, which means we skip them here.
 517        */
 518       dev->num_writers--;
 519       Dmsg1(100, "There are %d writers in release_device\n", dev->num_writers);
 520       if (dev->is_labeled()) {
 521          Dmsg0(100, "dir_create_jobmedia_record. Release\n");
 522          if (!dev->at_weot() && !dir_create_jobmedia_record(dcr)) {
 523             Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 524                dcr->VolCatInfo.VolCatName, jcr->Job);
 525          }
 526          /* If no more writers, write an EOF */
 527          if (!dev->num_writers && dev->can_write() && dev->block_num > 0) {
 528             dev->weof(1);
 529             write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName);
 530             volume_unused(dcr);
 531          }
 532          if (!dev->at_weot()) {
 533             dev->VolCatInfo.VolCatFiles = dev->file;   /* set number of files */
 534             /* Note! do volume update before close, which zaps VolCatInfo */
 535             Dmsg0(100, "dir_update_vol_info. Release0\n");
 536             dir_update_volume_info(dcr, false, false); /* send Volume info to Director */
 537          }
 538       }
 539
 540    } else {
 541       /*
 542        * If we reach here, it is most likely because the job
 543        *   has failed, since the device is not in read mode and
 544        *   there are no writers. It was probably reserved.
 545        */
 546       volume_unused(dcr);
 547    }
 548
 549    /* If no writers, close if file or !CAP_ALWAYS_OPEN */
 550    if (dev->num_writers == 0 && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
 551       dvd_remove_empty_part(dcr);        /* get rid of any empty spool part */
 552       dev->close();
 553    }
 554
 555    /* Fire off Alert command and include any output */
 556    if (!job_canceled(jcr) && dcr->device->alert_command) {
 557       POOLMEM *alert;
 558       int status = 1;
 559       BPIPE *bpipe;
 560       char line[MAXSTRING];
 561       alert = get_pool_memory(PM_FNAME);
 562       alert = edit_device_codes(dcr, alert, dcr->device->alert_command, "");
 563       bpipe = open_bpipe(alert, 0, "r");
 564       if (bpipe) {
 565          while (fgets(line, sizeof(line), bpipe->rfd)) {
 566             Jmsg(jcr, M_ALERT, 0, _("Alert: %s"), line);
 567          }
 568          status = close_bpipe(bpipe);
 569       } else {
 570          status = errno;
 571       }
 572       if (status != 0) {
 573          berrno be;
 574          Jmsg(jcr, M_ALERT, 0, _("3997 Bad alert command: %s: ERR=%s.\n"),
 575               alert, be.bstrerror(status));
 576       }
 577
 578       Dmsg1(400, "alert status=%d\n", status);
 579       free_pool_memory(alert);
 580    }
 581    pthread_cond_broadcast(&dev->wait_next_vol);
 582    Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
 583    pthread_cond_broadcast(&wait_device_release);
 584    dev->dunlock();
 585    if (dcr->keep_dcr) {
 586       detach_dcr_from_dev(dcr);
 587    } else {
 588       if (jcr->read_dcr == dcr) {
 589          jcr->read_dcr = NULL;
 590       }
 591       if (jcr->dcr == dcr) {
 592          jcr->dcr = NULL;
 593       }
 594       free_dcr(dcr);
 595    }
 596    Dmsg2(100, "===== Device %s released by JobId=%u\n", dev->print_name(),
 597          (uint32_t)jcr->JobId);
 598    return ok;
 599 }
 600
 601 /*
 602  * Clean up the device for reuse without freeing the memory
 603  */
 604 bool clean_device(DCR *dcr)
 605 {
 606    bool ok;
 607    dcr->keep_dcr = true;                  /* do not free the dcr */
 608    ok = release_device(dcr);
 609    dcr->keep_dcr = false;
 610    return ok;
 611 }
 612
 613 /*
 614  * Create a new Device Control Record and attach
 615  *   it to the device (if this is a real job).
 616  * Note, this has been updated so that it can be called first
 617  *   without a DEVICE, then a second or third time with a DEVICE,
 618  *   and each time, it should cleanup and point to the new device.
 619  *   This should facilitate switching devices.
 620  * Note, each dcr must point to the controlling job (jcr).  However,
 621  *   a job can have multiple dcrs, so we must not store in the jcr's
 622  *   structure as previously. The higher level routine must store
 623  *   this dcr in the right place
 624  *
 625  */
 626 DCR *new_dcr(JCR *jcr, DCR *dcr, DEVICE *dev)
 627 {
 628    if (!dcr) {
 629       dcr = (DCR *)malloc(sizeof(DCR));
 630       memset(dcr, 0, sizeof(DCR));
 631       dcr->tid = pthread_self();
 632       dcr->spool_fd = -1;
 633    }
 634    dcr->jcr = jcr;                 /* point back to jcr */
 635    /* Set device information, possibly change device */
 636    if (dev) {
 637       if (dcr->block) {
 638          free_block(dcr->block);
 639       }
 640       dcr->block = new_block(dev);
 641       if (dcr->rec) {
 642          free_record(dcr->rec);
 643       }
 644       dcr->rec = new_record();
 645       if (dcr->attached_to_dev) {
 646          detach_dcr_from_dev(dcr);
 647       }
 648       /* Use job spoolsize prior to device spoolsize */
 649       if (jcr->spool_size) {
 650          dcr->max_job_spool_size = jcr->spool_size;
 651       } else {
 652          dcr->max_job_spool_size = dev->device->max_job_spool_size;
 653       }
 654       dcr->device = dev->device;
 655       dcr->dev = dev;
 656       attach_dcr_to_dev(dcr);
 657    }
 658    return dcr;
 659 }
 660
 661 /*
 662  * Search the dcrs list for the given dcr. If it is found,
 663  *  as it should be, then remove it. Also zap the jcr pointer
 664  *  to the dcr if it is the same one.
 665  *
 666  * Note, this code will be turned on when we can write to multiple
 667  *  dcrs at the same time.
 668  */
 669 #ifdef needed
 670 static void remove_dcr_from_dcrs(DCR *dcr)
 671 {
 672    JCR *jcr = dcr->jcr;
 673    if (jcr->dcrs) {
 674       int i = 0;
 675       DCR *ldcr;
 676       int num = jcr->dcrs->size();
 677       for (i=0; i < num; i++) {
 678          ldcr = (DCR *)jcr->dcrs->get(i);
 679          if (ldcr == dcr) {
 680             jcr->dcrs->remove(i);
 681             if (jcr->dcr == dcr) {
 682                jcr->dcr = NULL;
 683             }
 684          }
 685       }
 686    }
 687 }
 688 #endif
 689
 690 static void attach_dcr_to_dev(DCR *dcr)
 691 {
 692    DEVICE *dev = dcr->dev;
 693    JCR *jcr = dcr->jcr;
 694
 695    if (jcr) Dmsg1(500, "JobId=%u enter attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
 696    if (!dcr->attached_to_dev && dev->initiated && jcr && jcr->JobType != JT_SYSTEM) {
 697       dev->attached_dcrs->append(dcr);  /* attach dcr to device */
 698       dcr->attached_to_dev = true;
 699       Dmsg1(500, "JobId=%u attach_dcr_to_dev\n", (uint32_t)jcr->JobId);
 700    }
 701 }
 702
 703 void detach_dcr_from_dev(DCR *dcr)
 704 {
 705    DEVICE *dev = dcr->dev;
 706    Dmsg1(500, "JobId=%u enter detach_dcr_from_dev\n", (uint32_t)dcr->jcr->JobId);
 707
 708    /* Detach this dcr only if attached */
 709    if (dcr->attached_to_dev && dev) {
 710       dev->dlock();
 711       unreserve_device(dcr);
 712       dcr->dev->attached_dcrs->remove(dcr);  /* detach dcr from device */
 713       dcr->attached_to_dev = false;
 714 //    remove_dcr_from_dcrs(dcr);      /* remove dcr from jcr list */
 715       dev->dunlock();
 716    }
 717 }
 718
 719 /*
 720  * Free up all aspects of the given dcr -- i.e. dechain it,
 721  *  release allocated memory, zap pointers, ...
 722  */
 723 void free_dcr(DCR *dcr)
 724 {
 725    JCR *jcr = dcr->jcr;
 726
 727    detach_dcr_from_dev(dcr);
 728
 729    if (dcr->block) {
 730       free_block(dcr->block);
 731    }
 732    if (dcr->rec) {
 733       free_record(dcr->rec);
 734    }
 735    if (jcr && jcr->dcr == dcr) {
 736       jcr->dcr = NULL;
 737    }
 738    free(dcr);
 739 }