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