git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/msgchan.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version three of the GNU Affero 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 Affero General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *
  30  *   Bacula Director -- msgchan.c -- handles the message channel
  31  *    to the Storage daemon and the File daemon.
  32  *
  33  *     Kern Sibbald, August MM
  34  *
  35  *    This routine runs as a thread and must be thread reentrant.
  36  *
  37  *  Basic tasks done here:
  38  *    Open a message channel with the Storage daemon
  39  *      to authenticate ourself and to pass the JobId.
  40  *    Create a thread to interact with the Storage daemon
  41  *      who returns a job status and requests Catalog services, etc.
  42  *
  43  */
  44
  45 #include "bacula.h"
  46 #include "dird.h"
  47
  48 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  49
  50 /* Commands sent to Storage daemon */
  51 static char jobcmd[]     = "JobId=%s job=%s job_name=%s client_name=%s "
  52    "type=%d level=%d FileSet=%s NoAttr=%d SpoolAttr=%d FileSetMD5=%s "
  53    "SpoolData=%d WritePartAfterJob=%d PreferMountedVols=%d SpoolSize=%s "
  54    "Resched=%d\n";
  55 static char use_storage[] = "use storage=%s media_type=%s pool_name=%s "
  56    "pool_type=%s append=%d copy=%d stripe=%d\n";
  57 static char use_device[] = "use device=%s\n";
  58 //static char query_device[] = _("query device=%s");
  59
  60 /* Response from Storage daemon */
  61 static char OKjob[]      = "3000 OK Job SDid=%d SDtime=%d Authorization=%100s\n";
  62 static char OK_device[]  = "3000 OK use device device=%s\n";
  63
  64 /* Storage Daemon requests */
  65 static char Job_start[]  = "3010 Job %127s start\n";
  66 static char Job_end[]    =
  67    "3099 Job %127s end JobStatus=%d JobFiles=%d JobBytes=%lld JobErrors=%u\n";
  68
  69 /* Forward referenced functions */
  70 extern "C" void *msg_thread(void *arg);
  71
  72 /*
  73  * Establish a message channel connection with the Storage daemon
  74  * and perform authentication.
  75  */
  76 bool connect_to_storage_daemon(JCR *jcr, int retry_interval,
  77                               int max_retry_time, int verbose)
  78 {
  79    BSOCK *sd = new_bsock();
  80    STORE *store;
  81    utime_t heart_beat;
  82
  83    if (jcr->store_bsock) {
  84       return true;                    /* already connected */
  85    }
  86
  87    /* If there is a write storage use it */
  88    if (jcr->wstore) {
  89       store = jcr->wstore;
  90    } else {
  91       store = jcr->rstore;
  92    }
  93
  94    if (store->heartbeat_interval) {
  95       heart_beat = store->heartbeat_interval;
  96    } else {
  97       heart_beat = director->heartbeat_interval;
  98    }
  99
 100    /*
 101     *  Open message channel with the Storage daemon
 102     */
 103    Dmsg2(100, "bnet_connect to Storage daemon %s:%d\n", store->address,
 104       store->SDport);
 105    sd->set_source_address(director->DIRsrc_addr);
 106    if (!sd->connect(jcr, retry_interval, max_retry_time, heart_beat, _("Storage daemon"),
 107          store->address, NULL, store->SDport, verbose)) {
 108       sd->destroy();
 109       sd = NULL;
 110    }
 111
 112    if (sd == NULL) {
 113       return false;
 114    }
 115    sd->res = (RES *)store;        /* save pointer to other end */
 116    jcr->store_bsock = sd;
 117
 118    if (!authenticate_storage_daemon(jcr, store)) {
 119       sd->close();
 120       jcr->store_bsock = NULL;
 121       return false;
 122    }
 123    return true;
 124 }
 125
 126 /*
 127  * Here we ask the SD to send us the info for a
 128  *  particular device resource.
 129  */
 130 #ifdef xxx
 131 bool update_device_res(JCR *jcr, DEVICE *dev)
 132 {
 133    POOL_MEM device_name;
 134    BSOCK *sd;
 135    if (!connect_to_storage_daemon(jcr, 5, 30, 0)) {
 136       return false;
 137    }
 138    sd = jcr->store_bsock;
 139    pm_strcpy(device_name, dev->name());
 140    bash_spaces(device_name);
 141    sd->fsend(query_device, device_name.c_str());
 142    Dmsg1(100, ">stored: %s\n", sd->msg);
 143    /* The data is returned through Device_update */
 144    if (bget_dirmsg(sd) <= 0) {
 145       return false;
 146    }
 147    return true;
 148 }
 149 #endif
 150
 151 static char OKbootstrap[] = "3000 OK bootstrap\n";
 152
 153 /*
 154  * Start a job with the Storage daemon
 155  */
 156 bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore, bool send_bsr)
 157 {
 158    bool ok = true;
 159    STORE *storage;
 160    BSOCK *sd;
 161    char auth_key[100];
 162    POOL_MEM store_name, device_name, pool_name, pool_type, media_type;
 163    POOL_MEM job_name, client_name, fileset_name;
 164    int copy = 0;
 165    int stripe = 0;
 166    char ed1[30], ed2[30];
 167
 168    sd = jcr->store_bsock;
 169    /*
 170     * Now send JobId and permissions, and get back the authorization key.
 171     */
 172    pm_strcpy(job_name, jcr->job->name());
 173    bash_spaces(job_name);
 174    pm_strcpy(client_name, jcr->client->name());
 175    bash_spaces(client_name);
 176    pm_strcpy(fileset_name, jcr->fileset->name());
 177    bash_spaces(fileset_name);
 178    if (jcr->fileset->MD5[0] == 0) {
 179       bstrncpy(jcr->fileset->MD5, "**Dummy**", sizeof(jcr->fileset->MD5));
 180    }
 181    /* If rescheduling, cancel the previous incarnation of this job
 182     *  with the SD, which might be waiting on the FD connection.
 183     *  If we do not cancel it the SD will not accept a new connection
 184     *  for the same jobid.
 185     */
 186    if (jcr->reschedule_count) {
 187       sd->fsend("cancel Job=%s\n", jcr->Job);
 188       while (sd->recv() >= 0)
 189          { }
 190    }
 191    sd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job,
 192              job_name.c_str(), client_name.c_str(),
 193              jcr->getJobType(), jcr->getJobLevel(),
 194              fileset_name.c_str(), !jcr->pool->catalog_files,
 195              jcr->job->SpoolAttributes, jcr->fileset->MD5, jcr->spool_data,
 196              jcr->write_part_after_job, jcr->job->PreferMountedVolumes,
 197              edit_int64(jcr->spool_size, ed2));
 198    Dmsg1(100, ">stored: %s", sd->msg);
 199    if (bget_dirmsg(sd) > 0) {
 200        Dmsg1(100, "<stored: %s", sd->msg);
 201        if (sscanf(sd->msg, OKjob, &jcr->VolSessionId,
 202                   &jcr->VolSessionTime, &auth_key) != 3) {
 203           Dmsg1(100, "BadJob=%s\n", sd->msg);
 204           Jmsg(jcr, M_FATAL, 0, _("Storage daemon rejected Job command: %s\n"), sd->msg);
 205           return false;
 206        } else {
 207           bfree_and_null(jcr->sd_auth_key);
 208           jcr->sd_auth_key = bstrdup(auth_key);
 209           Dmsg1(150, "sd_auth_key=%s\n", jcr->sd_auth_key);
 210        }
 211    } else {
 212       Jmsg(jcr, M_FATAL, 0, _("<stored: bad response to Job command: %s\n"),
 213          sd->bstrerror());
 214       return false;
 215    }
 216
 217    if (send_bsr && (!send_bootstrap_file(jcr, sd) ||
 218        !response(jcr, sd, OKbootstrap, "Bootstrap", DISPLAY_ERROR))) {
 219       return false;
 220    }
 221
 222    /*
 223     * We have two loops here. The first comes from the
 224     *  Storage = associated with the Job, and we need
 225     *  to attach to each one.
 226     * The inner loop loops over all the alternative devices
 227     *  associated with each Storage. It selects the first
 228     *  available one.
 229     *
 230     */
 231    /* Do read side of storage daemon */
 232    if (ok && rstore) {
 233       /* For the moment, only migrate, copy and vbackup have rpool */
 234       if (jcr->getJobType() == JT_MIGRATE || jcr->getJobType() == JT_COPY ||
 235            (jcr->getJobType() == JT_BACKUP && jcr->getJobLevel() == L_VIRTUAL_FULL)) {
 236          pm_strcpy(pool_type, jcr->rpool->pool_type);
 237          pm_strcpy(pool_name, jcr->rpool->name());
 238       } else {
 239          pm_strcpy(pool_type, jcr->pool->pool_type);
 240          pm_strcpy(pool_name, jcr->pool->name());
 241       }
 242       bash_spaces(pool_type);
 243       bash_spaces(pool_name);
 244       foreach_alist(storage, rstore) {
 245          Dmsg1(100, "Rstore=%s\n", storage->name());
 246          pm_strcpy(store_name, storage->name());
 247          bash_spaces(store_name);
 248          pm_strcpy(media_type, storage->media_type);
 249          bash_spaces(media_type);
 250          sd->fsend(use_storage, store_name.c_str(), media_type.c_str(),
 251                    pool_name.c_str(), pool_type.c_str(), 0, copy, stripe);
 252          Dmsg1(100, "rstore >stored: %s", sd->msg);
 253          DEVICE *dev;
 254          /* Loop over alternative storage Devices until one is OK */
 255          foreach_alist(dev, storage->device) {
 256             pm_strcpy(device_name, dev->name());
 257             bash_spaces(device_name);
 258             sd->fsend(use_device, device_name.c_str());
 259             Dmsg1(100, ">stored: %s", sd->msg);
 260          }
 261          sd->signal(BNET_EOD);           /* end of Devices */
 262       }
 263       sd->signal(BNET_EOD);              /* end of Storages */
 264       if (bget_dirmsg(sd) > 0) {
 265          Dmsg1(100, "<stored: %s", sd->msg);
 266          /* ****FIXME**** save actual device name */
 267          ok = sscanf(sd->msg, OK_device, device_name.c_str()) == 1;
 268       } else {
 269          ok = false;
 270       }
 271    }
 272
 273    /* Do write side of storage daemon */
 274    if (ok && wstore) {
 275       pm_strcpy(pool_type, jcr->pool->pool_type);
 276       pm_strcpy(pool_name, jcr->pool->name());
 277       bash_spaces(pool_type);
 278       bash_spaces(pool_name);
 279       foreach_alist(storage, wstore) {
 280          pm_strcpy(store_name, storage->name());
 281          bash_spaces(store_name);
 282          pm_strcpy(media_type, storage->media_type);
 283          bash_spaces(media_type);
 284          sd->fsend(use_storage, store_name.c_str(), media_type.c_str(),
 285                    pool_name.c_str(), pool_type.c_str(), 1, copy, stripe);
 286
 287          Dmsg1(100, "wstore >stored: %s", sd->msg);
 288          DEVICE *dev;
 289          /* Loop over alternative storage Devices until one is OK */
 290          foreach_alist(dev, storage->device) {
 291             pm_strcpy(device_name, dev->name());
 292             bash_spaces(device_name);
 293             sd->fsend(use_device, device_name.c_str());
 294             Dmsg1(100, ">stored: %s", sd->msg);
 295          }
 296          sd->signal(BNET_EOD);           /* end of Devices */
 297       }
 298       sd->signal(BNET_EOD);              /* end of Storages */
 299       if (bget_dirmsg(sd) > 0) {
 300          Dmsg1(100, "<stored: %s", sd->msg);
 301          /* ****FIXME**** save actual device name */
 302          ok = sscanf(sd->msg, OK_device, device_name.c_str()) == 1;
 303       } else {
 304          ok = false;
 305       }
 306    }
 307    if (!ok) {
 308       POOL_MEM err_msg;
 309       if (sd->msg[0]) {
 310          pm_strcpy(err_msg, sd->msg); /* save message */
 311          Jmsg(jcr, M_FATAL, 0, _("\n"
 312               "     Storage daemon didn't accept Device \"%s\" because:\n     %s"),
 313               device_name.c_str(), err_msg.c_str()/* sd->msg */);
 314       } else {
 315          Jmsg(jcr, M_FATAL, 0, _("\n"
 316               "     Storage daemon didn't accept Device \"%s\" command.\n"),
 317               device_name.c_str());
 318       }
 319    } else {
 320       Jmsg(jcr, M_INFO, 0, _("Using Device \"%s\"\n"), device_name.c_str());
 321    }
 322    return ok;
 323 }
 324
 325 /*
 326  * Start a thread to handle Storage daemon messages and
 327  *  Catalog requests.
 328  */
 329 bool start_storage_daemon_message_thread(JCR *jcr)
 330 {
 331    int status;
 332    pthread_t thid;
 333
 334    jcr->inc_use_count();              /* mark in use by msg thread */
 335    jcr->sd_msg_thread_done = false;
 336    jcr->SD_msg_chan = 0;
 337    Dmsg0(100, "Start SD msg_thread.\n");
 338    if ((status=pthread_create(&thid, NULL, msg_thread, (void *)jcr)) != 0) {
 339       berrno be;
 340       Jmsg1(jcr, M_ABORT, 0, _("Cannot create message thread: %s\n"), be.bstrerror(status));
 341    }
 342    /* Wait for thread to start */
 343    while (jcr->SD_msg_chan == 0) {
 344       bmicrosleep(0, 50);
 345       if (job_canceled(jcr) || jcr->sd_msg_thread_done) {
 346          return false;
 347       }
 348    }
 349    Dmsg1(100, "SD msg_thread started. use=%d\n", jcr->use_count());
 350    return true;
 351 }
 352
 353 extern "C" void msg_thread_cleanup(void *arg)
 354 {
 355    JCR *jcr = (JCR *)arg;
 356    db_end_transaction(jcr, jcr->db);       /* terminate any open transaction */
 357    jcr->lock();
 358    jcr->sd_msg_thread_done = true;
 359    jcr->SD_msg_chan = 0;
 360    jcr->unlock();
 361    pthread_cond_broadcast(&jcr->term_wait); /* wakeup any waiting threads */
 362    Dmsg2(100, "=== End msg_thread. JobId=%d usecnt=%d\n", jcr->JobId, jcr->use_count());
 363    free_jcr(jcr);                     /* release jcr */
 364    db_thread_cleanup();               /* remove thread specific data */
 365 }
 366
 367 /*
 368  * Handle the message channel (i.e. requests from the
 369  *  Storage daemon).
 370  * Note, we are running in a separate thread.
 371  */
 372 extern "C" void *msg_thread(void *arg)
 373 {
 374    JCR *jcr = (JCR *)arg;
 375    BSOCK *sd;
 376    int JobStatus;
 377    char Job[MAX_NAME_LENGTH];
 378    uint32_t JobFiles, JobErrors;
 379    uint64_t JobBytes;
 380
 381    pthread_detach(pthread_self());
 382    set_jcr_in_tsd(jcr);
 383    jcr->SD_msg_chan = pthread_self();
 384    pthread_cleanup_push(msg_thread_cleanup, arg);
 385    sd = jcr->store_bsock;
 386
 387    /* Read the Storage daemon's output.
 388     */
 389    Dmsg0(100, "Start msg_thread loop\n");
 390    while (!job_canceled(jcr) && bget_dirmsg(sd) >= 0) {
 391       Dmsg1(400, "<stored: %s", sd->msg);
 392       if (sscanf(sd->msg, Job_start, Job) == 1) {
 393          continue;
 394       }
 395       if (sscanf(sd->msg, Job_end, Job, &JobStatus, &JobFiles,
 396                  &JobBytes, &JobErrors) == 5) {
 397          jcr->SDJobStatus = JobStatus; /* termination status */
 398          jcr->SDJobFiles = JobFiles;
 399          jcr->SDJobBytes = JobBytes;
 400          jcr->SDErrors = JobErrors;
 401          break;
 402       }
 403       Dmsg1(400, "end loop use=%d\n", jcr->use_count());
 404    }
 405    if (is_bnet_error(sd)) {
 406       jcr->SDJobStatus = JS_ErrorTerminated;
 407    }
 408    pthread_cleanup_pop(1);            /* remove and execute the handler */
 409    return NULL;
 410 }
 411
 412 void wait_for_storage_daemon_termination(JCR *jcr)
 413 {
 414    int cancel_count = 0;
 415    /* Now wait for Storage daemon to terminate our message thread */
 416    while (!jcr->sd_msg_thread_done) {
 417       struct timeval tv;
 418       struct timezone tz;
 419       struct timespec timeout;
 420
 421       gettimeofday(&tv, &tz);
 422       timeout.tv_nsec = 0;
 423       timeout.tv_sec = tv.tv_sec + 5; /* wait 5 seconds */
 424       Dmsg0(400, "I'm waiting for message thread termination.\n");
 425       P(mutex);
 426       pthread_cond_timedwait(&jcr->term_wait, &mutex, &timeout);
 427       V(mutex);
 428       if (job_canceled(jcr)) {
 429          if (jcr->SD_msg_chan) {
 430             jcr->store_bsock->set_timed_out();
 431             jcr->store_bsock->set_terminated();
 432             sd_msg_thread_send_signal(jcr, TIMEOUT_SIGNAL);
 433          }
 434          cancel_count++;
 435       }
 436       /* Give SD 30 seconds to clean up after cancel */
 437       if (cancel_count == 6) {
 438          break;
 439       }
 440    }
 441    set_jcr_job_status(jcr, JS_Terminated);
 442 }
 443
 444 /*
 445  * Send bootstrap file to Storage daemon.
 446  *  This is used for restore, verify VolumeToCatalog, migration,
 447  *    and copy Jobs.
 448  */
 449 bool send_bootstrap_file(JCR *jcr, BSOCK *sd)
 450 {
 451    FILE *bs;
 452    char buf[1000];
 453    const char *bootstrap = "bootstrap\n";
 454
 455    Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
 456    if (!jcr->RestoreBootstrap) {
 457       return true;
 458    }
 459    bs = fopen(jcr->RestoreBootstrap, "rb");
 460    if (!bs) {
 461       berrno be;
 462       Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
 463          jcr->RestoreBootstrap, be.bstrerror());
 464       set_jcr_job_status(jcr, JS_ErrorTerminated);
 465       return false;
 466    }
 467    sd->fsend(bootstrap);
 468    while (fgets(buf, sizeof(buf), bs)) {
 469       sd->fsend("%s", buf);
 470    }
 471    sd->signal(BNET_EOD);
 472    fclose(bs);
 473    if (jcr->unlink_bsr) {
 474       unlink(jcr->RestoreBootstrap);
 475       jcr->unlink_bsr = false;
 476    }
 477    return true;
 478 }
 479
 480
 481 #ifdef needed
 482 #define MAX_TRIES 30
 483 #define WAIT_TIME 2
 484 extern "C" void *device_thread(void *arg)
 485 {
 486    int i;
 487    JCR *jcr;
 488    DEVICE *dev;
 489
 490
 491    pthread_detach(pthread_self());
 492    jcr = new_control_jcr("*DeviceInit*", JT_SYSTEM);
 493    for (i=0; i < MAX_TRIES; i++) {
 494       if (!connect_to_storage_daemon(jcr, 10, 30, 1)) {
 495          Dmsg0(900, "Failed connecting to SD.\n");
 496          continue;
 497       }
 498       LockRes();
 499       foreach_res(dev, R_DEVICE) {
 500          if (!update_device_res(jcr, dev)) {
 501             Dmsg1(900, "Error updating device=%s\n", dev->name());
 502          } else {
 503             Dmsg1(900, "Updated Device=%s\n", dev->name());
 504          }
 505       }
 506       UnlockRes();
 507       bnet_close(jcr->store_bsock);
 508       jcr->store_bsock = NULL;
 509       break;
 510
 511    }
 512    free_jcr(jcr);
 513    return NULL;
 514 }
 515
 516 /*
 517  * Start a thread to handle getting Device resource information
 518  *  from SD. This is called once at startup of the Director.
 519  */
 520 void init_device_resources()
 521 {
 522    int status;
 523    pthread_t thid;
 524
 525    Dmsg0(100, "Start Device thread.\n");
 526    if ((status=pthread_create(&thid, NULL, device_thread, NULL)) != 0) {
 527       berrno be;
 528       Jmsg1(NULL, M_ABORT, 0, _("Cannot create message thread: %s\n"), be.bstrerror(status));
 529    }
 530 }
 531 #endif