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

   1 /*
   2  *  Subroutines to handle Catalog reqests sent to the Director
   3  *   Reqests/commands from the Director are handled in dircmd.c
   4  *
   5  *   Kern Sibbald, December 2000
   6  *
   7  *   Version $Id$
   8  */
   9 /*
  10    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  11
  12    This program is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation; either version 2 of
  15    the License, or (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20    General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public
  23    License along with this program; if not, write to the Free
  24    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29 #include "bacula.h"                   /* pull in global headers */
  30 #include "stored.h"                   /* pull in Storage Deamon headers */
  31
  32 /* Requests sent to the Director */
  33 static char Find_media[]   = "CatReq Job=%s FindMedia=%d\n";
  34 static char Get_Vol_Info[] = "CatReq Job=%s GetVolInfo VolName=%s write=%d\n";
  35 static char Update_media[] = "CatReq Job=%s UpdateMedia VolName=%s"
  36    " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%s VolMounts=%u"
  37    " VolErrors=%u VolWrites=%u MaxVolBytes=%s EndTime=%d VolStatus=%s"
  38    " Slot=%d relabel=%d InChanger=%d VolReadTime=%s VolWriteTime=%s\n";
  39 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia"
  40    " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u"
  41    " StartBlock=%u EndBlock=%u\n";
  42 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
  43 static char Job_status[]     = "3012 Job %s jobstatus %d\n";
  44
  45
  46 /* Responses received from the Director */
  47 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u"
  48    " VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u"
  49    " MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s"
  50    " Slot=%d MaxVolJobs=%u MaxVolFiles=%u InChanger=%d"
  51    " VolReadTime=%" lld " VolWriteTime=%" lld;
  52
  53
  54 static char OK_create[] = "1000 OK CreateJobMedia\n";
  55
  56 /* Forward referenced functions */
  57 static int wait_for_sysop(DCR *dcr);
  58
  59 /*
  60  * Send current JobStatus to Director
  61  */
  62 bool dir_send_job_status(JCR *jcr)
  63 {
  64    return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
  65 }
  66
  67 /*
  68  * Common routine for:
  69  *   dir_get_volume_info()
  70  * and
  71  *   dir_find_next_appendable_volume()
  72  *
  73  *  Returns: true  on success and vol info in jcr->VolCatInfo
  74  *           false on failure
  75  */
  76 static bool do_get_volume_info(DCR *dcr)
  77 {
  78     JCR *jcr = dcr->jcr;
  79     BSOCK *dir = jcr->dir_bsock;
  80     VOLUME_CAT_INFO vol;
  81     int n;
  82     int InChanger;
  83
  84     jcr->VolumeName[0] = 0;           /* No volume */
  85     dcr->VolumeName[0] = 0;           /* No volume */
  86     if (bnet_recv(dir) <= 0) {
  87        Dmsg0(200, "getvolname error bnet_recv\n");
  88        Mmsg(jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
  89        return false;
  90     }
  91     memset(&vol, 0, sizeof(vol));
  92     Dmsg1(200, "Get vol info=%s\n", dir->msg);
  93     n = sscanf(dir->msg, OK_media, vol.VolCatName,
  94                &vol.VolCatJobs, &vol.VolCatFiles,
  95                &vol.VolCatBlocks, &vol.VolCatBytes,
  96                &vol.VolCatMounts, &vol.VolCatErrors,
  97                &vol.VolCatWrites, &vol.VolCatMaxBytes,
  98                &vol.VolCatCapacityBytes, vol.VolCatStatus,
  99                &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles,
 100                &InChanger, &vol.VolReadTime, &vol.VolWriteTime);
 101     if (n != 17) {
 102        Dmsg2(100, "Bad response from Dir fields=%d: %s\n", n, dir->msg);
 103        Mmsg(jcr->errmsg, _("Error getting Volume info: %s\n"), dir->msg);
 104        return false;
 105     }
 106     vol.InChanger = InChanger;        /* bool in structure */
 107     unbash_spaces(vol.VolCatName);
 108     pm_strcpy(&jcr->VolumeName, vol.VolCatName); /* set desired VolumeName */
 109     bstrncpy(dcr->VolumeName, vol.VolCatName, sizeof(dcr->VolumeName));
 110     memcpy(&jcr->VolCatInfo, &vol, sizeof(jcr->VolCatInfo));
 111     memcpy(&dcr->VolCatInfo, &vol, sizeof(dcr->VolCatInfo));
 112
 113     Dmsg2(200, "do_reqest_vol_info got slot=%d Volume=%s\n",
 114           vol.Slot, vol.VolCatName);
 115     return true;
 116 }
 117
 118
 119 /*
 120  * Get Volume info for a specific volume from the Director's Database
 121  *
 122  * Returns: true  on success   (not Director guarantees that Pool and MediaType
 123  *                             are correct and VolStatus==Append or
 124  *                             VolStatus==Recycle)
 125  *          false on failure
 126  *
 127  *          Volume information returned in jcr
 128  */
 129 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw writing)
 130 {
 131     JCR *jcr = dcr->jcr;
 132     BSOCK *dir = jcr->dir_bsock;
 133
 134     bstrncpy(jcr->VolCatInfo.VolCatName, jcr->VolumeName, sizeof(jcr->VolCatInfo.VolCatName));
 135     Dmsg1(200, "dir_get_volume_info=%s\n", jcr->VolCatInfo.VolCatName);
 136     bash_spaces(jcr->VolCatInfo.VolCatName);
 137     bnet_fsend(dir, Get_Vol_Info, jcr->Job, jcr->VolCatInfo.VolCatName,
 138        writing==GET_VOL_INFO_FOR_WRITE?1:0);
 139     return do_get_volume_info(dcr);
 140 }
 141
 142
 143
 144 /*
 145  * Get info on the next appendable volume in the Director's database
 146  * Returns: true  on success
 147  *          false on failure
 148  *
 149  *          Volume information returned in jcr
 150  *
 151  */
 152 bool dir_find_next_appendable_volume(DCR *dcr)
 153 {
 154     JCR *jcr = dcr->jcr;
 155     BSOCK *dir = jcr->dir_bsock;
 156     JCR *njcr;
 157
 158     Dmsg0(200, "dir_find_next_appendable_volume\n");
 159     for (int vol_index=1;  vol_index < 3; vol_index++) {
 160        bnet_fsend(dir, Find_media, jcr->Job, vol_index);
 161        if (do_get_volume_info(dcr)) {
 162           Dmsg2(200, "JobId=%d got possible Vol=%s\n", jcr->JobId, jcr->VolumeName);
 163           bool found = false;
 164           /*
 165            * Walk through all jobs and see if the volume is
 166            *  already mounted. If so, try a different one.
 167            * This would be better done by walking through
 168            *  all the devices.
 169            */
 170           lock_jcr_chain();
 171           foreach_jcr(njcr) {
 172              if (jcr == njcr) {
 173                 free_locked_jcr(njcr);
 174                 continue;             /* us */
 175              }
 176              Dmsg2(200, "Compare to JobId=%d using Vol=%s\n", njcr->JobId, njcr->VolumeName);
 177              if (strcmp(jcr->VolumeName, njcr->VolumeName) == 0) {
 178                 found = true;
 179                 Dmsg1(200, "Vol in use by JobId=%u\n", njcr->JobId);
 180                 free_locked_jcr(njcr);
 181                 break;
 182              }
 183              free_locked_jcr(njcr);
 184           }
 185           unlock_jcr_chain();
 186           if (!found) {
 187              Dmsg0(200, "dir_find_next_appendable_volume return true\n");
 188              return true;             /* Got good Volume */
 189           }
 190        } else {
 191           Dmsg0(200, "No volume info, return false\n");
 192           return false;
 193        }
 194     }
 195     Dmsg0(200, "dir_find_next_appendable_volume return true\n");
 196     return true;
 197 }
 198
 199
 200 /*
 201  * After writing a Volume, send the updated statistics
 202  * back to the director. The information comes from the
 203  * dev record.
 204  */
 205 bool dir_update_volume_info(DCR *dcr, bool label)
 206 {
 207    JCR *jcr = dcr->jcr;
 208    BSOCK *dir = jcr->dir_bsock;
 209    DEVICE *dev = dcr->dev;
 210    time_t LastWritten = time(NULL);
 211    char ed1[50], ed2[50], ed3[50], ed4[50];
 212    VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
 213    int InChanger;
 214
 215    if (vol->VolCatName[0] == 0) {
 216       Jmsg0(jcr, M_ERROR, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
 217       return false;
 218    }
 219    if (dev_state(dev, ST_READ)) {
 220       Jmsg0(jcr, M_ERROR, 0, _("Attempt to update_volume_info in read mode!!!\n"));
 221       return false;
 222    }
 223
 224    Dmsg1(100, "Update cat VolFiles=%d\n", dev->file);
 225    /* Just labeled or relabeled the tape */
 226    if (label) {
 227       bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
 228       vol->VolCatBytes = 1;           /* indicates tape labeled */
 229    }
 230    bash_spaces(vol->VolCatName);
 231    InChanger = vol->InChanger;
 232    bnet_fsend(dir, Update_media, jcr->Job,
 233       vol->VolCatName, vol->VolCatJobs, vol->VolCatFiles,
 234       vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
 235       vol->VolCatMounts, vol->VolCatErrors,
 236       vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
 237       LastWritten, vol->VolCatStatus, vol->Slot, label,
 238       InChanger,                      /* bool in structure */
 239       edit_uint64(vol->VolReadTime, ed3),
 240       edit_uint64(vol->VolWriteTime, ed4) );
 241
 242    Dmsg1(120, "update_volume_info(): %s", dir->msg);
 243    unbash_spaces(vol->VolCatName);
 244
 245    if (!do_get_volume_info(dcr)) {
 246       Jmsg(jcr, M_ERROR, 0, "%s", jcr->errmsg);
 247       return false;
 248    }
 249    Dmsg1(120, "get_volume_info(): %s", dir->msg);
 250    /* Update dev Volume info in case something changed (e.g. expired) */
 251    memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
 252    return true;
 253 }
 254
 255 /*
 256  * After writing a Volume, create the JobMedia record.
 257  */
 258 bool dir_create_jobmedia_record(DCR *dcr)
 259 {
 260    JCR *jcr = dcr->jcr;
 261    BSOCK *dir = jcr->dir_bsock;
 262
 263    if (!dcr->WroteVol) {
 264       return true;                    /* nothing written to tape */
 265    }
 266
 267    dcr->WroteVol = false;
 268    bnet_fsend(dir, Create_job_media, jcr->Job,
 269       dcr->VolFirstIndex, dcr->VolLastIndex,
 270       dcr->StartFile, dcr->EndFile,
 271       dcr->StartBlock, dcr->EndBlock);
 272    Dmsg1(100, "create_jobmedia(): %s", dir->msg);
 273    if (bnet_recv(dir) <= 0) {
 274       Dmsg0(190, "create_jobmedia error bnet_recv\n");
 275       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: ERR=%s\n"),
 276            bnet_strerror(dir));
 277       return false;
 278    }
 279    Dmsg1(120, "Create_jobmedia: %s", dir->msg);
 280    if (strcmp(dir->msg, OK_create) != 0) {
 281       Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
 282       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
 283       return false;
 284    }
 285    return true;
 286 }
 287
 288
 289 /*
 290  * Update File Attribute data
 291  */
 292 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec)
 293 {
 294    JCR *jcr = dcr->jcr;
 295    BSOCK *dir = jcr->dir_bsock;
 296    ser_declare;
 297
 298    dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
 299    dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
 300                 sizeof(DEV_RECORD) + rec->data_len);
 301    ser_begin(dir->msg + dir->msglen, 0);
 302    ser_uint32(rec->VolSessionId);
 303    ser_uint32(rec->VolSessionTime);
 304    ser_int32(rec->FileIndex);
 305    ser_int32(rec->Stream);
 306    ser_uint32(rec->data_len);
 307    ser_bytes(rec->data, rec->data_len);
 308    dir->msglen = ser_length(dir->msg);
 309    return bnet_send(dir);
 310 }
 311
 312
 313 /*
 314  *   Request the sysop to create an appendable volume
 315  *
 316  *   Entered with device blocked.
 317  *   Leaves with device blocked.
 318  *
 319  *   Returns: true  on success (operator issues a mount command)
 320  *            false on failure
 321  *              Note, must create dev->errmsg on error return.
 322  *
 323  *    On success, jcr->VolumeName and jcr->VolCatInfo contain
 324  *      information on suggested volume, but this may not be the
 325  *      same as what is actually mounted.
 326  *
 327  *    When we return with success, the correct tape may or may not
 328  *      actually be mounted. The calling routine must read it and
 329  *      verify the label.
 330  */
 331 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr)
 332 {
 333    int stat = 0, jstat;
 334    bool unmounted;
 335    bool first = true;
 336    DEVICE *dev = dcr->dev;
 337    JCR *jcr = dcr->jcr;
 338
 339    Dmsg0(130, "enter dir_ask_sysop_to_create_appendable_volume\n");
 340    ASSERT(dev->dev_blocked);
 341    for ( ;; ) {
 342       if (job_canceled(jcr)) {
 343          Mmsg(dev->errmsg,
 344               _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
 345               jcr->Job, jcr->dev_name);
 346          Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
 347          return false;
 348       }
 349       /* First pass, we *know* there are no appendable volumes, so no need to call */
 350       if (!first && dir_find_next_appendable_volume(dcr)) { /* get suggested volume */
 351          unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
 352                      (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 353          /*
 354           * If we have a valid volume name and we are not
 355           *   removable media, return now, or if we have a
 356           *   Slot for an autochanger, otherwise wait
 357           *   for the operator to mount the media.
 358           */
 359          if (!unmounted && ((jcr->VolumeName[0] && !dev_cap(dev, CAP_REM) &&
 360                 dev_cap(dev, CAP_LABEL)) ||
 361                  (jcr->VolumeName[0] && jcr->VolCatInfo.Slot))) {
 362             Dmsg0(100, "Return 1 from mount without wait.\n");
 363             return true;
 364          }
 365          jstat = JS_WaitMount;
 366          if (!dev->poll) {
 367             Jmsg(jcr, M_MOUNT, 0, _(
 368 "Please mount Volume \"%s\" on Storage Device \"%s\" for Job %s\n"
 369 "Use \"mount\" command to release Job.\n"),
 370               jcr->VolumeName, jcr->dev_name, jcr->Job);
 371             Dmsg3(190, "Mount %s on %s for Job %s\n",
 372                   jcr->VolumeName, jcr->dev_name, jcr->Job);
 373          }
 374       } else {
 375          jstat = JS_WaitMedia;
 376          if (!dev->poll) {
 377             Jmsg(jcr, M_MOUNT, 0, _(
 378 "Job %s waiting. Cannot find any appendable volumes.\n\
 379 Please use the \"label\"  command to create a new Volume for:\n\
 380     Storage:      %s\n\
 381     Media type:   %s\n\
 382     Pool:         %s\n"),
 383                jcr->Job,
 384                jcr->dev_name,
 385                jcr->media_type,
 386                jcr->pool_name);
 387          }
 388       }
 389       first = false;
 390
 391       jcr->JobStatus = jstat;
 392       dir_send_job_status(jcr);
 393
 394       stat = wait_for_sysop(dcr);
 395       if (dev->poll) {
 396          Dmsg1(200, "Poll timeout in create append vol on device %s\n", dev_name(dev));
 397          continue;
 398       }
 399
 400       if (stat == ETIMEDOUT) {
 401          if (!double_dev_wait_time(dev)) {
 402             Mmsg(dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
 403                dev_name(dev), jcr->Job);
 404             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 405             Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
 406             return false;             /* exceeded maximum waits */
 407          }
 408          continue;
 409       }
 410       if (stat == EINVAL) {
 411          Mmsg2(dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
 412                stat, strerror(stat));
 413          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 414          return false;
 415       }
 416       if (stat != 0) {
 417          Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
 418             strerror(stat));
 419       }
 420       Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
 421
 422       /* If no VolumeName, and cannot get one, try again */
 423       if (jcr->VolumeName[0] == 0 && !job_canceled(jcr) &&
 424           !dir_find_next_appendable_volume(dcr)) {
 425          Jmsg(jcr, M_MOUNT, 0, _(
 426 "Someone woke me up, but I cannot find any appendable\n\
 427 volumes for Job=%s.\n"), jcr->Job);
 428          /* Restart wait counters after user interaction */
 429          init_dev_wait_timers(dev);
 430          continue;
 431       }
 432       unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
 433                   (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 434       if (unmounted) {
 435          continue;                    /* continue to wait */
 436       }
 437
 438       /*
 439        * Device mounted, we have a volume, break and return
 440        */
 441       break;
 442    }
 443    set_jcr_job_status(jcr, JS_Running);
 444    dir_send_job_status(jcr);
 445    Dmsg0(130, "leave dir_ask_sysop_to_mount_create_appendable_volume\n");
 446    return true;
 447 }
 448
 449 /*
 450  *   Request to mount specific Volume
 451  *
 452  *   Entered with device blocked and jcr->VolumeName is desired
 453  *      volume.
 454  *   Leaves with device blocked.
 455  *
 456  *   Returns: 1 on success (operator issues a mount command)
 457  *            0 on failure
 458  *              Note, must create dev->errmsg on error return.
 459  *
 460  */
 461 bool dir_ask_sysop_to_mount_volume(DCR *dcr)
 462 {
 463    int stat = 0;
 464    const char *msg;
 465    DEVICE *dev = dcr->dev;
 466    JCR *jcr = dcr->jcr;
 467
 468    Dmsg0(130, "enter dir_ask_sysop_to_mount_volume\n");
 469    if (!jcr->VolumeName[0]) {
 470       Mmsg0(dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
 471       return 0;
 472    }
 473    ASSERT(dev->dev_blocked);
 474    for ( ;; ) {
 475       if (job_canceled(jcr)) {
 476          Mmsg(dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
 477               jcr->Job, jcr->dev_name);
 478          return false;
 479       }
 480
 481       if (!dev->poll) {
 482          msg = _("Please mount");
 483          Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device \"%s\" for Job %s\n"),
 484               msg, jcr->VolumeName, jcr->dev_name, jcr->Job);
 485          Dmsg3(190, "Mount %s on %s for Job %s\n",
 486                jcr->VolumeName, jcr->dev_name, jcr->Job);
 487       }
 488
 489       jcr->JobStatus = JS_WaitMount;
 490       dir_send_job_status(jcr);
 491
 492       stat = wait_for_sysop(dcr);    ;     /* wait on device */
 493       if (dev->poll) {
 494          Dmsg1(200, "Poll timeout in mount vol on device %s\n", dev_name(dev));
 495          Dmsg1(200, "Blocked=%d\n", dev->dev_blocked);
 496          return true;
 497       }
 498
 499       if (stat == ETIMEDOUT) {
 500          if (!double_dev_wait_time(dev)) {
 501             Mmsg(dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
 502                dev_name(dev), jcr->Job);
 503             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 504             Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
 505             return false;             /* exceeded maximum waits */
 506          }
 507          continue;
 508       }
 509       if (stat == EINVAL) {
 510          Mmsg2(dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
 511                stat, strerror(stat));
 512          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 513          return false;
 514       }
 515       if (stat != 0) {
 516          Jmsg(jcr, M_ERROR, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
 517             strerror(stat));
 518       }
 519       Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
 520       break;
 521    }
 522    set_jcr_job_status(jcr, JS_Running);
 523    dir_send_job_status(jcr);
 524    Dmsg0(130, "leave dir_ask_sysop_to_mount_volume\n");
 525    return true;
 526 }
 527
 528 /*
 529  * Wait for SysOp to mount a tape
 530  */
 531 static int wait_for_sysop(DCR *dcr)
 532 {
 533    struct timeval tv;
 534    struct timezone tz;
 535    struct timespec timeout;
 536    time_t last_heartbeat = 0;
 537    time_t first_start = time(NULL);
 538    int stat = 0;
 539    int add_wait;
 540    bool unmounted;
 541    DEVICE *dev = dcr->dev;
 542    JCR *jcr = dcr->jcr;
 543
 544    P(dev->mutex);
 545    unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
 546                 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 547
 548    dev->poll = false;
 549    /*
 550     * Wait requested time (dev->rem_wait_sec).  However, we also wake up every
 551     *    HB_TIME seconds and send a heartbeat to the FD and the Director
 552     *    to keep stateful firewalls from closing them down while waiting
 553     *    for the operator.
 554     */
 555    add_wait = dev->rem_wait_sec;
 556    if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
 557       add_wait = me->heartbeat_interval;
 558    }
 559    if (!unmounted && dev->vol_poll_interval && add_wait > dev->vol_poll_interval) {
 560       add_wait = dev->vol_poll_interval;
 561    }
 562    gettimeofday(&tv, &tz);
 563    timeout.tv_nsec = tv.tv_usec * 1000;
 564    timeout.tv_sec = tv.tv_sec + add_wait;
 565
 566    if (!unmounted) {
 567       dev->dev_prev_blocked = dev->dev_blocked;
 568       dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
 569    }
 570
 571    for ( ; !job_canceled(jcr); ) {
 572       time_t now, start;
 573
 574       Dmsg3(100, "I'm going to sleep on device %s. HB=%d wait=%d\n", dev_name(dev),
 575          (int)me->heartbeat_interval, dev->wait_sec);
 576       start = time(NULL);
 577       stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
 578       Dmsg1(100, "Wokeup from sleep on device stat=%d\n", stat);
 579
 580       now = time(NULL);
 581       dev->rem_wait_sec -= (now - start);
 582
 583       /* Note, this always triggers the first time. We want that. */
 584       if (me->heartbeat_interval) {
 585          if (now - last_heartbeat >= me->heartbeat_interval) {
 586             /* send heartbeats */
 587             if (jcr->file_bsock) {
 588                bnet_sig(jcr->file_bsock, BNET_HEARTBEAT);
 589                Dmsg0(100, "Send heartbeat to FD.\n");
 590             }
 591             if (jcr->dir_bsock) {
 592                bnet_sig(jcr->dir_bsock, BNET_HEARTBEAT);
 593             }
 594             last_heartbeat = now;
 595          }
 596       }
 597
 598       /*
 599        * Check if user unmounted the device while we were waiting
 600        */
 601       unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
 602                    (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
 603
 604       if (stat != ETIMEDOUT) {     /* we blocked the device */
 605          break;                    /* on error return */
 606       }
 607       if (dev->rem_wait_sec <= 0) {  /* on exceeding wait time return */
 608          Dmsg0(100, "Exceed wait time.\n");
 609          break;
 610       }
 611
 612       if (!unmounted && dev->vol_poll_interval &&
 613           (now - first_start >= dev->vol_poll_interval)) {
 614          Dmsg1(200, "In wait blocked=%d\n", dev->dev_blocked);
 615          dev->poll = true;
 616          break;
 617       }
 618       /*
 619        * Check if user mounted the device while we were waiting
 620        */
 621       if (dev->dev_blocked == BST_MOUNT) {   /* mount request ? */
 622          stat = 0;
 623          break;
 624       }
 625
 626       add_wait = dev->wait_sec - (now - start);
 627       if (add_wait < 0) {
 628          add_wait = 0;
 629       }
 630       if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
 631          add_wait = me->heartbeat_interval;
 632       }
 633       gettimeofday(&tv, &tz);
 634       timeout.tv_nsec = tv.tv_usec * 1000;
 635       timeout.tv_sec = tv.tv_sec + add_wait; /* additional wait */
 636       Dmsg1(100, "Additional wait %d sec.\n", add_wait);
 637    }
 638
 639    if (!unmounted) {
 640       dev->dev_blocked = dev->dev_prev_blocked;    /* restore entry state */
 641    }
 642    V(dev->mutex);
 643    return stat;
 644 }