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-2004 Kern Sibbald and John Walker
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)
148 /* Lookup the last FULL backup job to get the time/date for a
149 * differential or incremental save.
152 jcr->stime = get_pool_memory(PM_MESSAGE);
156 switch (jcr->JobLevel) {
159 /* Look up start time of last job */
160 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
161 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
162 /* No job found, so upgrade this one to Full */
163 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
164 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found. Doing FULL backup.\n"));
165 bsnprintf(since, since_len, " (upgraded from %s)",
166 level_to_str(jcr->JobLevel));
167 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
169 if (jcr->job->rerun_failed_levels) {
170 if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr, jcr->stime, JobLevel)) {
171 Jmsg(jcr, M_INFO, 0, _("Prior failed job found. Upgrading to %s.\n"),
172 level_to_str(JobLevel));
173 bsnprintf(since, since_len, " (upgraded from %s)",
174 level_to_str(jcr->JobLevel));
175 jcr->JobLevel = jcr->jr.JobLevel = JobLevel;
176 jcr->jr.JobId = jcr->JobId;
180 bstrncpy(since, ", since=", since_len);
181 bstrncat(since, jcr->stime, since_len);
183 jcr->jr.JobId = jcr->JobId;
186 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
191 * Send level command to FD.
192 * Used for backup jobs and estimate command.
194 int send_level_command(JCR *jcr)
196 BSOCK *fd = jcr->file_bsock;
200 * Send Level command to File daemon
202 switch (jcr->JobLevel) {
204 bnet_fsend(fd, levelcmd, "base", " ", 0);
206 /* L_NONE is the console, sending something off to the FD */
209 bnet_fsend(fd, levelcmd, "full", " ", 0);
213 stime = str_to_utime(jcr->stime);
214 bnet_fsend(fd, levelcmd, "since_utime ", edit_uint64(stime, ed1), 0);
215 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
216 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
221 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
222 jcr->JobLevel, jcr->JobLevel);
225 Dmsg1(120, ">filed: %s", fd->msg);
226 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
234 * Send either an Included or an Excluded list to FD
236 static int send_list(JCR *jcr, int list)
242 fd = jcr->file_bsock;
243 fileset = jcr->fileset;
245 if (list == INC_LIST) {
246 num = fileset->num_includes;
248 num = fileset->num_excludes;
251 for (int i=0; i<num; i++) {
260 if (list == INC_LIST) {
261 ie = fileset->include_items[i];
263 ie = fileset->exclude_items[i];
265 for (int j=0; j<ie->name_list.size(); j++) {
266 p = (char *)ie->name_list.get(j);
269 p++; /* skip over the | */
270 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
271 bpipe = open_bpipe(fd->msg, 0, "r");
274 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
278 /* Copy File options */
280 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
281 bstrncat(buf, " ", sizeof(buf));
283 bstrncpy(buf, "0 ", sizeof(buf));
285 Dmsg1(500, "Opts=%s\n", buf);
286 optlen = strlen(buf);
287 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
288 fd->msglen = Mmsg(fd->msg, "%s", buf);
289 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
290 if (!bnet_send(fd)) {
291 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
295 if ((stat=close_bpipe(bpipe)) != 0) {
297 Jmsg(jcr, M_FATAL, 0, _("Error running program %p: ERR=%s\n"),
298 p, be.strerror(stat));
303 p++; /* skip over < */
304 if ((ffd = fopen(p, "r")) == NULL) {
305 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
306 list==INC_LIST?"included":"excluded", p, strerror(errno));
309 /* Copy File options */
311 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
312 bstrncat(buf, " ", sizeof(buf));
314 bstrncpy(buf, "0 ", sizeof(buf));
316 Dmsg1(500, "Opts=%s\n", buf);
317 optlen = strlen(buf);
318 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
319 fd->msglen = Mmsg(fd->msg, "%s", buf);
320 if (!bnet_send(fd)) {
321 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
328 p++; /* skip over \ */
329 /* Note, fall through wanted */
332 Dmsg2(500, "numopts=%d opts=%s\n", ie->num_opts, NPRT(ie->opts_list[0]->opts));
333 pm_strcpy(fd->msg, ie->opts_list[0]->opts);
334 pm_strcat(fd->msg, " ");
336 pm_strcpy(fd->msg, "0 ");
338 fd->msglen = pm_strcat(fd->msg, p);
339 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
340 if (!bnet_send(fd)) {
341 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
348 bnet_sig(fd, BNET_EOD); /* end of data */
349 if (list == INC_LIST) {
350 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
353 } else if (!response(jcr, fd, OKexc, "Exclude", DISPLAY_ERROR)) {
359 set_jcr_job_status(jcr, JS_ErrorTerminated);
366 * Send either an Included or an Excluded list to FD
368 static int send_fileset(JCR *jcr)
370 FILESET *fileset = jcr->fileset;
371 BSOCK *fd = jcr->file_bsock;
377 num = fileset->num_includes;
379 num = fileset->num_excludes;
381 for (int i=0; i<num; i++) {
391 ie = fileset->include_items[i];
392 bnet_fsend(fd, "I\n");
394 ie = fileset->exclude_items[i];
395 bnet_fsend(fd, "E\n");
397 for (j=0; j<ie->num_opts; j++) {
398 FOPTS *fo = ie->opts_list[j];
399 bnet_fsend(fd, "O %s\n", fo->opts);
400 for (k=0; k<fo->regex.size(); k++) {
401 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
403 for (k=0; k<fo->wild.size(); k++) {
404 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
406 for (k=0; k<fo->base.size(); k++) {
407 bnet_fsend(fd, "B %s\n", fo->base.get(k));
409 for (k=0; k<fo->fstype.size(); k++) {
410 bnet_fsend(fd, "X %s\n", fo->fstype.get(k));
413 bnet_fsend(fd, "D %s\n", fo->reader);
416 bnet_fsend(fd, "T %s\n", fo->writer);
418 bnet_fsend(fd, "N\n");
421 for (j=0; j<ie->name_list.size(); j++) {
422 p = (char *)ie->name_list.get(j);
425 p++; /* skip over the | */
426 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
427 bpipe = open_bpipe(fd->msg, 0, "r");
430 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
434 bstrncpy(buf, "F ", sizeof(buf));
435 Dmsg1(500, "Opts=%s\n", buf);
436 optlen = strlen(buf);
437 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
438 fd->msglen = Mmsg(fd->msg, "%s", buf);
439 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
440 if (!bnet_send(fd)) {
441 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
445 if ((stat=close_bpipe(bpipe)) != 0) {
447 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
448 p, be.strerror(stat));
453 p++; /* skip over < */
454 if ((ffd = fopen(p, "r")) == NULL) {
456 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
460 bstrncpy(buf, "F ", sizeof(buf));
461 Dmsg1(500, "Opts=%s\n", buf);
462 optlen = strlen(buf);
463 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
464 fd->msglen = Mmsg(fd->msg, "%s", buf);
465 if (!bnet_send(fd)) {
466 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
473 p++; /* skip over \ */
474 /* Note, fall through wanted */
476 pm_strcpy(fd->msg, "F ");
477 fd->msglen = pm_strcat(fd->msg, p);
478 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
479 if (!bnet_send(fd)) {
480 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
486 bnet_fsend(fd, "N\n");
488 if (!include) { /* If we just did excludes */
489 break; /* all done */
491 include = false; /* Now do excludes */
494 bnet_sig(fd, BNET_EOD); /* end of data */
495 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
501 set_jcr_job_status(jcr, JS_ErrorTerminated);
508 * Send include list to File daemon
510 int send_include_list(JCR *jcr)
512 BSOCK *fd = jcr->file_bsock;
513 if (jcr->fileset->new_include) {
514 bnet_fsend(fd, fileset);
515 return send_fileset(jcr);
519 return send_list(jcr, INC_LIST);
524 * Send exclude list to File daemon
526 int send_exclude_list(JCR *jcr)
528 BSOCK *fd = jcr->file_bsock;
529 if (jcr->fileset->new_include) {
533 return send_list(jcr, EXC_LIST);
538 * Send bootstrap file if any to the File daemon.
539 * This is used for restore and verify VolumeToCatalog
541 int send_bootstrap_file(JCR *jcr)
545 BSOCK *fd = jcr->file_bsock;
546 const char *bootstrap = "bootstrap\n";
548 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
549 if (!jcr->RestoreBootstrap) {
552 bs = fopen(jcr->RestoreBootstrap, "r");
555 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
556 jcr->RestoreBootstrap, be.strerror());
557 set_jcr_job_status(jcr, JS_ErrorTerminated);
560 bnet_fsend(fd, bootstrap);
561 while (fgets(buf, sizeof(buf), bs)) {
562 bnet_fsend(fd, "%s", buf);
564 bnet_sig(fd, BNET_EOD);
566 if (!response(jcr, fd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
567 set_jcr_job_status(jcr, JS_ErrorTerminated);
574 * Send ClientRunBeforeJob and ClientRunAfterJob to File daemon
576 int send_run_before_and_after_commands(JCR *jcr)
578 POOLMEM *msg = get_pool_memory(PM_FNAME);
579 BSOCK *fd = jcr->file_bsock;
580 if (jcr->job->ClientRunBeforeJob) {
581 pm_strcpy(msg, jcr->job->ClientRunBeforeJob);
583 bnet_fsend(fd, runbefore, msg);
584 if (!response(jcr, fd, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR)) {
585 set_jcr_job_status(jcr, JS_ErrorTerminated);
586 free_pool_memory(msg);
590 if (jcr->job->ClientRunAfterJob) {
591 fd->msglen = pm_strcpy(msg, jcr->job->ClientRunAfterJob);
593 bnet_fsend(fd, runafter, msg);
594 if (!response(jcr, fd, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR)) {
595 set_jcr_job_status(jcr, JS_ErrorTerminated);
596 free_pool_memory(msg);
600 free_pool_memory(msg);
606 * Read the attributes from the File daemon for
607 * a Verify job and store them in the catalog.
609 int get_attributes_and_put_in_catalog(JCR *jcr)
615 fd = jcr->file_bsock;
616 jcr->jr.FirstIndex = 1;
617 memset(&ar, 0, sizeof(ar));
620 Dmsg0(120, "bdird: waiting to receive file attributes\n");
621 /* Pickup file attributes and signature */
622 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
624 /*****FIXME****** improve error handling to stop only on
625 * really fatal problems, or the number of errors is too
631 char Opts_SIG[MAXSTRING]; /* either Verify opts or MD5/SHA1 signature */
634 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
635 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Opts_SIG)) != 3) {
636 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n\
637 msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
638 set_jcr_job_status(jcr, JS_ErrorTerminated);
642 skip_nonspaces(&p); /* skip FileIndex */
644 skip_nonspaces(&p); /* skip Stream */
646 skip_nonspaces(&p); /* skip Opts_SHA1 */
647 p++; /* skip space */
650 *fn++ = *p++; /* copy filename */
652 *fn = *p++; /* term filename and point to attribs */
655 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
657 jcr->FileIndex = file_index;
659 ar.fname = jcr->fname;
660 ar.FileIndex = file_index;
663 ar.JobId = jcr->JobId;
664 ar.ClientId = jcr->ClientId;
668 Dmsg2(111, "dird<filed: stream=%d %s\n", stream, jcr->fname);
669 Dmsg1(120, "dird<filed: attr=%s\n", attr);
671 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
672 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
673 set_jcr_job_status(jcr, JS_Error);
676 jcr->FileId = ar.FileId;
677 } else if (stream == STREAM_MD5_SIGNATURE || stream == STREAM_SHA1_SIGNATURE) {
678 if (jcr->FileIndex != (uint32_t)file_index) {
679 Jmsg2(jcr, M_ERROR, 0, _("MD5/SHA1 index %d not same as attributes %d\n"),
680 file_index, jcr->FileIndex);
681 set_jcr_job_status(jcr, JS_Error);
684 db_escape_string(SIG, Opts_SIG, strlen(Opts_SIG));
685 Dmsg2(120, "SIGlen=%d SIG=%s\n", strlen(SIG), SIG);
686 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIG,
687 stream==STREAM_MD5_SIGNATURE?MD5_SIG:SHA1_SIG)) {
688 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
689 set_jcr_job_status(jcr, JS_Error);
692 jcr->jr.JobFiles = jcr->JobFiles = file_index;
693 jcr->jr.LastIndex = file_index;
695 if (is_bnet_error(fd)) {
696 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
698 set_jcr_job_status(jcr, JS_ErrorTerminated);
702 set_jcr_job_status(jcr, JS_Terminated);