2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 John Walker.
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 -- fd_cmds.c -- send commands to File daemon
32 * Kern Sibbald, October MM
34 * This routine is run as a separate thread. There may be more
35 * work to be done to make it totally reentrant!!!!
37 * Utility functions for sending info to File Daemon.
38 * These functions are used by both backup and verify.
45 #include "findlib/find.h"
47 const int dbglvl = 400;
49 /* Commands sent to File daemon */
50 static char filesetcmd[] = "fileset%s\n"; /* set full fileset */
51 static char jobcmd[] = "JobId=%s Job=%s SDid=%u SDtime=%u Authorization=%s\n";
52 /* Note, mtime_only is not used here -- implemented as file option */
53 static char levelcmd[] = "level = %s%s mtime_only=%d\n";
54 static char runscript[] = "Run OnSuccess=%u OnFailure=%u AbortOnError=%u When=%u Command=%s\n";
55 static char runbeforenow[]= "RunBeforeNow\n";
57 /* Responses received from File daemon */
58 static char OKinc[] = "2000 OK include\n";
59 static char OKjob[] = "2000 OK Job";
60 static char OKlevel[] = "2000 OK level\n";
61 static char OKRunScript[] = "2000 OK RunScript\n";
62 static char OKRunBeforeNow[] = "2000 OK RunBeforeNow\n";
64 /* Forward referenced functions */
66 /* External functions */
67 extern DIRRES *director;
68 extern int FDConnectTimeout;
74 * Open connection with File daemon.
75 * Try connecting every retry_interval (default 10 sec), and
76 * give up after max_retry_time (default 30 mins).
79 int connect_to_file_daemon(JCR *jcr, int retry_interval, int max_retry_time,
86 if (jcr->client->heartbeat_interval) {
87 heart_beat = jcr->client->heartbeat_interval;
89 heart_beat = director->heartbeat_interval;
92 if (!jcr->file_bsock) {
93 char name[MAX_NAME_LENGTH + 100];
94 bstrncpy(name, _("Client: "), sizeof(name));
95 bstrncat(name, jcr->client->name(), sizeof(name));
96 fd = bnet_connect(jcr, retry_interval, max_retry_time, heart_beat,
97 name, jcr->client->address, NULL, jcr->client->FDport, verbose);
99 set_jcr_job_status(jcr, JS_ErrorTerminated);
102 Dmsg0(10, "Opened connection with File daemon\n");
104 fd = jcr->file_bsock; /* use existing connection */
106 fd->res = (RES *)jcr->client; /* save resource in BSOCK */
107 jcr->file_bsock = fd;
108 set_jcr_job_status(jcr, JS_Running);
110 if (!authenticate_file_daemon(jcr)) {
111 set_jcr_job_status(jcr, JS_ErrorTerminated);
116 * Now send JobId and authorization key
118 fd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job, jcr->VolSessionId,
119 jcr->VolSessionTime, jcr->sd_auth_key);
120 if (debug_level == 3) {
121 Dmsg1(000, ">filed: %s", fd->msg);
123 if (strcmp(jcr->sd_auth_key, "dummy") != 0) {
124 memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
126 Dmsg1(100, ">filed: %s", fd->msg);
127 if (bget_dirmsg(fd) > 0) {
128 Dmsg1(110, "<filed: %s", fd->msg);
129 if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
130 Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
131 jcr->client->hdr.name, fd->msg);
132 set_jcr_job_status(jcr, JS_ErrorTerminated);
134 } else if (jcr->db) {
136 memset(&cr, 0, sizeof(cr));
137 bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
138 cr.AutoPrune = jcr->client->AutoPrune;
139 cr.FileRetention = jcr->client->FileRetention;
140 cr.JobRetention = jcr->client->JobRetention;
141 bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
142 if (!db_update_client_record(jcr, jcr->db, &cr)) {
143 Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
144 db_strerror(jcr->db));
148 Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
150 set_jcr_job_status(jcr, JS_ErrorTerminated);
157 * This subroutine edits the last job start time into a
158 * "since=date/time" buffer that is returned in the
159 * variable since. This is used for display purposes in
160 * the job report. The time in jcr->stime is later
161 * passed to tell the File daemon what to do.
163 void get_level_since_time(JCR *jcr, char *since, int since_len)
169 if (jcr->stime && jcr->stime[0]) {
170 bstrncpy(since, _(", since="), since_len);
171 bstrncat(since, jcr->stime, since_len);
176 jcr->stime = get_pool_memory(PM_MESSAGE);
179 /* Lookup the last FULL backup job to get the time/date for a
180 * differential or incremental save.
182 switch (jcr->JobLevel) {
185 /* Look up start time of last job */
186 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
187 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
188 /* No job found, so upgrade this one to Full */
189 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
190 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found in catalog. Doing FULL backup.\n"));
191 bsnprintf(since, since_len, _(" (upgraded from %s)"),
192 level_to_str(jcr->JobLevel));
193 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
195 if (jcr->job->rerun_failed_levels) {
196 if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr, jcr->stime, JobLevel)) {
197 Jmsg(jcr, M_INFO, 0, _("Prior failed job found in catalog. Upgrading to %s.\n"),
198 level_to_str(JobLevel));
199 bsnprintf(since, since_len, _(" (upgraded from %s)"),
200 level_to_str(jcr->JobLevel));
201 jcr->JobLevel = jcr->jr.JobLevel = JobLevel;
202 jcr->jr.JobId = jcr->JobId;
206 bstrncpy(since, _(", since="), since_len);
207 bstrncat(since, jcr->stime, since_len);
209 jcr->jr.JobId = jcr->JobId;
212 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
215 static void send_since_time(JCR *jcr)
217 BSOCK *fd = jcr->file_bsock;
221 stime = str_to_utime(jcr->stime);
222 bnet_fsend(fd, levelcmd, NT_("since_utime "), edit_uint64(stime, ed1), 0);
223 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
224 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
230 * Send level command to FD.
231 * Used for backup jobs and estimate command.
233 bool send_level_command(JCR *jcr)
235 BSOCK *fd = jcr->file_bsock;
237 * Send Level command to File daemon
239 switch (jcr->JobLevel) {
241 bnet_fsend(fd, levelcmd, "base", " ", 0);
243 /* L_NONE is the console, sending something off to the FD */
246 bnet_fsend(fd, levelcmd, "full", " ", 0);
249 bnet_fsend(fd, levelcmd, "differential", " ", 0);
250 send_since_time(jcr);
253 bnet_fsend(fd, levelcmd, "incremental", " ", 0);
254 send_since_time(jcr);
258 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
259 jcr->JobLevel, jcr->JobLevel);
262 Dmsg1(120, ">filed: %s", fd->msg);
263 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
270 * Send either an Included or an Excluded list to FD
272 static bool send_fileset(JCR *jcr)
274 FILESET *fileset = jcr->fileset;
275 BSOCK *fd = jcr->file_bsock;
281 num = fileset->num_includes;
283 num = fileset->num_excludes;
285 for (int i=0; i<num; i++) {
295 ie = fileset->include_items[i];
296 bnet_fsend(fd, "I\n");
298 ie = fileset->exclude_items[i];
299 bnet_fsend(fd, "E\n");
301 for (j=0; j<ie->num_opts; j++) {
302 FOPTS *fo = ie->opts_list[j];
303 bnet_fsend(fd, "O %s\n", fo->opts);
305 bool enhanced_wild = false;
306 for (k=0; fo->opts[k]!='\0'; k++) {
307 if (fo->opts[k]=='W') {
308 enhanced_wild = true;
313 for (k=0; k<fo->regex.size(); k++) {
314 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
316 for (k=0; k<fo->regexdir.size(); k++) {
317 bnet_fsend(fd, "RD %s\n", fo->regexdir.get(k));
319 for (k=0; k<fo->regexfile.size(); k++) {
320 bnet_fsend(fd, "RF %s\n", fo->regexfile.get(k));
322 for (k=0; k<fo->wild.size(); k++) {
323 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
325 for (k=0; k<fo->wilddir.size(); k++) {
326 bnet_fsend(fd, "WD %s\n", fo->wilddir.get(k));
328 for (k=0; k<fo->wildfile.size(); k++) {
329 bnet_fsend(fd, "WF %s\n", fo->wildfile.get(k));
331 for (k=0; k<fo->wildbase.size(); k++) {
332 bnet_fsend(fd, "W%c %s\n", enhanced_wild ? 'B' : 'F', fo->wildbase.get(k));
334 for (k=0; k<fo->base.size(); k++) {
335 bnet_fsend(fd, "B %s\n", fo->base.get(k));
337 for (k=0; k<fo->fstype.size(); k++) {
338 bnet_fsend(fd, "X %s\n", fo->fstype.get(k));
340 for (k=0; k<fo->drivetype.size(); k++) {
341 bnet_fsend(fd, "XD %s\n", fo->drivetype.get(k));
344 bnet_fsend(fd, "D %s\n", fo->reader);
347 bnet_fsend(fd, "T %s\n", fo->writer);
349 bnet_fsend(fd, "N\n");
352 for (j=0; j<ie->name_list.size(); j++) {
353 p = (char *)ie->name_list.get(j);
356 p++; /* skip over the | */
357 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
358 bpipe = open_bpipe(fd->msg, 0, "r");
361 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
365 bstrncpy(buf, "F ", sizeof(buf));
366 Dmsg1(500, "Opts=%s\n", buf);
367 optlen = strlen(buf);
368 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
369 fd->msglen = Mmsg(fd->msg, "%s", buf);
370 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
371 if (!bnet_send(fd)) {
372 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
376 if ((stat=close_bpipe(bpipe)) != 0) {
378 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
379 p, be.bstrerror(stat));
384 p++; /* skip over < */
385 if ((ffd = fopen(p, "rb")) == NULL) {
387 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
391 bstrncpy(buf, "F ", sizeof(buf));
392 Dmsg1(500, "Opts=%s\n", buf);
393 optlen = strlen(buf);
394 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
395 fd->msglen = Mmsg(fd->msg, "%s", buf);
396 if (!bnet_send(fd)) {
397 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
404 p++; /* skip over \ */
405 /* Note, fall through wanted */
407 pm_strcpy(fd->msg, "F ");
408 fd->msglen = pm_strcat(fd->msg, p);
409 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
410 if (!bnet_send(fd)) {
411 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
417 bnet_fsend(fd, "N\n");
419 if (!include) { /* If we just did excludes */
420 break; /* all done */
422 include = false; /* Now do excludes */
425 bnet_sig(fd, BNET_EOD); /* end of data */
426 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
432 set_jcr_job_status(jcr, JS_ErrorTerminated);
439 * Send include list to File daemon
441 bool send_include_list(JCR *jcr)
443 BSOCK *fd = jcr->file_bsock;
444 if (jcr->fileset->new_include) {
445 bnet_fsend(fd, filesetcmd, jcr->fileset->enable_vss ? " vss=1" : "");
446 return send_fileset(jcr);
453 * Send exclude list to File daemon
454 * Under the new scheme, the Exclude list
455 * is part of the FileSet sent with the
456 * "include_list" above.
458 bool send_exclude_list(JCR *jcr)
465 * Send bootstrap file if any to the socket given (FD or SD).
466 * This is used for restore, verify VolumeToCatalog, and
469 bool send_bootstrap_file(JCR *jcr, BSOCK *sock)
473 const char *bootstrap = "bootstrap\n";
475 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
476 if (!jcr->RestoreBootstrap) {
479 bs = fopen(jcr->RestoreBootstrap, "rb");
482 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
483 jcr->RestoreBootstrap, be.bstrerror());
484 set_jcr_job_status(jcr, JS_ErrorTerminated);
487 bnet_fsend(sock, bootstrap);
488 while (fgets(buf, sizeof(buf), bs)) {
489 bnet_fsend(sock, "%s", buf);
491 bnet_sig(sock, BNET_EOD);
493 if (jcr->unlink_bsr) {
494 unlink(jcr->RestoreBootstrap);
495 jcr->unlink_bsr = false;
500 /* TODO: drop this with runscript.old_proto in bacula 1.42 */
501 static char runbefore[] = "RunBeforeJob %s\n";
502 static char runafter[] = "RunAfterJob %s\n";
503 static char OKRunBefore[] = "2000 OK RunBefore\n";
504 static char OKRunAfter[] = "2000 OK RunAfter\n";
506 int send_runscript_with_old_proto(JCR *jcr, int when, POOLMEM *msg)
509 Dmsg1(120, "bdird: sending old runcommand to fd '%s'\n",msg);
510 if (when & SCRIPT_Before) {
511 bnet_fsend(jcr->file_bsock, runbefore, msg);
512 ret = response(jcr, jcr->file_bsock, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR);
514 bnet_fsend(jcr->file_bsock, runafter, msg);
515 ret = response(jcr, jcr->file_bsock, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR);
521 * Send RunScripts to File daemon
522 * 1) We send all runscript to FD, they can be executed Before, After, or twice
523 * 2) Then, we send a "RunBeforeNow" command to the FD to tell him to do the
524 * first run_script() call. (ie ClientRunBeforeJob)
526 int send_runscripts_commands(JCR *jcr)
528 POOLMEM *msg = get_pool_memory(PM_FNAME);
529 BSOCK *fd = jcr->file_bsock;
531 bool launch_before_cmd = false;
532 POOLMEM *ehost = get_pool_memory(PM_FNAME);
535 Dmsg0(120, "bdird: sending runscripts to fd\n");
537 foreach_alist(cmd, jcr->job->RunScripts) {
538 if (cmd->can_run_at_level(jcr->JobLevel) && cmd->target) {
539 ehost = edit_job_codes(jcr, ehost, cmd->target, "");
540 Dmsg2(200, "bdird: runscript %s -> %s\n", cmd->target, ehost);
542 if (strcmp(ehost, jcr->client->name()) == 0) {
543 pm_strcpy(msg, cmd->command);
546 Dmsg1(120, "bdird: sending runscripts to fd '%s'\n", cmd->command);
548 /* TODO: remove this with bacula 1.42 */
549 if (cmd->old_proto) {
550 result = send_runscript_with_old_proto(jcr, cmd->when, msg);
553 bnet_fsend(fd, runscript, cmd->on_success,
559 result = response(jcr, fd, OKRunScript, "RunScript", DISPLAY_ERROR);
560 launch_before_cmd = true;
567 /* TODO : we have to play with other client */
570 send command to an other client
576 /* Tell the FD to execute the ClientRunBeforeJob */
577 if (launch_before_cmd) {
578 bnet_fsend(fd, runbeforenow);
579 if (!response(jcr, fd, OKRunBeforeNow, "RunBeforeNow", DISPLAY_ERROR)) {
583 free_pool_memory(msg);
584 free_pool_memory(ehost);
588 Jmsg(jcr, M_FATAL, 0, _("Client \"%s\" RunScript failed.\n"), ehost);
589 free_pool_memory(msg);
590 free_pool_memory(ehost);
597 * Read the attributes from the File daemon for
598 * a Verify job and store them in the catalog.
600 int get_attributes_and_put_in_catalog(JCR *jcr)
605 char digest[MAXSTRING];
607 fd = jcr->file_bsock;
608 jcr->jr.FirstIndex = 1;
610 /* Start transaction allocates jcr->attr and jcr->ar if needed */
611 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
614 Dmsg0(120, "bdird: waiting to receive file attributes\n");
615 /* Pickup file attributes and digest */
616 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
620 char Digest[MAXSTRING]; /* either Verify opts or MD5/SHA1 digest */
622 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
623 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Digest)) != 3) {
624 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
625 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
626 set_jcr_job_status(jcr, JS_ErrorTerminated);
630 /* The following three fields were sscanf'ed above so skip them */
631 skip_nonspaces(&p); /* skip FileIndex */
633 skip_nonspaces(&p); /* skip Stream */
635 skip_nonspaces(&p); /* skip Opts_Digest */
636 p++; /* skip space */
637 Dmsg1(dbglvl, "Stream=%d\n", stream);
638 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
639 if (jcr->cached_attribute) {
640 Dmsg3(dbglvl, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname,
642 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
643 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
646 /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
649 *fn++ = *p++; /* copy filename */
651 *fn = *p++; /* term filename and point p to attribs */
652 pm_strcpy(jcr->attr, p); /* save attributes */
654 jcr->FileIndex = file_index;
655 ar->attr = jcr->attr;
656 ar->fname = jcr->fname;
657 ar->FileIndex = file_index;
660 ar->JobId = jcr->JobId;
661 ar->ClientId = jcr->ClientId;
665 ar->DigestType = CRYPTO_DIGEST_NONE;
666 jcr->cached_attribute = true;
668 Dmsg2(dbglvl, "dird<filed: stream=%d %s\n", stream, jcr->fname);
669 Dmsg1(dbglvl, "dird<filed: attr=%s\n", ar->attr);
670 jcr->FileId = ar->FileId;
672 * First, get STREAM_UNIX_ATTRIBUTES and fill ATTR_DBR structure
673 * Next, we CAN have a CRYPTO_DIGEST, so we fill ATTR_DBR with it (or not)
674 * When we get a new STREAM_UNIX_ATTRIBUTES, we known that we can add file to the catalog
675 * At the end, we have to add the last file
677 } else if (crypto_digest_stream_type(stream) != CRYPTO_DIGEST_NONE) {
678 if (jcr->FileIndex != (uint32_t)file_index) {
679 Jmsg3(jcr, M_ERROR, 0, _("%s index %d not same as attributes %d\n"),
680 stream_to_ascii(stream), file_index, jcr->FileIndex);
684 ar->DigestType = crypto_digest_stream_type(stream);
685 db_escape_string(jcr, jcr->db, digest, Digest, strlen(Digest));
686 Dmsg4(dbglvl, "stream=%d DigestLen=%d Digest=%s type=%d\n", stream,
687 strlen(digest), digest, ar->DigestType);
689 jcr->jr.JobFiles = jcr->JobFiles = file_index;
690 jcr->jr.LastIndex = file_index;
692 if (is_bnet_error(fd)) {
693 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
697 if (jcr->cached_attribute) {
698 Dmsg3(dbglvl, "Cached attr with digest. Stream=%d fname=%s attr=%s\n", ar->Stream,
699 ar->fname, ar->attr);
700 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
701 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
703 jcr->cached_attribute = false;
705 set_jcr_job_status(jcr, JS_Terminated);