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-2003 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\n";
  39
  40 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia \
  41  FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u \
  42  StartBlock=%u EndBlock=%u\n";
  43 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
  44 static char Job_status[]     = "3012 Job %s jobstatus %d\n";
  45
  46
  47 /* Responses received from the Director */
  48 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u\
  49  VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u\
  50  MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s\
  51  Slot=%d MaxVolJobs=%u MaxVolFiles=%u\n";
  52 static char OK_update[] = "1000 OK UpdateMedia\n";
  53
  54 /* Forward referenced functions */
  55 static int wait_for_sysop(JCR *jcr, DEVICE *dev, int wait_sec);
  56
  57 /*
  58  * Send current JobStatus to Director
  59  */
  60 int dir_send_job_status(JCR *jcr)
  61 {
  62    return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
  63 }
  64
  65 /*
  66  * Common routine for:
  67  *   dir_get_volume_info()
  68  * and
  69  *   dir_find_next_appendable_volume()
  70  */
  71 static int do_request_volume_info(JCR *jcr)
  72 {
  73     BSOCK *dir = jcr->dir_bsock;
  74     VOLUME_CAT_INFO vol;
  75
  76     jcr->VolumeName[0] = 0;           /* No volume */
  77     if (bnet_recv(dir) <= 0) {
  78        Dmsg0(200, "getvolname error bnet_recv\n");
  79        Mmsg(&jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
  80        return 0;
  81     }
  82     memset(&vol, 0, sizeof(vol));
  83     if (sscanf(dir->msg, OK_media, vol.VolCatName,
  84                &vol.VolCatJobs, &vol.VolCatFiles,
  85                &vol.VolCatBlocks, &vol.VolCatBytes,
  86                &vol.VolCatMounts, &vol.VolCatErrors,
  87                &vol.VolCatWrites, &vol.VolCatMaxBytes,
  88                &vol.VolCatCapacityBytes, vol.VolCatStatus,
  89                &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles) != 14) {
  90
  91        Dmsg1(200, "Bad response from Dir: %s\n", dir->msg);
  92        Mmsg(&jcr->errmsg, _("Error scanning Dir response: %s\n"), dir->msg);
  93        return 0;
  94     }
  95     unbash_spaces(vol.VolCatName);
  96     pm_strcpy(&jcr->VolumeName, vol.VolCatName); /* set desired VolumeName */
  97     memcpy(&jcr->VolCatInfo, &vol, sizeof(jcr->VolCatInfo));
  98
  99     Dmsg2(200, "do_reqest_vol_info got slot=%d Volume=%s\n",
 100           vol.Slot, vol.VolCatName);
 101     return 1;
 102 }
 103
 104
 105 /*
 106  * Get Volume info for a specific volume from the Director's Database
 107  *
 108  * Returns: 1 on success   (not Director guarantees that Pool and MediaType
 109  *                          are correct and VolStatus==Append or
 110  *                          VolStatus==Recycle)
 111  *          0 on failure
 112  *
 113  *          Volume information returned in jcr
 114  */
 115 int dir_get_volume_info(JCR *jcr, enum get_vol_info_rw writing)
 116 {
 117     BSOCK *dir = jcr->dir_bsock;
 118
 119     bstrncpy(jcr->VolCatInfo.VolCatName, jcr->VolumeName, sizeof(jcr->VolCatInfo.VolCatName));
 120     Dmsg1(200, "dir_get_volume_info=%s\n", jcr->VolCatInfo.VolCatName);
 121     bash_spaces(jcr->VolCatInfo.VolCatName);
 122     bnet_fsend(dir, Get_Vol_Info, jcr->Job, jcr->VolCatInfo.VolCatName,
 123        writing==GET_VOL_INFO_FOR_WRITE?1:0);
 124     return do_request_volume_info(jcr);
 125 }
 126
 127
 128
 129 /*
 130  * Get info on the next appendable volume in the Director's database
 131  * Returns: 1 on success
 132  *          0 on failure
 133  *
 134  *          Volume information returned in jcr
 135  *
 136  */
 137 int dir_find_next_appendable_volume(JCR *jcr)
 138 {
 139     BSOCK *dir = jcr->dir_bsock;
 140
 141     Dmsg0(200, "dir_find_next_appendable_volume\n");
 142     bnet_fsend(dir, Find_media, jcr->Job, 1);
 143     return do_request_volume_info(jcr);
 144 }
 145
 146
 147 /*
 148  * After writing a Volume, send the updated statistics
 149  * back to the director.
 150  */
 151 int dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int relabel)
 152 {
 153    BSOCK *dir = jcr->dir_bsock;
 154    time_t EndTime = time(NULL);
 155    char ed1[50], ed2[50];
 156
 157    if (vol->VolCatName[0] == 0) {
 158       Jmsg0(jcr, M_ERROR, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
 159       return 0;
 160    }
 161    bash_spaces(vol->VolCatName);
 162    bnet_fsend(dir, Update_media, jcr->Job,
 163       vol->VolCatName, vol->VolCatJobs, vol->VolCatFiles,
 164       vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
 165       vol->VolCatMounts, vol->VolCatErrors,
 166       vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
 167       EndTime, vol->VolCatStatus, vol->Slot, relabel);
 168    Dmsg1(120, "update_volume_data(): %s", dir->msg);
 169    unbash_spaces(vol->VolCatName);
 170    if (bnet_recv(dir) <= 0) {
 171       Dmsg0(190, "updateVolCatInfo error bnet_recv\n");
 172       Jmsg(jcr, M_ERROR, 0, _("Error updating Volume info Vol=\"%s\": ERR=%s\n"),
 173            vol->VolCatName, bnet_strerror(dir));
 174       return 0;
 175    }
 176    Dmsg1(120, "Updatevol: %s", dir->msg);
 177    if (strcmp(dir->msg, OK_update) != 0) {
 178       Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
 179       Jmsg(jcr, M_ERROR, 0, _("Error updating Volume info Vol=\"%s\": %s\n"),
 180            vol->VolCatName, dir->msg);
 181       return 0;
 182    }
 183    return 1;
 184 }
 185
 186 /*
 187  * After writing a Volume, create the JobMedia record.
 188  */
 189 int dir_create_jobmedia_record(JCR *jcr)
 190 {
 191    BSOCK *dir = jcr->dir_bsock;
 192
 193    if (!jcr->WroteVol) {
 194       return 1;                       /* nothing written to tape */
 195    }
 196
 197    jcr->WroteVol = false;
 198    bnet_fsend(dir, Create_job_media, jcr->Job,
 199       jcr->VolFirstIndex, jcr->VolLastIndex,
 200       jcr->StartFile, jcr->EndFile,
 201       jcr->StartBlock, jcr->EndBlock);
 202    Dmsg1(100, "create_jobmedia(): %s", dir->msg);
 203    if (bnet_recv(dir) <= 0) {
 204       Dmsg0(190, "create_jobmedia error bnet_recv\n");
 205       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: ERR=%s\n"),
 206            bnet_strerror(dir));
 207       return 0;
 208    }
 209    Dmsg1(120, "Create_jobmedia: %s", dir->msg);
 210    if (strcmp(dir->msg, OK_update) != 0) {
 211       Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
 212       Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
 213       return 0;
 214    }
 215    return 1;
 216 }
 217
 218
 219 /*
 220  * Update File Attribute data
 221  */
 222 int dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec)
 223 {
 224    BSOCK *dir = jcr->dir_bsock;
 225    ser_declare;
 226
 227    dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
 228    dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
 229                 sizeof(DEV_RECORD) + rec->data_len);
 230    ser_begin(dir->msg + dir->msglen, 0);
 231    ser_uint32(rec->VolSessionId);
 232    ser_uint32(rec->VolSessionTime);
 233    ser_int32(rec->FileIndex);
 234    ser_int32(rec->Stream);
 235    ser_uint32(rec->data_len);
 236    ser_bytes(rec->data, rec->data_len);
 237    dir->msglen = ser_length(dir->msg);
 238    return bnet_send(dir);
 239 }
 240
 241
 242 /*
 243  *
 244  *   Entered with device blocked.
 245  *   Leaves with device blocked.
 246  *
 247  *   Returns: 1 on success (operator issues a mount command)
 248  *            0 on failure
 249  *              Note, must create dev->errmsg on error return.
 250  *
 251  *    On success, jcr->VolumeName and jcr->VolCatInfo contain
 252  *      information on suggested volume, but this may not be the
 253  *      same as what is actually mounted.
 254  *
 255  *    When we return with success, the correct tape may or may not
 256  *      actually be mounted. The calling routine must read it and
 257  *      verify the label.
 258  */
 259 int dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev)
 260 {
 261    int stat = 0, jstat;
 262    /* ******FIXME******* put these on config variable */
 263    int min_wait = 60 * 60;
 264    int max_wait = 24 * 60 * 60;
 265    int max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
 266
 267    int wait_sec;
 268    int num_wait = 0;
 269
 270    Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
 271    ASSERT(dev->dev_blocked);
 272    wait_sec = min_wait;
 273    for ( ;; ) {
 274       if (job_canceled(jcr)) {
 275          Mmsg(&dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
 276               jcr->Job, jcr->dev_name);
 277          Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
 278          return 0;
 279       }
 280       if (dir_find_next_appendable_volume(jcr)) {    /* get suggested volume */
 281          jstat = JS_WaitMount;
 282          /*
 283           * If we have a valid volume name and we are not
 284           * removable media, return now, otherwise wait
 285           * for the operator to mount the media.
 286           */
 287          if (jcr->VolumeName[0] && !dev_cap(dev, CAP_REM) && dev_cap(dev, CAP_LABEL)) {
 288             Dmsg0(190, "Return 1 from mount without wait.\n");
 289             return 1;
 290          }
 291          Jmsg(jcr, M_MOUNT, 0, _(
 292 "Please mount Volume \"%s\" on Storage Device \"%s\" for Job %s\n"
 293 "Use \"mount\" command to release Job.\n"),
 294               jcr->VolumeName, jcr->dev_name, jcr->Job);
 295          Dmsg3(190, "Mount %s on %s for Job %s\n",
 296                 jcr->VolumeName, jcr->dev_name, jcr->Job);
 297       } else {
 298          jstat = JS_WaitMedia;
 299          Jmsg(jcr, M_MOUNT, 0, _(
 300 "Job %s waiting. Cannot find any appendable volumes.\n\
 301 Please use the \"label\"  command to create a new Volume for:\n\
 302     Storage:      %s\n\
 303     Media type:   %s\n\
 304     Pool:         %s\n"),
 305               jcr->Job,
 306               jcr->dev_name,
 307               jcr->media_type,
 308               jcr->pool_name);
 309       }
 310
 311       jcr->JobStatus = jstat;
 312       dir_send_job_status(jcr);
 313
 314       stat = wait_for_sysop(jcr, dev, wait_sec);
 315
 316       if (stat == ETIMEDOUT) {
 317          wait_sec *= 2;               /* double wait time */
 318          if (wait_sec > max_wait) {   /* but not longer than maxtime */
 319             wait_sec = max_wait;
 320          }
 321          num_wait++;
 322          if (num_wait >= max_num_wait) {
 323             Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
 324                  jcr->dev_name, jcr->Job);
 325             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 326             Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
 327             return 0;                 /* exceeded maximum waits */
 328          }
 329          continue;
 330       }
 331       if (stat == EINVAL) {
 332          Mmsg2(&dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
 333                stat, strerror(stat));
 334          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 335          return 0;
 336       }
 337       if (stat != 0) {
 338          Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
 339             strerror(stat));
 340       }
 341       Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
 342
 343       /* Restart wait counters */
 344       wait_sec = min_wait;
 345       num_wait = 0;
 346       /* If no VolumeName, and cannot get one, try again */
 347       if (jcr->VolumeName[0] == 0 &&
 348           !dir_find_next_appendable_volume(jcr) && !job_canceled(jcr)) {
 349          Jmsg(jcr, M_MOUNT, 0, _(
 350 "Someone woke me up, but I cannot find any appendable\n\
 351 volumes for Job=%s.\n"), jcr->Job);
 352          continue;
 353       }
 354       break;
 355    }
 356    set_jcr_job_status(jcr, JS_Running);
 357    dir_send_job_status(jcr);
 358    Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
 359    return 1;
 360 }
 361
 362 /*
 363  *
 364  *   Entered with device blocked and jcr->VolumeName is desired
 365  *      volume.
 366  *   Leaves with device blocked.
 367  *
 368  *   Returns: 1 on success (operator issues a mount command)
 369  *            0 on failure
 370  *              Note, must create dev->errmsg on error return.
 371  *
 372  */
 373 int dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev)
 374 {
 375    int stat = 0;
 376    /* ******FIXME******* put these on config variable */
 377    int min_wait = 60 * 60;
 378    int max_wait = 24 * 60 * 60;
 379    int max_num_wait = 9;              /* 5 waits =~ 1 day, then 1 day at a time */
 380    int wait_sec;
 381    int num_wait = 0;
 382    char *msg;
 383
 384    Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
 385    if (!jcr->VolumeName[0]) {
 386       Mmsg0(&dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
 387       return 0;
 388    }
 389    ASSERT(dev->dev_blocked);
 390    wait_sec = min_wait;
 391    for ( ;; ) {
 392       if (job_canceled(jcr)) {
 393          Mmsg(&dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
 394               jcr->Job, jcr->dev_name);
 395          return 0;
 396       }
 397       msg = _("Please mount");
 398       Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device \"%s\" for Job %s\n"),
 399            msg, jcr->VolumeName, jcr->dev_name, jcr->Job);
 400       Dmsg3(190, "Mount %s on %s for Job %s\n",
 401             jcr->VolumeName, jcr->dev_name, jcr->Job);
 402
 403       jcr->JobStatus = JS_WaitMount;
 404       dir_send_job_status(jcr);
 405
 406       stat = wait_for_sysop(jcr, dev, wait_sec); /* wait on device */
 407
 408       if (stat == ETIMEDOUT) {
 409          wait_sec *= 2;               /* double wait time */
 410          if (wait_sec > max_wait) {   /* but not longer than maxtime */
 411             wait_sec = max_wait;
 412          }
 413          num_wait++;
 414          if (num_wait >= max_num_wait) {
 415             Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
 416                  jcr->dev_name, jcr->Job);
 417             Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 418             Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
 419             return 0;                 /* exceeded maximum waits */
 420          }
 421          continue;
 422       }
 423       if (stat == EINVAL) {
 424          Mmsg2(&dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
 425                stat, strerror(stat));
 426          Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
 427          return 0;
 428       }
 429       if (stat != 0) {
 430          Jmsg(jcr, M_ERROR, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
 431             strerror(stat));
 432       }
 433       Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
 434
 435       /* Restart wait counters */
 436       wait_sec = min_wait;
 437       num_wait = 0;
 438       break;
 439    }
 440    set_jcr_job_status(jcr, JS_Running);
 441    dir_send_job_status(jcr);
 442    Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
 443    return 1;
 444 }
 445
 446 /*
 447  * Wait for SysOp to mount a tape
 448  */
 449 static int wait_for_sysop(JCR *jcr, DEVICE *dev, int wait_sec)
 450 {
 451    struct timeval tv;
 452    struct timezone tz;
 453    struct timespec timeout;
 454    int dev_blocked;
 455    time_t start = time(NULL);
 456    time_t last_heartbeat = 0;
 457    int stat = 0;
 458    int add_wait;
 459
 460    /*
 461     * Wait requested time (wait_sec).  However, we also wake up every
 462     *    HB_TIME seconds and send a heartbeat to the FD and the Director
 463     *    to keep stateful firewalls from closing them down while waiting
 464     *    for the operator.
 465     */
 466    add_wait = wait_sec;
 467    if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
 468       add_wait = me->heartbeat_interval;
 469    }
 470    gettimeofday(&tv, &tz);
 471    timeout.tv_nsec = tv.tv_usec * 1000;
 472    timeout.tv_sec = tv.tv_sec + add_wait;
 473
 474    P(dev->mutex);
 475    dev_blocked = dev->dev_blocked;
 476    dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
 477
 478    for ( ; !job_canceled(jcr); ) {
 479       time_t now;
 480
 481       Dmsg3(100, "I'm going to sleep on device %s. HB=%d wait=%d\n", dev_name(dev),
 482          (int)me->heartbeat_interval, wait_sec);
 483       stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
 484       Dmsg1(100, "Wokeup from sleep on device stat=%d\n", stat);
 485
 486       now = time(NULL);
 487
 488       /* Note, this always triggers the first time. We want that. */
 489       if (me->heartbeat_interval) {
 490          if (now - last_heartbeat >= me->heartbeat_interval) {
 491             /* send heartbeats */
 492             if (jcr->file_bsock) {
 493                bnet_sig(jcr->file_bsock, BNET_HEARTBEAT);
 494                Dmsg0(100, "Send heartbeat to FD.\n");
 495             }
 496             if (jcr->dir_bsock) {
 497                bnet_sig(jcr->dir_bsock, BNET_HEARTBEAT);
 498             }
 499             last_heartbeat = now;
 500          }
 501       }
 502
 503       if (dev->dev_blocked == BST_MOUNT) {   /* mount request ? */
 504          stat = 0;
 505          break;
 506       }
 507
 508       if (stat != ETIMEDOUT) {     /* we blocked the device */
 509          break;                    /* on error return */
 510       }
 511       if (now - start >= wait_sec) {  /* on exceeding wait time return */
 512          Dmsg0(100, "Exceed wait time.\n");
 513          break;
 514       }
 515       add_wait = wait_sec - (now - start);
 516       if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
 517          add_wait = me->heartbeat_interval;
 518       }
 519       gettimeofday(&tv, &tz);
 520       timeout.tv_nsec = tv.tv_usec * 1000;
 521       timeout.tv_sec = tv.tv_sec + add_wait; /* additional wait */
 522       Dmsg1(100, "Additional wait %d sec.\n", add_wait);
 523    }
 524
 525    dev->dev_blocked = dev_blocked;
 526    V(dev->mutex);
 527    return stat;
 528 }