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);
239 incexe->opts_list.destroy();
240 incexe->name_list.destroy();
242 fileset->include_list.destroy();
244 /* Delete FileSet Exclude lists */
245 for (i=0; i<fileset->exclude_list.size(); i++) {
246 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
247 for (j=0; j<incexe->opts_list.size(); j++) {
248 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
253 incexe->opts_list.destroy();
254 incexe->name_list.destroy();
256 fileset->exclude_list.destroy();
259 Dmsg0(100, "Calling term_find_files\n");
260 term_find_files((FF_PKT *)jcr->ff);
261 Dmsg0(100, "Done with term_find_files\n");
262 free_jcr(jcr); /* destroy JCR record */
263 Dmsg0(100, "Done with free_jcr\n");
268 * Hello from Director he must identify himself and provide his
271 static int hello_cmd(JCR *jcr)
273 Dmsg0(120, "Calling Authenticate\n");
274 if (!authenticate_director(jcr)) {
277 Dmsg0(120, "OK Authenticate\n");
278 jcr->authenticated = TRUE;
285 static int cancel_cmd(JCR *jcr)
287 BSOCK *dir = jcr->dir_bsock;
288 char Job[MAX_NAME_LENGTH];
291 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
292 if (!(cjcr=get_jcr_by_full_name(Job))) {
293 bnet_fsend(dir, "2901 Job %s not found.\n", Job);
295 if (cjcr->store_bsock) {
297 cjcr->store_bsock->timed_out = 1;
298 cjcr->store_bsock->terminated = 1;
300 * #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
302 #if !defined(HAVE_CYGWIN)
303 pthread_kill(cjcr->my_thread_id, TIMEOUT_SIGNAL);
307 set_jcr_job_status(cjcr, JS_Canceled);
309 bnet_fsend(dir, _("2001 Job %s marked to be canceled.\n"), Job);
312 bnet_fsend(dir, _("2902 Error scanning cancel command.\n"));
314 bnet_sig(dir, BNET_EOD);
320 * Set debug level as requested by the Director
323 static int setdebug_cmd(JCR *jcr)
325 BSOCK *dir = jcr->dir_bsock;
326 int level, trace_flag;
328 Dmsg1(110, "setdebug_cmd: %s", dir->msg);
329 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
330 pm_strcpy(&jcr->errmsg, dir->msg);
331 bnet_fsend(dir, "2991 Bad setdebug command: %s\n", jcr->errmsg);
335 set_trace(trace_flag);
336 return bnet_fsend(dir, OKsetdebug, level);
340 static int estimate_cmd(JCR *jcr)
342 BSOCK *dir = jcr->dir_bsock;
345 if (sscanf(dir->msg, estimatecmd, &jcr->listing) != 1) {
346 pm_strcpy(&jcr->errmsg, dir->msg);
347 Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
348 bnet_fsend(dir, "2992 Bad estimate command.\n");
352 bnet_fsend(dir, OKest, jcr->num_files_examined,
353 edit_uint64_with_commas(jcr->JobBytes, ed2));
354 bnet_sig(dir, BNET_EOD);
359 * Get JobId and Storage Daemon Authorization key from Director
361 static int job_cmd(JCR *jcr)
363 BSOCK *dir = jcr->dir_bsock;
364 POOLMEM *sd_auth_key;
366 sd_auth_key = get_memory(dir->msglen);
367 if (sscanf(dir->msg, jobcmd, &jcr->JobId, jcr->Job,
368 &jcr->VolSessionId, &jcr->VolSessionTime,
370 pm_strcpy(&jcr->errmsg, dir->msg);
371 Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
372 bnet_fsend(dir, BADjob);
373 free_pool_memory(sd_auth_key);
376 jcr->sd_auth_key = bstrdup(sd_auth_key);
377 free_pool_memory(sd_auth_key);
378 Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
379 return bnet_fsend(dir, OKjob, HOST_OS, DISTNAME, DISTVER);
382 static int runbefore_cmd(JCR *jcr)
385 BSOCK *dir = jcr->dir_bsock;
386 POOLMEM *cmd = get_memory(dir->msglen+1);
388 Dmsg1(100, "runbefore_cmd: %s", dir->msg);
389 if (sscanf(dir->msg, runbefore, cmd) != 1) {
390 pm_strcpy(&jcr->errmsg, dir->msg);
391 Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
392 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
398 /* Run the command now */
399 stat = run_cmd(jcr, cmd, "ClientRunBeforeJob");
402 bnet_fsend(dir, OKRunBefore);
405 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
410 static int runafter_cmd(JCR *jcr)
412 BSOCK *dir = jcr->dir_bsock;
413 POOLMEM *msg = get_memory(dir->msglen+1);
415 Dmsg1(100, "runafter_cmd: %s", dir->msg);
416 if (sscanf(dir->msg, runafter, msg) != 1) {
417 pm_strcpy(&jcr->errmsg, dir->msg);
418 Jmsg1(jcr, M_FATAL, 0, _("Bad RunAfter command: %s\n"), jcr->errmsg);
419 bnet_fsend(dir, "2905 Bad RunAfterJob command.\n");
424 if (jcr->RunAfterJob) {
425 free_pool_memory(jcr->RunAfterJob);
427 jcr->RunAfterJob = get_pool_memory(PM_FNAME);
428 pm_strcpy(&jcr->RunAfterJob, msg);
429 free_pool_memory(msg);
430 return bnet_fsend(dir, OKRunAfter);
433 static int run_cmd(JCR *jcr, char *cmd, const char *name)
435 POOLMEM *ecmd = get_pool_memory(PM_FNAME);
438 char line[MAXSTRING];
440 ecmd = edit_job_codes(jcr, ecmd, cmd, "");
441 bpipe = open_bpipe(ecmd, 0, "r");
442 free_pool_memory(ecmd);
444 Jmsg(jcr, M_FATAL, 0, _("%s could not execute\n"), name);
445 set_jcr_job_status(jcr, JS_FatalError);
448 while (fgets(line, sizeof(line), bpipe->rfd)) {
449 Jmsg(jcr, M_INFO, 0, _("%s: %s"), name, line);
451 status = close_bpipe(bpipe);
453 Jmsg(jcr, M_FATAL, 0, _("%s returned non-zero status=%d\n"), name,
455 set_jcr_job_status(jcr, JS_FatalError);
465 static void add_fname_to_list(JCR *jcr, char *fname, int list)
475 /* Skip leading options -- currently ignored */
476 for (p=fname; *p && *p != ' '; p++)
478 /* Skip spaces, and q points to first space */
479 for (q=NULL; *p && *p == ' '; p++) {
487 p++; /* skip over | */
488 fn = get_pool_memory(PM_FNAME);
489 fn = edit_job_codes(jcr, fn, p, "");
490 bpipe = open_bpipe(fn, 0, "r");
491 free_pool_memory(fn);
493 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
497 /* Copy File options */
498 if (list == INC_LIST) {
499 *q = 0; /* terminate options */
502 optlen = strlen(buf);
506 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
507 strip_trailing_junk(buf);
508 if (list == INC_LIST) {
509 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
511 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
514 if ((stat=close_bpipe(bpipe)) != 0) {
515 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. RtnStat=%d ERR=%s\n"),
516 p, stat, strerror(errno));
521 p++; /* skip over < */
522 if ((ffd = fopen(p, "r")) == NULL) {
523 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
524 list==INC_LIST?"included":"excluded", p, strerror(errno));
527 /* Copy File options */
528 if (list == INC_LIST) {
529 *q = 0; /* terminate options */
532 optlen = strlen(buf);
536 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
537 strip_trailing_junk(buf);
538 if (list == INC_LIST) {
539 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
541 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
547 if (list == INC_LIST) {
548 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, fname);
550 add_fname_to_exclude_list((FF_PKT *)jcr->ff, p);
558 * Get list of files/directories to include from Director
561 static int include_cmd(JCR *jcr)
563 BSOCK *dir = jcr->dir_bsock;
565 while (bnet_recv(dir) >= 0) {
566 dir->msg[dir->msglen] = 0;
567 strip_trailing_junk(dir->msg);
568 Dmsg1(010, "include file: %s\n", dir->msg);
569 add_fname_to_list(jcr, dir->msg, INC_LIST);
572 return bnet_fsend(dir, OKinc);
575 static bool init_fileset(JCR *jcr)
578 findFILESET *fileset;
583 ff = (FF_PKT *)jcr->ff;
587 fileset = (findFILESET *)malloc(sizeof(findFILESET));
588 memset(fileset, 0, sizeof(findFILESET));
589 ff->fileset = fileset;
590 fileset->state = state_none;
591 fileset->include_list.init(1, true);
592 fileset->exclude_list.init(1, true);
596 static findFOPTS *start_options(FF_PKT *ff)
598 int state = ff->fileset->state;
599 findINCEXE *incexe = ff->fileset->incexe;
601 if (state != state_options) {
602 ff->fileset->state = state_options;
603 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
604 memset(fo, 0, sizeof(findFOPTS));
605 fo->regex.init(1, true);
606 fo->wild.init(1, true);
607 fo->base.init(1, true);
608 incexe->current_opts = fo;
609 incexe->opts_list.append(fo);
611 return incexe->current_opts;
616 * Add fname to include/exclude fileset list. First check for
617 * | and < and if necessary perform command.
619 static void add_file_to_fileset(JCR *jcr, const char *fname, findFILESET *fileset)
631 p++; /* skip over | */
632 fn = get_pool_memory(PM_FNAME);
633 fn = edit_job_codes(jcr, fn, p, "");
634 bpipe = open_bpipe(fn, 0, "r");
635 free_pool_memory(fn);
637 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
641 while (fgets(buf, sizeof(buf), bpipe->rfd)) {
642 strip_trailing_junk(buf);
643 fileset->incexe->name_list.append(bstrdup(buf));
645 if ((stat=close_bpipe(bpipe)) != 0) {
646 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. RtnStat=%d ERR=%s\n"),
647 p, stat, strerror(errno));
652 p++; /* skip over < */
653 if ((ffd = fopen(p, "r")) == NULL) {
654 Jmsg(jcr, M_FATAL, 0, _("Cannot open FileSet input file: %s. ERR=%s\n"),
658 while (fgets(buf, sizeof(buf), ffd)) {
659 strip_trailing_junk(buf);
660 fileset->incexe->name_list.append(bstrdup(buf));
665 fileset->incexe->name_list.append(bstrdup(fname));
671 static void add_fileset(JCR *jcr, const char *item)
673 FF_PKT *ff = (FF_PKT *)jcr->ff;
674 findFILESET *fileset = ff->fileset;
675 int state = fileset->state;
676 findFOPTS *current_opts;
678 Dmsg1(100, "%s\n", item);
680 if (item[1] == ' ') { /* If string follows */
681 item += 2; /* point to string */
684 if (state == state_error) {
690 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
691 memset(fileset->incexe, 0, sizeof(findINCEXE));
692 fileset->incexe->opts_list.init(1, true);
693 fileset->incexe->name_list.init(1, true);
694 fileset->include_list.append(fileset->incexe);
698 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
699 memset(fileset->incexe, 0, sizeof(findINCEXE));
700 fileset->incexe->opts_list.init(1, true);
701 fileset->incexe->name_list.init(1, true);
702 fileset->exclude_list.append(fileset->incexe);
708 /* File item to either include/include list */
709 state = state_include;
710 add_file_to_fileset(jcr, item, fileset);
713 current_opts = start_options(ff);
714 current_opts->regex.append(bstrdup(item));
715 state = state_options;
718 current_opts = start_options(ff);
719 current_opts->base.append(bstrdup(item));
720 state = state_options;
723 current_opts = start_options(ff);
724 current_opts->wild.append(bstrdup(item));
725 state = state_options;
728 current_opts = start_options(ff);
729 set_options(current_opts, item);
730 state = state_options;
733 Jmsg(jcr, M_FATAL, 0, "Invalid FileSet command: %s\n", item);
737 ff->fileset->state = state;
740 static bool term_fileset(JCR *jcr)
742 FF_PKT *ff = (FF_PKT *)jcr->ff;
743 findFILESET *fileset = ff->fileset;
746 for (i=0; i<fileset->include_list.size(); i++) {
747 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
749 for (j=0; j<incexe->opts_list.size(); j++) {
750 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
751 for (k=0; k<fo->regex.size(); k++) {
752 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
754 for (k=0; k<fo->wild.size(); k++) {
755 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
757 for (k=0; k<fo->base.size(); k++) {
758 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
761 for (j=0; j<incexe->name_list.size(); j++) {
762 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
765 for (i=0; i<fileset->exclude_list.size(); i++) {
766 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
768 for (j=0; j<incexe->opts_list.size(); j++) {
769 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
770 for (k=0; k<fo->regex.size(); k++) {
771 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
773 for (k=0; k<fo->wild.size(); k++) {
774 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
776 for (k=0; k<fo->base.size(); k++) {
777 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
780 for (j=0; j<incexe->name_list.size(); j++) {
781 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
784 return ff->fileset->state != state_error;
789 * As an optimization, we should do this during
790 * "compile" time in filed/job.c, and keep only a bit mask
791 * and the Verify options.
793 static void set_options(findFOPTS *fo, const char *opts)
798 for (p=opts; *p; p++) {
800 case 'a': /* alway replace */
801 case '0': /* no option */
804 fo->flags |= FO_EXCLUDE;
807 fo->flags |= FO_MULTIFS;
809 case 'h': /* no recursion */
810 fo->flags |= FO_NO_RECURSION;
816 fo->flags |= FO_NOREPLACE;
818 case 'p': /* use portable data format */
819 fo->flags |= FO_PORTABLE;
821 case 'r': /* read fifo */
822 fo->flags |= FO_READFIFO;
825 fo->flags |= FO_SHA1;
828 fo->flags |= FO_SPARSE;
831 fo->flags |= FO_MTIMEONLY;
834 fo->flags |= FO_KEEPATIME;
836 case 'V': /* verify options */
837 /* Copy Verify Options */
838 for (j=0; *p && *p != ':'; p++) {
839 fo->VerifyOpts[j] = *p;
840 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
844 fo->VerifyOpts[j] = 0;
847 fo->flags |= FO_IF_NEWER;
849 case 'Z': /* gzip compression */
850 fo->flags |= FO_GZIP;
851 fo->GZIP_level = *++p - '0';
852 Dmsg1(200, "Compression level=%d\n", fo->GZIP_level);
855 Emsg1(M_ERROR, 0, "Unknown include/exclude option: %c\n", *p);
863 * Director is passing his Fileset
865 static int fileset_cmd(JCR *jcr)
867 BSOCK *dir = jcr->dir_bsock;
869 if (!init_fileset(jcr)) {
872 while (bnet_recv(dir) >= 0) {
873 strip_trailing_junk(dir->msg);
874 Dmsg1(400, "Fileset: %s\n", dir->msg);
875 add_fileset(jcr, dir->msg);
877 if (!term_fileset(jcr)) {
880 return bnet_fsend(dir, OKinc);
885 * Get list of files to exclude from Director
888 static int exclude_cmd(JCR *jcr)
890 BSOCK *dir = jcr->dir_bsock;
892 while (bnet_recv(dir) >= 0) {
893 dir->msg[dir->msglen] = 0;
894 strip_trailing_junk(dir->msg);
895 add_fname_to_list(jcr, dir->msg, EXC_LIST);
896 Dmsg1(110, "<dird: exclude file %s\n", dir->msg);
899 return bnet_fsend(dir, OKexc);
903 static int bootstrap_cmd(JCR *jcr)
905 BSOCK *dir = jcr->dir_bsock;
906 POOLMEM *fname = get_pool_memory(PM_FNAME);
909 if (jcr->RestoreBootstrap) {
910 unlink(jcr->RestoreBootstrap);
911 free_pool_memory(jcr->RestoreBootstrap);
913 Mmsg(&fname, "%s/%s.%s.bootstrap", me->working_directory, me->hdr.name,
915 Dmsg1(400, "bootstrap=%s\n", fname);
916 jcr->RestoreBootstrap = fname;
917 bs = fopen(fname, "a+"); /* create file */
920 * Suck up what he is sending to us so that he will then
921 * read our error message.
923 while (bnet_recv(dir) >= 0)
926 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
927 jcr->RestoreBootstrap, strerror(errno));
928 free_pool_memory(jcr->RestoreBootstrap);
929 jcr->RestoreBootstrap = NULL;
930 set_jcr_job_status(jcr, JS_ErrorTerminated);
934 while (bnet_recv(dir) >= 0) {
935 Dmsg1(200, "filed<dird: bootstrap file %s\n", dir->msg);
940 return bnet_fsend(dir, OKbootstrap);
945 * Get backup level from Director
948 static int level_cmd(JCR *jcr)
950 BSOCK *dir = jcr->dir_bsock;
951 POOLMEM *level, *buf = NULL;
956 level = get_memory(dir->msglen+1);
957 Dmsg1(110, "level_cmd: %s", dir->msg);
958 if (sscanf(dir->msg, "level = %s ", level) != 1) {
961 /* Base backup requested? */
962 if (strcmp(level, "base") == 0) {
963 jcr->JobLevel = L_BASE;
964 /* Full backup requested? */
965 } else if (strcmp(level, "full") == 0) {
966 jcr->JobLevel = L_FULL;
968 * Backup requested since <date> <time>
969 * This form is also used for incremental and differential
970 * This code is deprecated. See since_utime for new code.
972 } else if (strcmp(level, "since") == 0) {
973 jcr->JobLevel = L_SINCE;
974 if (sscanf(dir->msg, "level = since %d-%d-%d %d:%d:%d mtime_only=%d",
975 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
976 &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &mtime_only) != 7) {
981 tm.tm_wday = tm.tm_yday = 0;
984 Dmsg2(100, "Got since time: %s mtime_only=%d\n", ctime(&mtime), mtime_only);
985 jcr->incremental = 1; /* set incremental or decremental backup */
986 jcr->mtime = mtime; /* set since time */
988 * We get his UTC since time, then sync the clocks and correct it
989 * to agree with our clock.
991 } else if (strcmp(level, "since_utime") == 0) {
992 buf = get_memory(dir->msglen+1);
993 utime_t since_time, adj;
994 btime_t his_time, bt_start, rt=0, bt_adj=0;
995 jcr->JobLevel = L_SINCE;
996 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
997 buf, &mtime_only) != 2) {
1000 since_time = str_to_uint64(buf); /* this is the since time */
1001 char ed1[50], ed2[50];
1003 * Sync clocks by polling him for the time. We take
1004 * 10 samples of his time throwing out the first two.
1006 for (int i=0; i<10; i++) {
1007 bt_start = get_current_btime();
1008 bnet_sig(dir, BNET_BTIME); /* poll for time */
1009 if (bnet_recv(dir) <= 0) { /* get response */
1012 if (sscanf(dir->msg, "btime %s", buf) != 1) {
1015 if (i < 2) { /* toss first two results */
1018 his_time = str_to_uint64(buf);
1019 rt = get_current_btime() - bt_start; /* compute round trip time */
1020 bt_adj -= his_time - bt_start - rt/2;
1021 Dmsg2(200, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1024 bt_adj = bt_adj / 8; /* compute average time */
1025 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1026 adj = btime_to_utime(bt_adj);
1027 since_time += adj; /* adjust for clock difference */
1029 Jmsg(jcr, M_INFO, 0, _("Since time adjusted by %d seconds.\n"), adj);
1031 bnet_sig(dir, BNET_EOD);
1033 Dmsg2(100, "adj = %d since_time=%d\n", (int)adj, (int)since_time);
1034 jcr->incremental = 1; /* set incremental or decremental backup */
1035 jcr->mtime = since_time; /* set since time */
1037 Jmsg1(jcr, M_FATAL, 0, "Unknown backup level: %s\n", level);
1045 return bnet_fsend(dir, OKlevel);
1048 pm_strcpy(&jcr->errmsg, dir->msg);
1049 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
1058 * Get session parameters from Director -- this is for a Restore command
1060 static int session_cmd(JCR *jcr)
1062 BSOCK *dir = jcr->dir_bsock;
1064 Dmsg1(100, "SessionCmd: %s", dir->msg);
1065 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1066 &jcr->VolSessionId, &jcr->VolSessionTime,
1067 &jcr->StartFile, &jcr->EndFile,
1068 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1069 pm_strcpy(&jcr->errmsg, dir->msg);
1070 Jmsg(jcr, M_FATAL, 0, "Bad session command: %s", jcr->errmsg);
1074 return bnet_fsend(dir, OKsession);
1078 * Get address of storage daemon from Director
1081 static int storage_cmd(JCR *jcr)
1083 int stored_port; /* storage daemon port */
1084 int enable_ssl; /* enable ssl to sd */
1085 BSOCK *dir = jcr->dir_bsock;
1086 BSOCK *sd; /* storage daemon bsock */
1088 Dmsg1(100, "StorageCmd: %s", dir->msg);
1089 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port, &enable_ssl) != 3) {
1090 pm_strcpy(&jcr->errmsg, dir->msg);
1091 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1094 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port, enable_ssl);
1095 /* Open command communications with Storage daemon */
1096 /* Try to connect for 1 hour at 10 second intervals */
1097 sd = bnet_connect(jcr, 10, me->SDConnectTimeout, _("Storage daemon"),
1098 jcr->stored_addr, NULL, stored_port, 1);
1100 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1101 jcr->stored_addr, stored_port);
1102 Dmsg2(100, "Failed to connect to Storage daemon: %s:%d\n",
1103 jcr->stored_addr, stored_port);
1107 jcr->store_bsock = sd;
1109 bnet_fsend(sd, "Hello Start Job %s\n", jcr->Job);
1110 if (!authenticate_storagedaemon(jcr)) {
1111 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1114 Dmsg0(110, "Authenticated with SD.\n");
1116 /* Send OK to Director */
1117 return bnet_fsend(dir, OKstore);
1122 * Do a backup. For now, we handle only Full and Incremental.
1124 static int backup_cmd(JCR *jcr)
1126 BSOCK *dir = jcr->dir_bsock;
1127 BSOCK *sd = jcr->store_bsock;
1130 char ed1[50], ed2[50];
1132 set_jcr_job_status(jcr, JS_Blocked);
1133 jcr->JobType = JT_BACKUP;
1134 Dmsg1(100, "begin backup ff=%p\n", (FF_PKT *)jcr->ff);
1137 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1141 bnet_fsend(dir, OKbackup);
1142 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1145 * Send Append Open Session to Storage daemon
1147 bnet_fsend(sd, append_open);
1148 Dmsg1(110, ">stored: %s", sd->msg);
1150 * Expect to receive back the Ticket number
1152 if (bget_msg(sd) >= 0) {
1153 Dmsg1(110, "<stored: %s", sd->msg);
1154 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1155 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1158 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1160 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1165 * Send Append data command to Storage daemon
1167 bnet_fsend(sd, append_data, jcr->Ticket);
1168 Dmsg1(110, ">stored: %s", sd->msg);
1171 * Expect to get OK data
1173 Dmsg1(110, "<stored: %s", sd->msg);
1174 if (!response(jcr, sd, OK_data, "Append Data")) {
1179 * Send Files to Storage daemon
1181 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1182 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1183 set_jcr_job_status(jcr, JS_ErrorTerminated);
1184 bnet_suppress_error_messages(sd, 1);
1185 Dmsg0(110, "Error in blast_data.\n");
1187 set_jcr_job_status(jcr, JS_Terminated);
1188 if (jcr->JobStatus != JS_Terminated) {
1189 bnet_suppress_error_messages(sd, 1);
1190 goto cleanup; /* bail out now */
1193 * Expect to get response to append_data from Storage daemon
1195 if (!response(jcr, sd, OK_append, "Append Data")) {
1196 set_jcr_job_status(jcr, JS_ErrorTerminated);
1201 * Send Append End Data to Storage daemon
1203 bnet_fsend(sd, append_end, jcr->Ticket);
1205 if (!response(jcr, sd, OK_end, "Append End")) {
1206 set_jcr_job_status(jcr, JS_ErrorTerminated);
1211 * Send Append Close to Storage daemon
1213 bnet_fsend(sd, append_close, jcr->Ticket);
1214 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1215 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1217 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1221 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1224 if (SDJobStatus != JS_Terminated) {
1225 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1231 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1232 edit_uint64(jcr->ReadBytes, ed1),
1233 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1234 Dmsg1(110, "End FD msg: %s\n", dir->msg);
1236 return 0; /* return and stop command loop */
1240 * Do a Verify for Director
1243 static int verify_cmd(JCR *jcr)
1245 BSOCK *dir = jcr->dir_bsock;
1246 BSOCK *sd = jcr->store_bsock;
1247 char level[100], ed1[50], ed2[50];
1249 jcr->JobType = JT_VERIFY;
1250 if (sscanf(dir->msg, verifycmd, level) != 1) {
1251 bnet_fsend(dir, "2994 Bad verify command: %s\n", dir->msg);
1254 if (strcasecmp(level, "init") == 0) {
1255 jcr->JobLevel = L_VERIFY_INIT;
1256 } else if (strcasecmp(level, "catalog") == 0){
1257 jcr->JobLevel = L_VERIFY_CATALOG;
1258 } else if (strcasecmp(level, "volume") == 0){
1259 jcr->JobLevel = L_VERIFY_VOLUME_TO_CATALOG;
1260 } else if (strcasecmp(level, "data") == 0){
1261 jcr->JobLevel = L_VERIFY_DATA;
1262 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1263 jcr->JobLevel = L_VERIFY_DISK_TO_CATALOG;
1265 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1269 bnet_fsend(dir, OKverify);
1270 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1272 switch (jcr->JobLevel) {
1274 case L_VERIFY_CATALOG:
1277 case L_VERIFY_VOLUME_TO_CATALOG:
1278 if (!open_sd_read_session(jcr)) {
1281 start_dir_heartbeat(jcr);
1282 do_verify_volume(jcr);
1283 stop_dir_heartbeat(jcr);
1285 * Send Close session command to Storage daemon
1287 bnet_fsend(sd, read_close, jcr->Ticket);
1288 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1290 /* ****FIXME**** check response */
1291 bget_msg(sd); /* get OK */
1293 /* Inform Storage daemon that we are done */
1294 bnet_sig(sd, BNET_TERMINATE);
1297 case L_VERIFY_DISK_TO_CATALOG:
1301 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1305 bnet_sig(dir, BNET_EOD);
1307 /* Send termination status back to Dir */
1308 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1309 edit_uint64(jcr->ReadBytes, ed1),
1310 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1312 /* Inform Director that we are done */
1313 bnet_sig(dir, BNET_TERMINATE);
1314 return 0; /* return and terminate command loop */
1318 * Do a Restore for Director
1321 static int restore_cmd(JCR *jcr)
1323 BSOCK *dir = jcr->dir_bsock;
1324 BSOCK *sd = jcr->store_bsock;
1328 char ed1[50], ed2[50];
1331 * Scan WHERE (base directory for restore) from command
1333 Dmsg0(150, "restore command\n");
1334 /* Pickup where string */
1335 where = get_memory(dir->msglen+1);
1338 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, where) != 3) {
1339 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
1340 pm_strcpy(&jcr->errmsg, dir->msg);
1341 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
1346 /* Turn / into nothing */
1347 if (where[0] == '/' && where[1] == 0) {
1351 Dmsg2(150, "Got replace %c, where=%s\n", replace, where);
1352 unbash_spaces(where);
1353 jcr->where = bstrdup(where);
1354 free_pool_memory(where);
1355 jcr->replace = replace;
1356 jcr->prefix_links = prefix_links;
1358 bnet_fsend(dir, OKrestore);
1359 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1361 jcr->JobType = JT_RESTORE;
1363 set_jcr_job_status(jcr, JS_Blocked);
1364 if (!open_sd_read_session(jcr)) {
1365 set_jcr_job_status(jcr, JS_ErrorTerminated);
1369 set_jcr_job_status(jcr, JS_Running);
1372 * Do restore of files and data
1374 start_dir_heartbeat(jcr);
1376 stop_dir_heartbeat(jcr);
1378 set_jcr_job_status(jcr, JS_Terminated);
1379 if (jcr->JobStatus != JS_Terminated) {
1380 bnet_suppress_error_messages(sd, 1);
1384 * Send Close session command to Storage daemon
1386 bnet_fsend(sd, read_close, jcr->Ticket);
1387 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1389 bget_msg(sd); /* get OK */
1391 /* Inform Storage daemon that we are done */
1392 bnet_sig(sd, BNET_TERMINATE);
1397 set_jcr_job_status(jcr, JS_ErrorTerminated);
1399 /* Send termination status back to Dir */
1400 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1401 edit_uint64(jcr->ReadBytes, ed1),
1402 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1404 /* Inform Director that we are done */
1405 bnet_sig(dir, BNET_TERMINATE);
1407 Dmsg0(130, "Done in job.c\n");
1408 return 0; /* return and terminate command loop */
1411 static int open_sd_read_session(JCR *jcr)
1413 BSOCK *sd = jcr->store_bsock;
1416 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
1419 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
1420 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
1421 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
1423 * Open Read Session with Storage daemon
1425 bnet_fsend(sd, read_open, jcr->VolumeName,
1426 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
1427 jcr->StartBlock, jcr->EndBlock);
1428 Dmsg1(110, ">stored: %s", sd->msg);
1433 if (bget_msg(sd) >= 0) {
1434 Dmsg1(110, "bfiled<stored: %s", sd->msg);
1435 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1436 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
1439 Dmsg1(110, "bfiled: got Ticket=%d\n", jcr->Ticket);
1441 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
1445 if (!send_bootstrap_file(jcr)) {
1450 * Start read of data with Storage daemon
1452 bnet_fsend(sd, read_data, jcr->Ticket);
1453 Dmsg1(110, ">stored: %s", sd->msg);
1458 if (!response(jcr, sd, OK_data, "Read Data")) {
1465 * Destroy the Job Control Record and associated
1466 * resources (sockets).
1468 static void filed_free_jcr(JCR *jcr)
1470 if (jcr->store_bsock) {
1471 bnet_close(jcr->store_bsock);
1473 if (jcr->RestoreBootstrap) {
1474 unlink(jcr->RestoreBootstrap);
1475 free_pool_memory(jcr->RestoreBootstrap);
1476 jcr->RestoreBootstrap = NULL;
1478 if (jcr->last_fname) {
1479 free_pool_memory(jcr->last_fname);
1481 if (jcr->RunAfterJob) {
1482 free_pool_memory(jcr->RunAfterJob);
1490 * Get response from Storage daemon to a command we
1491 * sent. Check that the response is OK.
1493 * Returns: 0 on failure
1496 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
1501 if (bget_msg(sd) > 0) {
1502 Dmsg0(110, sd->msg);
1503 if (strcmp(sd->msg, resp) == 0) {
1507 if (job_canceled(jcr)) {
1508 return 0; /* if canceled avoid useless error messages */
1510 if (is_bnet_error(sd)) {
1511 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
1512 cmd, bnet_strerror(sd));
1514 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
1515 cmd, resp, sd->msg);
1520 static int send_bootstrap_file(JCR *jcr)
1524 BSOCK *sd = jcr->store_bsock;
1525 char *bootstrap = "bootstrap\n";
1528 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
1529 if (!jcr->RestoreBootstrap) {
1532 bs = fopen(jcr->RestoreBootstrap, "r");
1534 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
1535 jcr->RestoreBootstrap, strerror(errno));
1536 set_jcr_job_status(jcr, JS_ErrorTerminated);
1539 pm_strcpy(&sd->msg, bootstrap);
1540 sd->msglen = strlen(sd->msg);
1542 while (fgets(buf, sizeof(buf), bs)) {
1543 sd->msglen = Mmsg(&sd->msg, "%s", buf);
1546 bnet_sig(sd, BNET_EOD);
1548 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
1549 set_jcr_job_status(jcr, JS_ErrorTerminated);
1555 if (jcr->RestoreBootstrap) {
1556 unlink(jcr->RestoreBootstrap);
1557 free_pool_memory(jcr->RestoreBootstrap);
1558 jcr->RestoreBootstrap = NULL;