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 fd = bnet_connect(jcr, retry_interval, max_retry_time,
80 _("File daemon"), jcr->client->address,
81 NULL, jcr->client->FDport, verbose);
83 set_jcr_job_status(jcr, JS_ErrorTerminated);
86 Dmsg0(10, "Opened connection with File daemon\n");
87 fd->res = (RES *)jcr->client; /* save resource in BSOCK */
89 set_jcr_job_status(jcr, JS_Running);
91 if (!authenticate_file_daemon(jcr)) {
92 set_jcr_job_status(jcr, JS_ErrorTerminated);
97 * Now send JobId and authorization key
99 bnet_fsend(fd, jobcmd, jcr->JobId, jcr->Job, jcr->VolSessionId,
100 jcr->VolSessionTime, jcr->sd_auth_key);
101 if (strcmp(jcr->sd_auth_key, "dummy") != 0) {
102 memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
104 Dmsg1(100, ">filed: %s", fd->msg);
105 if (bget_dirmsg(fd) > 0) {
106 Dmsg1(110, "<filed: %s", fd->msg);
107 if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
108 Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
109 jcr->client->hdr.name, fd->msg);
110 set_jcr_job_status(jcr, JS_ErrorTerminated);
112 } else if (jcr->db) {
114 memset(&cr, 0, sizeof(cr));
115 bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
116 cr.AutoPrune = jcr->client->AutoPrune;
117 cr.FileRetention = jcr->client->FileRetention;
118 cr.JobRetention = jcr->client->JobRetention;
119 bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
120 if (!db_update_client_record(jcr, jcr->db, &cr)) {
121 Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
122 db_strerror(jcr->db));
126 Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
128 set_jcr_job_status(jcr, JS_ErrorTerminated);
135 * This subroutine edits the last job start time into a
136 * "since=date/time" buffer that is returned in the
137 * variable since. This is used for display purposes in
138 * the job report. The time in jcr->stime is later
139 * passed to tell the File daemon what to do.
141 void get_level_since_time(JCR *jcr, char *since, int since_len)
143 /* Lookup the last FULL backup job to get the time/date for a
144 * differential or incremental save.
147 jcr->stime = get_pool_memory(PM_MESSAGE);
151 switch (jcr->JobLevel) {
154 /* Look up start time of last job */
155 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
156 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
157 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
158 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found. Doing FULL backup.\n"));
159 bsnprintf(since, since_len, " (upgraded from %s)",
160 level_to_str(jcr->JobLevel));
161 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
163 bstrncpy(since, ", since=", since_len);
164 bstrncat(since, jcr->stime, since_len);
166 jcr->jr.JobId = jcr->JobId;
169 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
174 * Send level command to FD.
175 * Used for backup jobs and estimate command.
177 int send_level_command(JCR *jcr)
179 BSOCK *fd = jcr->file_bsock;
183 * Send Level command to File daemon
185 switch (jcr->JobLevel) {
187 bnet_fsend(fd, levelcmd, "base", " ", 0);
189 /* L_NONE is the console, sending something off to the FD */
192 bnet_fsend(fd, levelcmd, "full", " ", 0);
196 stime = str_to_utime(jcr->stime);
197 bnet_fsend(fd, levelcmd, "since_utime ", edit_uint64(stime, ed1), 0);
198 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
199 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
204 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
205 jcr->JobLevel, jcr->JobLevel);
208 Dmsg1(120, ">filed: %s", fd->msg);
209 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
217 * Send either an Included or an Excluded list to FD
219 static int send_list(JCR *jcr, int list)
225 fd = jcr->file_bsock;
226 fileset = jcr->fileset;
228 if (list == INC_LIST) {
229 num = fileset->num_includes;
231 num = fileset->num_excludes;
234 for (int i=0; i<num; i++) {
243 if (list == INC_LIST) {
244 ie = fileset->include_items[i];
246 ie = fileset->exclude_items[i];
248 for (int j=0; j<ie->name_list.size(); j++) {
249 p = (char *)ie->name_list.get(j);
252 p++; /* skip over the | */
253 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
254 bpipe = open_bpipe(fd->msg, 0, "r");
257 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
261 /* Copy File options */
263 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
264 bstrncat(buf, " ", sizeof(buf));
266 bstrncpy(buf, "0 ", sizeof(buf));
268 Dmsg1(500, "Opts=%s\n", buf);
269 optlen = strlen(buf);
270 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
271 fd->msglen = Mmsg(fd->msg, "%s", buf);
272 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
273 if (!bnet_send(fd)) {
274 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
278 if ((stat=close_bpipe(bpipe)) != 0) {
280 Jmsg(jcr, M_FATAL, 0, _("Error running program %p: ERR=%s\n"),
281 p, be.strerror(stat));
286 p++; /* skip over < */
287 if ((ffd = fopen(p, "r")) == NULL) {
288 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
289 list==INC_LIST?"included":"excluded", p, strerror(errno));
292 /* Copy File options */
294 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
295 bstrncat(buf, " ", sizeof(buf));
297 bstrncpy(buf, "0 ", sizeof(buf));
299 Dmsg1(500, "Opts=%s\n", buf);
300 optlen = strlen(buf);
301 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
302 fd->msglen = Mmsg(fd->msg, "%s", buf);
303 if (!bnet_send(fd)) {
304 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
311 p++; /* skip over \ */
312 /* Note, fall through wanted */
315 Dmsg2(500, "numopts=%d opts=%s\n", ie->num_opts, NPRT(ie->opts_list[0]->opts));
316 pm_strcpy(fd->msg, ie->opts_list[0]->opts);
317 pm_strcat(fd->msg, " ");
319 pm_strcpy(fd->msg, "0 ");
321 fd->msglen = pm_strcat(fd->msg, p);
322 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
323 if (!bnet_send(fd)) {
324 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
331 bnet_sig(fd, BNET_EOD); /* end of data */
332 if (list == INC_LIST) {
333 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
336 } else if (!response(jcr, fd, OKexc, "Exclude", DISPLAY_ERROR)) {
342 set_jcr_job_status(jcr, JS_ErrorTerminated);
349 * Send either an Included or an Excluded list to FD
351 static int send_fileset(JCR *jcr)
353 FILESET *fileset = jcr->fileset;
354 BSOCK *fd = jcr->file_bsock;
360 num = fileset->num_includes;
362 num = fileset->num_excludes;
364 for (int i=0; i<num; i++) {
374 ie = fileset->include_items[i];
375 bnet_fsend(fd, "I\n");
377 ie = fileset->exclude_items[i];
378 bnet_fsend(fd, "E\n");
380 for (j=0; j<ie->num_opts; j++) {
381 FOPTS *fo = ie->opts_list[j];
382 bnet_fsend(fd, "O %s\n", fo->opts);
383 for (k=0; k<fo->regex.size(); k++) {
384 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
386 for (k=0; k<fo->wild.size(); k++) {
387 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
389 for (k=0; k<fo->base.size(); k++) {
390 bnet_fsend(fd, "B %s\n", fo->base.get(k));
393 bnet_fsend(fd, "D %s\n", fo->reader);
396 bnet_fsend(fd, "T %s\n", fo->writer);
398 bnet_fsend(fd, "N\n");
401 for (j=0; j<ie->name_list.size(); j++) {
402 p = (char *)ie->name_list.get(j);
405 p++; /* skip over the | */
406 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
407 bpipe = open_bpipe(fd->msg, 0, "r");
410 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
414 bstrncpy(buf, "F ", sizeof(buf));
415 Dmsg1(500, "Opts=%s\n", buf);
416 optlen = strlen(buf);
417 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
418 fd->msglen = Mmsg(fd->msg, "%s", buf);
419 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
420 if (!bnet_send(fd)) {
421 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
425 if ((stat=close_bpipe(bpipe)) != 0) {
427 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
428 p, be.strerror(stat));
433 p++; /* skip over < */
434 if ((ffd = fopen(p, "r")) == NULL) {
436 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
440 bstrncpy(buf, "F ", sizeof(buf));
441 Dmsg1(500, "Opts=%s\n", buf);
442 optlen = strlen(buf);
443 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
444 fd->msglen = Mmsg(fd->msg, "%s", buf);
445 if (!bnet_send(fd)) {
446 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
453 p++; /* skip over \ */
454 /* Note, fall through wanted */
456 pm_strcpy(fd->msg, "F ");
457 fd->msglen = pm_strcat(fd->msg, p);
458 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
459 if (!bnet_send(fd)) {
460 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
466 bnet_fsend(fd, "N\n");
468 if (!include) { /* If we just did excludes */
469 break; /* all done */
471 include = false; /* Now do excludes */
474 bnet_sig(fd, BNET_EOD); /* end of data */
475 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
481 set_jcr_job_status(jcr, JS_ErrorTerminated);
488 * Send include list to File daemon
490 int send_include_list(JCR *jcr)
492 BSOCK *fd = jcr->file_bsock;
493 if (jcr->fileset->new_include) {
494 bnet_fsend(fd, fileset);
495 return send_fileset(jcr);
499 return send_list(jcr, INC_LIST);
504 * Send exclude list to File daemon
506 int send_exclude_list(JCR *jcr)
508 BSOCK *fd = jcr->file_bsock;
509 if (jcr->fileset->new_include) {
513 return send_list(jcr, EXC_LIST);
518 * Send bootstrap file if any to the File daemon.
519 * This is used for restore and verify VolumeToCatalog
521 int send_bootstrap_file(JCR *jcr)
525 BSOCK *fd = jcr->file_bsock;
526 const char *bootstrap = "bootstrap\n";
528 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
529 if (!jcr->RestoreBootstrap) {
532 bs = fopen(jcr->RestoreBootstrap, "r");
535 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
536 jcr->RestoreBootstrap, be.strerror());
537 set_jcr_job_status(jcr, JS_ErrorTerminated);
540 bnet_fsend(fd, bootstrap);
541 while (fgets(buf, sizeof(buf), bs)) {
542 bnet_fsend(fd, "%s", buf);
544 bnet_sig(fd, BNET_EOD);
546 if (!response(jcr, fd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
547 set_jcr_job_status(jcr, JS_ErrorTerminated);
554 * Send ClientRunBeforeJob and ClientRunAfterJob to File daemon
556 int send_run_before_and_after_commands(JCR *jcr)
558 POOLMEM *msg = get_pool_memory(PM_FNAME);
559 BSOCK *fd = jcr->file_bsock;
560 if (jcr->job->ClientRunBeforeJob) {
561 pm_strcpy(msg, jcr->job->ClientRunBeforeJob);
563 bnet_fsend(fd, runbefore, msg);
564 if (!response(jcr, fd, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR)) {
565 set_jcr_job_status(jcr, JS_ErrorTerminated);
566 free_pool_memory(msg);
570 if (jcr->job->ClientRunAfterJob) {
571 fd->msglen = pm_strcpy(msg, jcr->job->ClientRunAfterJob);
573 bnet_fsend(fd, runafter, msg);
574 if (!response(jcr, fd, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR)) {
575 set_jcr_job_status(jcr, JS_ErrorTerminated);
576 free_pool_memory(msg);
580 free_pool_memory(msg);
586 * Read the attributes from the File daemon for
587 * a Verify job and store them in the catalog.
589 int get_attributes_and_put_in_catalog(JCR *jcr)
595 fd = jcr->file_bsock;
596 jcr->jr.FirstIndex = 1;
597 memset(&ar, 0, sizeof(ar));
600 Dmsg0(120, "bdird: waiting to receive file attributes\n");
601 /* Pickup file attributes and signature */
602 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
604 /*****FIXME****** improve error handling to stop only on
605 * really fatal problems, or the number of errors is too
611 char Opts_SIG[MAXSTRING]; /* either Verify opts or MD5/SHA1 signature */
614 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
615 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Opts_SIG)) != 3) {
616 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n\
617 msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
618 set_jcr_job_status(jcr, JS_ErrorTerminated);
622 skip_nonspaces(&p); /* skip FileIndex */
624 skip_nonspaces(&p); /* skip Stream */
626 skip_nonspaces(&p); /* skip Opts_SHA1 */
627 p++; /* skip space */
630 *fn++ = *p++; /* copy filename */
632 *fn = *p++; /* term filename and point to attribs */
635 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
637 jcr->FileIndex = file_index;
639 ar.fname = jcr->fname;
640 ar.FileIndex = file_index;
643 ar.JobId = jcr->JobId;
644 ar.ClientId = jcr->ClientId;
648 Dmsg2(111, "dird<filed: stream=%d %s\n", stream, jcr->fname);
649 Dmsg1(120, "dird<filed: attr=%s\n", attr);
651 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
652 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
653 set_jcr_job_status(jcr, JS_Error);
656 jcr->FileId = ar.FileId;
657 } else if (stream == STREAM_MD5_SIGNATURE || stream == STREAM_SHA1_SIGNATURE) {
658 if (jcr->FileIndex != (uint32_t)file_index) {
659 Jmsg2(jcr, M_ERROR, 0, _("MD5/SHA1 index %d not same as attributes %d\n"),
660 file_index, jcr->FileIndex);
661 set_jcr_job_status(jcr, JS_Error);
664 db_escape_string(SIG, Opts_SIG, strlen(Opts_SIG));
665 Dmsg2(120, "SIGlen=%d SIG=%s\n", strlen(SIG), SIG);
666 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIG,
667 stream==STREAM_MD5_SIGNATURE?MD5_SIG:SHA1_SIG)) {
668 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
669 set_jcr_job_status(jcr, JS_Error);
672 jcr->jr.JobFiles = jcr->JobFiles = file_index;
673 jcr->jr.LastIndex = file_index;
675 if (is_bnet_error(fd)) {
676 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
678 set_jcr_job_status(jcr, JS_ErrorTerminated);
682 set_jcr_job_status(jcr, JS_Terminated);