2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
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 two of the GNU General Public
10 License as published by the Free Software Foundation and included
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.
18 You should have received a copy of the GNU 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
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.
30 * Bacula Director -- backup.c -- responsible for doing backup jobs
32 * Kern Sibbald, March MM
34 * Basic tasks done here:
35 * Open DB and create records for this job.
36 * Open Message Channel with Storage daemon to tell him a job will be starting.
37 * Open connection with File daemon and pass him commands
39 * When the File daemon finishes the job, update the DB.
48 /* Commands sent to File daemon */
49 static char backupcmd[] = "backup\n";
50 static char storaddr[] = "storage address=%s port=%d ssl=%d\n";
52 /* Responses received from File daemon */
53 static char OKbackup[] = "2000 OK backup\n";
54 static char OKstore[] = "2000 OK storage\n";
55 static char EndJob[] = "2800 End Job TermCode=%d JobFiles=%u "
56 "ReadBytes=%llu JobBytes=%llu Errors=%u "
57 "VSS=%d Encrypt=%d\n";
58 /* Pre 1.39.29 (04Dec06) EndJob */
59 static char OldEndJob[] = "2800 End Job TermCode=%d JobFiles=%u "
60 "ReadBytes=%llu JobBytes=%llu Errors=%u\n";
62 * Called here before the job is run to do the job
65 bool do_backup_init(JCR *jcr)
68 if (jcr->get_JobLevel() == L_VIRTUAL_FULL) {
69 return do_vbackup_init(jcr);
71 free_rstorage(jcr); /* we don't read so release */
73 if (!get_or_create_fileset_record(jcr)) {
78 * Get definitive Job level and since time
80 get_level_since_time(jcr, jcr->since, sizeof(jcr->since));
82 apply_pool_overrides(jcr);
84 if (!allow_duplicate_job(jcr)) {
88 jcr->jr.PoolId = get_or_create_pool_record(jcr, jcr->pool->name());
89 if (jcr->jr.PoolId == 0) {
93 /* If pool storage specified, use it instead of job storage */
94 copy_wstorage(jcr, jcr->pool->storage, _("Pool resource"));
97 Jmsg(jcr, M_FATAL, 0, _("No Storage specification found in Job or Pool.\n"));
101 create_clones(jcr); /* run any clone jobs */
106 /* Take all base jobs from job resource and find the
109 static bool get_base_jobids(JCR *jcr, POOLMEM *jobids)
116 if (!jcr->job->base) {
117 return false; /* no base job, stop accurate */
120 memset(&jr, 0, sizeof(JOB_DBR));
121 jr.StartTime = jcr->jr.StartTime;
123 foreach_alist(job, jcr->job->base) {
124 bstrncpy(jr.Name, job->name(), sizeof(jr.Name));
125 db_get_base_jobid(jcr, jcr->db, &jr, &id);
129 pm_strcat(jobids, ",");
131 pm_strcat(jobids, edit_uint64(id, str_jobid));
135 return *jobids != '\0';
139 * Foreach files in currrent list, send "/path/fname\0LStat" to FD
141 static int accurate_list_handler(void *ctx, int num_fields, char **row)
143 JCR *jcr = (JCR *)ctx;
145 if (job_canceled(jcr)) {
149 if (row[2] > 0) { /* discard when file_index == 0 */
150 jcr->file_bsock->fsend("%s%s%c%s", row[0], row[1], 0, row[4]);
156 * Send current file list to FD
157 * DIR -> FD : accurate files=xxxx
158 * DIR -> FD : /path/to/file\0Lstat
159 * DIR -> FD : /path/to/dir/\0Lstat
163 bool send_accurate_current_files(JCR *jcr)
168 if (!jcr->accurate || job_canceled(jcr)) {
171 /* In base level, no previous job is used */
172 if (jcr->get_JobLevel() == L_BASE) {
176 POOLMEM *nb = get_pool_memory(PM_FNAME);
177 POOLMEM *jobids = get_pool_memory(PM_FNAME);
178 nb[0] = jobids[0] = '\0';
180 if (jcr->get_JobLevel() == L_FULL) {
181 /* On Full mode, if no previous base job, no accurate things */
182 if (!get_base_jobids(jcr, jobids)) {
188 /* For Incr/Diff level, we search for older jobs */
189 db_accurate_get_jobids(jcr, jcr->db, &jcr->jr, jobids);
191 /* We are in Incr/Diff, but no Full to build the accurate list... */
194 Jmsg(jcr, M_FATAL, 0, _("Cannot find previous jobids.\n"));
199 if (jcr->JobId) { /* display the message only for real jobs */
200 Jmsg(jcr, M_INFO, 0, _("Sending Accurate information.\n"));
203 /* to be able to allocate the right size for htable */
204 Mmsg(buf, "SELECT sum(JobFiles) FROM Job WHERE JobId IN (%s)",jobids);
205 db_sql_query(jcr->db, buf.c_str(), db_get_int_handler, nb);
206 Dmsg2(200, "jobids=%s nb=%s\n", jobids, nb);
207 jcr->file_bsock->fsend("accurate files=%s\n", nb);
209 if (!db_open_batch_connexion(jcr, jcr->db)) {
211 Jmsg0(jcr, M_FATAL, 0, "Can't get dedicate sql connexion");
216 db_create_base_file_list(jcr, jcr->db_batch, jobids);
217 db_get_base_file_list(jcr, jcr->db_batch,
218 accurate_list_handler, (void *)jcr);
221 db_get_file_list(jcr, jcr->db_batch, jobids,
222 accurate_list_handler, (void *)jcr);
225 /* TODO: close the batch connexion ? (can be used very soon) */
227 jcr->file_bsock->signal(BNET_EOD);
230 free_pool_memory(jobids);
231 free_pool_memory(nb);
237 * Do a backup of the specified FileSet
239 * Returns: false on failure
242 bool do_backup(JCR *jcr)
245 int tls_need = BNET_TLS_NONE;
250 if (jcr->get_JobLevel() == L_VIRTUAL_FULL) {
251 return do_vbackup(jcr);
254 /* Print Job Start message */
255 Jmsg(jcr, M_INFO, 0, _("Start Backup JobId %s, Job=%s\n"),
256 edit_uint64(jcr->JobId, ed1), jcr->Job);
258 set_jcr_job_status(jcr, JS_Running);
259 Dmsg2(100, "JobId=%d JobLevel=%c\n", jcr->jr.JobId, jcr->jr.JobLevel);
260 if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
261 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
266 * Open a message channel connection with the Storage
267 * daemon. This is to let him know that our client
268 * will be contacting him for a backup session.
271 Dmsg0(110, "Open connection with storage daemon\n");
272 set_jcr_job_status(jcr, JS_WaitSD);
274 * Start conversation with Storage daemon
276 if (!connect_to_storage_daemon(jcr, 10, SDConnectTimeout, 1)) {
280 * Now start a job with the Storage daemon
282 if (!start_storage_daemon_job(jcr, NULL, jcr->wstorage)) {
287 * Start the job prior to starting the message thread below
288 * to avoid two threads from using the BSOCK structure at
291 if (!bnet_fsend(jcr->store_bsock, "run")) {
296 * Now start a Storage daemon message thread. Note,
297 * this thread is used to provide the catalog services
298 * for the backup job, including inserting the attributes
299 * into the catalog. See catalog_update() in catreq.c
301 if (!start_storage_daemon_message_thread(jcr)) {
304 Dmsg0(150, "Storage daemon connection OK\n");
306 set_jcr_job_status(jcr, JS_WaitFD);
307 if (!connect_to_file_daemon(jcr, 10, FDConnectTimeout, 1)) {
311 set_jcr_job_status(jcr, JS_Running);
312 fd = jcr->file_bsock;
314 if (!send_include_list(jcr)) {
318 if (!send_exclude_list(jcr)) {
322 if (!send_level_command(jcr)) {
327 * send Storage daemon address to the File daemon
330 if (store->SDDport == 0) {
331 store->SDDport = store->SDport;
334 /* TLS Requirement */
335 if (store->tls_enable) {
336 if (store->tls_require) {
337 tls_need = BNET_TLS_REQUIRED;
339 tls_need = BNET_TLS_OK;
343 fd->fsend(storaddr, store->address, store->SDDport, tls_need);
344 if (!response(jcr, fd, OKstore, "Storage", DISPLAY_ERROR)) {
348 if (!send_runscripts_commands(jcr)) {
353 * We re-update the job start record so that the start
354 * time is set after the run before job. This avoids
355 * that any files created by the run before job will
356 * be saved twice. They will be backed up in the current
357 * job, but not in the next one unless they are changed.
358 * Without this, they will be backed up in this job and
359 * in the next job run because in that case, their date
360 * is after the start of this run.
362 jcr->start_time = time(NULL);
363 jcr->jr.StartTime = jcr->start_time;
364 if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
365 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
369 * If backup is in accurate mode, we send the list of
372 if (!send_accurate_current_files(jcr)) {
376 /* Send backup command */
377 fd->fsend(backupcmd);
378 if (!response(jcr, fd, OKbackup, "backup", DISPLAY_ERROR)) {
382 /* Pickup Job termination data */
383 stat = wait_for_job_termination(jcr);
384 db_write_batch_file_records(jcr); /* used by bulk batch file insert */
387 !db_commit_base_file_attributes_record(jcr, jcr->db_batch))
389 Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db_batch));
392 if (stat == JS_Terminated) {
393 backup_cleanup(jcr, stat);
398 /* Come here only after starting SD thread */
400 set_jcr_job_status(jcr, JS_ErrorTerminated);
401 Dmsg1(400, "wait for sd. use=%d\n", jcr->use_count());
403 wait_for_job_termination(jcr, FDConnectTimeout);
404 Dmsg1(400, "after wait for sd. use=%d\n", jcr->use_count());
410 * Here we wait for the File daemon to signal termination,
411 * then we wait for the Storage daemon. When both
412 * are done, we return the job status.
413 * Also used by restore.c
415 int wait_for_job_termination(JCR *jcr, int timeout)
418 BSOCK *fd = jcr->file_bsock;
420 uint32_t JobFiles, JobErrors;
421 uint32_t JobWarnings = 0;
422 uint64_t ReadBytes = 0;
423 uint64_t JobBytes = 0;
428 set_jcr_job_status(jcr, JS_Running);
432 tid = start_bsock_timer(fd, timeout); /* TODO: New timeout directive??? */
434 /* Wait for Client to terminate */
435 while ((n = bget_dirmsg(fd)) >= 0) {
437 (sscanf(fd->msg, EndJob, &jcr->FDJobStatus, &JobFiles,
438 &ReadBytes, &JobBytes, &JobErrors, &VSS, &Encrypt) == 7 ||
439 sscanf(fd->msg, OldEndJob, &jcr->FDJobStatus, &JobFiles,
440 &ReadBytes, &JobBytes, &JobErrors) == 5)) {
442 set_jcr_job_status(jcr, jcr->FDJobStatus);
443 Dmsg1(100, "FDStatus=%c\n", (char)jcr->JobStatus);
445 Jmsg(jcr, M_WARNING, 0, _("Unexpected Client Job message: %s\n"),
448 if (job_canceled(jcr)) {
453 stop_bsock_timer(tid);
456 if (is_bnet_error(fd)) {
457 Jmsg(jcr, M_FATAL, 0, _("Network error with FD during %s: ERR=%s\n"),
458 job_type_to_str(jcr->get_JobType()), fd->bstrerror());
460 fd->signal(BNET_TERMINATE); /* tell Client we are terminating */
463 /* Force cancel in SD if failing */
464 if (job_canceled(jcr) || !fd_ok) {
465 cancel_storage_daemon_job(jcr);
468 /* Note, the SD stores in jcr->JobFiles/ReadBytes/JobBytes/JobErrors */
469 wait_for_storage_daemon_termination(jcr);
471 /* Return values from FD */
473 jcr->JobFiles = JobFiles;
474 jcr->JobErrors += JobErrors; /* Keep total errors */
475 jcr->ReadBytes = ReadBytes;
476 jcr->JobBytes = JobBytes;
477 jcr->JobWarnings = JobWarnings;
479 jcr->Encrypt = Encrypt;
481 Jmsg(jcr, M_FATAL, 0, _("No Job status returned from FD.\n"));
484 // Dmsg4(100, "fd_ok=%d FDJS=%d JS=%d SDJS=%d\n", fd_ok, jcr->FDJobStatus,
485 // jcr->JobStatus, jcr->SDJobStatus);
487 /* Return the first error status we find Dir, FD, or SD */
488 if (!fd_ok || is_bnet_error(fd)) { /* if fd not set, that use !fd_ok */
489 jcr->FDJobStatus = JS_ErrorTerminated;
491 if (jcr->JobStatus != JS_Terminated) {
492 return jcr->JobStatus;
494 if (jcr->FDJobStatus != JS_Terminated) {
495 return jcr->FDJobStatus;
497 return jcr->SDJobStatus;
501 * Release resources allocated during backup.
503 void backup_cleanup(JCR *jcr, int TermCode)
505 char sdt[50], edt[50], schedt[50];
506 char ec1[30], ec2[30], ec3[30], ec4[30], ec5[30], compress[50];
507 char ec6[30], ec7[30], ec8[30], elapsed[50];
508 char term_code[100], fd_term_msg[100], sd_term_msg[100];
509 const char *term_msg;
510 int msg_type = M_INFO;
513 double kbps, compression;
516 if (jcr->get_JobLevel() == L_VIRTUAL_FULL) {
517 vbackup_cleanup(jcr, TermCode);
521 Dmsg2(100, "Enter backup_cleanup %d %c\n", TermCode, TermCode);
522 memset(&mr, 0, sizeof(mr));
523 memset(&cr, 0, sizeof(cr));
525 update_job_end(jcr, TermCode);
527 if (!db_get_job_record(jcr, jcr->db, &jcr->jr)) {
528 Jmsg(jcr, M_WARNING, 0, _("Error getting Job record for Job report: ERR=%s"),
529 db_strerror(jcr->db));
530 set_jcr_job_status(jcr, JS_ErrorTerminated);
533 bstrncpy(cr.Name, jcr->client->name(), sizeof(cr.Name));
534 if (!db_get_client_record(jcr, jcr->db, &cr)) {
535 Jmsg(jcr, M_WARNING, 0, _("Error getting Client record for Job report: ERR=%s"),
536 db_strerror(jcr->db));
539 bstrncpy(mr.VolumeName, jcr->VolumeName, sizeof(mr.VolumeName));
540 if (!db_get_media_record(jcr, jcr->db, &mr)) {
541 Jmsg(jcr, M_WARNING, 0, _("Error getting Media record for Volume \"%s\": ERR=%s"),
542 mr.VolumeName, db_strerror(jcr->db));
543 set_jcr_job_status(jcr, JS_ErrorTerminated);
546 update_bootstrap_file(jcr);
548 switch (jcr->JobStatus) {
550 if (jcr->JobErrors || jcr->SDErrors) {
551 term_msg = _("Backup OK -- with warnings");
553 term_msg = _("Backup OK");
557 term_msg = _("Backup OK -- with warnings");
560 case JS_ErrorTerminated:
561 term_msg = _("*** Backup Error ***");
562 msg_type = M_ERROR; /* Generate error message */
563 if (jcr->store_bsock) {
564 jcr->store_bsock->signal(BNET_TERMINATE);
565 if (jcr->SD_msg_chan) {
566 pthread_cancel(jcr->SD_msg_chan);
571 term_msg = _("Backup Canceled");
572 if (jcr->store_bsock) {
573 jcr->store_bsock->signal(BNET_TERMINATE);
574 if (jcr->SD_msg_chan) {
575 pthread_cancel(jcr->SD_msg_chan);
580 term_msg = term_code;
581 sprintf(term_code, _("Inappropriate term code: %c\n"), jcr->JobStatus);
584 bstrftimes(schedt, sizeof(schedt), jcr->jr.SchedTime);
585 bstrftimes(sdt, sizeof(sdt), jcr->jr.StartTime);
586 bstrftimes(edt, sizeof(edt), jcr->jr.EndTime);
587 RunTime = jcr->jr.EndTime - jcr->jr.StartTime;
591 kbps = ((double)jcr->jr.JobBytes) / (1000.0 * (double)RunTime);
593 if (!db_get_job_volume_names(jcr, jcr->db, jcr->jr.JobId, &jcr->VolumeName)) {
595 * Note, if the job has erred, most likely it did not write any
596 * tape, so suppress this "error" message since in that case
597 * it is normal. Or look at it the other way, only for a
598 * normal exit should we complain about this error.
600 if (jcr->JobStatus == JS_Terminated && jcr->jr.JobBytes) {
601 Jmsg(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
603 jcr->VolumeName[0] = 0; /* none */
606 if (jcr->ReadBytes == 0) {
607 bstrncpy(compress, "None", sizeof(compress));
609 compression = (double)100 - 100.0 * ((double)jcr->JobBytes / (double)jcr->ReadBytes);
610 if (compression < 0.5) {
611 bstrncpy(compress, "None", sizeof(compress));
613 bsnprintf(compress, sizeof(compress), "%.1f %%", compression);
616 jobstatus_to_ascii(jcr->FDJobStatus, fd_term_msg, sizeof(fd_term_msg));
617 jobstatus_to_ascii(jcr->SDJobStatus, sd_term_msg, sizeof(sd_term_msg));
619 // bmicrosleep(15, 0); /* for debugging SIGHUP */
621 Jmsg(jcr, msg_type, 0, _("%s %s %s (%s): %s\n"
622 " Build OS: %s %s %s\n"
625 " Backup Level: %s%s\n"
626 " Client: \"%s\" %s\n"
627 " FileSet: \"%s\" %s\n"
628 " Pool: \"%s\" (From %s)\n"
629 " Catalog: \"%s\" (From %s)\n"
630 " Storage: \"%s\" (From %s)\n"
631 " Scheduled time: %s\n"
634 " Elapsed time: %s\n"
636 " FD Files Written: %s\n"
637 " SD Files Written: %s\n"
638 " FD Bytes Written: %s (%sB)\n"
639 " SD Bytes Written: %s (%sB)\n"
641 " Software Compression: %s\n"
645 " Volume name(s): %s\n"
646 " Volume Session Id: %d\n"
647 " Volume Session Time: %d\n"
648 " Last Volume Bytes: %s (%sB)\n"
649 " Non-fatal FD errors: %d\n"
651 " FD termination status: %s\n"
652 " SD termination status: %s\n"
653 " Termination: %s\n\n"),
654 BACULA, my_name, VERSION, LSMDATE, edt,
655 HOST_OS, DISTNAME, DISTVER,
658 level_to_str(jcr->get_JobLevel()), jcr->since,
659 jcr->client->name(), cr.Uname,
660 jcr->fileset->name(), jcr->FSCreateTime,
661 jcr->pool->name(), jcr->pool_source,
662 jcr->catalog->name(), jcr->catalog_source,
663 jcr->wstore->name(), jcr->wstore_source,
667 edit_utime(RunTime, elapsed, sizeof(elapsed)),
669 edit_uint64_with_commas(jcr->jr.JobFiles, ec1),
670 edit_uint64_with_commas(jcr->SDJobFiles, ec2),
671 edit_uint64_with_commas(jcr->jr.JobBytes, ec3),
672 edit_uint64_with_suffix(jcr->jr.JobBytes, ec4),
673 edit_uint64_with_commas(jcr->SDJobBytes, ec5),
674 edit_uint64_with_suffix(jcr->SDJobBytes, ec6),
677 jcr->VSS?_("yes"):_("no"),
678 jcr->Encrypt?_("yes"):_("no"),
679 jcr->accurate?_("yes"):_("no"),
683 edit_uint64_with_commas(mr.VolBytes, ec7),
684 edit_uint64_with_suffix(mr.VolBytes, ec8),
691 Dmsg0(100, "Leave backup_cleanup()\n");
694 void update_bootstrap_file(JCR *jcr)
696 /* Now update the bootstrap file if any */
697 if (jcr->JobStatus == JS_Terminated && jcr->jr.JobBytes &&
698 jcr->job->WriteBootstrap) {
702 POOLMEM *fname = get_pool_memory(PM_FNAME);
703 fname = edit_job_codes(jcr, fname, jcr->job->WriteBootstrap, "");
705 VOL_PARAMS *VolParams = NULL;
707 char edt[50], ed1[50], ed2[50];
711 bpipe = open_bpipe(fname+1, 0, "w"); /* skip first char "|" */
712 fd = bpipe ? bpipe->wfd : NULL;
714 /* ***FIXME*** handle BASE */
715 fd = fopen(fname, jcr->get_JobLevel()==L_FULL?"w+b":"a+b");
718 VolCount = db_get_job_volume_parameters(jcr, jcr->db, jcr->JobId,
721 Jmsg(jcr, M_ERROR, 0, _("Could not get Job Volume Parameters to "
722 "update Bootstrap file. ERR=%s\n"), db_strerror(jcr->db));
723 if (jcr->SDJobFiles != 0) {
724 set_jcr_job_status(jcr, JS_ErrorTerminated);
728 /* Start output with when and who wrote it */
729 bstrftimes(edt, sizeof(edt), time(NULL));
730 fprintf(fd, "# %s - %s - %s%s\n", edt, jcr->jr.Job,
731 level_to_str(jcr->get_JobLevel()), jcr->since);
732 for (int i=0; i < VolCount; i++) {
733 /* Write the record */
734 fprintf(fd, "Volume=\"%s\"\n", VolParams[i].VolumeName);
735 fprintf(fd, "MediaType=\"%s\"\n", VolParams[i].MediaType);
736 if (VolParams[i].Slot > 0) {
737 fprintf(fd, "Slot=%d\n", VolParams[i].Slot);
739 fprintf(fd, "VolSessionId=%u\n", jcr->VolSessionId);
740 fprintf(fd, "VolSessionTime=%u\n", jcr->VolSessionTime);
741 fprintf(fd, "VolAddr=%s-%s\n",
742 edit_uint64(VolParams[i].StartAddr, ed1),
743 edit_uint64(VolParams[i].EndAddr, ed2));
744 fprintf(fd, "FileIndex=%d-%d\n", VolParams[i].FirstIndex,
745 VolParams[i].LastIndex);
757 Jmsg(jcr, M_ERROR, 0, _("Could not open WriteBootstrap file:\n"
758 "%s: ERR=%s\n"), fname, be.bstrerror());
759 set_jcr_job_status(jcr, JS_ErrorTerminated);
761 free_pool_memory(fname);