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