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