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
  71    since[0] = 0;
  72
  73    if (!get_or_create_client_record(jcr)) {
  74       Jmsg(jcr, M_ERROR, 0, _("Could not get/create Client record. ERR=%s\n"),
  75          db_strerror(jcr->db));
  76       goto bail_out;
  77    }
  78
  79    /*
  80     * Get or Create FileSet record
  81     */
  82    memset(&fsr, 0, sizeof(fsr));
  83    bstrncpy(fsr.FileSet, jcr->fileset->hdr.name, sizeof(fsr.FileSet));
  84    if (jcr->fileset->have_MD5) {
  85       struct MD5Context md5c;
  86       unsigned char signature[16];
  87       memcpy(&md5c, &jcr->fileset->md5c, sizeof(md5c));
  88       MD5Final(signature, &md5c);
  89       bin_to_base64(fsr.MD5, (char *)signature, 16); /* encode 16 bytes */
  90       bstrncpy(jcr->fileset->MD5, fsr.MD5, sizeof(jcr->fileset->MD5));
  91    } else {
  92       Jmsg(jcr, M_WARNING, 0, _("FileSet MD5 signature not found.\n"));
  93    }
  94    if (!db_create_fileset_record(jcr, jcr->db, &fsr)) {
  95       Jmsg(jcr, M_ERROR, 0, _("Could not create FileSet \"%s\" record. ERR=%s\n"),
  96          fsr.FileSet, db_strerror(jcr->db));
  97       goto bail_out;
  98    }
  99    jcr->jr.FileSetId = fsr.FileSetId;
 100    if (fsr.created) {
 101       Jmsg(jcr, M_INFO, 0, _("Created new FileSet record \"%s\" %s\n"),
 102          fsr.FileSet, fsr.cCreateTime);
 103    }
 104    Dmsg2(119, "Created FileSet %s record %u\n", jcr->fileset->hdr.name,
 105       jcr->jr.FileSetId);
 106
 107    get_level_since_time(jcr, since, sizeof(since));
 108
 109    jcr->jr.JobId = jcr->JobId;
 110    jcr->jr.StartTime = jcr->start_time;
 111    if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
 112       Jmsg(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
 113       goto bail_out;
 114    }
 115
 116    jcr->fname = (char *) get_pool_memory(PM_FNAME);
 117
 118    /* Print Job Start message */
 119    Jmsg(jcr, M_INFO, 0, _("Start Backup JobId %u, Job=%s\n"),
 120         jcr->JobId, jcr->Job);
 121
 122    /*
 123     * Get the Pool record -- first apply any level defined pools
 124     */
 125    switch (jcr->JobLevel) {
 126    case L_FULL:
 127       if (jcr->full_pool) {
 128          jcr->pool = jcr->full_pool;
 129       }
 130       break;
 131    case L_INCREMENTAL:
 132       if (jcr->inc_pool) {
 133          jcr->pool = jcr->inc_pool;
 134       }
 135       break;
 136    case L_DIFFERENTIAL:
 137       if (jcr->dif_pool) {
 138          jcr->pool = jcr->dif_pool;
 139       }
 140       break;
 141    }
 142    memset(&pr, 0, sizeof(pr));
 143    bstrncpy(pr.Name, jcr->pool->hdr.name, sizeof(pr.Name));
 144
 145    while (!db_get_pool_record(jcr, jcr->db, &pr)) { /* get by Name */
 146       /* Try to create the pool */
 147       if (create_pool(jcr, jcr->db, jcr->pool, POOL_OP_CREATE) < 0) {
 148          Jmsg(jcr, M_FATAL, 0, _("Pool %s not in database. %s"), pr.Name,
 149             db_strerror(jcr->db));
 150          goto bail_out;
 151       } else {
 152          Jmsg(jcr, M_INFO, 0, _("Pool %s created in database.\n"), pr.Name);
 153       }
 154    }
 155    jcr->PoolId = pr.PoolId;               /****FIXME**** this can go away */
 156    jcr->jr.PoolId = pr.PoolId;
 157
 158    /*
 159     * Open a message channel connection with the Storage
 160     * daemon. This is to let him know that our client
 161     * will be contacting him for a backup  session.
 162     *
 163     */
 164    Dmsg0(110, "Open connection with storage daemon\n");
 165    set_jcr_job_status(jcr, JS_WaitSD);
 166    /*
 167     * Start conversation with Storage daemon
 168     */
 169    if (!connect_to_storage_daemon(jcr, 10, SDConnectTimeout, 1)) {
 170       goto bail_out;
 171    }
 172    /*
 173     * Now start a job with the Storage daemon
 174     */
 175    if (!start_storage_daemon_job(jcr)) {
 176       goto bail_out;
 177    }
 178    /*
 179     * Now start a Storage daemon message thread
 180     */
 181    if (!start_storage_daemon_message_thread(jcr)) {
 182       goto bail_out;
 183    }
 184    Dmsg0(150, "Storage daemon connection OK\n");
 185
 186    set_jcr_job_status(jcr, JS_WaitFD);
 187    if (!connect_to_file_daemon(jcr, 10, FDConnectTimeout, 1)) {
 188       goto bail_out;
 189    }
 190
 191    set_jcr_job_status(jcr, JS_Running);
 192    fd = jcr->file_bsock;
 193
 194    if (!send_include_list(jcr)) {
 195       goto bail_out;
 196    }
 197
 198    if (!send_exclude_list(jcr)) {
 199       goto bail_out;
 200    }
 201
 202    /*
 203     * send Storage daemon address to the File daemon
 204     */
 205    if (jcr->store->SDDport == 0) {
 206       jcr->store->SDDport = jcr->store->SDport;
 207    }
 208    bnet_fsend(fd, storaddr, jcr->store->address, jcr->store->SDDport,
 209               jcr->store->enable_ssl);
 210    if (!response(jcr, fd, OKstore, "Storage", DISPLAY_ERROR)) {
 211       goto bail_out;
 212    }
 213
 214
 215    if (!send_level_command(jcr)) {
 216       goto bail_out;
 217    }
 218
 219    if (!send_run_before_and_after_commands(jcr)) {
 220       goto bail_out;
 221    }
 222
 223    /* Send backup command */
 224    bnet_fsend(fd, backupcmd);
 225    if (!response(jcr, fd, OKbackup, "backup", DISPLAY_ERROR)) {
 226       goto bail_out;
 227    }
 228
 229    /* Pickup Job termination data */
 230    stat = wait_for_job_termination(jcr);
 231    backup_cleanup(jcr, stat, since, &fsr);
 232    return 1;
 233
 234 bail_out:
 235    backup_cleanup(jcr, JS_ErrorTerminated, since, &fsr);
 236    return 0;
 237 }
 238
 239 /*
 240  * Here we wait for the File daemon to signal termination,
 241  *   then we wait for the Storage daemon.  When both
 242  *   are done, we return the job status.
 243  * Also used by restore.c
 244  */
 245 int wait_for_job_termination(JCR *jcr)
 246 {
 247    int32_t n = 0;
 248    BSOCK *fd = jcr->file_bsock;
 249    bool fd_ok = false;
 250    uint32_t JobFiles, Errors;
 251    uint64_t ReadBytes, JobBytes;
 252
 253    set_jcr_job_status(jcr, JS_Running);
 254    /* Wait for Client to terminate */
 255    while ((n = bget_dirmsg(fd)) >= 0) {
 256       if (!fd_ok && sscanf(fd->msg, EndJob, &jcr->FDJobStatus, &JobFiles,
 257           &ReadBytes, &JobBytes, &Errors) == 5) {
 258          fd_ok = true;
 259          set_jcr_job_status(jcr, jcr->FDJobStatus);
 260          Dmsg1(100, "FDStatus=%c\n", (char)jcr->JobStatus);
 261       } else {
 262          Jmsg(jcr, M_WARNING, 0, _("Unexpected Client Job message: %s\n"),
 263             fd->msg);
 264       }
 265       if (job_canceled(jcr)) {
 266          break;
 267       }
 268    }
 269    if (is_bnet_error(fd)) {
 270       Jmsg(jcr, M_FATAL, 0, _("Network error with FD during %s: ERR=%s\n"),
 271           job_type_to_str(jcr->JobType), bnet_strerror(fd));
 272    }
 273    bnet_sig(fd, BNET_TERMINATE);   /* tell Client we are terminating */
 274
 275    /* Note, the SD stores in jcr->JobFiles/ReadBytes/JobBytes/Errors */
 276    wait_for_storage_daemon_termination(jcr);
 277
 278
 279    /* Return values from FD */
 280    if (fd_ok) {
 281       jcr->JobFiles = JobFiles;
 282       jcr->Errors = Errors;
 283       jcr->ReadBytes = ReadBytes;
 284       jcr->JobBytes = JobBytes;
 285    } else {
 286       Jmsg(jcr, M_FATAL, 0, _("No Job status returned from FD.\n"));
 287    }
 288
 289 // Dmsg4(100, "fd_ok=%d FDJS=%d JS=%d SDJS=%d\n", fd_ok, jcr->FDJobStatus,
 290 //   jcr->JobStatus, jcr->SDJobStatus);
 291
 292    /* Return the first error status we find Dir, FD, or SD */
 293    if (!fd_ok || is_bnet_error(fd)) {
 294       jcr->FDJobStatus = JS_ErrorTerminated;
 295    }
 296    if (jcr->JobStatus != JS_Terminated) {
 297       return jcr->JobStatus;
 298    }
 299    if (jcr->FDJobStatus != JS_Terminated) {
 300       return jcr->FDJobStatus;
 301    }
 302    return jcr->SDJobStatus;
 303 }
 304
 305 /*
 306  * Release resources allocated during backup.
 307  */
 308 static void backup_cleanup(JCR *jcr, int TermCode, char *since, FILESET_DBR *fsr)
 309 {
 310    char sdt[50], edt[50];
 311    char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], compress[50];
 312    char term_code[100], fd_term_msg[100], sd_term_msg[100];
 313    char *term_msg;
 314    int msg_type;
 315    MEDIA_DBR mr;
 316    double kbps, compression;
 317    utime_t RunTime;
 318
 319    Dmsg2(100, "Enter backup_cleanup %d %c\n", TermCode, TermCode);
 320    memset(&mr, 0, sizeof(mr));
 321    set_jcr_job_status(jcr, TermCode);
 322
 323    update_job_end_record(jcr);        /* update database */
 324
 325    if (!db_get_job_record(jcr, jcr->db, &jcr->jr)) {
 326       Jmsg(jcr, M_WARNING, 0, _("Error getting job record for stats: %s"),
 327          db_strerror(jcr->db));
 328       set_jcr_job_status(jcr, JS_ErrorTerminated);
 329    }
 330
 331    bstrncpy(mr.VolumeName, jcr->VolumeName, sizeof(mr.VolumeName));
 332    if (!db_get_media_record(jcr, jcr->db, &mr)) {
 333       Jmsg(jcr, M_WARNING, 0, _("Error getting Media record for Volume \"%s\": ERR=%s"),
 334          mr.VolumeName, db_strerror(jcr->db));
 335       set_jcr_job_status(jcr, JS_ErrorTerminated);
 336    }
 337
 338    /* Now update the bootstrap file if any */
 339    if (jcr->JobStatus == JS_Terminated && jcr->jr.JobBytes &&
 340        jcr->job->WriteBootstrap) {
 341       FILE *fd;
 342       BPIPE *bpipe = NULL;
 343       int got_pipe = 0;
 344       char *fname = jcr->job->WriteBootstrap;
 345       VOL_PARAMS *VolParams = NULL;
 346       int VolCount;
 347
 348       if (*fname == '|') {
 349          fname++;
 350          got_pipe = 1;
 351          bpipe = open_bpipe(fname, 0, "w");
 352          fd = bpipe ? bpipe->wfd : NULL;
 353       } else {
 354          /* ***FIXME*** handle BASE */
 355          fd = fopen(fname, jcr->JobLevel==L_FULL?"w+":"a+");
 356       }
 357       if (fd) {
 358          VolCount = db_get_job_volume_parameters(jcr, jcr->db, jcr->JobId,
 359                     &VolParams);
 360          if (VolCount == 0) {
 361             Jmsg(jcr, M_ERROR, 0, _("Could not get Job Volume Parameters to "
 362                  "update Bootstrap file. ERR=%s\n"), db_strerror(jcr->db));
 363              if (jcr->SDJobFiles != 0) {
 364                 set_jcr_job_status(jcr, JS_ErrorTerminated);
 365              }
 366
 367          }
 368          for (int i=0; i < VolCount; i++) {
 369             /* Write the record */
 370             fprintf(fd, "Volume=\"%s\"\n", VolParams[i].VolumeName);
 371             fprintf(fd, "VolSessionId=%u\n", jcr->VolSessionId);
 372             fprintf(fd, "VolSessionTime=%u\n", jcr->VolSessionTime);
 373             fprintf(fd, "VolFile=%u-%u\n", VolParams[i].StartFile,
 374                          VolParams[i].EndFile);
 375             fprintf(fd, "VolBlock=%u-%u\n", VolParams[i].StartBlock,
 376                          VolParams[i].EndBlock);
 377             fprintf(fd, "FileIndex=%d-%d\n", VolParams[i].FirstIndex,
 378                          VolParams[i].LastIndex);
 379          }
 380          if (VolParams) {
 381             free(VolParams);
 382          }
 383          if (got_pipe) {
 384             close_bpipe(bpipe);
 385          } else {
 386             fclose(fd);
 387          }
 388       } else {
 389          Jmsg(jcr, M_ERROR, 0, _("Could not open WriteBootstrap file:\n"
 390               "%s: ERR=%s\n"), fname, strerror(errno));
 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    bstrftime(sdt, sizeof(sdt), jcr->jr.StartTime);
 430    bstrftime(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 Start time:             %s\n\
 472 End time:               %s\n\
 473 FD Files Written:       %s\n\
 474 SD Files Written:       %s\n\
 475 FD Bytes Written:       %s\n\
 476 SD Bytes Written:       %s\n\
 477 Rate:                   %.1f KB/s\n\
 478 Software Compression:   %s\n\
 479 Volume name(s):         %s\n\
 480 Volume Session Id:      %d\n\
 481 Volume Session Time:    %d\n\
 482 Last Volume Bytes:      %s\n\
 483 Non-fatal FD errors:    %d\n\
 484 SD Errors:              %d\n\
 485 FD termination status:  %s\n\
 486 SD termination status:  %s\n\
 487 Termination:            %s\n\n"),
 488         edt,
 489         jcr->jr.JobId,
 490         jcr->jr.Job,
 491         level_to_str(jcr->JobLevel), since,
 492         jcr->client->hdr.name,
 493         jcr->fileset->hdr.name, fsr->cCreateTime,
 494         sdt,
 495         edt,
 496         edit_uint64_with_commas(jcr->jr.JobFiles, ec1),
 497         edit_uint64_with_commas(jcr->SDJobFiles, ec4),
 498         edit_uint64_with_commas(jcr->jr.JobBytes, ec2),
 499         edit_uint64_with_commas(jcr->SDJobBytes, ec5),
 500         (float)kbps,
 501         compress,
 502         jcr->VolumeName,
 503         jcr->VolSessionId,
 504         jcr->VolSessionTime,
 505         edit_uint64_with_commas(mr.VolBytes, ec3),
 506         jcr->Errors,
 507         jcr->SDErrors,
 508         fd_term_msg,
 509         sd_term_msg,
 510         term_msg);
 511
 512    Dmsg0(100, "Leave backup_cleanup()\n");
 513 }