3 * Bacula Director -- fd_cmds.c -- send commands to File daemon
5 * Kern Sibbald, October MM
7 * This routine is run as a separate thread. There may be more
8 * work to be done to make it totally reentrant!!!!
10 * Utility functions for sending info to File Daemon.
11 * These functions are used by both backup and verify.
16 Copyright (C) 2000-2005 Kern Sibbald
18 This program is free software; you can redistribute it and/or
19 modify it under the terms of the GNU General Public License as
20 published by the Free Software Foundation; either version 2 of
21 the License, or (at your option) any later version.
23 This program is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 General Public License for more details.
28 You should have received a copy of the GNU General Public
29 License along with this program; if not, write to the Free
30 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
38 /* Commands sent to File daemon */
39 static char inc[] = "include\n";
40 static char exc[] = "exclude\n";
41 static char fileset[] = "fileset\n"; /* set full fileset */
42 static char jobcmd[] = "JobId=%d Job=%s SDid=%u SDtime=%u Authorization=%s\n";
43 /* Note, mtime_only is not used here -- implemented as file option */
44 static char levelcmd[] = "level = %s%s mtime_only=%d\n";
45 static char runbefore[] = "RunBeforeJob %s\n";
46 static char runafter[] = "RunAfterJob %s\n";
49 /* Responses received from File daemon */
50 static char OKinc[] = "2000 OK include\n";
51 static char OKexc[] = "2000 OK exclude\n";
52 static char OKjob[] = "2000 OK Job";
53 static char OKbootstrap[] = "2000 OK bootstrap\n";
54 static char OKlevel[] = "2000 OK level\n";
55 static char OKRunBefore[] = "2000 OK RunBefore\n";
56 static char OKRunAfter[] = "2000 OK RunAfter\n";
58 /* Forward referenced functions */
60 /* External functions */
61 extern int debug_level;
62 extern DIRRES *director;
63 extern int FDConnectTimeout;
69 * Open connection with File daemon.
70 * Try connecting every retry_interval (default 10 sec), and
71 * give up after max_retry_time (default 30 mins).
74 int connect_to_file_daemon(JCR *jcr, int retry_interval, int max_retry_time,
79 if (!jcr->file_bsock) {
80 fd = bnet_connect(jcr, retry_interval, max_retry_time,
81 _("File daemon"), jcr->client->address,
82 NULL, jcr->client->FDport, verbose);
84 set_jcr_job_status(jcr, JS_ErrorTerminated);
87 Dmsg0(10, "Opened connection with File daemon\n");
89 fd = jcr->file_bsock; /* use existing connection */
91 fd->res = (RES *)jcr->client; /* save resource in BSOCK */
93 set_jcr_job_status(jcr, JS_Running);
95 if (!authenticate_file_daemon(jcr)) {
96 set_jcr_job_status(jcr, JS_ErrorTerminated);
101 * Now send JobId and authorization key
103 bnet_fsend(fd, jobcmd, jcr->JobId, jcr->Job, jcr->VolSessionId,
104 jcr->VolSessionTime, jcr->sd_auth_key);
105 if (strcmp(jcr->sd_auth_key, "dummy") != 0) {
106 memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
108 Dmsg1(100, ">filed: %s", fd->msg);
109 if (bget_dirmsg(fd) > 0) {
110 Dmsg1(110, "<filed: %s", fd->msg);
111 if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
112 Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
113 jcr->client->hdr.name, fd->msg);
114 set_jcr_job_status(jcr, JS_ErrorTerminated);
116 } else if (jcr->db) {
118 memset(&cr, 0, sizeof(cr));
119 bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
120 cr.AutoPrune = jcr->client->AutoPrune;
121 cr.FileRetention = jcr->client->FileRetention;
122 cr.JobRetention = jcr->client->JobRetention;
123 bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
124 if (!db_update_client_record(jcr, jcr->db, &cr)) {
125 Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
126 db_strerror(jcr->db));
130 Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
132 set_jcr_job_status(jcr, JS_ErrorTerminated);
139 * This subroutine edits the last job start time into a
140 * "since=date/time" buffer that is returned in the
141 * variable since. This is used for display purposes in
142 * the job report. The time in jcr->stime is later
143 * passed to tell the File daemon what to do.
145 void get_level_since_time(JCR *jcr, char *since, int since_len)
151 if ( jcr->stime && jcr->stime[0]) {
152 bstrncpy(since, ", since=", since_len);
153 bstrncat(since, jcr->stime, since_len);
158 jcr->stime = get_pool_memory(PM_MESSAGE);
161 /* Lookup the last FULL backup job to get the time/date for a
162 * differential or incremental save.
164 switch (jcr->JobLevel) {
167 /* Look up start time of last job */
168 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
169 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
170 /* No job found, so upgrade this one to Full */
171 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
172 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found. Doing FULL backup.\n"));
173 bsnprintf(since, since_len, " (upgraded from %s)",
174 level_to_str(jcr->JobLevel));
175 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
177 if (jcr->job->rerun_failed_levels) {
178 if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr, jcr->stime, JobLevel)) {
179 Jmsg(jcr, M_INFO, 0, _("Prior failed job found. Upgrading to %s.\n"),
180 level_to_str(JobLevel));
181 bsnprintf(since, since_len, " (upgraded from %s)",
182 level_to_str(jcr->JobLevel));
183 jcr->JobLevel = jcr->jr.JobLevel = JobLevel;
184 jcr->jr.JobId = jcr->JobId;
188 bstrncpy(since, ", since=", since_len);
189 bstrncat(since, jcr->stime, since_len);
191 jcr->jr.JobId = jcr->JobId;
194 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
197 static void send_since_time(JCR *jcr)
199 BSOCK *fd = jcr->file_bsock;
203 stime = str_to_utime(jcr->stime);
204 bnet_fsend(fd, levelcmd, "since_utime ", edit_uint64(stime, ed1), 0);
205 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
206 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
212 * Send level command to FD.
213 * Used for backup jobs and estimate command.
215 int send_level_command(JCR *jcr)
217 BSOCK *fd = jcr->file_bsock;
219 * Send Level command to File daemon
221 switch (jcr->JobLevel) {
223 bnet_fsend(fd, levelcmd, "base", " ", 0);
225 /* L_NONE is the console, sending something off to the FD */
228 bnet_fsend(fd, levelcmd, "full", " ", 0);
231 bnet_fsend(fd, levelcmd, "differential", " ", 0);
232 send_since_time(jcr);
235 bnet_fsend(fd, levelcmd, "incremental", " ", 0);
236 send_since_time(jcr);
240 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
241 jcr->JobLevel, jcr->JobLevel);
244 Dmsg1(120, ">filed: %s", fd->msg);
245 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
253 * Send either an Included or an Excluded list to FD
255 static int send_list(JCR *jcr, int list)
261 fd = jcr->file_bsock;
262 fileset = jcr->fileset;
264 if (list == INC_LIST) {
265 num = fileset->num_includes;
267 num = fileset->num_excludes;
270 for (int i=0; i<num; i++) {
279 if (list == INC_LIST) {
280 ie = fileset->include_items[i];
282 ie = fileset->exclude_items[i];
284 for (int j=0; j<ie->name_list.size(); j++) {
285 p = (char *)ie->name_list.get(j);
288 p++; /* skip over the | */
289 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
290 bpipe = open_bpipe(fd->msg, 0, "r");
293 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
297 /* Copy File options */
299 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
300 bstrncat(buf, " ", sizeof(buf));
302 bstrncpy(buf, "0 ", sizeof(buf));
304 Dmsg1(500, "Opts=%s\n", buf);
305 optlen = strlen(buf);
306 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
307 fd->msglen = Mmsg(fd->msg, "%s", buf);
308 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
309 if (!bnet_send(fd)) {
310 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
314 if ((stat=close_bpipe(bpipe)) != 0) {
316 Jmsg(jcr, M_FATAL, 0, _("Error running program %p: ERR=%s\n"),
317 p, be.strerror(stat));
322 p++; /* skip over < */
323 if ((ffd = fopen(p, "r")) == NULL) {
324 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
325 list==INC_LIST?"included":"excluded", p, strerror(errno));
328 /* Copy File options */
330 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
331 bstrncat(buf, " ", sizeof(buf));
333 bstrncpy(buf, "0 ", sizeof(buf));
335 Dmsg1(500, "Opts=%s\n", buf);
336 optlen = strlen(buf);
337 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
338 fd->msglen = Mmsg(fd->msg, "%s", buf);
339 if (!bnet_send(fd)) {
340 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
347 p++; /* skip over \ */
348 /* Note, fall through wanted */
351 Dmsg2(500, "numopts=%d opts=%s\n", ie->num_opts, NPRT(ie->opts_list[0]->opts));
352 pm_strcpy(fd->msg, ie->opts_list[0]->opts);
353 pm_strcat(fd->msg, " ");
355 pm_strcpy(fd->msg, "0 ");
357 fd->msglen = pm_strcat(fd->msg, p);
358 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
359 if (!bnet_send(fd)) {
360 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
367 bnet_sig(fd, BNET_EOD); /* end of data */
368 if (list == INC_LIST) {
369 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
372 } else if (!response(jcr, fd, OKexc, "Exclude", DISPLAY_ERROR)) {
378 set_jcr_job_status(jcr, JS_ErrorTerminated);
385 * Send either an Included or an Excluded list to FD
387 static int send_fileset(JCR *jcr)
389 FILESET *fileset = jcr->fileset;
390 BSOCK *fd = jcr->file_bsock;
396 num = fileset->num_includes;
398 num = fileset->num_excludes;
400 for (int i=0; i<num; i++) {
410 ie = fileset->include_items[i];
411 bnet_fsend(fd, "I\n");
413 ie = fileset->exclude_items[i];
414 bnet_fsend(fd, "E\n");
416 for (j=0; j<ie->num_opts; j++) {
417 FOPTS *fo = ie->opts_list[j];
418 bnet_fsend(fd, "O %s\n", fo->opts);
419 for (k=0; k<fo->regex.size(); k++) {
420 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
422 for (k=0; k<fo->regexdir.size(); k++) {
423 bnet_fsend(fd, "RD %s\n", fo->regexdir.get(k));
425 for (k=0; k<fo->regexfile.size(); k++) {
426 bnet_fsend(fd, "RF %s\n", fo->regexfile.get(k));
428 for (k=0; k<fo->wild.size(); k++) {
429 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
431 for (k=0; k<fo->wilddir.size(); k++) {
432 bnet_fsend(fd, "WD %s\n", fo->wilddir.get(k));
434 for (k=0; k<fo->wildfile.size(); k++) {
435 bnet_fsend(fd, "WF %s\n", fo->wildfile.get(k));
437 for (k=0; k<fo->base.size(); k++) {
438 bnet_fsend(fd, "B %s\n", fo->base.get(k));
440 for (k=0; k<fo->fstype.size(); k++) {
441 bnet_fsend(fd, "X %s\n", fo->fstype.get(k));
444 bnet_fsend(fd, "D %s\n", fo->reader);
447 bnet_fsend(fd, "T %s\n", fo->writer);
449 bnet_fsend(fd, "N\n");
452 for (j=0; j<ie->name_list.size(); j++) {
453 p = (char *)ie->name_list.get(j);
456 p++; /* skip over the | */
457 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
458 bpipe = open_bpipe(fd->msg, 0, "r");
461 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
465 bstrncpy(buf, "F ", sizeof(buf));
466 Dmsg1(500, "Opts=%s\n", buf);
467 optlen = strlen(buf);
468 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
469 fd->msglen = Mmsg(fd->msg, "%s", buf);
470 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
471 if (!bnet_send(fd)) {
472 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
476 if ((stat=close_bpipe(bpipe)) != 0) {
478 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
479 p, be.strerror(stat));
484 p++; /* skip over < */
485 if ((ffd = fopen(p, "r")) == NULL) {
487 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
491 bstrncpy(buf, "F ", sizeof(buf));
492 Dmsg1(500, "Opts=%s\n", buf);
493 optlen = strlen(buf);
494 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
495 fd->msglen = Mmsg(fd->msg, "%s", buf);
496 if (!bnet_send(fd)) {
497 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
504 p++; /* skip over \ */
505 /* Note, fall through wanted */
507 pm_strcpy(fd->msg, "F ");
508 fd->msglen = pm_strcat(fd->msg, p);
509 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
510 if (!bnet_send(fd)) {
511 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
517 bnet_fsend(fd, "N\n");
519 if (!include) { /* If we just did excludes */
520 break; /* all done */
522 include = false; /* Now do excludes */
525 bnet_sig(fd, BNET_EOD); /* end of data */
526 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
532 set_jcr_job_status(jcr, JS_ErrorTerminated);
539 * Send include list to File daemon
541 int send_include_list(JCR *jcr)
543 BSOCK *fd = jcr->file_bsock;
544 if (jcr->fileset->new_include) {
545 bnet_fsend(fd, fileset);
546 return send_fileset(jcr);
550 return send_list(jcr, INC_LIST);
555 * Send exclude list to File daemon
557 int send_exclude_list(JCR *jcr)
559 BSOCK *fd = jcr->file_bsock;
560 if (jcr->fileset->new_include) {
564 return send_list(jcr, EXC_LIST);
569 * Send bootstrap file if any to the File daemon.
570 * This is used for restore and verify VolumeToCatalog
572 int send_bootstrap_file(JCR *jcr)
576 BSOCK *fd = jcr->file_bsock;
577 const char *bootstrap = "bootstrap\n";
579 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
580 if (!jcr->RestoreBootstrap) {
583 bs = fopen(jcr->RestoreBootstrap, "r");
586 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
587 jcr->RestoreBootstrap, be.strerror());
588 set_jcr_job_status(jcr, JS_ErrorTerminated);
591 bnet_fsend(fd, bootstrap);
592 while (fgets(buf, sizeof(buf), bs)) {
593 bnet_fsend(fd, "%s", buf);
595 bnet_sig(fd, BNET_EOD);
597 if (!response(jcr, fd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
598 set_jcr_job_status(jcr, JS_ErrorTerminated);
605 * Send ClientRunBeforeJob and ClientRunAfterJob to File daemon
607 int send_run_before_and_after_commands(JCR *jcr)
609 POOLMEM *msg = get_pool_memory(PM_FNAME);
610 BSOCK *fd = jcr->file_bsock;
611 if (jcr->job->ClientRunBeforeJob) {
612 pm_strcpy(msg, jcr->job->ClientRunBeforeJob);
614 bnet_fsend(fd, runbefore, msg);
615 if (!response(jcr, fd, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR)) {
616 set_jcr_job_status(jcr, JS_ErrorTerminated);
617 free_pool_memory(msg);
621 if (jcr->job->ClientRunAfterJob) {
622 fd->msglen = pm_strcpy(msg, jcr->job->ClientRunAfterJob);
624 bnet_fsend(fd, runafter, msg);
625 if (!response(jcr, fd, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR)) {
626 set_jcr_job_status(jcr, JS_ErrorTerminated);
627 free_pool_memory(msg);
631 free_pool_memory(msg);
637 * Read the attributes from the File daemon for
638 * a Verify job and store them in the catalog.
640 int get_attributes_and_put_in_catalog(JCR *jcr)
646 fd = jcr->file_bsock;
647 jcr->jr.FirstIndex = 1;
648 memset(&ar, 0, sizeof(ar));
651 Dmsg0(120, "bdird: waiting to receive file attributes\n");
652 /* Pickup file attributes and signature */
653 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
655 /*****FIXME****** improve error handling to stop only on
656 * really fatal problems, or the number of errors is too
662 char Opts_SIG[MAXSTRING]; /* either Verify opts or MD5/SHA1 signature */
665 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
666 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Opts_SIG)) != 3) {
667 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
668 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
669 set_jcr_job_status(jcr, JS_ErrorTerminated);
673 skip_nonspaces(&p); /* skip FileIndex */
675 skip_nonspaces(&p); /* skip Stream */
677 skip_nonspaces(&p); /* skip Opts_SHA1 */
678 p++; /* skip space */
681 *fn++ = *p++; /* copy filename */
683 *fn = *p++; /* term filename and point to attribs */
686 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
688 jcr->FileIndex = file_index;
690 ar.fname = jcr->fname;
691 ar.FileIndex = file_index;
694 ar.JobId = jcr->JobId;
695 ar.ClientId = jcr->ClientId;
699 Dmsg2(111, "dird<filed: stream=%d %s\n", stream, jcr->fname);
700 Dmsg1(120, "dird<filed: attr=%s\n", attr);
702 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
703 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
704 set_jcr_job_status(jcr, JS_Error);
707 jcr->FileId = ar.FileId;
708 } else if (stream == STREAM_MD5_SIGNATURE || stream == STREAM_SHA1_SIGNATURE) {
709 if (jcr->FileIndex != (uint32_t)file_index) {
710 Jmsg2(jcr, M_ERROR, 0, _("MD5/SHA1 index %d not same as attributes %d\n"),
711 file_index, jcr->FileIndex);
712 set_jcr_job_status(jcr, JS_Error);
715 db_escape_string(SIG, Opts_SIG, strlen(Opts_SIG));
716 Dmsg2(120, "SIGlen=%d SIG=%s\n", strlen(SIG), SIG);
717 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIG,
718 stream==STREAM_MD5_SIGNATURE?MD5_SIG:SHA1_SIG)) {
719 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
720 set_jcr_job_status(jcr, JS_Error);
723 jcr->jr.JobFiles = jcr->JobFiles = file_index;
724 jcr->jr.LastIndex = file_index;
726 if (is_bnet_error(fd)) {
727 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
729 set_jcr_job_status(jcr, JS_ErrorTerminated);
733 set_jcr_job_status(jcr, JS_Terminated);