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)
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);
189 static void send_since_time(JCR *jcr)
191 BSOCK *fd = jcr->file_bsock;
195 stime = str_to_utime(jcr->stime);
196 bnet_fsend(fd, levelcmd, "since_utime ", edit_uint64(stime, ed1), 0);
197 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
198 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
204 * Send level command to FD.
205 * Used for backup jobs and estimate command.
207 int send_level_command(JCR *jcr)
209 BSOCK *fd = jcr->file_bsock;
211 * Send Level command to File daemon
213 switch (jcr->JobLevel) {
215 bnet_fsend(fd, levelcmd, "base", " ", 0);
217 /* L_NONE is the console, sending something off to the FD */
220 bnet_fsend(fd, levelcmd, "full", " ", 0);
223 bnet_fsend(fd, levelcmd, "differential", " ", 0);
224 send_since_time(jcr);
227 bnet_fsend(fd, levelcmd, "incremental", " ", 0);
228 send_since_time(jcr);
232 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
233 jcr->JobLevel, jcr->JobLevel);
236 Dmsg1(120, ">filed: %s", fd->msg);
237 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
245 * Send either an Included or an Excluded list to FD
247 static int send_list(JCR *jcr, int list)
253 fd = jcr->file_bsock;
254 fileset = jcr->fileset;
256 if (list == INC_LIST) {
257 num = fileset->num_includes;
259 num = fileset->num_excludes;
262 for (int i=0; i<num; i++) {
271 if (list == INC_LIST) {
272 ie = fileset->include_items[i];
274 ie = fileset->exclude_items[i];
276 for (int j=0; j<ie->name_list.size(); j++) {
277 p = (char *)ie->name_list.get(j);
280 p++; /* skip over the | */
281 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
282 bpipe = open_bpipe(fd->msg, 0, "r");
285 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
289 /* Copy File options */
291 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
292 bstrncat(buf, " ", sizeof(buf));
294 bstrncpy(buf, "0 ", sizeof(buf));
296 Dmsg1(500, "Opts=%s\n", buf);
297 optlen = strlen(buf);
298 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
299 fd->msglen = Mmsg(fd->msg, "%s", buf);
300 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
301 if (!bnet_send(fd)) {
302 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
306 if ((stat=close_bpipe(bpipe)) != 0) {
308 Jmsg(jcr, M_FATAL, 0, _("Error running program %p: ERR=%s\n"),
309 p, be.strerror(stat));
314 p++; /* skip over < */
315 if ((ffd = fopen(p, "r")) == NULL) {
316 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
317 list==INC_LIST?"included":"excluded", p, strerror(errno));
320 /* Copy File options */
322 bstrncpy(buf, ie->opts_list[0]->opts, sizeof(buf));
323 bstrncat(buf, " ", sizeof(buf));
325 bstrncpy(buf, "0 ", sizeof(buf));
327 Dmsg1(500, "Opts=%s\n", buf);
328 optlen = strlen(buf);
329 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
330 fd->msglen = Mmsg(fd->msg, "%s", buf);
331 if (!bnet_send(fd)) {
332 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
339 p++; /* skip over \ */
340 /* Note, fall through wanted */
343 Dmsg2(500, "numopts=%d opts=%s\n", ie->num_opts, NPRT(ie->opts_list[0]->opts));
344 pm_strcpy(fd->msg, ie->opts_list[0]->opts);
345 pm_strcat(fd->msg, " ");
347 pm_strcpy(fd->msg, "0 ");
349 fd->msglen = pm_strcat(fd->msg, p);
350 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
351 if (!bnet_send(fd)) {
352 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
359 bnet_sig(fd, BNET_EOD); /* end of data */
360 if (list == INC_LIST) {
361 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
364 } else if (!response(jcr, fd, OKexc, "Exclude", DISPLAY_ERROR)) {
370 set_jcr_job_status(jcr, JS_ErrorTerminated);
377 * Send either an Included or an Excluded list to FD
379 static int send_fileset(JCR *jcr)
381 FILESET *fileset = jcr->fileset;
382 BSOCK *fd = jcr->file_bsock;
388 num = fileset->num_includes;
390 num = fileset->num_excludes;
392 for (int i=0; i<num; i++) {
402 ie = fileset->include_items[i];
403 bnet_fsend(fd, "I\n");
405 ie = fileset->exclude_items[i];
406 bnet_fsend(fd, "E\n");
408 for (j=0; j<ie->num_opts; j++) {
409 FOPTS *fo = ie->opts_list[j];
410 bnet_fsend(fd, "O %s\n", fo->opts);
411 for (k=0; k<fo->regex.size(); k++) {
412 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
414 for (k=0; k<fo->regexdir.size(); k++) {
415 bnet_fsend(fd, "RD %s\n", fo->regexdir.get(k));
417 for (k=0; k<fo->regexfile.size(); k++) {
418 bnet_fsend(fd, "RF %s\n", fo->regexfile.get(k));
420 for (k=0; k<fo->wild.size(); k++) {
421 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
423 for (k=0; k<fo->wilddir.size(); k++) {
424 bnet_fsend(fd, "WD %s\n", fo->wilddir.get(k));
426 for (k=0; k<fo->wildfile.size(); k++) {
427 bnet_fsend(fd, "WF %s\n", fo->wildfile.get(k));
429 for (k=0; k<fo->base.size(); k++) {
430 bnet_fsend(fd, "B %s\n", fo->base.get(k));
432 for (k=0; k<fo->fstype.size(); k++) {
433 bnet_fsend(fd, "X %s\n", fo->fstype.get(k));
436 bnet_fsend(fd, "D %s\n", fo->reader);
439 bnet_fsend(fd, "T %s\n", fo->writer);
441 bnet_fsend(fd, "N\n");
444 for (j=0; j<ie->name_list.size(); j++) {
445 p = (char *)ie->name_list.get(j);
448 p++; /* skip over the | */
449 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
450 bpipe = open_bpipe(fd->msg, 0, "r");
453 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
457 bstrncpy(buf, "F ", sizeof(buf));
458 Dmsg1(500, "Opts=%s\n", buf);
459 optlen = strlen(buf);
460 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
461 fd->msglen = Mmsg(fd->msg, "%s", buf);
462 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
463 if (!bnet_send(fd)) {
464 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
468 if ((stat=close_bpipe(bpipe)) != 0) {
470 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
471 p, be.strerror(stat));
476 p++; /* skip over < */
477 if ((ffd = fopen(p, "r")) == NULL) {
479 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
483 bstrncpy(buf, "F ", sizeof(buf));
484 Dmsg1(500, "Opts=%s\n", buf);
485 optlen = strlen(buf);
486 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
487 fd->msglen = Mmsg(fd->msg, "%s", buf);
488 if (!bnet_send(fd)) {
489 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
496 p++; /* skip over \ */
497 /* Note, fall through wanted */
499 pm_strcpy(fd->msg, "F ");
500 fd->msglen = pm_strcat(fd->msg, p);
501 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
502 if (!bnet_send(fd)) {
503 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
509 bnet_fsend(fd, "N\n");
511 if (!include) { /* If we just did excludes */
512 break; /* all done */
514 include = false; /* Now do excludes */
517 bnet_sig(fd, BNET_EOD); /* end of data */
518 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
524 set_jcr_job_status(jcr, JS_ErrorTerminated);
531 * Send include list to File daemon
533 int send_include_list(JCR *jcr)
535 BSOCK *fd = jcr->file_bsock;
536 if (jcr->fileset->new_include) {
537 bnet_fsend(fd, fileset);
538 return send_fileset(jcr);
542 return send_list(jcr, INC_LIST);
547 * Send exclude list to File daemon
549 int send_exclude_list(JCR *jcr)
551 BSOCK *fd = jcr->file_bsock;
552 if (jcr->fileset->new_include) {
556 return send_list(jcr, EXC_LIST);
561 * Send bootstrap file if any to the File daemon.
562 * This is used for restore and verify VolumeToCatalog
564 int send_bootstrap_file(JCR *jcr)
568 BSOCK *fd = jcr->file_bsock;
569 const char *bootstrap = "bootstrap\n";
571 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
572 if (!jcr->RestoreBootstrap) {
575 bs = fopen(jcr->RestoreBootstrap, "r");
578 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
579 jcr->RestoreBootstrap, be.strerror());
580 set_jcr_job_status(jcr, JS_ErrorTerminated);
583 bnet_fsend(fd, bootstrap);
584 while (fgets(buf, sizeof(buf), bs)) {
585 bnet_fsend(fd, "%s", buf);
587 bnet_sig(fd, BNET_EOD);
589 if (!response(jcr, fd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
590 set_jcr_job_status(jcr, JS_ErrorTerminated);
597 * Send ClientRunBeforeJob and ClientRunAfterJob to File daemon
599 int send_run_before_and_after_commands(JCR *jcr)
601 POOLMEM *msg = get_pool_memory(PM_FNAME);
602 BSOCK *fd = jcr->file_bsock;
603 if (jcr->job->ClientRunBeforeJob) {
604 pm_strcpy(msg, jcr->job->ClientRunBeforeJob);
606 bnet_fsend(fd, runbefore, msg);
607 if (!response(jcr, fd, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR)) {
608 set_jcr_job_status(jcr, JS_ErrorTerminated);
609 free_pool_memory(msg);
613 if (jcr->job->ClientRunAfterJob) {
614 fd->msglen = pm_strcpy(msg, jcr->job->ClientRunAfterJob);
616 bnet_fsend(fd, runafter, msg);
617 if (!response(jcr, fd, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR)) {
618 set_jcr_job_status(jcr, JS_ErrorTerminated);
619 free_pool_memory(msg);
623 free_pool_memory(msg);
629 * Read the attributes from the File daemon for
630 * a Verify job and store them in the catalog.
632 int get_attributes_and_put_in_catalog(JCR *jcr)
638 fd = jcr->file_bsock;
639 jcr->jr.FirstIndex = 1;
640 memset(&ar, 0, sizeof(ar));
643 Dmsg0(120, "bdird: waiting to receive file attributes\n");
644 /* Pickup file attributes and signature */
645 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
647 /*****FIXME****** improve error handling to stop only on
648 * really fatal problems, or the number of errors is too
654 char Opts_SIG[MAXSTRING]; /* either Verify opts or MD5/SHA1 signature */
657 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
658 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Opts_SIG)) != 3) {
659 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
660 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
661 set_jcr_job_status(jcr, JS_ErrorTerminated);
665 skip_nonspaces(&p); /* skip FileIndex */
667 skip_nonspaces(&p); /* skip Stream */
669 skip_nonspaces(&p); /* skip Opts_SHA1 */
670 p++; /* skip space */
673 *fn++ = *p++; /* copy filename */
675 *fn = *p++; /* term filename and point to attribs */
678 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
680 jcr->FileIndex = file_index;
682 ar.fname = jcr->fname;
683 ar.FileIndex = file_index;
686 ar.JobId = jcr->JobId;
687 ar.ClientId = jcr->ClientId;
691 Dmsg2(111, "dird<filed: stream=%d %s\n", stream, jcr->fname);
692 Dmsg1(120, "dird<filed: attr=%s\n", attr);
694 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
695 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
696 set_jcr_job_status(jcr, JS_Error);
699 jcr->FileId = ar.FileId;
700 } else if (stream == STREAM_MD5_SIGNATURE || stream == STREAM_SHA1_SIGNATURE) {
701 if (jcr->FileIndex != (uint32_t)file_index) {
702 Jmsg2(jcr, M_ERROR, 0, _("MD5/SHA1 index %d not same as attributes %d\n"),
703 file_index, jcr->FileIndex);
704 set_jcr_job_status(jcr, JS_Error);
707 db_escape_string(SIG, Opts_SIG, strlen(Opts_SIG));
708 Dmsg2(120, "SIGlen=%d SIG=%s\n", strlen(SIG), SIG);
709 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIG,
710 stream==STREAM_MD5_SIGNATURE?MD5_SIG:SHA1_SIG)) {
711 Jmsg1(jcr, M_ERROR, 0, "%s", db_strerror(jcr->db));
712 set_jcr_job_status(jcr, JS_Error);
715 jcr->jr.JobFiles = jcr->JobFiles = file_index;
716 jcr->jr.LastIndex = file_index;
718 if (is_bnet_error(fd)) {
719 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
721 set_jcr_job_status(jcr, JS_ErrorTerminated);
725 set_jcr_job_status(jcr, JS_Terminated);