2 * Bacula File Daemon Job processing
4 * Kern Sibbald, October MM
10 Copyright (C) 2000-2004 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 extern char my_name[];
33 extern CLIENT *me; /* our client resource */
35 /* Imported functions */
36 extern int status_cmd(JCR *jcr);
38 /* Forward referenced functions */
39 static int backup_cmd(JCR *jcr);
40 static int bootstrap_cmd(JCR *jcr);
41 static int cancel_cmd(JCR *jcr);
42 static int setdebug_cmd(JCR *jcr);
43 static int estimate_cmd(JCR *jcr);
44 static int exclude_cmd(JCR *jcr);
45 static int hello_cmd(JCR *jcr);
46 static int job_cmd(JCR *jcr);
47 static int include_cmd(JCR *jcr);
48 static int fileset_cmd(JCR *jcr);
49 static int level_cmd(JCR *jcr);
50 static int verify_cmd(JCR *jcr);
51 static int restore_cmd(JCR *jcr);
52 static int storage_cmd(JCR *jcr);
53 static int session_cmd(JCR *jcr);
54 static int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd);
55 static void filed_free_jcr(JCR *jcr);
56 static int open_sd_read_session(JCR *jcr);
57 static int send_bootstrap_file(JCR *jcr);
58 static int runbefore_cmd(JCR *jcr);
59 static int runafter_cmd(JCR *jcr);
60 static int run_cmd(JCR *jcr, char *cmd, const char *name);
61 static void set_options(findFOPTS *fo, const char *opts);
64 /* Exported functions */
72 * The following are the recognized commands from the Director.
74 static struct s_cmds cmds[] = {
75 {"backup", backup_cmd},
76 {"cancel", cancel_cmd},
77 {"setdebug=", setdebug_cmd},
78 {"estimate", estimate_cmd},
79 {"exclude", exclude_cmd},
81 {"include", include_cmd},
82 {"fileset", fileset_cmd},
84 {"level = ", level_cmd},
85 {"restore", restore_cmd},
86 {"session", session_cmd},
87 {"status", status_cmd},
88 {"storage ", storage_cmd},
89 {"verify", verify_cmd},
90 {"bootstrap", bootstrap_cmd},
91 {"RunBeforeJob", runbefore_cmd},
92 {"RunAfterJob", runafter_cmd},
93 {NULL, NULL} /* list terminator */
96 /* Commands received from director that need scanning */
97 static char jobcmd[] = "JobId=%d Job=%127s SDid=%d SDtime=%d Authorization=%100s";
98 static char storaddr[] = "storage address=%s port=%d ssl=%d\n";
99 static char sessioncmd[] = "session %127s %ld %ld %ld %ld %ld %ld\n";
100 static char restorecmd[] = "restore replace=%c prelinks=%d where=%s\n";
101 static char restorecmd1[] = "restore replace=%c prelinks=%d where=\n";
102 static char verifycmd[] = "verify level=%30s\n";
103 static char estimatecmd[] = "estimate listing=%d\n";
104 static char runbefore[] = "RunBeforeJob %s\n";
105 static char runafter[] = "RunAfterJob %s\n";
107 /* Responses sent to Director */
108 static char errmsg[] = "2999 Invalid command\n";
109 static char no_auth[] = "2998 No Authorization\n";
110 static char OKinc[] = "2000 OK include\n";
111 static char OKest[] = "2000 OK estimate files=%u bytes=%s\n";
112 static char OKexc[] = "2000 OK exclude\n";
113 static char OKlevel[] = "2000 OK level\n";
114 static char OKbackup[] = "2000 OK backup\n";
115 static char OKbootstrap[] = "2000 OK bootstrap\n";
116 static char OKverify[] = "2000 OK verify\n";
117 static char OKrestore[] = "2000 OK restore\n";
118 static char OKsession[] = "2000 OK session\n";
119 static char OKstore[] = "2000 OK storage\n";
120 static char OKjob[] = "2000 OK Job %s,%s,%s";
121 static char OKsetdebug[] = "2000 OK setdebug=%d\n";
122 static char BADjob[] = "2901 Bad Job\n";
123 static char EndJob[] = "2800 End Job TermCode=%d JobFiles=%u ReadBytes=%s JobBytes=%s Errors=%u\n";
124 static char OKRunBefore[] = "2000 OK RunBefore\n";
125 static char OKRunAfter[] = "2000 OK RunAfter\n";
127 /* Responses received from Storage Daemon */
128 static char OK_end[] = "3000 OK end\n";
129 static char OK_close[] = "3000 OK close Status = %d\n";
130 static char OK_open[] = "3000 OK open ticket = %d\n";
131 static char OK_data[] = "3000 OK data\n";
132 static char OK_append[] = "3000 OK append data\n";
133 static char OKSDbootstrap[] = "3000 OK bootstrap\n";
136 /* Commands sent to Storage Daemon */
137 static char append_open[] = "append open session\n";
138 static char append_data[] = "append data %d\n";
139 static char append_end[] = "append end session %d\n";
140 static char append_close[] = "append close session %d\n";
141 static char read_open[] = "read open session = %s %ld %ld %ld %ld %ld %ld\n";
142 static char read_data[] = "read data %d\n";
143 static char read_close[] = "read close session %d\n";
146 * Accept requests from a Director
148 * NOTE! We are running as a separate thread
150 * Send output one line
151 * at a time followed by a zero length transmission.
153 * Return when the connection is terminated or there
156 * Basic task here is:
157 * Authenticate Director (during Hello command).
158 * Accept commands one at a time from the Director
162 void *handle_client_request(void *dirp)
167 BSOCK *dir = (BSOCK *)dirp;
169 jcr = new_jcr(sizeof(JCR), filed_free_jcr); /* create JCR */
170 jcr->dir_bsock = dir;
171 jcr->ff = init_find_files();
172 jcr->start_time = time(NULL);
173 jcr->last_fname = get_pool_memory(PM_FNAME);
174 jcr->last_fname[0] = 0;
175 jcr->client_name = get_memory(strlen(my_name) + 1);
176 pm_strcpy(&jcr->client_name, my_name);
178 enable_backup_privileges(NULL, 1 /* ignore_errors */);
180 /**********FIXME******* add command handler error code */
182 for (quit=false; !quit;) {
185 if (bnet_recv(dir) < 0) {
186 break; /* connection terminated */
188 dir->msg[dir->msglen] = 0;
189 Dmsg1(100, "<dird: %s", dir->msg);
191 for (i=0; cmds[i].cmd; i++) {
192 if (strncmp(cmds[i].cmd, dir->msg, strlen(cmds[i].cmd)) == 0) {
193 if (!jcr->authenticated && cmds[i].func != hello_cmd) {
194 bnet_fsend(dir, no_auth);
197 found = true; /* indicate command found */
198 Dmsg1(100, "Executing %s command.\n", cmds[i].cmd);
199 if (!cmds[i].func(jcr)) { /* do command */
200 quit = true; /* error or fully terminated, get out */
201 Dmsg0(20, "Quit command loop due to command error or Job done.\n");
206 if (!found) { /* command not found */
207 bnet_fsend(dir, errmsg);
213 /* Inform Storage daemon that we are done */
214 if (jcr->store_bsock) {
215 bnet_sig(jcr->store_bsock, BNET_TERMINATE);
218 if (jcr->RunAfterJob && !job_canceled(jcr)) {
219 run_cmd(jcr, jcr->RunAfterJob, "ClientRunAfterJob");
222 /* Inform Director that we are done */
223 bnet_sig(dir, BNET_TERMINATE);
225 /* Clean up fileset */
226 FF_PKT *ff = (FF_PKT *)jcr->ff;
227 findFILESET *fileset = ff->fileset;
230 /* Delete FileSet Include lists */
231 for (i=0; i<fileset->include_list.size(); i++) {
232 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
233 for (j=0; j<incexe->opts_list.size(); j++) {
234 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
235 for (k=0; k<fo->regex.size(); k++) {
236 regfree((regex_t *)fo->regex.get(k));
242 incexe->opts_list.destroy();
243 incexe->name_list.destroy();
245 fileset->include_list.destroy();
247 /* Delete FileSet Exclude lists */
248 for (i=0; i<fileset->exclude_list.size(); i++) {
249 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
250 for (j=0; j<incexe->opts_list.size(); j++) {
251 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
256 incexe->opts_list.destroy();
257 incexe->name_list.destroy();
259 fileset->exclude_list.destroy();
262 Dmsg0(100, "Calling term_find_files\n");
263 term_find_files((FF_PKT *)jcr->ff);
264 Dmsg0(100, "Done with term_find_files\n");
265 free_jcr(jcr); /* destroy JCR record */
266 Dmsg0(100, "Done with free_jcr\n");
271 * Hello from Director he must identify himself and provide his
274 static int hello_cmd(JCR *jcr)
276 Dmsg0(120, "Calling Authenticate\n");
277 if (!authenticate_director(jcr)) {
280 Dmsg0(120, "OK Authenticate\n");
281 jcr->authenticated = true;
288 static int cancel_cmd(JCR *jcr)
290 BSOCK *dir = jcr->dir_bsock;
291 char Job[MAX_NAME_LENGTH];
294 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
295 if (!(cjcr=get_jcr_by_full_name(Job))) {
296 bnet_fsend(dir, "2901 Job %s not found.\n", Job);
298 if (cjcr->store_bsock) {
300 cjcr->store_bsock->timed_out = 1;
301 cjcr->store_bsock->terminated = 1;
303 * #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
305 #if !defined(HAVE_CYGWIN)
306 pthread_kill(cjcr->my_thread_id, TIMEOUT_SIGNAL);
310 set_jcr_job_status(cjcr, JS_Canceled);
312 bnet_fsend(dir, _("2001 Job %s marked to be canceled.\n"), Job);
315 bnet_fsend(dir, _("2902 Error scanning cancel command.\n"));
317 bnet_sig(dir, BNET_EOD);
323 * Set debug level as requested by the Director
326 static int setdebug_cmd(JCR *jcr)
328 BSOCK *dir = jcr->dir_bsock;
329 int level, trace_flag;
331 Dmsg1(110, "setdebug_cmd: %s", dir->msg);
332 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
333 pm_strcpy(&jcr->errmsg, dir->msg);
334 bnet_fsend(dir, "2991 Bad setdebug command: %s\n", jcr->errmsg);
338 set_trace(trace_flag);
339 return bnet_fsend(dir, OKsetdebug, level);
343 static int estimate_cmd(JCR *jcr)
345 BSOCK *dir = jcr->dir_bsock;
348 if (sscanf(dir->msg, estimatecmd, &jcr->listing) != 1) {
349 pm_strcpy(&jcr->errmsg, dir->msg);
350 Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
351 bnet_fsend(dir, "2992 Bad estimate command.\n");
355 bnet_fsend(dir, OKest, jcr->num_files_examined,
356 edit_uint64_with_commas(jcr->JobBytes, ed2));
357 bnet_sig(dir, BNET_EOD);
362 * Get JobId and Storage Daemon Authorization key from Director
364 static int job_cmd(JCR *jcr)
366 BSOCK *dir = jcr->dir_bsock;
367 POOLMEM *sd_auth_key;
369 sd_auth_key = get_memory(dir->msglen);
370 if (sscanf(dir->msg, jobcmd, &jcr->JobId, jcr->Job,
371 &jcr->VolSessionId, &jcr->VolSessionTime,
373 pm_strcpy(&jcr->errmsg, dir->msg);
374 Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
375 bnet_fsend(dir, BADjob);
376 free_pool_memory(sd_auth_key);
379 jcr->sd_auth_key = bstrdup(sd_auth_key);
380 free_pool_memory(sd_auth_key);
381 Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
382 return bnet_fsend(dir, OKjob, HOST_OS, DISTNAME, DISTVER);
385 static int runbefore_cmd(JCR *jcr)
388 BSOCK *dir = jcr->dir_bsock;
389 POOLMEM *cmd = get_memory(dir->msglen+1);
391 Dmsg1(100, "runbefore_cmd: %s", dir->msg);
392 if (sscanf(dir->msg, runbefore, cmd) != 1) {
393 pm_strcpy(&jcr->errmsg, dir->msg);
394 Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
395 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
401 /* Run the command now */
402 stat = run_cmd(jcr, cmd, "ClientRunBeforeJob");
405 bnet_fsend(dir, OKRunBefore);
408 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
413 static int runafter_cmd(JCR *jcr)
415 BSOCK *dir = jcr->dir_bsock;
416 POOLMEM *msg = get_memory(dir->msglen+1);
418 Dmsg1(100, "runafter_cmd: %s", dir->msg);
419 if (sscanf(dir->msg, runafter, msg) != 1) {
420 pm_strcpy(&jcr->errmsg, dir->msg);
421 Jmsg1(jcr, M_FATAL, 0, _("Bad RunAfter command: %s\n"), jcr->errmsg);
422 bnet_fsend(dir, "2905 Bad RunAfterJob command.\n");
427 if (jcr->RunAfterJob) {
428 free_pool_memory(jcr->RunAfterJob);
430 jcr->RunAfterJob = get_pool_memory(PM_FNAME);
431 pm_strcpy(&jcr->RunAfterJob, msg);
432 free_pool_memory(msg);
433 return bnet_fsend(dir, OKRunAfter);
436 static int run_cmd(JCR *jcr, char *cmd, const char *name)
438 POOLMEM *ecmd = get_pool_memory(PM_FNAME);
441 char line[MAXSTRING];
443 ecmd = edit_job_codes(jcr, ecmd, cmd, "");
444 bpipe = open_bpipe(ecmd, 0, "r");
445 free_pool_memory(ecmd);
447 Jmsg(jcr, M_FATAL, 0, _("%s could not execute\n"), name);
448 set_jcr_job_status(jcr, JS_FatalError);
451 while (fgets(line, sizeof(line), bpipe->rfd)) {
452 Jmsg(jcr, M_INFO, 0, _("%s: %s"), name, line);
454 status = close_bpipe(bpipe);
456 Jmsg(jcr, M_FATAL, 0, _("%s returned non-zero status=%d\n"), name,
458 set_jcr_job_status(jcr, JS_FatalError);
468 static void add_fname_to_list(JCR *jcr, char *fname, int list)
478 /* Skip leading options -- currently ignored */
479 for (p=fname; *p && *p != ' '; p++)
481 /* Skip spaces, and q points to first space */
482 for (q=NULL; *p && *p == ' '; p++) {
490 p++; /* skip over | */
491 fn = get_pool_memory(PM_FNAME);
492 fn = edit_job_codes(jcr, fn, p, "");
493 bpipe = open_bpipe(fn, 0, "r");
494 free_pool_memory(fn);
496 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
500 /* Copy File options */
501 if (list == INC_LIST) {
502 *q = 0; /* terminate options */
505 optlen = strlen(buf);
509 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
510 strip_trailing_junk(buf);
511 if (list == INC_LIST) {
512 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
514 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
517 if ((stat=close_bpipe(bpipe)) != 0) {
518 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. RtnStat=%d ERR=%s\n"),
519 p, stat, strerror(errno));
524 p++; /* skip over < */
525 if ((ffd = fopen(p, "r")) == NULL) {
526 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
527 list==INC_LIST?"included":"excluded", p, strerror(errno));
530 /* Copy File options */
531 if (list == INC_LIST) {
532 *q = 0; /* terminate options */
535 optlen = strlen(buf);
539 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
540 strip_trailing_junk(buf);
541 if (list == INC_LIST) {
542 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
544 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
550 if (list == INC_LIST) {
551 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, fname);
553 add_fname_to_exclude_list((FF_PKT *)jcr->ff, p);
561 * Get list of files/directories to include from Director
564 static int include_cmd(JCR *jcr)
566 BSOCK *dir = jcr->dir_bsock;
568 while (bnet_recv(dir) >= 0) {
569 dir->msg[dir->msglen] = 0;
570 strip_trailing_junk(dir->msg);
571 Dmsg1(010, "include file: %s\n", dir->msg);
572 add_fname_to_list(jcr, dir->msg, INC_LIST);
575 return bnet_fsend(dir, OKinc);
578 static bool init_fileset(JCR *jcr)
581 findFILESET *fileset;
586 ff = (FF_PKT *)jcr->ff;
590 fileset = (findFILESET *)malloc(sizeof(findFILESET));
591 memset(fileset, 0, sizeof(findFILESET));
592 ff->fileset = fileset;
593 fileset->state = state_none;
594 fileset->include_list.init(1, true);
595 fileset->exclude_list.init(1, true);
599 static findFOPTS *start_options(FF_PKT *ff)
601 int state = ff->fileset->state;
602 findINCEXE *incexe = ff->fileset->incexe;
604 if (state != state_options) {
605 ff->fileset->state = state_options;
606 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
607 memset(fo, 0, sizeof(findFOPTS));
608 fo->regex.init(1, true);
609 fo->wild.init(1, true);
610 fo->base.init(1, true);
611 incexe->current_opts = fo;
612 incexe->opts_list.append(fo);
614 return incexe->current_opts;
619 * Add fname to include/exclude fileset list. First check for
620 * | and < and if necessary perform command.
622 static void add_file_to_fileset(JCR *jcr, const char *fname, findFILESET *fileset)
634 p++; /* skip over | */
635 fn = get_pool_memory(PM_FNAME);
636 fn = edit_job_codes(jcr, fn, p, "");
637 bpipe = open_bpipe(fn, 0, "r");
638 free_pool_memory(fn);
640 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
644 while (fgets(buf, sizeof(buf), bpipe->rfd)) {
645 strip_trailing_junk(buf);
646 fileset->incexe->name_list.append(bstrdup(buf));
648 if ((stat=close_bpipe(bpipe)) != 0) {
649 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. RtnStat=%d ERR=%s\n"),
650 p, stat, strerror(errno));
655 p++; /* skip over < */
656 if ((ffd = fopen(p, "r")) == NULL) {
657 Jmsg(jcr, M_FATAL, 0, _("Cannot open FileSet input file: %s. ERR=%s\n"),
661 while (fgets(buf, sizeof(buf), ffd)) {
662 strip_trailing_junk(buf);
663 fileset->incexe->name_list.append(bstrdup(buf));
668 fileset->incexe->name_list.append(bstrdup(fname));
674 static void add_fileset(JCR *jcr, const char *item)
676 FF_PKT *ff = (FF_PKT *)jcr->ff;
677 findFILESET *fileset = ff->fileset;
678 int state = fileset->state;
679 findFOPTS *current_opts;
681 Dmsg1(100, "%s\n", item);
683 if (item[1] == ' ') { /* If string follows */
684 item += 2; /* point to string */
687 if (state == state_error) {
693 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
694 memset(fileset->incexe, 0, sizeof(findINCEXE));
695 fileset->incexe->opts_list.init(1, true);
696 fileset->incexe->name_list.init(1, true);
697 fileset->include_list.append(fileset->incexe);
701 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
702 memset(fileset->incexe, 0, sizeof(findINCEXE));
703 fileset->incexe->opts_list.init(1, true);
704 fileset->incexe->name_list.init(1, true);
705 fileset->exclude_list.append(fileset->incexe);
711 /* File item to either include/include list */
712 state = state_include;
713 add_file_to_fileset(jcr, item, fileset);
716 current_opts = start_options(ff);
720 preg = (regex_t *)malloc(sizeof(regex_t));
721 rc = regcomp(preg, item, REG_EXTENDED);
723 regerror(rc, preg, prbuf, sizeof(prbuf));
726 Jmsg(jcr, M_FATAL, 0, "REGEX %s compile error. ERR=%s\n", item, prbuf);
730 current_opts->regex.append(preg);
731 state = state_options;
734 current_opts = start_options(ff);
735 current_opts->base.append(bstrdup(item));
736 state = state_options;
739 current_opts = start_options(ff);
740 current_opts->wild.append(bstrdup(item));
741 state = state_options;
744 current_opts = start_options(ff);
745 set_options(current_opts, item);
746 state = state_options;
749 Jmsg(jcr, M_FATAL, 0, "Invalid FileSet command: %s\n", item);
753 ff->fileset->state = state;
756 static bool term_fileset(JCR *jcr)
758 FF_PKT *ff = (FF_PKT *)jcr->ff;
759 findFILESET *fileset = ff->fileset;
762 for (i=0; i<fileset->include_list.size(); i++) {
763 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
765 for (j=0; j<incexe->opts_list.size(); j++) {
766 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
767 for (k=0; k<fo->regex.size(); k++) {
768 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
770 for (k=0; k<fo->wild.size(); k++) {
771 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
773 for (k=0; k<fo->base.size(); k++) {
774 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
777 for (j=0; j<incexe->name_list.size(); j++) {
778 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
781 for (i=0; i<fileset->exclude_list.size(); i++) {
782 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
784 for (j=0; j<incexe->opts_list.size(); j++) {
785 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
786 for (k=0; k<fo->regex.size(); k++) {
787 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
789 for (k=0; k<fo->wild.size(); k++) {
790 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
792 for (k=0; k<fo->base.size(); k++) {
793 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
796 for (j=0; j<incexe->name_list.size(); j++) {
797 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
800 return ff->fileset->state != state_error;
805 * As an optimization, we should do this during
806 * "compile" time in filed/job.c, and keep only a bit mask
807 * and the Verify options.
809 static void set_options(findFOPTS *fo, const char *opts)
814 for (p=opts; *p; p++) {
816 case 'a': /* alway replace */
817 case '0': /* no option */
820 fo->flags |= FO_EXCLUDE;
823 fo->flags |= FO_MULTIFS;
825 case 'h': /* no recursion */
826 fo->flags |= FO_NO_RECURSION;
832 fo->flags |= FO_NOREPLACE;
834 case 'p': /* use portable data format */
835 fo->flags |= FO_PORTABLE;
837 case 'r': /* read fifo */
838 fo->flags |= FO_READFIFO;
841 fo->flags |= FO_SHA1;
844 fo->flags |= FO_SPARSE;
847 fo->flags |= FO_MTIMEONLY;
850 fo->flags |= FO_KEEPATIME;
852 case 'V': /* verify options */
853 /* Copy Verify Options */
854 for (j=0; *p && *p != ':'; p++) {
855 fo->VerifyOpts[j] = *p;
856 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
860 fo->VerifyOpts[j] = 0;
863 fo->flags |= FO_IF_NEWER;
865 case 'Z': /* gzip compression */
866 fo->flags |= FO_GZIP;
867 fo->GZIP_level = *++p - '0';
868 Dmsg1(200, "Compression level=%d\n", fo->GZIP_level);
871 Emsg1(M_ERROR, 0, "Unknown include/exclude option: %c\n", *p);
879 * Director is passing his Fileset
881 static int fileset_cmd(JCR *jcr)
883 BSOCK *dir = jcr->dir_bsock;
885 if (!init_fileset(jcr)) {
888 while (bnet_recv(dir) >= 0) {
889 strip_trailing_junk(dir->msg);
890 Dmsg1(400, "Fileset: %s\n", dir->msg);
891 add_fileset(jcr, dir->msg);
893 if (!term_fileset(jcr)) {
896 return bnet_fsend(dir, OKinc);
901 * Get list of files to exclude from Director
904 static int exclude_cmd(JCR *jcr)
906 BSOCK *dir = jcr->dir_bsock;
908 while (bnet_recv(dir) >= 0) {
909 dir->msg[dir->msglen] = 0;
910 strip_trailing_junk(dir->msg);
911 add_fname_to_list(jcr, dir->msg, EXC_LIST);
912 Dmsg1(110, "<dird: exclude file %s\n", dir->msg);
915 return bnet_fsend(dir, OKexc);
919 static int bootstrap_cmd(JCR *jcr)
921 BSOCK *dir = jcr->dir_bsock;
922 POOLMEM *fname = get_pool_memory(PM_FNAME);
925 if (jcr->RestoreBootstrap) {
926 unlink(jcr->RestoreBootstrap);
927 free_pool_memory(jcr->RestoreBootstrap);
929 Mmsg(&fname, "%s/%s.%s.bootstrap", me->working_directory, me->hdr.name,
931 Dmsg1(400, "bootstrap=%s\n", fname);
932 jcr->RestoreBootstrap = fname;
933 bs = fopen(fname, "a+"); /* create file */
936 * Suck up what he is sending to us so that he will then
937 * read our error message.
939 while (bnet_recv(dir) >= 0)
942 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
943 jcr->RestoreBootstrap, strerror(errno));
944 free_pool_memory(jcr->RestoreBootstrap);
945 jcr->RestoreBootstrap = NULL;
946 set_jcr_job_status(jcr, JS_ErrorTerminated);
950 while (bnet_recv(dir) >= 0) {
951 Dmsg1(200, "filed<dird: bootstrap file %s\n", dir->msg);
956 return bnet_fsend(dir, OKbootstrap);
961 * Get backup level from Director
964 static int level_cmd(JCR *jcr)
966 BSOCK *dir = jcr->dir_bsock;
967 POOLMEM *level, *buf = NULL;
972 level = get_memory(dir->msglen+1);
973 Dmsg1(110, "level_cmd: %s", dir->msg);
974 if (sscanf(dir->msg, "level = %s ", level) != 1) {
977 /* Base backup requested? */
978 if (strcmp(level, "base") == 0) {
979 jcr->JobLevel = L_BASE;
980 /* Full backup requested? */
981 } else if (strcmp(level, "full") == 0) {
982 jcr->JobLevel = L_FULL;
984 * Backup requested since <date> <time>
985 * This form is also used for incremental and differential
986 * This code is deprecated. See since_utime for new code.
988 } else if (strcmp(level, "since") == 0) {
989 jcr->JobLevel = L_SINCE;
990 if (sscanf(dir->msg, "level = since %d-%d-%d %d:%d:%d mtime_only=%d",
991 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
992 &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &mtime_only) != 7) {
997 tm.tm_wday = tm.tm_yday = 0;
1000 Dmsg2(100, "Got since time: %s mtime_only=%d\n", ctime(&mtime), mtime_only);
1001 jcr->incremental = 1; /* set incremental or decremental backup */
1002 jcr->mtime = mtime; /* set since time */
1004 * We get his UTC since time, then sync the clocks and correct it
1005 * to agree with our clock.
1007 } else if (strcmp(level, "since_utime") == 0) {
1008 buf = get_memory(dir->msglen+1);
1009 utime_t since_time, adj;
1010 btime_t his_time, bt_start, rt=0, bt_adj=0;
1011 jcr->JobLevel = L_SINCE;
1012 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
1013 buf, &mtime_only) != 2) {
1016 since_time = str_to_uint64(buf); /* this is the since time */
1017 char ed1[50], ed2[50];
1019 * Sync clocks by polling him for the time. We take
1020 * 10 samples of his time throwing out the first two.
1022 for (int i=0; i<10; i++) {
1023 bt_start = get_current_btime();
1024 bnet_sig(dir, BNET_BTIME); /* poll for time */
1025 if (bnet_recv(dir) <= 0) { /* get response */
1028 if (sscanf(dir->msg, "btime %s", buf) != 1) {
1031 if (i < 2) { /* toss first two results */
1034 his_time = str_to_uint64(buf);
1035 rt = get_current_btime() - bt_start; /* compute round trip time */
1036 bt_adj -= his_time - bt_start - rt/2;
1037 Dmsg2(200, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1040 bt_adj = bt_adj / 8; /* compute average time */
1041 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1042 adj = btime_to_utime(bt_adj);
1043 since_time += adj; /* adjust for clock difference */
1045 Jmsg(jcr, M_INFO, 0, _("Since time adjusted by %d seconds.\n"), adj);
1047 bnet_sig(dir, BNET_EOD);
1049 Dmsg2(100, "adj = %d since_time=%d\n", (int)adj, (int)since_time);
1050 jcr->incremental = 1; /* set incremental or decremental backup */
1051 jcr->mtime = (time_t)since_time; /* set since time */
1053 Jmsg1(jcr, M_FATAL, 0, "Unknown backup level: %s\n", level);
1061 return bnet_fsend(dir, OKlevel);
1064 pm_strcpy(&jcr->errmsg, dir->msg);
1065 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
1074 * Get session parameters from Director -- this is for a Restore command
1076 static int session_cmd(JCR *jcr)
1078 BSOCK *dir = jcr->dir_bsock;
1080 Dmsg1(100, "SessionCmd: %s", dir->msg);
1081 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1082 &jcr->VolSessionId, &jcr->VolSessionTime,
1083 &jcr->StartFile, &jcr->EndFile,
1084 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1085 pm_strcpy(&jcr->errmsg, dir->msg);
1086 Jmsg(jcr, M_FATAL, 0, "Bad session command: %s", jcr->errmsg);
1090 return bnet_fsend(dir, OKsession);
1094 * Get address of storage daemon from Director
1097 static int storage_cmd(JCR *jcr)
1099 int stored_port; /* storage daemon port */
1100 int enable_ssl; /* enable ssl to sd */
1101 BSOCK *dir = jcr->dir_bsock;
1102 BSOCK *sd; /* storage daemon bsock */
1104 Dmsg1(100, "StorageCmd: %s", dir->msg);
1105 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port, &enable_ssl) != 3) {
1106 pm_strcpy(&jcr->errmsg, dir->msg);
1107 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1110 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port, enable_ssl);
1111 /* Open command communications with Storage daemon */
1112 /* Try to connect for 1 hour at 10 second intervals */
1113 sd = bnet_connect(jcr, 10, (int)me->SDConnectTimeout, _("Storage daemon"),
1114 jcr->stored_addr, NULL, stored_port, 1);
1115 Dmsg0(110, "Connection OK to SD.\n");
1117 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1118 jcr->stored_addr, stored_port);
1119 Dmsg2(100, "Failed to connect to Storage daemon: %s:%d\n",
1120 jcr->stored_addr, stored_port);
1124 jcr->store_bsock = sd;
1126 bnet_fsend(sd, "Hello Start Job %s\n", jcr->Job);
1127 if (!authenticate_storagedaemon(jcr)) {
1128 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1131 Dmsg0(110, "Authenticated with SD.\n");
1133 /* Send OK to Director */
1134 return bnet_fsend(dir, OKstore);
1139 * Do a backup. For now, we handle only Full and Incremental.
1141 static int backup_cmd(JCR *jcr)
1143 BSOCK *dir = jcr->dir_bsock;
1144 BSOCK *sd = jcr->store_bsock;
1147 char ed1[50], ed2[50];
1149 set_jcr_job_status(jcr, JS_Blocked);
1150 jcr->JobType = JT_BACKUP;
1151 Dmsg1(100, "begin backup ff=%p\n", (FF_PKT *)jcr->ff);
1154 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1158 bnet_fsend(dir, OKbackup);
1159 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1162 * Send Append Open Session to Storage daemon
1164 bnet_fsend(sd, append_open);
1165 Dmsg1(110, ">stored: %s", sd->msg);
1167 * Expect to receive back the Ticket number
1169 if (bget_msg(sd) >= 0) {
1170 Dmsg1(110, "<stored: %s", sd->msg);
1171 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1172 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1175 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1177 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1182 * Send Append data command to Storage daemon
1184 bnet_fsend(sd, append_data, jcr->Ticket);
1185 Dmsg1(110, ">stored: %s", sd->msg);
1188 * Expect to get OK data
1190 Dmsg1(110, "<stored: %s", sd->msg);
1191 if (!response(jcr, sd, OK_data, "Append Data")) {
1196 * Send Files to Storage daemon
1198 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1199 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1200 set_jcr_job_status(jcr, JS_ErrorTerminated);
1201 bnet_suppress_error_messages(sd, 1);
1202 Dmsg0(110, "Error in blast_data.\n");
1204 set_jcr_job_status(jcr, JS_Terminated);
1205 if (jcr->JobStatus != JS_Terminated) {
1206 bnet_suppress_error_messages(sd, 1);
1207 goto cleanup; /* bail out now */
1210 * Expect to get response to append_data from Storage daemon
1212 if (!response(jcr, sd, OK_append, "Append Data")) {
1213 set_jcr_job_status(jcr, JS_ErrorTerminated);
1218 * Send Append End Data to Storage daemon
1220 bnet_fsend(sd, append_end, jcr->Ticket);
1222 if (!response(jcr, sd, OK_end, "Append End")) {
1223 set_jcr_job_status(jcr, JS_ErrorTerminated);
1228 * Send Append Close to Storage daemon
1230 bnet_fsend(sd, append_close, jcr->Ticket);
1231 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1232 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1234 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1238 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1241 if (SDJobStatus != JS_Terminated) {
1242 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1248 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1249 edit_uint64(jcr->ReadBytes, ed1),
1250 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1251 Dmsg1(110, "End FD msg: %s\n", dir->msg);
1253 return 0; /* return and stop command loop */
1257 * Do a Verify for Director
1260 static int verify_cmd(JCR *jcr)
1262 BSOCK *dir = jcr->dir_bsock;
1263 BSOCK *sd = jcr->store_bsock;
1264 char level[100], ed1[50], ed2[50];
1266 jcr->JobType = JT_VERIFY;
1267 if (sscanf(dir->msg, verifycmd, level) != 1) {
1268 bnet_fsend(dir, "2994 Bad verify command: %s\n", dir->msg);
1271 if (strcasecmp(level, "init") == 0) {
1272 jcr->JobLevel = L_VERIFY_INIT;
1273 } else if (strcasecmp(level, "catalog") == 0){
1274 jcr->JobLevel = L_VERIFY_CATALOG;
1275 } else if (strcasecmp(level, "volume") == 0){
1276 jcr->JobLevel = L_VERIFY_VOLUME_TO_CATALOG;
1277 } else if (strcasecmp(level, "data") == 0){
1278 jcr->JobLevel = L_VERIFY_DATA;
1279 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1280 jcr->JobLevel = L_VERIFY_DISK_TO_CATALOG;
1282 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1286 bnet_fsend(dir, OKverify);
1287 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1289 switch (jcr->JobLevel) {
1291 case L_VERIFY_CATALOG:
1294 case L_VERIFY_VOLUME_TO_CATALOG:
1295 if (!open_sd_read_session(jcr)) {
1298 start_dir_heartbeat(jcr);
1299 do_verify_volume(jcr);
1300 stop_dir_heartbeat(jcr);
1302 * Send Close session command to Storage daemon
1304 bnet_fsend(sd, read_close, jcr->Ticket);
1305 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1307 /* ****FIXME**** check response */
1308 bget_msg(sd); /* get OK */
1310 /* Inform Storage daemon that we are done */
1311 bnet_sig(sd, BNET_TERMINATE);
1314 case L_VERIFY_DISK_TO_CATALOG:
1318 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1322 bnet_sig(dir, BNET_EOD);
1324 /* Send termination status back to Dir */
1325 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1326 edit_uint64(jcr->ReadBytes, ed1),
1327 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1329 /* Inform Director that we are done */
1330 bnet_sig(dir, BNET_TERMINATE);
1331 return 0; /* return and terminate command loop */
1335 * Do a Restore for Director
1338 static int restore_cmd(JCR *jcr)
1340 BSOCK *dir = jcr->dir_bsock;
1341 BSOCK *sd = jcr->store_bsock;
1345 char ed1[50], ed2[50];
1348 * Scan WHERE (base directory for restore) from command
1350 Dmsg0(150, "restore command\n");
1351 /* Pickup where string */
1352 where = get_memory(dir->msglen+1);
1355 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, where) != 3) {
1356 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
1357 pm_strcpy(&jcr->errmsg, dir->msg);
1358 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
1363 /* Turn / into nothing */
1364 if (where[0] == '/' && where[1] == 0) {
1368 Dmsg2(150, "Got replace %c, where=%s\n", replace, where);
1369 unbash_spaces(where);
1370 jcr->where = bstrdup(where);
1371 free_pool_memory(where);
1372 jcr->replace = replace;
1373 jcr->prefix_links = prefix_links;
1375 bnet_fsend(dir, OKrestore);
1376 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1378 jcr->JobType = JT_RESTORE;
1380 set_jcr_job_status(jcr, JS_Blocked);
1381 if (!open_sd_read_session(jcr)) {
1382 set_jcr_job_status(jcr, JS_ErrorTerminated);
1386 set_jcr_job_status(jcr, JS_Running);
1389 * Do restore of files and data
1391 start_dir_heartbeat(jcr);
1393 stop_dir_heartbeat(jcr);
1395 set_jcr_job_status(jcr, JS_Terminated);
1396 if (jcr->JobStatus != JS_Terminated) {
1397 bnet_suppress_error_messages(sd, 1);
1401 * Send Close session command to Storage daemon
1403 bnet_fsend(sd, read_close, jcr->Ticket);
1404 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1406 bget_msg(sd); /* get OK */
1408 /* Inform Storage daemon that we are done */
1409 bnet_sig(sd, BNET_TERMINATE);
1414 set_jcr_job_status(jcr, JS_ErrorTerminated);
1416 /* Send termination status back to Dir */
1417 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1418 edit_uint64(jcr->ReadBytes, ed1),
1419 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1421 /* Inform Director that we are done */
1422 bnet_sig(dir, BNET_TERMINATE);
1424 Dmsg0(130, "Done in job.c\n");
1425 return 0; /* return and terminate command loop */
1428 static int open_sd_read_session(JCR *jcr)
1430 BSOCK *sd = jcr->store_bsock;
1433 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
1436 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
1437 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
1438 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
1440 * Open Read Session with Storage daemon
1442 bnet_fsend(sd, read_open, jcr->VolumeName,
1443 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
1444 jcr->StartBlock, jcr->EndBlock);
1445 Dmsg1(110, ">stored: %s", sd->msg);
1450 if (bget_msg(sd) >= 0) {
1451 Dmsg1(110, "bfiled<stored: %s", sd->msg);
1452 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1453 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
1456 Dmsg1(110, "bfiled: got Ticket=%d\n", jcr->Ticket);
1458 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
1462 if (!send_bootstrap_file(jcr)) {
1467 * Start read of data with Storage daemon
1469 bnet_fsend(sd, read_data, jcr->Ticket);
1470 Dmsg1(110, ">stored: %s", sd->msg);
1475 if (!response(jcr, sd, OK_data, "Read Data")) {
1482 * Destroy the Job Control Record and associated
1483 * resources (sockets).
1485 static void filed_free_jcr(JCR *jcr)
1487 if (jcr->store_bsock) {
1488 bnet_close(jcr->store_bsock);
1490 if (jcr->RestoreBootstrap) {
1491 unlink(jcr->RestoreBootstrap);
1492 free_pool_memory(jcr->RestoreBootstrap);
1493 jcr->RestoreBootstrap = NULL;
1495 if (jcr->last_fname) {
1496 free_pool_memory(jcr->last_fname);
1498 if (jcr->RunAfterJob) {
1499 free_pool_memory(jcr->RunAfterJob);
1507 * Get response from Storage daemon to a command we
1508 * sent. Check that the response is OK.
1510 * Returns: 0 on failure
1513 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
1518 if (bget_msg(sd) > 0) {
1519 Dmsg0(110, sd->msg);
1520 if (strcmp(sd->msg, resp) == 0) {
1524 if (job_canceled(jcr)) {
1525 return 0; /* if canceled avoid useless error messages */
1527 if (is_bnet_error(sd)) {
1528 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
1529 cmd, bnet_strerror(sd));
1531 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
1532 cmd, resp, sd->msg);
1537 static int send_bootstrap_file(JCR *jcr)
1541 BSOCK *sd = jcr->store_bsock;
1542 const char *bootstrap = "bootstrap\n";
1545 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
1546 if (!jcr->RestoreBootstrap) {
1549 bs = fopen(jcr->RestoreBootstrap, "r");
1551 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
1552 jcr->RestoreBootstrap, strerror(errno));
1553 set_jcr_job_status(jcr, JS_ErrorTerminated);
1556 pm_strcpy(&sd->msg, bootstrap);
1557 sd->msglen = strlen(sd->msg);
1559 while (fgets(buf, sizeof(buf), bs)) {
1560 sd->msglen = Mmsg(&sd->msg, "%s", buf);
1563 bnet_sig(sd, BNET_EOD);
1565 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
1566 set_jcr_job_status(jcr, JS_ErrorTerminated);
1572 if (jcr->RestoreBootstrap) {
1573 unlink(jcr->RestoreBootstrap);
1574 free_pool_memory(jcr->RestoreBootstrap);
1575 jcr->RestoreBootstrap = NULL;