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

   1 /*
   2  *
   3  *   Bacula Director -- backup.c -- responsible for doing backup jobs
   4  *
   5  *     Kern Sibbald, March MM
   6  *
   7  *  Basic tasks done here:
   8  *     Open DB and create records for this job.
   9  *     Open Message Channel with Storage daemon to tell him a job will be starting.
  10  *     Open connection with File daemon and pass him commands
  11  *       to do the backup.
  12  *     When the File daemon finishes the job, update the DB.
  13  *
  14  *   Version $Id$
  15  */
  16
  17 /*
  18    Copyright (C) 2000-2005 Kern Sibbald
  19
  20    This program is free software; you can redistribute it and/or
  21    modify it under the terms of the GNU General Public License as
  22    published by the Free Software Foundation; either version 2 of
  23    the License, or (at your option) any later version.
  24
  25    This program is distributed in the hope that it will be useful,
  26    but WITHOUT ANY WARRANTY; without even the implied warranty of
  27    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  28    General Public License for more details.
  29
  30    You should have received a copy of the GNU General Public
  31    License along with this program; if not, write to the Free
  32    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  33    MA 02111-1307, USA.
  34
  35  */
  36
  37 #include "bacula.h"
  38 #include "dird.h"
  39 #include "ua.h"
  40
  41 /* Commands sent to File daemon */
  42 static char backupcmd[] = "backup\n";
  43 static char storaddr[]  = "storage address=%s port=%d ssl=%d\n";
  44
  45 /* Responses received from File daemon */
  46 static char OKbackup[]   = "2000 OK backup\n";
  47 static char OKstore[]    = "2000 OK storage\n";
  48 static char EndJob[]     = "2800 End Job TermCode=%d JobFiles=%u "
  49                            "ReadBytes=%lld JobBytes=%lld Errors=%u\n";
  50
  51 /*
  52  * Called here before the job is run to do the job
  53  *   specific setup.
  54  */
  55 bool do_backup_init(JCR *jcr)
  56 {
  57    FILESET_DBR fsr;
  58    POOL_DBR pr;
  59    /*
  60     * Get the Pool record -- first apply any level defined pools
  61     */
  62    switch (jcr->JobLevel) {
  63    case L_FULL:
  64       if (jcr->full_pool) {
  65          jcr->pool = jcr->full_pool;
  66       }
  67       break;
  68    case L_INCREMENTAL:
  69       if (jcr->inc_pool) {
  70          jcr->pool = jcr->inc_pool;
  71       }
  72       break;
  73    case L_DIFFERENTIAL:
  74       if (jcr->dif_pool) {
  75          jcr->pool = jcr->dif_pool;
  76       }
  77       break;
  78    }
  79    memset(&pr, 0, sizeof(pr));
  80    bstrncpy(pr.Name, jcr->pool->hdr.name, sizeof(pr.Name));
  81
  82    if (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
  83       /* Try to create the pool */
  84       if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
  85          Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
  86             db_strerror(jcr->db));
  87          return false;
  88       } else {
  89          Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
  90          if (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
  91             Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
  92                db_strerror(jcr->db));
  93             return false;
  94          }
  95       }
  96    }
  97    jcr->PoolId = pr.PoolId;               /****FIXME**** this can go away */
  98    jcr->jr.PoolId = pr.PoolId;
  99
 100    if (!get_or_create_fileset_record(jcr, &fsr)) {
 101       return false;
 102    }
 103    bstrncpy(jcr->FSCreateTime, fsr.cCreateTime, sizeof(jcr->FSCreateTime));
 104
 105    get_level_since_time(jcr, jcr->since, sizeof(jcr->since));
 106
 107    Dmsg2(900, "cloned=%d run_cmds=%p\n", jcr->cloned, jcr->job->run_cmds);
 108    if (!jcr->cloned && jcr->job->run_cmds) {
 109       char *runcmd;
 110       JOB *job = jcr->job;
 111       POOLMEM *cmd = get_pool_memory(PM_FNAME);
 112       UAContext *ua = new_ua_context(jcr);
 113       ua->batch = true;
 114       foreach_alist(runcmd, job->run_cmds) {
 115          cmd = edit_job_codes(jcr, cmd, runcmd, "");
 116          Mmsg(ua->cmd, "run %s cloned=yes", cmd);
 117          Dmsg1(900, "=============== Clone cmd=%s\n", ua->cmd);
 118          parse_ua_args(ua);                 /* parse command */
 119          int stat = run_cmd(ua, ua->cmd);
 120          if (stat == 0) {
 121             Jmsg(jcr, M_ERROR, 0, _("Could not start clone job.\n"));
 122          } else {
 123             Jmsg(jcr, M_INFO, 0, _("Clone JobId %d started.\n"), stat);
 124          }
 125       }
 126       free_ua_context(ua);
 127       free_pool_memory(cmd);
 128    }
 129
 130    return true;
 131 }
 132
 133 /*
 134  * Do a backup of the specified FileSet
 135  *
 136  *  Returns:  false on failure
 137  *            true  on success
 138  */
 139 bool do_backup(JCR *jcr)
 140 {
 141    int stat;
 142    BSOCK   *fd;
 143    STORE *store;
 144
 145
 146    /* Print Job Start message */
 147    Jmsg(jcr, M_INFO, 0, _("Start Backup JobId %u, Job=%s\n"),
 148         jcr->JobId, jcr->Job);
 149
 150    set_jcr_job_status(jcr, JS_Running);
 151    Dmsg2(100, "JobId=%d JobLevel=%c\n", jcr->jr.JobId, jcr->jr.JobLevel);
 152    if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 153       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 154       return false;
 155    }
 156
 157    /*
 158     * Open a message channel connection with the Storage
 159     * daemon. This is to let him know that our client
 160     * will be contacting him for a backup  session.
 161     *
 162     */
 163    Dmsg0(110, "Open connection with storage daemon\n");
 164    set_jcr_job_status(jcr, JS_WaitSD);
 165    /*
 166     * Start conversation with Storage daemon
 167     */
 168    if (!connect_to_storage_daemon(jcr, 10, SDConnectTimeout, 1)) {
 169       return false;
 170    }
 171    /*
 172     * Now start a job with the Storage daemon
 173     */
 174    if (!start_storage_daemon_job(jcr, jcr->storage, SD_APPEND)) {
 175       return false;
 176    }
 177    /*
 178     * Now start a Storage daemon message thread
 179     */
 180    if (!start_storage_daemon_message_thread(jcr)) {
 181       return false;
 182    }
 183    Dmsg0(150, "Storage daemon connection OK\n");
 184
 185    set_jcr_job_status(jcr, JS_WaitFD);
 186    if (!connect_to_file_daemon(jcr, 10, FDConnectTimeout, 1)) {
 187       return false;
 188    }
 189
 190    set_jcr_job_status(jcr, JS_Running);
 191    fd = jcr->file_bsock;
 192
 193    if (!send_include_list(jcr)) {
 194       return false;
 195    }
 196
 197    if (!send_exclude_list(jcr)) {
 198       return false;
 199    }
 200
 201    if (!send_level_command(jcr)) {
 202       return false;
 203    }
 204
 205    /*
 206     * send Storage daemon address to the File daemon
 207     */
 208    store = jcr->store;
 209    if (store->SDDport == 0) {
 210       store->SDDport = store->SDport;
 211    }
 212    bnet_fsend(fd, storaddr, store->address, store->SDDport,
 213               store->enable_ssl);
 214    if (!response(jcr, fd, OKstore, "Storage", DISPLAY_ERROR)) {
 215       return false;
 216    }
 217
 218
 219    if (!send_run_before_and_after_commands(jcr)) {
 220       return false;
 221    }
 222
 223    /* Send backup command */
 224    bnet_fsend(fd, backupcmd);
 225    if (!response(jcr, fd, OKbackup, "backup", DISPLAY_ERROR)) {
 226       return false;
 227    }
 228
 229    /* Pickup Job termination data */
 230    stat = wait_for_job_termination(jcr);
 231    backup_cleanup(jcr, stat);
 232    return stat == JS_Terminated;
 233 }
 234
 235
 236 /*
 237  * Here we wait for the File daemon to signal termination,
 238  *   then we wait for the Storage daemon.  When both
 239  *   are done, we return the job status.
 240  * Also used by restore.c
 241  */
 242 int wait_for_job_termination(JCR *jcr)
 243 {
 244    int32_t n = 0;
 245    BSOCK *fd = jcr->file_bsock;
 246    bool fd_ok = false;
 247    uint32_t JobFiles, Errors;
 248    uint64_t ReadBytes, JobBytes;
 249
 250    set_jcr_job_status(jcr, JS_Running);
 251    /* Wait for Client to terminate */
 252    while ((n = bget_dirmsg(fd)) >= 0) {
 253       if (!fd_ok && sscanf(fd->msg, EndJob, &jcr->FDJobStatus, &JobFiles,
 254           &ReadBytes, &JobBytes, &Errors) == 5) {
 255          fd_ok = true;
 256          set_jcr_job_status(jcr, jcr->FDJobStatus);
 257          Dmsg1(100, "FDStatus=%c\n", (char)jcr->JobStatus);
 258       } else {
 259          Jmsg(jcr, M_WARNING, 0, _("Unexpected Client Job message: %s\n"),
 260             fd->msg);
 261       }
 262       if (job_canceled(jcr)) {
 263          break;
 264       }
 265    }
 266    if (is_bnet_error(fd)) {
 267       Jmsg(jcr, M_FATAL, 0, _("Network error with FD during %s: ERR=%s\n"),
 268           job_type_to_str(jcr->JobType), bnet_strerror(fd));
 269    }
 270    bnet_sig(fd, BNET_TERMINATE);   /* tell Client we are terminating */
 271
 272    /* Note, the SD stores in jcr->JobFiles/ReadBytes/JobBytes/Errors */
 273    wait_for_storage_daemon_termination(jcr);
 274
 275
 276    /* Return values from FD */
 277    if (fd_ok) {
 278       jcr->JobFiles = JobFiles;
 279       jcr->Errors = Errors;
 280       jcr->ReadBytes = ReadBytes;
 281       jcr->JobBytes = JobBytes;
 282    } else {
 283       Jmsg(jcr, M_FATAL, 0, _("No Job status returned from FD.\n"));
 284    }
 285
 286 // Dmsg4(100, "fd_ok=%d FDJS=%d JS=%d SDJS=%d\n", fd_ok, jcr->FDJobStatus,
 287 //   jcr->JobStatus, jcr->SDJobStatus);
 288
 289    /* Return the first error status we find Dir, FD, or SD */
 290    if (!fd_ok || is_bnet_error(fd)) {
 291       jcr->FDJobStatus = JS_ErrorTerminated;
 292    }
 293    if (jcr->JobStatus != JS_Terminated) {
 294       return jcr->JobStatus;
 295    }
 296    if (jcr->FDJobStatus != JS_Terminated) {
 297       return jcr->FDJobStatus;
 298    }
 299    return jcr->SDJobStatus;
 300 }
 301
 302 /*
 303  * Release resources allocated during backup.
 304  */
 305 void backup_cleanup(JCR *jcr, int TermCode)
 306 {
 307    char sdt[50], edt[50];
 308    char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], compress[50];
 309    char term_code[100], fd_term_msg[100], sd_term_msg[100];
 310    const char *term_msg;
 311    int msg_type;
 312    MEDIA_DBR mr;
 313    double kbps, compression;
 314    utime_t RunTime;
 315
 316    Dmsg2(100, "Enter backup_cleanup %d %c\n", TermCode, TermCode);
 317    dequeue_messages(jcr);             /* display any queued messages */
 318    memset(&mr, 0, sizeof(mr));
 319    set_jcr_job_status(jcr, TermCode);
 320
 321    update_job_end_record(jcr);        /* update database */
 322
 323    if (!db_get_job_record(jcr, jcr->db, &jcr->jr)) {
 324       Jmsg(jcr, M_WARNING, 0, _("Error getting job record for stats: %s"),
 325          db_strerror(jcr->db));
 326       set_jcr_job_status(jcr, JS_ErrorTerminated);
 327    }
 328
 329    bstrncpy(mr.VolumeName, jcr->VolumeName, sizeof(mr.VolumeName));
 330    if (!db_get_media_record(jcr, jcr->db, &mr)) {
 331       Jmsg(jcr, M_WARNING, 0, _("Error getting Media record for Volume \"%s\": ERR=%s"),
 332          mr.VolumeName, db_strerror(jcr->db));
 333       set_jcr_job_status(jcr, JS_ErrorTerminated);
 334    }
 335
 336    /* Now update the bootstrap file if any */
 337    if (jcr->JobStatus == JS_Terminated && jcr->jr.JobBytes &&
 338        jcr->job->WriteBootstrap) {
 339       FILE *fd;
 340       BPIPE *bpipe = NULL;
 341       int got_pipe = 0;
 342       char *fname = jcr->job->WriteBootstrap;
 343       VOL_PARAMS *VolParams = NULL;
 344       int VolCount;
 345
 346       if (*fname == '|') {
 347          fname++;
 348          got_pipe = 1;
 349          bpipe = open_bpipe(fname, 0, "w");
 350          fd = bpipe ? bpipe->wfd : NULL;
 351       } else {
 352          /* ***FIXME*** handle BASE */
 353          fd = fopen(fname, jcr->JobLevel==L_FULL?"w+":"a+");
 354       }
 355       if (fd) {
 356          VolCount = db_get_job_volume_parameters(jcr, jcr->db, jcr->JobId,
 357                     &VolParams);
 358          if (VolCount == 0) {
 359             Jmsg(jcr, M_ERROR, 0, _("Could not get Job Volume Parameters to "
 360                  "update Bootstrap file. ERR=%s\n"), db_strerror(jcr->db));
 361              if (jcr->SDJobFiles != 0) {
 362                 set_jcr_job_status(jcr, JS_ErrorTerminated);
 363              }
 364
 365          }
 366          for (int i=0; i < VolCount; i++) {
 367             /* Write the record */
 368             fprintf(fd, "Volume=\"%s\"\n", VolParams[i].VolumeName);
 369             fprintf(fd, "MediaType=\"%s\"\n", VolParams[i].MediaType);
 370             fprintf(fd, "VolSessionId=%u\n", jcr->VolSessionId);
 371             fprintf(fd, "VolSessionTime=%u\n", jcr->VolSessionTime);
 372             fprintf(fd, "VolFile=%u-%u\n", VolParams[i].StartFile,
 373                          VolParams[i].EndFile);
 374             fprintf(fd, "VolBlock=%u-%u\n", VolParams[i].StartBlock,
 375                          VolParams[i].EndBlock);
 376             fprintf(fd, "FileIndex=%d-%d\n", VolParams[i].FirstIndex,
 377                          VolParams[i].LastIndex);
 378          }
 379          if (VolParams) {
 380             free(VolParams);
 381          }
 382          if (got_pipe) {
 383             close_bpipe(bpipe);
 384          } else {
 385             fclose(fd);
 386          }
 387       } else {
 388          berrno be;
 389          Jmsg(jcr, M_ERROR, 0, _("Could not open WriteBootstrap file:\n"
 390               "%s: ERR=%s\n"), fname, be.strerror());
 391          set_jcr_job_status(jcr, JS_ErrorTerminated);
 392       }
 393    }
 394
 395    msg_type = M_INFO;                 /* by default INFO message */
 396    switch (jcr->JobStatus) {
 397       case JS_Terminated:
 398          if (jcr->Errors || jcr->SDErrors) {
 399             term_msg = _("Backup OK -- with warnings");
 400          } else {
 401             term_msg = _("Backup OK");
 402          }
 403          break;
 404       case JS_FatalError:
 405       case JS_ErrorTerminated:
 406          term_msg = _("*** Backup Error ***");
 407          msg_type = M_ERROR;          /* Generate error message */
 408          if (jcr->store_bsock) {
 409             bnet_sig(jcr->store_bsock, BNET_TERMINATE);
 410             if (jcr->SD_msg_chan) {
 411                pthread_cancel(jcr->SD_msg_chan);
 412             }
 413          }
 414          break;
 415       case JS_Canceled:
 416          term_msg = _("Backup Canceled");
 417          if (jcr->store_bsock) {
 418             bnet_sig(jcr->store_bsock, BNET_TERMINATE);
 419             if (jcr->SD_msg_chan) {
 420                pthread_cancel(jcr->SD_msg_chan);
 421             }
 422          }
 423          break;
 424       default:
 425          term_msg = term_code;
 426          sprintf(term_code, _("Inappropriate term code: %c\n"), jcr->JobStatus);
 427          break;
 428    }
 429    bstrftimes(sdt, sizeof(sdt), jcr->jr.StartTime);
 430    bstrftimes(edt, sizeof(edt), jcr->jr.EndTime);
 431    RunTime = jcr->jr.EndTime - jcr->jr.StartTime;
 432    if (RunTime <= 0) {
 433       kbps = 0;
 434    } else {
 435       kbps = (double)jcr->jr.JobBytes / (1000 * RunTime);
 436    }
 437    if (!db_get_job_volume_names(jcr, jcr->db, jcr->jr.JobId, &jcr->VolumeName)) {
 438       /*
 439        * Note, if the job has erred, most likely it did not write any
 440        *  tape, so suppress this "error" message since in that case
 441        *  it is normal.  Or look at it the other way, only for a
 442        *  normal exit should we complain about this error.
 443        */
 444       if (jcr->JobStatus == JS_Terminated && jcr->jr.JobBytes) {
 445          Jmsg(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
 446       }
 447       jcr->VolumeName[0] = 0;         /* none */
 448    }
 449
 450    if (jcr->ReadBytes == 0) {
 451       bstrncpy(compress, "None", sizeof(compress));
 452    } else {
 453       compression = (double)100 - 100.0 * ((double)jcr->JobBytes / (double)jcr->ReadBytes);
 454       if (compression < 0.5) {
 455          bstrncpy(compress, "None", sizeof(compress));
 456       } else {
 457          bsnprintf(compress, sizeof(compress), "%.1f %%", (float)compression);
 458       }
 459    }
 460    jobstatus_to_ascii(jcr->FDJobStatus, fd_term_msg, sizeof(fd_term_msg));
 461    jobstatus_to_ascii(jcr->SDJobStatus, sd_term_msg, sizeof(sd_term_msg));
 462
 463 // bmicrosleep(15, 0);                /* for debugging SIGHUP */
 464
 465    Jmsg(jcr, msg_type, 0, _("Bacula " VERSION " (" LSMDATE "): %s\n"
 466 "  JobId:                  %d\n"
 467 "  Job:                    %s\n"
 468 "  Backup Level:           %s%s\n"
 469 "  Client:                 %s\n"
 470 "  FileSet:                \"%s\" %s\n"
 471 "  Pool:                   \"%s\"\n"
 472 "  Storage:                \"%s\"\n"
 473 "  Start time:             %s\n"
 474 "  End time:               %s\n"
 475 "  FD Files Written:       %s\n"
 476 "  SD Files Written:       %s\n"
 477 "  FD Bytes Written:       %s\n"
 478 "  SD Bytes Written:       %s\n"
 479 "  Rate:                   %.1f KB/s\n"
 480 "  Software Compression:   %s\n"
 481 "  Volume name(s):         %s\n"
 482 "  Volume Session Id:      %d\n"
 483 "  Volume Session Time:    %d\n"
 484 "  Last Volume Bytes:      %s\n"
 485 "  Non-fatal FD errors:    %d\n"
 486 "  SD Errors:              %d\n"
 487 "  FD termination status:  %s\n"
 488 "  SD termination status:  %s\n"
 489 "  Termination:            %s\n\n"),
 490         edt,
 491         jcr->jr.JobId,
 492         jcr->jr.Job,
 493         level_to_str(jcr->JobLevel), jcr->since,
 494         jcr->client->hdr.name,
 495         jcr->fileset->hdr.name, jcr->FSCreateTime,
 496         jcr->pool->hdr.name,
 497         jcr->store->hdr.name,
 498         sdt,
 499         edt,
 500         edit_uint64_with_commas(jcr->jr.JobFiles, ec1),
 501         edit_uint64_with_commas(jcr->SDJobFiles, ec4),
 502         edit_uint64_with_commas(jcr->jr.JobBytes, ec2),
 503         edit_uint64_with_commas(jcr->SDJobBytes, ec5),
 504         (float)kbps,
 505         compress,
 506         jcr->VolumeName,
 507         jcr->VolSessionId,
 508         jcr->VolSessionTime,
 509         edit_uint64_with_commas(mr.VolBytes, ec3),
 510         jcr->Errors,
 511         jcr->SDErrors,
 512         fd_term_msg,
 513         sd_term_msg,
 514         term_msg);
 515
 516    Dmsg0(100, "Leave backup_cleanup()\n");
 517 }