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)
166 BSOCK *dir = (BSOCK *)dirp;
168 jcr = new_jcr(sizeof(JCR), filed_free_jcr); /* create JCR */
169 jcr->dir_bsock = dir;
170 jcr->ff = init_find_files();
171 jcr->start_time = time(NULL);
172 jcr->last_fname = get_pool_memory(PM_FNAME);
173 jcr->last_fname[0] = 0;
174 jcr->client_name = get_memory(strlen(my_name) + 1);
175 pm_strcpy(&jcr->client_name, my_name);
177 enable_backup_privileges(NULL, 1 /* ignore_errors */);
179 /**********FIXME******* add command handler error code */
181 for (quit=0; !quit;) {
184 if (bnet_recv(dir) < 0) {
185 break; /* connection terminated */
187 dir->msg[dir->msglen] = 0;
188 Dmsg1(100, "<dird: %s", dir->msg);
190 for (i=0; cmds[i].cmd; i++) {
191 if (strncmp(cmds[i].cmd, dir->msg, strlen(cmds[i].cmd)) == 0) {
192 if (!jcr->authenticated && cmds[i].func != hello_cmd) {
193 bnet_fsend(dir, no_auth);
196 found = TRUE; /* indicate command found */
197 if (!cmds[i].func(jcr)) { /* do command */
198 quit = TRUE; /* error or fully terminated, get out */
199 Dmsg0(20, "Command error or Job done.\n");
204 if (!found) { /* command not found */
205 bnet_fsend(dir, errmsg);
211 /* Inform Storage daemon that we are done */
212 if (jcr->store_bsock) {
213 bnet_sig(jcr->store_bsock, BNET_TERMINATE);
216 if (jcr->RunAfterJob && !job_canceled(jcr)) {
217 run_cmd(jcr, jcr->RunAfterJob, "ClientRunAfterJob");
220 /* Inform Director that we are done */
221 bnet_sig(dir, BNET_TERMINATE);
223 /* Clean up fileset */
224 FF_PKT *ff = (FF_PKT *)jcr->ff;
225 findFILESET *fileset = ff->fileset;
228 /* Delete FileSet Include lists */
229 for (i=0; i<fileset->include_list.size(); i++) {
230 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
231 for (j=0; j<incexe->opts_list.size(); j++) {
232 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
237 incexe->opts_list.destroy();
238 incexe->name_list.destroy();
240 fileset->include_list.destroy();
242 /* Delete FileSet Exclude lists */
243 for (i=0; i<fileset->exclude_list.size(); i++) {
244 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
245 for (j=0; j<incexe->opts_list.size(); j++) {
246 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
251 incexe->opts_list.destroy();
252 incexe->name_list.destroy();
254 fileset->exclude_list.destroy();
257 Dmsg0(100, "Calling term_find_files\n");
258 term_find_files((FF_PKT *)jcr->ff);
259 Dmsg0(100, "Done with term_find_files\n");
260 free_jcr(jcr); /* destroy JCR record */
261 Dmsg0(100, "Done with free_jcr\n");
266 * Hello from Director he must identify himself and provide his
269 static int hello_cmd(JCR *jcr)
271 Dmsg0(120, "Calling Authenticate\n");
272 if (!authenticate_director(jcr)) {
275 Dmsg0(120, "OK Authenticate\n");
276 jcr->authenticated = TRUE;
283 static int cancel_cmd(JCR *jcr)
285 BSOCK *dir = jcr->dir_bsock;
286 char Job[MAX_NAME_LENGTH];
289 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
290 if (!(cjcr=get_jcr_by_full_name(Job))) {
291 bnet_fsend(dir, "2901 Job %s not found.\n", Job);
293 if (cjcr->store_bsock) {
295 cjcr->store_bsock->timed_out = 1;
296 cjcr->store_bsock->terminated = 1;
298 * #if !defined(HAVE_CYGWIN) && !defined(HAVE_WIN32)
300 #if !defined(HAVE_CYGWIN)
301 pthread_kill(cjcr->my_thread_id, TIMEOUT_SIGNAL);
305 set_jcr_job_status(cjcr, JS_Canceled);
307 bnet_fsend(dir, _("2001 Job %s marked to be canceled.\n"), Job);
310 bnet_fsend(dir, _("2902 Error scanning cancel command.\n"));
312 bnet_sig(dir, BNET_EOD);
318 * Set debug level as requested by the Director
321 static int setdebug_cmd(JCR *jcr)
323 BSOCK *dir = jcr->dir_bsock;
324 int level, trace_flag;
326 Dmsg1(110, "setdebug_cmd: %s", dir->msg);
327 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
328 pm_strcpy(&jcr->errmsg, dir->msg);
329 bnet_fsend(dir, "2991 Bad setdebug command: %s\n", jcr->errmsg);
333 set_trace(trace_flag);
334 return bnet_fsend(dir, OKsetdebug, level);
338 static int estimate_cmd(JCR *jcr)
340 BSOCK *dir = jcr->dir_bsock;
343 if (sscanf(dir->msg, estimatecmd, &jcr->listing) != 1) {
344 pm_strcpy(&jcr->errmsg, dir->msg);
345 Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
346 bnet_fsend(dir, "2992 Bad estimate command.\n");
350 bnet_fsend(dir, OKest, jcr->num_files_examined,
351 edit_uint64_with_commas(jcr->JobBytes, ed2));
352 bnet_sig(dir, BNET_EOD);
357 * Get JobId and Storage Daemon Authorization key from Director
359 static int job_cmd(JCR *jcr)
361 BSOCK *dir = jcr->dir_bsock;
362 POOLMEM *sd_auth_key;
364 sd_auth_key = get_memory(dir->msglen);
365 if (sscanf(dir->msg, jobcmd, &jcr->JobId, jcr->Job,
366 &jcr->VolSessionId, &jcr->VolSessionTime,
368 pm_strcpy(&jcr->errmsg, dir->msg);
369 Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
370 bnet_fsend(dir, BADjob);
371 free_pool_memory(sd_auth_key);
374 jcr->sd_auth_key = bstrdup(sd_auth_key);
375 free_pool_memory(sd_auth_key);
376 Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
377 return bnet_fsend(dir, OKjob, HOST_OS, DISTNAME, DISTVER);
380 static int runbefore_cmd(JCR *jcr)
383 BSOCK *dir = jcr->dir_bsock;
384 POOLMEM *cmd = get_memory(dir->msglen+1);
386 Dmsg1(100, "runbefore_cmd: %s", dir->msg);
387 if (sscanf(dir->msg, runbefore, cmd) != 1) {
388 pm_strcpy(&jcr->errmsg, dir->msg);
389 Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
390 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
396 /* Run the command now */
397 stat = run_cmd(jcr, cmd, "ClientRunBeforeJob");
400 bnet_fsend(dir, OKRunBefore);
403 bnet_fsend(dir, "2905 Bad RunBeforeJob command.\n");
408 static int runafter_cmd(JCR *jcr)
410 BSOCK *dir = jcr->dir_bsock;
411 POOLMEM *msg = get_memory(dir->msglen+1);
413 Dmsg1(100, "runafter_cmd: %s", dir->msg);
414 if (sscanf(dir->msg, runafter, msg) != 1) {
415 pm_strcpy(&jcr->errmsg, dir->msg);
416 Jmsg1(jcr, M_FATAL, 0, _("Bad RunAfter command: %s\n"), jcr->errmsg);
417 bnet_fsend(dir, "2905 Bad RunAfterJob command.\n");
422 if (jcr->RunAfterJob) {
423 free_pool_memory(jcr->RunAfterJob);
425 jcr->RunAfterJob = get_pool_memory(PM_FNAME);
426 pm_strcpy(&jcr->RunAfterJob, msg);
427 free_pool_memory(msg);
428 return bnet_fsend(dir, OKRunAfter);
431 static int run_cmd(JCR *jcr, char *cmd, const char *name)
433 POOLMEM *ecmd = get_pool_memory(PM_FNAME);
436 char line[MAXSTRING];
438 ecmd = edit_job_codes(jcr, ecmd, cmd, "");
439 bpipe = open_bpipe(ecmd, 0, "r");
440 free_pool_memory(ecmd);
441 while (fgets(line, sizeof(line), bpipe->rfd)) {
442 Jmsg(jcr, M_INFO, 0, _("%s: %s"), name, line);
444 status = close_bpipe(bpipe);
446 Jmsg(jcr, M_FATAL, 0, _("%s returned non-zero status=%d\n"), name,
448 set_jcr_job_status(jcr, JS_FatalError);
458 static void add_fname_to_list(JCR *jcr, char *fname, int list)
468 /* Skip leading options -- currently ignored */
469 for (p=fname; *p && *p != ' '; p++)
471 /* Skip spaces, and q points to first space */
472 for (q=NULL; *p && *p == ' '; p++) {
480 p++; /* skip over | */
481 fn = get_pool_memory(PM_FNAME);
482 fn = edit_job_codes(jcr, fn, p, "");
483 bpipe = open_bpipe(fn, 0, "r");
484 free_pool_memory(fn);
486 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
490 /* Copy File options */
491 if (list == INC_LIST) {
492 *q = 0; /* terminate options */
495 optlen = strlen(buf);
499 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
500 strip_trailing_junk(buf);
501 if (list == INC_LIST) {
502 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
504 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
507 if ((stat=close_bpipe(bpipe)) != 0) {
508 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. RtnStat=%d ERR=%s\n"),
509 p, stat, strerror(errno));
514 p++; /* skip over < */
515 if ((ffd = fopen(p, "r")) == NULL) {
516 Jmsg(jcr, M_FATAL, 0, _("Cannot open %s file: %s. ERR=%s\n"),
517 list==INC_LIST?"included":"excluded", p, strerror(errno));
520 /* Copy File options */
521 if (list == INC_LIST) {
522 *q = 0; /* terminate options */
525 optlen = strlen(buf);
529 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
530 strip_trailing_junk(buf);
531 if (list == INC_LIST) {
532 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, buf);
534 add_fname_to_exclude_list((FF_PKT *)jcr->ff, buf);
540 if (list == INC_LIST) {
541 add_fname_to_include_list((FF_PKT *)jcr->ff, 1, fname);
543 add_fname_to_exclude_list((FF_PKT *)jcr->ff, p);
551 * Get list of files/directories to include from Director
554 static int include_cmd(JCR *jcr)
556 BSOCK *dir = jcr->dir_bsock;
558 while (bnet_recv(dir) >= 0) {
559 dir->msg[dir->msglen] = 0;
560 strip_trailing_junk(dir->msg);
561 Dmsg1(010, "include file: %s\n", dir->msg);
562 add_fname_to_list(jcr, dir->msg, INC_LIST);
565 return bnet_fsend(dir, OKinc);
568 static bool init_fileset(JCR *jcr)
571 findFILESET *fileset;
576 ff = (FF_PKT *)jcr->ff;
580 fileset = (findFILESET *)malloc(sizeof(findFILESET));
581 memset(fileset, 0, sizeof(findFILESET));
582 ff->fileset = fileset;
583 fileset->state = state_none;
584 fileset->include_list.init(1, true);
585 fileset->exclude_list.init(1, true);
589 static findFOPTS *start_options(FF_PKT *ff)
591 int state = ff->fileset->state;
592 findINCEXE *incexe = ff->fileset->incexe;
594 if (state != state_options) {
595 ff->fileset->state = state_options;
596 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
597 memset(fo, 0, sizeof(findFOPTS));
598 fo->regex.init(1, true);
599 fo->wild.init(1, true);
600 fo->base.init(1, true);
601 incexe->current_opts = fo;
602 incexe->opts_list.append(fo);
604 return incexe->current_opts;
609 static void add_fileset(JCR *jcr, const char *item)
611 FF_PKT *ff = (FF_PKT *)jcr->ff;
612 findFILESET *fileset = ff->fileset;
613 int state = fileset->state;
614 findFOPTS *current_opts;
617 if (item[1] == ' ') { /* If string follows */
618 item += 2; /* point to string */
621 if (state == state_error) {
627 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
628 memset(fileset->incexe, 0, sizeof(findINCEXE));
629 fileset->incexe->opts_list.init(1, true);
630 fileset->incexe->name_list.init(1, true);
631 fileset->include_list.append(fileset->incexe);
635 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
636 memset(fileset->incexe, 0, sizeof(findINCEXE));
637 fileset->incexe->opts_list.init(1, true);
638 fileset->incexe->name_list.init(1, true);
639 fileset->exclude_list.append(fileset->incexe);
646 state = state_include;
647 fileset->incexe->name_list.append(bstrdup(item));
650 current_opts = start_options(ff);
651 current_opts->regex.append(bstrdup(item));
652 state = state_options;
655 current_opts = start_options(ff);
656 current_opts->base.append(bstrdup(item));
657 state = state_options;
660 current_opts = start_options(ff);
661 current_opts->wild.append(bstrdup(item));
662 state = state_options;
665 current_opts = start_options(ff);
666 set_options(current_opts, item);
667 state = state_options;
670 Jmsg(jcr, M_FATAL, 0, "Invalid FileSet command: %s\n", item);
674 ff->fileset->state = state;
677 static bool term_fileset(JCR *jcr)
679 FF_PKT *ff = (FF_PKT *)jcr->ff;
680 findFILESET *fileset = ff->fileset;
683 for (i=0; i<fileset->include_list.size(); i++) {
684 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
686 for (j=0; j<incexe->opts_list.size(); j++) {
687 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
688 for (k=0; k<fo->regex.size(); k++) {
689 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
691 for (k=0; k<fo->wild.size(); k++) {
692 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
694 for (k=0; k<fo->base.size(); k++) {
695 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
698 for (j=0; j<incexe->name_list.size(); j++) {
699 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
702 for (i=0; i<fileset->exclude_list.size(); i++) {
703 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
705 for (j=0; j<incexe->opts_list.size(); j++) {
706 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
707 for (k=0; k<fo->regex.size(); k++) {
708 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
710 for (k=0; k<fo->wild.size(); k++) {
711 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
713 for (k=0; k<fo->base.size(); k++) {
714 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
717 for (j=0; j<incexe->name_list.size(); j++) {
718 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
721 return ff->fileset->state != state_error;
726 * As an optimization, we should do this during
727 * "compile" time in filed/job.c, and keep only a bit mask
728 * and the Verify options.
730 static void set_options(findFOPTS *fo, const char *opts)
735 for (p=opts; *p; p++) {
737 case 'a': /* alway replace */
738 case '0': /* no option */
741 fo->flags |= FO_EXCLUDE;
744 fo->flags |= FO_MULTIFS;
746 case 'h': /* no recursion */
747 fo->flags |= FO_NO_RECURSION;
753 fo->flags |= FO_NOREPLACE;
755 case 'p': /* use portable data format */
756 fo->flags |= FO_PORTABLE;
758 case 'r': /* read fifo */
759 fo->flags |= FO_READFIFO;
762 fo->flags |= FO_SHA1;
765 fo->flags |= FO_SPARSE;
768 fo->flags |= FO_MTIMEONLY;
771 fo->flags |= FO_KEEPATIME;
773 case 'V': /* verify options */
774 /* Copy Verify Options */
775 for (j=0; *p && *p != ':'; p++) {
776 fo->VerifyOpts[j] = *p;
777 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
781 fo->VerifyOpts[j] = 0;
784 fo->flags |= FO_IF_NEWER;
786 case 'Z': /* gzip compression */
787 fo->flags |= FO_GZIP;
788 fo->GZIP_level = *++p - '0';
789 Dmsg1(200, "Compression level=%d\n", fo->GZIP_level);
792 Emsg1(M_ERROR, 0, "Unknown include/exclude option: %c\n", *p);
800 * Director is passing his Fileset
802 static int fileset_cmd(JCR *jcr)
804 BSOCK *dir = jcr->dir_bsock;
806 if (!init_fileset(jcr)) {
809 while (bnet_recv(dir) >= 0) {
810 strip_trailing_junk(dir->msg);
811 Dmsg1(400, "Fileset: %s\n", dir->msg);
812 add_fileset(jcr, dir->msg);
814 if (!term_fileset(jcr)) {
817 return bnet_fsend(dir, OKinc);
822 * Get list of files to exclude from Director
825 static int exclude_cmd(JCR *jcr)
827 BSOCK *dir = jcr->dir_bsock;
829 while (bnet_recv(dir) >= 0) {
830 dir->msg[dir->msglen] = 0;
831 strip_trailing_junk(dir->msg);
832 add_fname_to_list(jcr, dir->msg, EXC_LIST);
833 Dmsg1(110, "<dird: exclude file %s\n", dir->msg);
836 return bnet_fsend(dir, OKexc);
840 static int bootstrap_cmd(JCR *jcr)
842 BSOCK *dir = jcr->dir_bsock;
843 POOLMEM *fname = get_pool_memory(PM_FNAME);
846 if (jcr->RestoreBootstrap) {
847 unlink(jcr->RestoreBootstrap);
848 free_pool_memory(jcr->RestoreBootstrap);
850 Mmsg(&fname, "%s/%s.%s.bootstrap", me->working_directory, me->hdr.name,
852 Dmsg1(400, "bootstrap=%s\n", fname);
853 jcr->RestoreBootstrap = fname;
854 bs = fopen(fname, "a+"); /* create file */
857 * Suck up what he is sending to us so that he will then
858 * read our error message.
860 while (bnet_recv(dir) >= 0)
863 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
864 jcr->RestoreBootstrap, strerror(errno));
865 free_pool_memory(jcr->RestoreBootstrap);
866 jcr->RestoreBootstrap = NULL;
867 set_jcr_job_status(jcr, JS_ErrorTerminated);
871 while (bnet_recv(dir) >= 0) {
872 Dmsg1(200, "filed<dird: bootstrap file %s\n", dir->msg);
877 return bnet_fsend(dir, OKbootstrap);
882 * Get backup level from Director
885 static int level_cmd(JCR *jcr)
887 BSOCK *dir = jcr->dir_bsock;
888 POOLMEM *level, *buf = NULL;
893 level = get_memory(dir->msglen+1);
894 Dmsg1(110, "level_cmd: %s", dir->msg);
895 if (sscanf(dir->msg, "level = %s ", level) != 1) {
898 /* Base backup requested? */
899 if (strcmp(level, "base") == 0) {
900 jcr->JobLevel = L_BASE;
901 /* Full backup requested? */
902 } else if (strcmp(level, "full") == 0) {
903 jcr->JobLevel = L_FULL;
905 * Backup requested since <date> <time>
906 * This form is also used for incremental and differential
907 * This code is deprecated. See since_utime for new code.
909 } else if (strcmp(level, "since") == 0) {
910 jcr->JobLevel = L_SINCE;
911 if (sscanf(dir->msg, "level = since %d-%d-%d %d:%d:%d mtime_only=%d",
912 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
913 &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &mtime_only) != 7) {
918 tm.tm_wday = tm.tm_yday = 0;
921 Dmsg2(100, "Got since time: %s mtime_only=%d\n", ctime(&mtime), mtime_only);
922 jcr->incremental = 1; /* set incremental or decremental backup */
923 jcr->mtime = mtime; /* set since time */
925 * We get his UTC since time, then sync the clocks and correct it
926 * to agree with our clock.
928 } else if (strcmp(level, "since_utime") == 0) {
929 buf = get_memory(dir->msglen+1);
930 utime_t since_time, adj;
931 btime_t his_time, bt_start, rt=0, bt_adj=0;
932 jcr->JobLevel = L_SINCE;
933 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
934 buf, &mtime_only) != 2) {
937 since_time = str_to_uint64(buf); /* this is the since time */
938 char ed1[50], ed2[50];
940 * Sync clocks by polling him for the time. We take
941 * 10 samples of his time throwing out the first two.
943 for (int i=0; i<10; i++) {
944 bt_start = get_current_btime();
945 bnet_sig(dir, BNET_BTIME); /* poll for time */
946 if (bnet_recv(dir) <= 0) { /* get response */
949 if (sscanf(dir->msg, "btime %s", buf) != 1) {
952 if (i < 2) { /* toss first two results */
955 his_time = str_to_uint64(buf);
956 rt = get_current_btime() - bt_start; /* compute round trip time */
957 bt_adj -= his_time - bt_start - rt/2;
958 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
961 bt_adj = bt_adj / 8; /* compute average time */
962 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
963 adj = btime_to_utime(bt_adj);
964 since_time += adj; /* adjust for clock difference */
966 Jmsg(jcr, M_INFO, 0, _("Since time adjusted by %d seconds.\n"), adj);
968 bnet_sig(dir, BNET_EOD);
970 Dmsg2(100, "adj = %d since_time=%d\n", (int)adj, (int)since_time);
971 jcr->incremental = 1; /* set incremental or decremental backup */
972 jcr->mtime = since_time; /* set since time */
974 Jmsg1(jcr, M_FATAL, 0, "Unknown backup level: %s\n", level);
982 return bnet_fsend(dir, OKlevel);
985 pm_strcpy(&jcr->errmsg, dir->msg);
986 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
995 * Get session parameters from Director -- this is for a Restore command
997 static int session_cmd(JCR *jcr)
999 BSOCK *dir = jcr->dir_bsock;
1001 Dmsg1(100, "SessionCmd: %s", dir->msg);
1002 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1003 &jcr->VolSessionId, &jcr->VolSessionTime,
1004 &jcr->StartFile, &jcr->EndFile,
1005 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1006 pm_strcpy(&jcr->errmsg, dir->msg);
1007 Jmsg(jcr, M_FATAL, 0, "Bad session command: %s", jcr->errmsg);
1011 return bnet_fsend(dir, OKsession);
1015 * Get address of storage daemon from Director
1018 static int storage_cmd(JCR *jcr)
1020 int stored_port; /* storage daemon port */
1021 int enable_ssl; /* enable ssl to sd */
1022 BSOCK *dir = jcr->dir_bsock;
1023 BSOCK *sd; /* storage daemon bsock */
1025 Dmsg1(100, "StorageCmd: %s", dir->msg);
1026 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port, &enable_ssl) != 3) {
1027 pm_strcpy(&jcr->errmsg, dir->msg);
1028 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1031 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port, enable_ssl);
1032 /* Open command communications with Storage daemon */
1033 /* Try to connect for 1 hour at 10 second intervals */
1034 sd = bnet_connect(jcr, 10, me->SDConnectTimeout, _("Storage daemon"),
1035 jcr->stored_addr, NULL, stored_port, 1);
1037 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1038 jcr->stored_addr, stored_port);
1042 jcr->store_bsock = sd;
1044 bnet_fsend(sd, "Hello Start Job %s\n", jcr->Job);
1045 if (!authenticate_storagedaemon(jcr)) {
1046 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1049 Dmsg0(110, "Authenticated with SD.\n");
1051 /* Send OK to Director */
1052 return bnet_fsend(dir, OKstore);
1057 * Do a backup. For now, we handle only Full and Incremental.
1059 static int backup_cmd(JCR *jcr)
1061 BSOCK *dir = jcr->dir_bsock;
1062 BSOCK *sd = jcr->store_bsock;
1065 char ed1[50], ed2[50];
1067 set_jcr_job_status(jcr, JS_Blocked);
1068 jcr->JobType = JT_BACKUP;
1069 Dmsg1(100, "begin backup ff=%p\n", (FF_PKT *)jcr->ff);
1072 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1076 bnet_fsend(dir, OKbackup);
1077 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1080 * Send Append Open Session to Storage daemon
1082 bnet_fsend(sd, append_open);
1083 Dmsg1(110, ">stored: %s", sd->msg);
1085 * Expect to receive back the Ticket number
1087 if (bget_msg(sd) >= 0) {
1088 Dmsg1(110, "<stored: %s", sd->msg);
1089 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1090 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1093 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1095 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1100 * Send Append data command to Storage daemon
1102 bnet_fsend(sd, append_data, jcr->Ticket);
1103 Dmsg1(110, ">stored: %s", sd->msg);
1106 * Expect to get OK data
1108 Dmsg1(110, "<stored: %s", sd->msg);
1109 if (!response(jcr, sd, OK_data, "Append Data")) {
1114 * Send Files to Storage daemon
1116 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1117 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1118 set_jcr_job_status(jcr, JS_ErrorTerminated);
1119 bnet_suppress_error_messages(sd, 1);
1121 set_jcr_job_status(jcr, JS_Terminated);
1122 if (jcr->JobStatus != JS_Terminated) {
1123 bnet_suppress_error_messages(sd, 1);
1124 goto cleanup; /* bail out now */
1127 * Expect to get response to append_data from Storage daemon
1129 if (!response(jcr, sd, OK_append, "Append Data")) {
1130 set_jcr_job_status(jcr, JS_ErrorTerminated);
1135 * Send Append End Data to Storage daemon
1137 bnet_fsend(sd, append_end, jcr->Ticket);
1139 if (!response(jcr, sd, OK_end, "Append End")) {
1140 set_jcr_job_status(jcr, JS_ErrorTerminated);
1145 * Send Append Close to Storage daemon
1147 bnet_fsend(sd, append_close, jcr->Ticket);
1148 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1149 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1151 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1155 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1158 if (SDJobStatus != JS_Terminated) {
1159 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1166 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1167 edit_uint64(jcr->ReadBytes, ed1),
1168 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1170 return 0; /* return and stop command loop */
1174 * Do a Verify for Director
1177 static int verify_cmd(JCR *jcr)
1179 BSOCK *dir = jcr->dir_bsock;
1180 BSOCK *sd = jcr->store_bsock;
1181 char level[100], ed1[50], ed2[50];
1183 jcr->JobType = JT_VERIFY;
1184 if (sscanf(dir->msg, verifycmd, level) != 1) {
1185 bnet_fsend(dir, "2994 Bad verify command: %s\n", dir->msg);
1188 if (strcasecmp(level, "init") == 0) {
1189 jcr->JobLevel = L_VERIFY_INIT;
1190 } else if (strcasecmp(level, "catalog") == 0){
1191 jcr->JobLevel = L_VERIFY_CATALOG;
1192 } else if (strcasecmp(level, "volume") == 0){
1193 jcr->JobLevel = L_VERIFY_VOLUME_TO_CATALOG;
1194 } else if (strcasecmp(level, "data") == 0){
1195 jcr->JobLevel = L_VERIFY_DATA;
1196 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1197 jcr->JobLevel = L_VERIFY_DISK_TO_CATALOG;
1199 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1203 bnet_fsend(dir, OKverify);
1204 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1206 switch (jcr->JobLevel) {
1208 case L_VERIFY_CATALOG:
1211 case L_VERIFY_VOLUME_TO_CATALOG:
1212 if (!open_sd_read_session(jcr)) {
1215 start_dir_heartbeat(jcr);
1216 do_verify_volume(jcr);
1217 stop_dir_heartbeat(jcr);
1219 * Send Close session command to Storage daemon
1221 bnet_fsend(sd, read_close, jcr->Ticket);
1222 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1224 /* ****FIXME**** check response */
1225 bget_msg(sd); /* get OK */
1227 /* Inform Storage daemon that we are done */
1228 bnet_sig(sd, BNET_TERMINATE);
1231 case L_VERIFY_DISK_TO_CATALOG:
1235 bnet_fsend(dir, "2994 Bad verify level: %s\n", dir->msg);
1239 bnet_sig(dir, BNET_EOD);
1241 /* Send termination status back to Dir */
1242 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1243 edit_uint64(jcr->ReadBytes, ed1),
1244 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1246 /* Inform Director that we are done */
1247 bnet_sig(dir, BNET_TERMINATE);
1248 return 0; /* return and terminate command loop */
1252 * Do a Restore for Director
1255 static int restore_cmd(JCR *jcr)
1257 BSOCK *dir = jcr->dir_bsock;
1258 BSOCK *sd = jcr->store_bsock;
1262 char ed1[50], ed2[50];
1265 * Scan WHERE (base directory for restore) from command
1267 Dmsg0(150, "restore command\n");
1268 /* Pickup where string */
1269 where = get_memory(dir->msglen+1);
1272 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, where) != 3) {
1273 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
1274 pm_strcpy(&jcr->errmsg, dir->msg);
1275 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
1280 /* Turn / into nothing */
1281 if (where[0] == '/' && where[1] == 0) {
1285 Dmsg2(150, "Got replace %c, where=%s\n", replace, where);
1286 unbash_spaces(where);
1287 jcr->where = bstrdup(where);
1288 free_pool_memory(where);
1289 jcr->replace = replace;
1290 jcr->prefix_links = prefix_links;
1292 bnet_fsend(dir, OKrestore);
1293 Dmsg1(110, "bfiled>dird: %s", dir->msg);
1295 jcr->JobType = JT_RESTORE;
1297 set_jcr_job_status(jcr, JS_Blocked);
1298 if (!open_sd_read_session(jcr)) {
1299 set_jcr_job_status(jcr, JS_ErrorTerminated);
1303 set_jcr_job_status(jcr, JS_Running);
1306 * Do restore of files and data
1308 start_dir_heartbeat(jcr);
1310 stop_dir_heartbeat(jcr);
1312 set_jcr_job_status(jcr, JS_Terminated);
1313 if (jcr->JobStatus != JS_Terminated) {
1314 bnet_suppress_error_messages(sd, 1);
1318 * Send Close session command to Storage daemon
1320 bnet_fsend(sd, read_close, jcr->Ticket);
1321 Dmsg1(130, "bfiled>stored: %s", sd->msg);
1323 bget_msg(sd); /* get OK */
1325 /* Inform Storage daemon that we are done */
1326 bnet_sig(sd, BNET_TERMINATE);
1331 set_jcr_job_status(jcr, JS_ErrorTerminated);
1333 /* Send termination status back to Dir */
1334 bnet_fsend(dir, EndJob, jcr->JobStatus, jcr->JobFiles,
1335 edit_uint64(jcr->ReadBytes, ed1),
1336 edit_uint64(jcr->JobBytes, ed2), jcr->Errors);
1338 /* Inform Director that we are done */
1339 bnet_sig(dir, BNET_TERMINATE);
1341 Dmsg0(130, "Done in job.c\n");
1342 return 0; /* return and terminate command loop */
1345 static int open_sd_read_session(JCR *jcr)
1347 BSOCK *sd = jcr->store_bsock;
1350 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
1353 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
1354 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
1355 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
1357 * Open Read Session with Storage daemon
1359 bnet_fsend(sd, read_open, jcr->VolumeName,
1360 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
1361 jcr->StartBlock, jcr->EndBlock);
1362 Dmsg1(110, ">stored: %s", sd->msg);
1367 if (bget_msg(sd) >= 0) {
1368 Dmsg1(110, "bfiled<stored: %s", sd->msg);
1369 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1370 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
1373 Dmsg1(110, "bfiled: got Ticket=%d\n", jcr->Ticket);
1375 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
1379 if (!send_bootstrap_file(jcr)) {
1384 * Start read of data with Storage daemon
1386 bnet_fsend(sd, read_data, jcr->Ticket);
1387 Dmsg1(110, ">stored: %s", sd->msg);
1392 if (!response(jcr, sd, OK_data, "Read Data")) {
1399 * Destroy the Job Control Record and associated
1400 * resources (sockets).
1402 static void filed_free_jcr(JCR *jcr)
1404 if (jcr->store_bsock) {
1405 bnet_close(jcr->store_bsock);
1407 if (jcr->RestoreBootstrap) {
1408 unlink(jcr->RestoreBootstrap);
1409 free_pool_memory(jcr->RestoreBootstrap);
1410 jcr->RestoreBootstrap = NULL;
1412 if (jcr->last_fname) {
1413 free_pool_memory(jcr->last_fname);
1415 if (jcr->RunAfterJob) {
1416 free_pool_memory(jcr->RunAfterJob);
1424 * Get response from Storage daemon to a command we
1425 * sent. Check that the response is OK.
1427 * Returns: 0 on failure
1430 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
1435 if (bget_msg(sd) > 0) {
1436 Dmsg0(110, sd->msg);
1437 if (strcmp(sd->msg, resp) == 0) {
1441 if (job_canceled(jcr)) {
1442 return 0; /* if canceled avoid useless error messages */
1444 if (is_bnet_error(sd)) {
1445 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
1446 cmd, bnet_strerror(sd));
1448 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
1449 cmd, resp, sd->msg);
1454 static int send_bootstrap_file(JCR *jcr)
1458 BSOCK *sd = jcr->store_bsock;
1459 char *bootstrap = "bootstrap\n";
1462 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
1463 if (!jcr->RestoreBootstrap) {
1466 bs = fopen(jcr->RestoreBootstrap, "r");
1468 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
1469 jcr->RestoreBootstrap, strerror(errno));
1470 set_jcr_job_status(jcr, JS_ErrorTerminated);
1473 pm_strcpy(&sd->msg, bootstrap);
1474 sd->msglen = strlen(sd->msg);
1476 while (fgets(buf, sizeof(buf), bs)) {
1477 sd->msglen = Mmsg(&sd->msg, "%s", buf);
1480 bnet_sig(sd, BNET_EOD);
1482 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
1483 set_jcr_job_status(jcr, JS_ErrorTerminated);
1489 if (jcr->RestoreBootstrap) {
1490 unlink(jcr->RestoreBootstrap);
1491 free_pool_memory(jcr->RestoreBootstrap);
1492 jcr->RestoreBootstrap = NULL;