2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Bacula File Daemon Job processing
31 * Kern Sibbald, October MM
38 #if defined(WIN32_VSS)
41 static pthread_mutex_t vss_mutex = PTHREAD_MUTEX_INITIALIZER;
42 static int enable_vss = 0;
46 * As Windows saves ACLs as part of the standard backup stream
47 * we just pretend here that is has implicit acl support.
49 #if defined(HAVE_ACL) || defined(HAVE_WIN32)
50 const bool have_acl = true;
52 const bool have_acl = false;
55 #if defined(HAVE_XATTR)
56 const bool have_xattr = true;
58 const bool have_xattr = false;
61 extern CLIENT *me; /* our client resource */
63 /* Imported functions */
64 extern int status_cmd(JCR *jcr);
65 extern int qstatus_cmd(JCR *jcr);
66 extern int accurate_cmd(JCR *jcr);
68 /* Forward referenced functions */
69 static int backup_cmd(JCR *jcr);
70 static int bootstrap_cmd(JCR *jcr);
71 static int cancel_cmd(JCR *jcr);
72 static int setdebug_cmd(JCR *jcr);
73 static int estimate_cmd(JCR *jcr);
74 static int hello_cmd(JCR *jcr);
75 static int job_cmd(JCR *jcr);
76 static int fileset_cmd(JCR *jcr);
77 static int level_cmd(JCR *jcr);
78 static int verify_cmd(JCR *jcr);
79 static int restore_cmd(JCR *jcr);
80 static int end_restore_cmd(JCR *jcr);
81 static int storage_cmd(JCR *jcr);
82 static int session_cmd(JCR *jcr);
83 static int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd);
84 static void filed_free_jcr(JCR *jcr);
85 static int open_sd_read_session(JCR *jcr);
86 static int send_bootstrap_file(JCR *jcr);
87 static int runscript_cmd(JCR *jcr);
88 static int runbefore_cmd(JCR *jcr);
89 static int runafter_cmd(JCR *jcr);
90 static int runbeforenow_cmd(JCR *jcr);
91 static int restore_object_cmd(JCR *jcr);
92 static void set_options(findFOPTS *fo, const char *opts);
93 static void set_storage_auth_key(JCR *jcr, char *key);
95 /* Exported functions */
100 int monitoraccess; /* specify if monitors have access to this function */
104 * The following are the recognized commands from the Director.
106 static struct s_cmds cmds[] = {
107 {"backup", backup_cmd, 0},
108 {"cancel", cancel_cmd, 0},
109 {"setdebug=", setdebug_cmd, 0},
110 {"estimate", estimate_cmd, 0},
111 {"Hello", hello_cmd, 1},
112 {"fileset", fileset_cmd, 0},
113 {"JobId=", job_cmd, 0},
114 {"level = ", level_cmd, 0},
115 {"restore ", restore_cmd, 0},
116 {"endrestore", end_restore_cmd, 0},
117 {"session", session_cmd, 0},
118 {"status", status_cmd, 1},
119 {".status", qstatus_cmd, 1},
120 {"storage ", storage_cmd, 0},
121 {"verify", verify_cmd, 0},
122 {"bootstrap", bootstrap_cmd, 0},
123 {"RunBeforeNow", runbeforenow_cmd, 0},
124 {"RunBeforeJob", runbefore_cmd, 0},
125 {"RunAfterJob", runafter_cmd, 0},
126 {"Run", runscript_cmd, 0},
127 {"accurate", accurate_cmd, 0},
128 {"restoreobject", restore_object_cmd, 0},
129 {NULL, NULL} /* list terminator */
132 /* Commands received from director that need scanning */
133 static char jobcmd[] = "JobId=%d Job=%127s SDid=%d SDtime=%d Authorization=%100s";
134 static char storaddr[] = "storage address=%s port=%d ssl=%d Authorization=%100s";
135 static char storaddr_v1[] = "storage address=%s port=%d ssl=%d";
136 static char sessioncmd[] = "session %127s %ld %ld %ld %ld %ld %ld\n";
137 static char restorecmd[] = "restore replace=%c prelinks=%d where=%s\n";
138 static char restorecmd1[] = "restore replace=%c prelinks=%d where=\n";
139 static char restorecmdR[] = "restore replace=%c prelinks=%d regexwhere=%s\n";
140 static char restoreobjcmd[] = "restoreobject JobId=%u ObjLen=%d ObjInx=%d ObjType=%d FI=%d\n";
141 static char endrestoreobjectcmd[] = "restoreobject end\n";
142 static char verifycmd[] = "verify level=%30s";
143 static char estimatecmd[] = "estimate listing=%d";
144 static char runbefore[] = "RunBeforeJob %s";
145 static char runafter[] = "RunAfterJob %s";
146 static char runscript[] = "Run OnSuccess=%d OnFailure=%d AbortOnError=%d When=%d Command=%s";
148 /* Responses sent to Director */
149 static char errmsg[] = "2999 Invalid command\n";
150 static char no_auth[] = "2998 No Authorization\n";
151 static char invalid_cmd[] = "2997 Invalid command for a Director with Monitor directive enabled.\n";
152 static char OKinc[] = "2000 OK include\n";
153 static char OKest[] = "2000 OK estimate files=%s bytes=%s\n";
154 static char OKlevel[] = "2000 OK level\n";
155 static char OKbackup[] = "2000 OK backup\n";
156 static char OKbootstrap[] = "2000 OK bootstrap\n";
157 static char OKverify[] = "2000 OK verify\n";
158 static char OKrestore[] = "2000 OK restore\n";
159 static char OKsession[] = "2000 OK session\n";
160 static char OKstore[] = "2000 OK storage\n";
161 static char OKstoreend[] = "2000 OK storage end\n";
162 static char OKjob[] = "2000 OK Job %s (%s) %s,%s,%s";
163 static char OKsetdebug[] = "2000 OK setdebug=%d\n";
164 static char BADjob[] = "2901 Bad Job\n";
165 static char EndJob[] = "2800 End Job TermCode=%d JobFiles=%u ReadBytes=%s"
166 " JobBytes=%s Errors=%u VSS=%d Encrypt=%d\n";
167 static char OKRunBefore[] = "2000 OK RunBefore\n";
168 static char OKRunBeforeNow[] = "2000 OK RunBeforeNow\n";
169 static char OKRunAfter[] = "2000 OK RunAfter\n";
170 static char OKRunScript[] = "2000 OK RunScript\n";
171 static char BADcmd[] = "2902 Bad %s\n";
172 static char OKRestoreObject[] = "2000 OK ObjectRestored\n";
175 /* Responses received from Storage Daemon */
176 static char OK_end[] = "3000 OK end\n";
177 static char OK_close[] = "3000 OK close Status = %d\n";
178 static char OK_open[] = "3000 OK open ticket = %d\n";
179 static char OK_data[] = "3000 OK data\n";
180 static char OK_append[] = "3000 OK append data\n";
181 static char OKSDbootstrap[]= "3000 OK bootstrap\n";
184 /* Commands sent to Storage Daemon */
185 static char append_open[] = "append open session\n";
186 static char append_data[] = "append data %d\n";
187 static char append_end[] = "append end session %d\n";
188 static char append_close[] = "append close session %d\n";
189 static char read_open[] = "read open session = %s %ld %ld %ld %ld %ld %ld\n";
190 static char read_data[] = "read data %d\n";
191 static char read_close[] = "read close session %d\n";
194 * Accept requests from a Director
196 * NOTE! We are running as a separate thread
198 * Send output one line
199 * at a time followed by a zero length transmission.
201 * Return when the connection is terminated or there
204 * Basic task here is:
205 * Authenticate Director (during Hello command).
206 * Accept commands one at a time from the Director
209 * Concerning ClientRunBefore/After, the sequence of events
210 * is rather critical. If they are not done in the right
211 * order one can easily get FD->SD timeouts if the script
214 * The current sequence of events is:
215 * 1. Dir starts job with FD
216 * 2. Dir connects to SD
217 * 3. Dir connects to FD
218 * 4. FD connects to SD
219 * 5. FD gets/runs ClientRunBeforeJob and sends ClientRunAfterJob
220 * 6. Dir sends include/exclude
221 * 7. FD sends data to SD
222 * 8. SD/FD disconnects while SD despools data and attributes (optional)
223 * 9. FD runs ClientRunAfterJob
226 void *handle_client_request(void *dirp)
231 BSOCK *dir = (BSOCK *)dirp;
232 const char jobname[12] = "*Director*";
235 jcr = new_jcr(sizeof(JCR), filed_free_jcr); /* create JCR */
236 jcr->dir_bsock = dir;
237 jcr->ff = init_find_files();
238 // save_cwd.save(jcr);
239 jcr->start_time = time(NULL);
240 jcr->RunScripts = New(alist(10, not_owned_by_alist));
241 jcr->last_fname = get_pool_memory(PM_FNAME);
242 jcr->last_fname[0] = 0;
243 jcr->client_name = get_memory(strlen(my_name) + 1);
244 pm_strcpy(jcr->client_name, my_name);
245 bstrncpy(jcr->Job, jobname, sizeof(jobname)); /* dummy */
246 jcr->crypto.pki_sign = me->pki_sign;
247 jcr->crypto.pki_encrypt = me->pki_encrypt;
248 jcr->crypto.pki_keypair = me->pki_keypair;
249 jcr->crypto.pki_signers = me->pki_signers;
250 jcr->crypto.pki_recipients = me->pki_recipients;
252 enable_backup_privileges(NULL, 1 /* ignore_errors */);
254 /**********FIXME******* add command handler error code */
256 for (quit=false; !quit;) {
258 if (dir->recv() < 0) {
259 break; /* connection terminated */
261 dir->msg[dir->msglen] = 0;
262 Dmsg1(100, "<dird: %s", dir->msg);
264 for (i=0; cmds[i].cmd; i++) {
265 if (strncmp(cmds[i].cmd, dir->msg, strlen(cmds[i].cmd)) == 0) {
266 found = true; /* indicate command found */
267 if (!jcr->authenticated && cmds[i].func != hello_cmd) {
269 dir->signal(BNET_EOD);
272 if ((jcr->authenticated) && (!cmds[i].monitoraccess) && (jcr->director->monitor)) {
273 Dmsg1(100, "Command \"%s\" is invalid.\n", cmds[i].cmd);
274 dir->fsend(invalid_cmd);
275 dir->signal(BNET_EOD);
278 Dmsg1(100, "Executing %s command.\n", cmds[i].cmd);
279 if (!cmds[i].func(jcr)) { /* do command */
280 quit = true; /* error or fully terminated, get out */
281 Dmsg1(100, "Quit command loop. Canceled=%d\n", job_canceled(jcr));
286 if (!found) { /* command not found */
293 /* Inform Storage daemon that we are done */
294 if (jcr->store_bsock) {
295 jcr->store_bsock->signal(BNET_TERMINATE);
298 /* Run the after job */
299 run_scripts(jcr, jcr->RunScripts, "ClientAfterJob");
301 if (jcr->JobId) { /* send EndJob if running a job */
302 char ed1[50], ed2[50];
303 /* Send termination status back to Dir */
304 dir->fsend(EndJob, jcr->JobStatus, jcr->JobFiles,
305 edit_uint64(jcr->ReadBytes, ed1),
306 edit_uint64(jcr->JobBytes, ed2), jcr->JobErrors, jcr->VSS,
307 jcr->crypto.pki_encrypt);
308 Dmsg1(110, "End FD msg: %s\n", dir->msg);
311 generate_daemon_event(jcr, "JobEnd");
312 generate_plugin_event(jcr, bEventJobEnd);
314 dequeue_messages(jcr); /* send any queued messages */
316 /* Inform Director that we are done */
317 dir->signal(BNET_TERMINATE);
319 free_plugins(jcr); /* release instantiated plugins */
321 /* Clean up fileset */
322 FF_PKT *ff = jcr->ff;
323 findFILESET *fileset = ff->fileset;
326 /* Delete FileSet Include lists */
327 for (i=0; i<fileset->include_list.size(); i++) {
328 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
329 for (j=0; j<incexe->opts_list.size(); j++) {
330 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
331 for (k=0; k<fo->regex.size(); k++) {
332 regfree((regex_t *)fo->regex.get(k));
334 for (k=0; k<fo->regexdir.size(); k++) {
335 regfree((regex_t *)fo->regexdir.get(k));
337 for (k=0; k<fo->regexfile.size(); k++) {
338 regfree((regex_t *)fo->regexfile.get(k));
341 fo->regexdir.destroy();
342 fo->regexfile.destroy();
344 fo->wilddir.destroy();
345 fo->wildfile.destroy();
346 fo->wildbase.destroy();
348 fo->fstype.destroy();
349 fo->drivetype.destroy();
351 incexe->opts_list.destroy();
352 incexe->name_list.destroy();
353 incexe->plugin_list.destroy();
354 if (incexe->ignoredir) {
355 free(incexe->ignoredir);
358 fileset->include_list.destroy();
360 /* Delete FileSet Exclude lists */
361 for (i=0; i<fileset->exclude_list.size(); i++) {
362 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
363 for (j=0; j<incexe->opts_list.size(); j++) {
364 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
366 fo->regexdir.destroy();
367 fo->regexfile.destroy();
369 fo->wilddir.destroy();
370 fo->wildfile.destroy();
371 fo->wildbase.destroy();
373 fo->fstype.destroy();
374 fo->drivetype.destroy();
376 incexe->opts_list.destroy();
377 incexe->name_list.destroy();
378 incexe->plugin_list.destroy();
379 if (incexe->ignoredir) {
380 free(incexe->ignoredir);
383 fileset->exclude_list.destroy();
387 Dmsg0(100, "Calling term_find_files\n");
388 term_find_files(jcr->ff);
389 // save_cwd.restore(jcr);
390 // save_cwd.release();
392 Dmsg0(100, "Done with term_find_files\n");
393 free_jcr(jcr); /* destroy JCR record */
394 Dmsg0(100, "Done with free_jcr\n");
400 * Hello from Director he must identify himself and provide his
403 static int hello_cmd(JCR *jcr)
405 Dmsg0(120, "Calling Authenticate\n");
406 if (!authenticate_director(jcr)) {
409 Dmsg0(120, "OK Authenticate\n");
410 jcr->authenticated = true;
417 static int cancel_cmd(JCR *jcr)
419 BSOCK *dir = jcr->dir_bsock;
420 char Job[MAX_NAME_LENGTH];
423 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
424 if (!(cjcr=get_jcr_by_full_name(Job))) {
425 dir->fsend(_("2901 Job %s not found.\n"), Job);
427 if (cjcr->store_bsock) {
428 cjcr->store_bsock->set_timed_out();
429 cjcr->store_bsock->set_terminated();
430 pthread_kill(cjcr->my_thread_id, TIMEOUT_SIGNAL);
432 generate_plugin_event(cjcr, bEventCancelCommand, NULL);
433 set_jcr_job_status(cjcr, JS_Canceled);
435 dir->fsend(_("2001 Job %s marked to be canceled.\n"), Job);
438 dir->fsend(_("2902 Error scanning cancel command.\n"));
440 dir->signal(BNET_EOD);
446 * Set debug level as requested by the Director
449 static int setdebug_cmd(JCR *jcr)
451 BSOCK *dir = jcr->dir_bsock;
452 int level, trace_flag;
454 Dmsg1(110, "setdebug_cmd: %s", dir->msg);
455 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
456 pm_strcpy(jcr->errmsg, dir->msg);
457 dir->fsend(_("2991 Bad setdebug command: %s\n"), jcr->errmsg);
461 set_trace(trace_flag);
462 return dir->fsend(OKsetdebug, level);
466 static int estimate_cmd(JCR *jcr)
468 BSOCK *dir = jcr->dir_bsock;
469 char ed1[50], ed2[50];
471 if (sscanf(dir->msg, estimatecmd, &jcr->listing) != 1) {
472 pm_strcpy(jcr->errmsg, dir->msg);
473 Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
474 dir->fsend(_("2992 Bad estimate command.\n"));
478 dir->fsend(OKest, edit_uint64_with_commas(jcr->num_files_examined, ed1),
479 edit_uint64_with_commas(jcr->JobBytes, ed2));
480 dir->signal(BNET_EOD);
485 * Get JobId and Storage Daemon Authorization key from Director
487 static int job_cmd(JCR *jcr)
489 BSOCK *dir = jcr->dir_bsock;
490 POOL_MEM sd_auth_key(PM_MESSAGE);
491 sd_auth_key.check_size(dir->msglen);
493 if (sscanf(dir->msg, jobcmd, &jcr->JobId, jcr->Job,
494 &jcr->VolSessionId, &jcr->VolSessionTime,
495 sd_auth_key.c_str()) != 5) {
496 pm_strcpy(jcr->errmsg, dir->msg);
497 Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
501 set_storage_auth_key(jcr, sd_auth_key.c_str());
502 Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
503 Mmsg(jcr->errmsg, "JobId=%d Job=%s", jcr->JobId, jcr->Job);
504 new_plugins(jcr); /* instantiate plugins for this jcr */
505 generate_plugin_event(jcr, bEventJobStart, (void *)jcr->errmsg);
506 return dir->fsend(OKjob, VERSION, LSMDATE, HOST_OS, DISTNAME, DISTVER);
509 static int runbefore_cmd(JCR *jcr)
512 BSOCK *dir = jcr->dir_bsock;
513 POOLMEM *cmd = get_memory(dir->msglen+1);
516 Dmsg1(100, "runbefore_cmd: %s", dir->msg);
517 if (sscanf(dir->msg, runbefore, cmd) != 1) {
518 pm_strcpy(jcr->errmsg, dir->msg);
519 Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
520 dir->fsend(_("2905 Bad RunBeforeJob command.\n"));
526 /* Run the command now */
527 script = new_runscript();
528 script->set_command(cmd);
529 script->when = SCRIPT_Before;
530 ok = script->run(jcr, "ClientRunBeforeJob");
531 free_runscript(script);
535 dir->fsend(OKRunBefore);
538 dir->fsend(_("2905 Bad RunBeforeJob command.\n"));
543 static int runbeforenow_cmd(JCR *jcr)
545 BSOCK *dir = jcr->dir_bsock;
547 run_scripts(jcr, jcr->RunScripts, "ClientBeforeJob");
548 if (job_canceled(jcr)) {
549 dir->fsend(_("2905 Bad RunBeforeNow command.\n"));
550 Dmsg0(100, "Back from run_scripts ClientBeforeJob now: FAILED\n");
553 dir->fsend(OKRunBeforeNow);
554 Dmsg0(100, "Back from run_scripts ClientBeforeJob now: OK\n");
559 static int runafter_cmd(JCR *jcr)
561 BSOCK *dir = jcr->dir_bsock;
562 POOLMEM *msg = get_memory(dir->msglen+1);
565 Dmsg1(100, "runafter_cmd: %s", dir->msg);
566 if (sscanf(dir->msg, runafter, msg) != 1) {
567 pm_strcpy(jcr->errmsg, dir->msg);
568 Jmsg1(jcr, M_FATAL, 0, _("Bad RunAfter command: %s\n"), jcr->errmsg);
569 dir->fsend(_("2905 Bad RunAfterJob command.\n"));
575 cmd = new_runscript();
576 cmd->set_command(msg);
577 cmd->on_success = true;
578 cmd->on_failure = false;
579 cmd->when = SCRIPT_After;
581 jcr->RunScripts->append(cmd);
583 free_pool_memory(msg);
584 return dir->fsend(OKRunAfter);
587 static int runscript_cmd(JCR *jcr)
589 BSOCK *dir = jcr->dir_bsock;
590 POOLMEM *msg = get_memory(dir->msglen+1);
591 int on_success, on_failure, fail_on_error;
593 RUNSCRIPT *cmd = new_runscript() ;
595 Dmsg1(100, "runscript_cmd: '%s'\n", dir->msg);
596 /* Note, we cannot sscanf into bools */
597 if (sscanf(dir->msg, runscript, &on_success,
602 pm_strcpy(jcr->errmsg, dir->msg);
603 Jmsg1(jcr, M_FATAL, 0, _("Bad RunScript command: %s\n"), jcr->errmsg);
604 dir->fsend(_("2905 Bad RunScript command.\n"));
609 cmd->on_success = on_success;
610 cmd->on_failure = on_failure;
611 cmd->fail_on_error = fail_on_error;
614 cmd->set_command(msg);
616 jcr->RunScripts->append(cmd);
618 free_pool_memory(msg);
619 return dir->fsend(OKRunScript);
623 static int restore_object_cmd(JCR *jcr)
625 BSOCK *dir = jcr->dir_bsock;
626 POOLMEM *msg = get_memory(dir->msglen+1);
628 int32_t object_len, object_index, object_type, FileIndex;
630 Dmsg1(100, "Enter restoreobject_cmd: %s", dir->msg);
631 if (strcmp(dir->msg, endrestoreobjectcmd) == 0) {
633 return dir->fsend(OKRestoreObject);
636 if (sscanf(dir->msg, restoreobjcmd, &JobId, &object_len, &object_index,
637 &object_type, &FileIndex) != 5) {
638 Dmsg0(5, "Bad restore object command\n");
639 pm_strcpy(jcr->errmsg, dir->msg);
640 Jmsg1(jcr, M_FATAL, 0, _("Bad RestoreObject command: %s\n"), jcr->errmsg);
644 // Dmsg5(000, "Recv object: JobId=%u objlen=%d objinx=%d objtype=%d FI=%d\n",
645 // JobId, object_len, object_index, object_type, FileIndex);
647 if (dir->recv() < 0) {
650 // Dmsg2(000, "Recv Fname object: len=%d Fname=%s\n", dir->msglen, dir->msg);
653 if (dir->recv() < 0) {
656 // Dmsg2(000, "Recv Path object: len=%d Path=%s\n", dir->msglen, dir->msg);
659 if (dir->recv() < 0) {
662 // Dmsg2(000, "Recv Object: len=%d Object=%s\n", dir->msglen, dir->msg);
665 Dmsg1(100, "Send: %s", OKRestoreObject);
669 dir->fsend(_("2909 Bad RestoreObject command.\n"));
676 static bool init_fileset(JCR *jcr)
679 findFILESET *fileset;
688 fileset = (findFILESET *)malloc(sizeof(findFILESET));
689 memset(fileset, 0, sizeof(findFILESET));
690 ff->fileset = fileset;
691 fileset->state = state_none;
692 fileset->include_list.init(1, true);
693 fileset->exclude_list.init(1, true);
697 static findFOPTS *start_options(FF_PKT *ff)
699 int state = ff->fileset->state;
700 findINCEXE *incexe = ff->fileset->incexe;
702 if (state != state_options) {
703 ff->fileset->state = state_options;
704 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
705 memset(fo, 0, sizeof(findFOPTS));
706 fo->regex.init(1, true);
707 fo->regexdir.init(1, true);
708 fo->regexfile.init(1, true);
709 fo->wild.init(1, true);
710 fo->wilddir.init(1, true);
711 fo->wildfile.init(1, true);
712 fo->wildbase.init(1, true);
713 fo->base.init(1, true);
714 fo->fstype.init(1, true);
715 fo->drivetype.init(1, true);
716 incexe->current_opts = fo;
717 incexe->opts_list.append(fo);
719 return incexe->current_opts;
724 * Add fname to include/exclude fileset list. First check for
725 * | and < and if necessary perform command.
727 void add_file_to_fileset(JCR *jcr, const char *fname, findFILESET *fileset,
742 p++; /* skip over | */
743 fn = get_pool_memory(PM_FNAME);
744 fn = edit_job_codes(jcr, fn, p, "");
745 bpipe = open_bpipe(fn, 0, "r");
748 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
750 free_pool_memory(fn);
753 free_pool_memory(fn);
754 while (fgets(buf, sizeof(buf), bpipe->rfd)) {
755 strip_trailing_junk(buf);
757 fileset->incexe->name_list.append(new_dlistString(buf));
759 fileset->incexe->plugin_list.append(new_dlistString(buf));
762 if ((stat=close_bpipe(bpipe)) != 0) {
764 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. stat=%d: ERR=%s\n"),
765 p, be.code(stat), be.bstrerror(stat));
770 Dmsg1(100, "Doing < of '%s' include on client.\n", p + 1);
771 p++; /* skip over < */
772 if ((ffd = fopen(p, "rb")) == NULL) {
774 Jmsg(jcr, M_FATAL, 0, _("Cannot open FileSet input file: %s. ERR=%s\n"),
778 while (fgets(buf, sizeof(buf), ffd)) {
779 strip_trailing_junk(buf);
780 Dmsg1(100, "%s\n", buf);
782 fileset->incexe->name_list.append(new_dlistString(buf));
784 fileset->incexe->plugin_list.append(new_dlistString(buf));
791 fileset->incexe->name_list.append(new_dlistString(fname));
793 if (me->plugin_directory) {
794 fileset->incexe->plugin_list.append(new_dlistString(fname));
796 Jmsg(jcr, M_FATAL, 0, _("Plugin Directory not defined. Cannot use plugin: \"%\"\n"),
805 * Define a new Exclude block in the FileSet
807 findFILESET *new_exclude(JCR *jcr)
809 FF_PKT *ff = jcr->ff;
810 findFILESET *fileset = ff->fileset;
813 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
814 memset(fileset->incexe, 0, sizeof(findINCEXE));
815 fileset->incexe->opts_list.init(1, true);
816 fileset->incexe->name_list.init();
817 fileset->incexe->plugin_list.init();
818 fileset->exclude_list.append(fileset->incexe);
823 static void add_fileset(JCR *jcr, const char *item)
825 FF_PKT *ff = jcr->ff;
826 findFILESET *fileset = ff->fileset;
827 int state = fileset->state;
828 findFOPTS *current_opts;
830 /* Get code, optional subcode, and position item past the dividing space */
831 Dmsg1(100, "%s\n", item);
836 int subcode = ' '; /* A space is always a valid subcode */
837 if (item[0] != '\0' && item[0] != ' ') {
845 /* Skip all lines we receive after an error */
846 if (state == state_error) {
847 Dmsg0(100, "State=error return\n");
852 * The switch tests the code for validity.
853 * The subcode is always good if it is a space, otherwise we must confirm.
854 * We set state to state_error first assuming the subcode is invalid,
855 * requiring state to be set in cases below that handle subcodes.
857 if (subcode != ' ') {
859 Dmsg0(100, "Set state=error or double code.\n");
864 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
865 memset(fileset->incexe, 0, sizeof(findINCEXE));
866 fileset->incexe->opts_list.init(1, true);
867 fileset->incexe->name_list.init(); /* for dlist; was 1,true for alist */
868 fileset->incexe->plugin_list.init();
869 fileset->include_list.append(fileset->incexe);
872 fileset = new_exclude(jcr);
878 /* File item to include or exclude list */
879 state = state_include;
880 add_file_to_fileset(jcr, item, fileset, true);
883 /* Plugin item to include list */
884 state = state_include;
885 add_file_to_fileset(jcr, item, fileset, false);
888 current_opts = start_options(ff);
892 preg = (regex_t *)malloc(sizeof(regex_t));
893 if (current_opts->flags & FO_IGNORECASE) {
894 rc = regcomp(preg, item, REG_EXTENDED|REG_ICASE);
896 rc = regcomp(preg, item, REG_EXTENDED);
899 regerror(rc, preg, prbuf, sizeof(prbuf));
902 Jmsg(jcr, M_FATAL, 0, _("REGEX %s compile error. ERR=%s\n"), item, prbuf);
906 state = state_options;
907 if (subcode == ' ') {
908 current_opts->regex.append(preg);
909 } else if (subcode == 'D') {
910 current_opts->regexdir.append(preg);
911 } else if (subcode == 'F') {
912 current_opts->regexfile.append(preg);
918 current_opts = start_options(ff);
919 current_opts->base.append(bstrdup(item));
920 state = state_options;
923 current_opts = start_options(ff);
924 state = state_options;
925 if (subcode == ' ') {
926 current_opts->fstype.append(bstrdup(item));
927 } else if (subcode == 'D') {
928 current_opts->drivetype.append(bstrdup(item));
934 current_opts = start_options(ff);
935 state = state_options;
936 if (subcode == ' ') {
937 current_opts->wild.append(bstrdup(item));
938 } else if (subcode == 'D') {
939 current_opts->wilddir.append(bstrdup(item));
940 } else if (subcode == 'F') {
941 current_opts->wildfile.append(bstrdup(item));
942 } else if (subcode == 'B') {
943 current_opts->wildbase.append(bstrdup(item));
949 current_opts = start_options(ff);
950 set_options(current_opts, item);
951 state = state_options;
954 state = state_include;
955 fileset->incexe->ignoredir = bstrdup(item);
958 current_opts = start_options(ff);
959 // current_opts->reader = bstrdup(item);
960 state = state_options;
963 current_opts = start_options(ff);
964 // current_opts->writer = bstrdup(item);
965 state = state_options;
968 Jmsg(jcr, M_FATAL, 0, _("Invalid FileSet command: %s\n"), item);
972 ff->fileset->state = state;
975 static bool term_fileset(JCR *jcr)
977 FF_PKT *ff = jcr->ff;
979 #ifdef xxx_DEBUG_CODE
980 findFILESET *fileset = ff->fileset;
983 for (i=0; i<fileset->include_list.size(); i++) {
984 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
986 for (j=0; j<incexe->opts_list.size(); j++) {
987 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
988 for (k=0; k<fo->regex.size(); k++) {
989 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
991 for (k=0; k<fo->regexdir.size(); k++) {
992 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
994 for (k=0; k<fo->regexfile.size(); k++) {
995 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
997 for (k=0; k<fo->wild.size(); k++) {
998 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1000 for (k=0; k<fo->wilddir.size(); k++) {
1001 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1003 for (k=0; k<fo->wildfile.size(); k++) {
1004 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1006 for (k=0; k<fo->wildbase.size(); k++) {
1007 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1009 for (k=0; k<fo->base.size(); k++) {
1010 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1012 for (k=0; k<fo->fstype.size(); k++) {
1013 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1015 for (k=0; k<fo->drivetype.size(); k++) {
1016 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1019 if (incexe->ignoredir) {
1020 Dmsg1(400, "Z %s\n", incexe->ignoredir);
1023 foreach_dlist(node, &incexe->name_list) {
1024 Dmsg1(400, "F %s\n", node->c_str());
1026 foreach_dlist(node, &incexe->plugin_list) {
1027 Dmsg1(400, "P %s\n", node->c_str());
1030 for (i=0; i<fileset->exclude_list.size(); i++) {
1031 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
1033 for (j=0; j<incexe->opts_list.size(); j++) {
1034 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
1035 for (k=0; k<fo->regex.size(); k++) {
1036 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
1038 for (k=0; k<fo->regexdir.size(); k++) {
1039 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
1041 for (k=0; k<fo->regexfile.size(); k++) {
1042 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
1044 for (k=0; k<fo->wild.size(); k++) {
1045 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1047 for (k=0; k<fo->wilddir.size(); k++) {
1048 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1050 for (k=0; k<fo->wildfile.size(); k++) {
1051 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1053 for (k=0; k<fo->wildbase.size(); k++) {
1054 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1056 for (k=0; k<fo->base.size(); k++) {
1057 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1059 for (k=0; k<fo->fstype.size(); k++) {
1060 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1062 for (k=0; k<fo->drivetype.size(); k++) {
1063 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1067 foreach_dlist(node, incexe->name_list) {
1068 Dmsg1(400, "F %s\n", node->c_str());
1070 foreach_dlist(node, &incexe->plugin_list) {
1071 Dmsg1(400, "P %s\n", node->c_str());
1075 return ff->fileset->state != state_error;
1080 * As an optimization, we should do this during
1081 * "compile" time in filed/job.c, and keep only a bit mask
1082 * and the Verify options.
1084 static void set_options(findFOPTS *fo, const char *opts)
1090 // Commented out as it is not backward compatible - KES
1092 // fo->flags |= FO_IGNORECASE; /* always ignorecase under windows */
1095 for (p=opts; *p; p++) {
1097 case 'a': /* alway replace */
1098 case '0': /* no option */
1101 fo->flags |= FO_EXCLUDE;
1104 fo->flags |= FO_MULTIFS;
1106 case 'h': /* no recursion */
1107 fo->flags |= FO_NO_RECURSION;
1109 case 'H': /* no hard link handling */
1110 fo->flags |= FO_NO_HARDLINK;
1113 fo->flags |= FO_IGNORECASE;
1116 fo->flags |= FO_MD5;
1119 fo->flags |= FO_NOREPLACE;
1121 case 'p': /* use portable data format */
1122 fo->flags |= FO_PORTABLE;
1124 case 'R': /* Resource forks and Finder Info */
1125 fo->flags |= FO_HFSPLUS;
1126 case 'r': /* read fifo */
1127 fo->flags |= FO_READFIFO;
1132 fo->flags |= FO_SHA1;
1137 fo->flags |= FO_SHA256;
1141 fo->flags |= FO_SHA512;
1147 * If 2 or 3 is seen here, SHA2 is not configured, so
1148 * eat the option, and drop back to SHA-1.
1150 if (p[1] == '2' || p[1] == '3') {
1153 fo->flags |= FO_SHA1;
1158 fo->flags |= FO_SPARSE;
1161 fo->flags |= FO_MTIMEONLY;
1164 fo->flags |= FO_KEEPATIME;
1167 fo->flags |= FO_ACL;
1169 case 'V': /* verify options */
1170 /* Copy Verify Options */
1171 for (j=0; *p && *p != ':'; p++) {
1172 fo->VerifyOpts[j] = *p;
1173 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
1177 fo->VerifyOpts[j] = 0;
1179 case 'C': /* accurate options */
1180 /* Copy Accurate Options */
1181 for (j=0; *p && *p != ':'; p++) {
1182 fo->AccurateOpts[j] = *p;
1183 if (j < (int)sizeof(fo->AccurateOpts) - 1) {
1187 fo->AccurateOpts[j] = 0;
1189 case 'J': /* Basejob options */
1190 /* Copy BaseJob Options */
1191 for (j=0; *p && *p != ':'; p++) {
1192 fo->BaseJobOpts[j] = *p;
1193 if (j < (int)sizeof(fo->BaseJobOpts) - 1) {
1197 fo->BaseJobOpts[j] = 0;
1199 case 'P': /* strip path */
1202 for (j=0; *p && *p != ':'; p++) {
1204 if (j < (int)sizeof(strip) - 1) {
1209 fo->strip_path = atoi(strip);
1210 fo->flags |= FO_STRIPPATH;
1211 Dmsg2(100, "strip=%s strip_path=%d\n", strip, fo->strip_path);
1214 fo->flags |= FO_IF_NEWER;
1217 fo->flags |= FO_ENHANCEDWILD;
1219 case 'Z': /* gzip compression */
1220 fo->flags |= FO_GZIP;
1221 fo->GZIP_level = *++p - '0';
1224 fo->flags |= FO_NOATIME;
1227 fo->flags |= FO_CHKCHANGES;
1230 fo->flags |= FO_HONOR_NODUMP;
1233 fo->flags |= FO_XATTR;
1236 Emsg1(M_ERROR, 0, _("Unknown include/exclude option: %c\n"), *p);
1244 * Director is passing his Fileset
1246 static int fileset_cmd(JCR *jcr)
1248 BSOCK *dir = jcr->dir_bsock;
1250 #if defined(WIN32_VSS)
1253 sscanf(dir->msg, "fileset vss=%d", &vss);
1257 if (!init_fileset(jcr)) {
1260 while (dir->recv() >= 0) {
1261 strip_trailing_junk(dir->msg);
1262 Dmsg1(500, "Fileset: %s\n", dir->msg);
1263 add_fileset(jcr, dir->msg);
1265 if (!term_fileset(jcr)) {
1268 return dir->fsend(OKinc);
1271 static void free_bootstrap(JCR *jcr)
1273 if (jcr->RestoreBootstrap) {
1274 unlink(jcr->RestoreBootstrap);
1275 free_pool_memory(jcr->RestoreBootstrap);
1276 jcr->RestoreBootstrap = NULL;
1281 static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER;
1282 static uint32_t bsr_uniq = 0;
1285 * The Director sends us the bootstrap file, which
1286 * we will in turn pass to the SD.
1287 * Deprecated. The bsr is now sent directly from the
1288 * Director to the SD.
1290 static int bootstrap_cmd(JCR *jcr)
1292 BSOCK *dir = jcr->dir_bsock;
1293 POOLMEM *fname = get_pool_memory(PM_FNAME);
1296 free_bootstrap(jcr);
1299 Mmsg(fname, "%s/%s.%s.%d.bootstrap", me->working_directory, me->hdr.name,
1300 jcr->Job, bsr_uniq);
1302 Dmsg1(400, "bootstrap=%s\n", fname);
1303 jcr->RestoreBootstrap = fname;
1304 bs = fopen(fname, "a+b"); /* create file */
1307 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
1308 jcr->RestoreBootstrap, be.bstrerror());
1310 * Suck up what he is sending to us so that he will then
1311 * read our error message.
1313 while (dir->recv() >= 0)
1315 free_bootstrap(jcr);
1316 set_jcr_job_status(jcr, JS_ErrorTerminated);
1320 while (dir->recv() >= 0) {
1321 Dmsg1(200, "filed<dird: bootstrap: %s", dir->msg);
1322 fputs(dir->msg, bs);
1326 * Note, do not free the bootstrap yet -- it needs to be
1329 return dir->fsend(OKbootstrap);
1334 * Get backup level from Director
1337 static int level_cmd(JCR *jcr)
1339 BSOCK *dir = jcr->dir_bsock;
1340 POOLMEM *level, *buf = NULL;
1343 level = get_memory(dir->msglen+1);
1344 Dmsg1(100, "level_cmd: %s", dir->msg);
1346 /* keep compatibility with older directors */
1347 if (strstr(dir->msg, "accurate")) {
1348 jcr->accurate = true;
1350 if (sscanf(dir->msg, "level = %s ", level) != 1) {
1353 /* Base backup requested? */
1354 if (strcmp(level, "base") == 0) {
1355 jcr->set_JobLevel(L_BASE);
1356 /* Full backup requested? */
1357 } else if (strcmp(level, "full") == 0) {
1358 jcr->set_JobLevel(L_FULL);
1359 } else if (strstr(level, "differential")) {
1360 jcr->set_JobLevel(L_DIFFERENTIAL);
1363 } else if (strstr(level, "incremental")) {
1364 jcr->set_JobLevel(L_INCREMENTAL);
1368 * We get his UTC since time, then sync the clocks and correct it
1369 * to agree with our clock.
1371 } else if (strcmp(level, "since_utime") == 0) {
1372 buf = get_memory(dir->msglen+1);
1373 utime_t since_time, adj;
1374 btime_t his_time, bt_start, rt=0, bt_adj=0;
1375 if (jcr->getJobLevel() == L_NONE) {
1376 jcr->set_JobLevel(L_SINCE); /* if no other job level set, do it now */
1378 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
1379 buf, &mtime_only) != 2) {
1382 since_time = str_to_uint64(buf); /* this is the since time */
1383 Dmsg1(100, "since_time=%lld\n", since_time);
1384 char ed1[50], ed2[50];
1386 * Sync clocks by polling him for the time. We take
1387 * 10 samples of his time throwing out the first two.
1389 for (int i=0; i<10; i++) {
1390 bt_start = get_current_btime();
1391 dir->signal(BNET_BTIME); /* poll for time */
1392 if (dir->recv() <= 0) { /* get response */
1395 if (sscanf(dir->msg, "btime %s", buf) != 1) {
1398 if (i < 2) { /* toss first two results */
1401 his_time = str_to_uint64(buf);
1402 rt = get_current_btime() - bt_start; /* compute round trip time */
1403 Dmsg2(100, "Dirtime=%s FDtime=%s\n", edit_uint64(his_time, ed1),
1404 edit_uint64(bt_start, ed2));
1405 bt_adj += bt_start - his_time - rt/2;
1406 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1409 bt_adj = bt_adj / 8; /* compute average time */
1410 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1411 adj = btime_to_utime(bt_adj);
1412 since_time += adj; /* adjust for clock difference */
1413 /* Don't notify if time within 3 seconds */
1414 if (adj > 3 || adj < -3) {
1416 if (adj > 600 || adj < -600) {
1421 Jmsg(jcr, type, 0, _("DIR and FD clocks differ by %lld seconds, FD automatically compensating.\n"), adj);
1423 dir->signal(BNET_EOD);
1425 Dmsg2(100, "adj=%lld since_time=%lld\n", adj, since_time);
1426 jcr->incremental = 1; /* set incremental or decremental backup */
1427 jcr->mtime = since_time; /* set since time */
1428 generate_plugin_event(jcr, bEventSince, (void *)(time_t)jcr->mtime);
1430 Jmsg1(jcr, M_FATAL, 0, _("Unknown backup level: %s\n"), level);
1438 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1439 return dir->fsend(OKlevel);
1442 pm_strcpy(jcr->errmsg, dir->msg);
1443 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
1452 * Get session parameters from Director -- this is for a Restore command
1453 * This is deprecated. It is now passed via the bsr.
1455 static int session_cmd(JCR *jcr)
1457 BSOCK *dir = jcr->dir_bsock;
1459 Dmsg1(100, "SessionCmd: %s", dir->msg);
1460 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1461 &jcr->VolSessionId, &jcr->VolSessionTime,
1462 &jcr->StartFile, &jcr->EndFile,
1463 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1464 pm_strcpy(jcr->errmsg, dir->msg);
1465 Jmsg(jcr, M_FATAL, 0, _("Bad session command: %s"), jcr->errmsg);
1469 return dir->fsend(OKsession);
1472 static void set_storage_auth_key(JCR *jcr, char *key)
1474 /* if no key don't update anything */
1480 * We can be contacting multiple storage daemons.
1481 * So, make sure that any old jcr->store_bsock is cleaned up.
1483 if (jcr->store_bsock) {
1484 jcr->store_bsock->destroy();
1485 jcr->store_bsock = NULL;
1489 * We can be contacting multiple storage daemons.
1490 * So, make sure that any old jcr->sd_auth_key is cleaned up.
1492 if (jcr->sd_auth_key) {
1494 * If we already have a Authorization key, director can do multi
1497 Dmsg0(5, "set multi_restore=true\n");
1498 jcr->multi_restore = true;
1499 bfree(jcr->sd_auth_key);
1502 jcr->sd_auth_key = bstrdup(key);
1503 Dmsg0(5, "set sd auth key\n");
1507 * Get address of storage daemon from Director
1510 static int storage_cmd(JCR *jcr)
1512 int stored_port; /* storage daemon port */
1513 int enable_ssl; /* enable ssl to sd */
1514 POOL_MEM sd_auth_key(PM_MESSAGE);
1515 BSOCK *dir = jcr->dir_bsock;
1516 BSOCK *sd = new_bsock(); /* storage daemon bsock */
1519 Dmsg1(100, "StorageCmd: %s", dir->msg);
1520 sd_auth_key.check_size(dir->msglen);
1521 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port,
1522 &enable_ssl, sd_auth_key.c_str()) != 4) {
1523 if (sscanf(dir->msg, storaddr_v1, &jcr->stored_addr,
1524 &stored_port, &enable_ssl) != 3) {
1525 pm_strcpy(jcr->errmsg, dir->msg);
1526 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1531 set_storage_auth_key(jcr, sd_auth_key.c_str());
1533 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port,
1535 /* Open command communications with Storage daemon */
1536 /* Try to connect for 1 hour at 10 second intervals */
1538 sd->set_source_address(me->FDsrc_addr);
1539 if (!sd->connect(jcr, 10, (int)me->SDConnectTimeout, me->heartbeat_interval,
1540 _("Storage daemon"), jcr->stored_addr, NULL, stored_port, 1)) {
1546 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1547 jcr->stored_addr, stored_port);
1548 Dmsg2(100, "Failed to connect to Storage daemon: %s:%d\n",
1549 jcr->stored_addr, stored_port);
1552 Dmsg0(110, "Connection OK to SD.\n");
1554 jcr->store_bsock = sd;
1556 sd->fsend("Hello Start Job %s\n", jcr->Job);
1557 if (!authenticate_storagedaemon(jcr)) {
1558 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1561 Dmsg0(110, "Authenticated with SD.\n");
1563 /* Send OK to Director */
1564 return dir->fsend(OKstore);
1567 dir->fsend(BADcmd, "storage");
1576 static int backup_cmd(JCR *jcr)
1578 BSOCK *dir = jcr->dir_bsock;
1579 BSOCK *sd = jcr->store_bsock;
1583 #if defined(WIN32_VSS)
1584 // capture state here, if client is backed up by multiple directors
1585 // and one enables vss and the other does not then enable_vss can change
1586 // between here and where its evaluated after the job completes.
1587 jcr->VSS = g_pVSSClient && enable_vss;
1589 /* Run only one at a time */
1595 * Validate some options given to the backup make sense for the compiled in
1596 * options of this filed.
1598 if (jcr->ff->flags & FO_ACL && !have_acl) {
1599 Jmsg(jcr, M_FATAL, 0, _("ACL support not configured for your machine.\n"));
1602 if (jcr->ff->flags & FO_XATTR && !have_xattr) {
1603 Jmsg(jcr, M_FATAL, 0, _("XATTR support not configured for your machine.\n"));
1607 set_jcr_job_status(jcr, JS_Blocked);
1608 jcr->set_JobType(JT_BACKUP);
1609 Dmsg1(100, "begin backup ff=%p\n", jcr->ff);
1612 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1613 dir->fsend(BADcmd, "backup");
1617 dir->fsend(OKbackup);
1618 Dmsg1(110, "filed>dird: %s", dir->msg);
1621 * Send Append Open Session to Storage daemon
1623 sd->fsend(append_open);
1624 Dmsg1(110, ">stored: %s", sd->msg);
1626 * Expect to receive back the Ticket number
1628 if (bget_msg(sd) >= 0) {
1629 Dmsg1(110, "<stored: %s", sd->msg);
1630 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1631 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1634 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1636 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1641 * Send Append data command to Storage daemon
1643 sd->fsend(append_data, jcr->Ticket);
1644 Dmsg1(110, ">stored: %s", sd->msg);
1647 * Expect to get OK data
1649 Dmsg1(110, "<stored: %s", sd->msg);
1650 if (!response(jcr, sd, OK_data, "Append Data")) {
1654 generate_daemon_event(jcr, "JobStart");
1655 generate_plugin_event(jcr, bEventStartBackupJob);
1657 #if defined(WIN32_VSS)
1658 /* START VSS ON WIN32 */
1660 if (g_pVSSClient->InitializeForBackup(jcr)) {
1661 generate_plugin_event(jcr, bEventVssBackupAddComponents);
1662 /* tell vss which drives to snapshot */
1663 char szWinDriveLetters[27];
1664 if (get_win32_driveletters(jcr->ff, szWinDriveLetters)) {
1665 Jmsg(jcr, M_INFO, 0, _("Generate VSS snapshots. Driver=\"%s\", Drive(s)=\"%s\"\n"), g_pVSSClient->GetDriverName(), szWinDriveLetters);
1666 if (!g_pVSSClient->CreateSnapshots(szWinDriveLetters)) {
1667 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshots failed.\n"));
1670 /* tell user if snapshot creation of a specific drive failed */
1672 for (i=0; i < (int)strlen(szWinDriveLetters); i++) {
1673 if (islower(szWinDriveLetters[i])) {
1674 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshot of drive \"%c:\\\" failed. VSS support is disabled on this drive.\n"), szWinDriveLetters[i]);
1678 /* inform user about writer states */
1679 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++)
1680 if (g_pVSSClient->GetWriterState(i) < 1) {
1681 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PrepareForBackup): %s\n"), g_pVSSClient->GetWriterInfo(i));
1686 Jmsg(jcr, M_INFO, 0, _("No drive letters found for generating VSS snapshots.\n"));
1690 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
1692 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
1697 * Send Files to Storage daemon
1699 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1700 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1701 set_jcr_job_status(jcr, JS_ErrorTerminated);
1702 bnet_suppress_error_messages(sd, 1);
1703 Dmsg0(110, "Error in blast_data.\n");
1705 set_jcr_job_status(jcr, JS_Terminated);
1706 /* Note, the above set status will not override an error */
1707 if (!(jcr->JobStatus == JS_Terminated || jcr->JobStatus == JS_Warnings)) {
1708 bnet_suppress_error_messages(sd, 1);
1709 goto cleanup; /* bail out now */
1712 * Expect to get response to append_data from Storage daemon
1714 if (!response(jcr, sd, OK_append, "Append Data")) {
1715 set_jcr_job_status(jcr, JS_ErrorTerminated);
1720 * Send Append End Data to Storage daemon
1722 sd->fsend(append_end, jcr->Ticket);
1724 if (!response(jcr, sd, OK_end, "Append End")) {
1725 set_jcr_job_status(jcr, JS_ErrorTerminated);
1730 * Send Append Close to Storage daemon
1732 sd->fsend(append_close, jcr->Ticket);
1733 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1734 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1736 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1740 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1743 if (!(SDJobStatus == JS_Terminated || SDJobStatus == JS_Warnings)) {
1744 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1750 #if defined(WIN32_VSS)
1751 /* STOP VSS ON WIN32 */
1752 /* tell vss to close the backup session */
1754 if (g_pVSSClient->CloseBackup()) {
1755 /* inform user about writer states */
1756 for (int i=0; i<(int)g_pVSSClient->GetWriterCount(); i++) {
1757 int msg_type = M_INFO;
1758 if (g_pVSSClient->GetWriterState(i) < 1) {
1759 msg_type = M_WARNING;
1762 Jmsg(jcr, msg_type, 0, _("VSS Writer (BackupComplete): %s\n"), g_pVSSClient->GetWriterInfo(i));
1765 Win32ConvCleanupCache();
1770 generate_plugin_event(jcr, bEventEndBackupJob);
1771 return 0; /* return and stop command loop */
1775 * Do a Verify for Director
1778 static int verify_cmd(JCR *jcr)
1780 BSOCK *dir = jcr->dir_bsock;
1781 BSOCK *sd = jcr->store_bsock;
1784 jcr->set_JobType(JT_VERIFY);
1785 if (sscanf(dir->msg, verifycmd, level) != 1) {
1786 dir->fsend(_("2994 Bad verify command: %s\n"), dir->msg);
1790 if (strcasecmp(level, "init") == 0) {
1791 jcr->set_JobLevel(L_VERIFY_INIT);
1792 } else if (strcasecmp(level, "catalog") == 0){
1793 jcr->set_JobLevel(L_VERIFY_CATALOG);
1794 } else if (strcasecmp(level, "volume") == 0){
1795 jcr->set_JobLevel(L_VERIFY_VOLUME_TO_CATALOG);
1796 } else if (strcasecmp(level, "data") == 0){
1797 jcr->set_JobLevel(L_VERIFY_DATA);
1798 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1799 jcr->set_JobLevel(L_VERIFY_DISK_TO_CATALOG);
1801 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1805 dir->fsend(OKverify);
1807 generate_daemon_event(jcr, "JobStart");
1808 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1809 generate_plugin_event(jcr, bEventStartVerifyJob);
1811 Dmsg1(110, "filed>dird: %s", dir->msg);
1813 switch (jcr->getJobLevel()) {
1815 case L_VERIFY_CATALOG:
1818 case L_VERIFY_VOLUME_TO_CATALOG:
1819 if (!open_sd_read_session(jcr)) {
1822 start_dir_heartbeat(jcr);
1823 do_verify_volume(jcr);
1824 stop_dir_heartbeat(jcr);
1826 * Send Close session command to Storage daemon
1828 sd->fsend(read_close, jcr->Ticket);
1829 Dmsg1(130, "filed>stored: %s", sd->msg);
1831 /* ****FIXME**** check response */
1832 bget_msg(sd); /* get OK */
1834 /* Inform Storage daemon that we are done */
1835 sd->signal(BNET_TERMINATE);
1838 case L_VERIFY_DISK_TO_CATALOG:
1842 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1846 dir->signal(BNET_EOD);
1847 generate_plugin_event(jcr, bEventEndVerifyJob);
1848 return 0; /* return and terminate command loop */
1852 static bool vss_restore_init_callback(JCR *jcr, int init_type)
1856 case VSS_INIT_RESTORE_AFTER_INIT:
1857 generate_plugin_event(jcr, bEventVssRestoreLoadComponentMetadata);
1859 case VSS_INIT_RESTORE_AFTER_GATHER:
1860 generate_plugin_event(jcr, bEventVssRestoreSetComponentsSelected);
1870 * Do a Restore for Director
1873 static int restore_cmd(JCR *jcr)
1875 BSOCK *dir = jcr->dir_bsock;
1876 BSOCK *sd = jcr->store_bsock;
1878 bool use_regexwhere=false;
1883 * Scan WHERE (base directory for restore) from command
1885 Dmsg0(100, "restore command\n");
1886 #if defined(WIN32_VSS)
1888 /* TODO: this should be given from the director */
1891 Dmsg2(50, "g_pVSSClient = %p, enable_vss = %d\n", g_pVSSClient, enable_vss);
1892 // capture state here, if client is backed up by multiple directors
1893 // and one enables vss and the other does not then enable_vss can change
1894 // between here and where its evaluated after the job completes.
1895 jcr->VSS = g_pVSSClient && enable_vss;
1897 /* Run only one at a time */
1901 /* Pickup where string */
1902 args = get_memory(dir->msglen+1);
1905 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, args) != 3) {
1906 if (sscanf(dir->msg, restorecmdR, &replace, &prefix_links, args) != 3){
1907 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
1908 pm_strcpy(jcr->errmsg, dir->msg);
1909 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
1914 use_regexwhere = true;
1916 /* Turn / into nothing */
1917 if (IsPathSeparator(args[0]) && args[1] == '\0') {
1921 Dmsg2(150, "Got replace %c, where=%s\n", replace, args);
1922 unbash_spaces(args);
1924 if (use_regexwhere) {
1925 jcr->where_bregexp = get_bregexps(args);
1926 if (!jcr->where_bregexp) {
1927 Jmsg(jcr, M_FATAL, 0, _("Bad where regexp. where=%s\n"), args);
1928 free_pool_memory(args);
1932 jcr->where = bstrdup(args);
1935 free_pool_memory(args);
1936 jcr->replace = replace;
1937 jcr->prefix_links = prefix_links;
1939 dir->fsend(OKrestore);
1940 Dmsg1(110, "filed>dird: %s", dir->msg);
1942 jcr->set_JobType(JT_RESTORE);
1944 set_jcr_job_status(jcr, JS_Blocked);
1946 if (!open_sd_read_session(jcr)) {
1947 set_jcr_job_status(jcr, JS_ErrorTerminated);
1951 set_jcr_job_status(jcr, JS_Running);
1954 * Do restore of files and data
1956 start_dir_heartbeat(jcr);
1957 generate_daemon_event(jcr, "JobStart");
1958 generate_plugin_event(jcr, bEventStartRestoreJob);
1960 #if defined(WIN32_VSS)
1961 /* START VSS ON WIN32 */
1963 if (g_pVSSClient->InitializeForRestore(jcr, vss_restore_init_callback)) {
1964 /* inform user about writer states */
1966 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++) {
1967 int msg_type = M_INFO;
1968 if (g_pVSSClient->GetWriterState(i) < 1) {
1969 msg_type = M_WARNING;
1972 if (g_pVSSClient->GetWriterState(i) < 1) {
1973 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PreRestore): %s\n"), g_pVSSClient->GetWriterInfo(i));
1979 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
1981 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
1986 stop_dir_heartbeat(jcr);
1988 set_jcr_job_status(jcr, JS_Terminated);
1989 if (jcr->JobStatus != JS_Terminated) {
1990 bnet_suppress_error_messages(sd, 1);
1994 * Send Close session command to Storage daemon
1996 sd->fsend(read_close, jcr->Ticket);
1997 Dmsg1(100, "filed>stored: %s", sd->msg);
1999 bget_msg(sd); /* get OK */
2001 /* Inform Storage daemon that we are done */
2002 sd->signal(BNET_TERMINATE);
2004 #if defined(WIN32_VSS)
2005 /* STOP VSS ON WIN32 */
2006 /* tell vss to close the restore session */
2007 Dmsg0(0, "About to call CloseRestore\n");
2009 Dmsg0(0, "Really about to call CloseRestore\n");
2010 if (g_pVSSClient->CloseRestore()) {
2011 Dmsg0(0, "CloseRestore success\n");
2012 /* inform user about writer states */
2013 for (int i=0; i<(int)g_pVSSClient->GetWriterCount(); i++) {
2014 int msg_type = M_INFO;
2015 if (g_pVSSClient->GetWriterState(i) < 1) {
2016 msg_type = M_WARNING;
2019 Jmsg(jcr, msg_type, 0, _("VSS Writer (RestoreComplete): %s\n"), g_pVSSClient->GetWriterInfo(i));
2023 Dmsg1(0, "CloseRestore fail - %08x\n", errno);
2029 bfree_and_null(jcr->where);
2031 if (jcr->JobErrors) {
2032 set_jcr_job_status(jcr, JS_ErrorTerminated);
2035 Dmsg0(100, "Done in job.c\n");
2038 if (jcr->multi_restore) {
2039 Dmsg0(100, OKstoreend);
2040 dir->fsend(OKstoreend);
2041 ret = 1; /* we continue the loop, waiting for next part */
2043 end_restore_cmd(jcr);
2044 ret = 0; /* we stop here */
2050 static int end_restore_cmd(JCR *jcr)
2052 Dmsg0(5, "end_restore_cmd\n");
2053 generate_plugin_event(jcr, bEventEndRestoreJob);
2054 return 0; /* return and terminate command loop */
2057 static int open_sd_read_session(JCR *jcr)
2059 BSOCK *sd = jcr->store_bsock;
2062 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
2065 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
2066 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
2067 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
2069 * Open Read Session with Storage daemon
2071 sd->fsend(read_open, "DummyVolume",
2072 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
2073 jcr->StartBlock, jcr->EndBlock);
2074 Dmsg1(110, ">stored: %s", sd->msg);
2079 if (bget_msg(sd) >= 0) {
2080 Dmsg1(110, "filed<stored: %s", sd->msg);
2081 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
2082 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
2085 Dmsg1(110, "filed: got Ticket=%d\n", jcr->Ticket);
2087 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
2091 if (!send_bootstrap_file(jcr)) {
2096 * Start read of data with Storage daemon
2098 sd->fsend(read_data, jcr->Ticket);
2099 Dmsg1(110, ">stored: %s", sd->msg);
2104 if (!response(jcr, sd, OK_data, "Read Data")) {
2111 * Destroy the Job Control Record and associated
2112 * resources (sockets).
2114 static void filed_free_jcr(JCR *jcr)
2116 if (jcr->store_bsock) {
2117 jcr->store_bsock->close();
2119 free_bootstrap(jcr);
2120 if (jcr->last_fname) {
2121 free_pool_memory(jcr->last_fname);
2123 free_runscripts(jcr->RunScripts);
2124 delete jcr->RunScripts;
2126 if (jcr->JobId != 0)
2127 write_state_file(me->working_directory, "bacula-fd", get_first_port_host_order(me->FDaddrs));
2133 * Get response from Storage daemon to a command we
2134 * sent. Check that the response is OK.
2136 * Returns: 0 on failure
2139 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
2144 if (bget_msg(sd) > 0) {
2145 Dmsg0(110, sd->msg);
2146 if (strcmp(sd->msg, resp) == 0) {
2150 if (job_canceled(jcr)) {
2151 return 0; /* if canceled avoid useless error messages */
2153 if (is_bnet_error(sd)) {
2154 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
2155 cmd, bnet_strerror(sd));
2157 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
2158 cmd, resp, sd->msg);
2163 static int send_bootstrap_file(JCR *jcr)
2167 BSOCK *sd = jcr->store_bsock;
2168 const char *bootstrap = "bootstrap\n";
2171 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
2172 if (!jcr->RestoreBootstrap) {
2175 bs = fopen(jcr->RestoreBootstrap, "rb");
2178 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
2179 jcr->RestoreBootstrap, be.bstrerror());
2180 set_jcr_job_status(jcr, JS_ErrorTerminated);
2183 sd->msglen = pm_strcpy(sd->msg, bootstrap);
2185 while (fgets(buf, sizeof(buf), bs)) {
2186 sd->msglen = Mmsg(sd->msg, "%s", buf);
2189 sd->signal(BNET_EOD);
2191 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
2192 set_jcr_job_status(jcr, JS_ErrorTerminated);
2198 free_bootstrap(jcr);