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 restore_object_pkt rop;
630 memset(&rop, 0, sizeof(rop));
631 rop.pkt_size = sizeof(rop);
632 rop.pkt_end = sizeof(rop);
633 Dmsg1(100, "Enter restoreobject_cmd: %s", dir->msg);
634 if (strcmp(dir->msg, endrestoreobjectcmd) == 0) {
635 generate_plugin_event(jcr, bEventRestoreObject, NULL);
637 return dir->fsend(OKRestoreObject);
640 if (sscanf(dir->msg, restoreobjcmd, &rop.JobId, &rop.object_len,
641 &rop.object_index, &rop.object_type, &FileIndex) != 5) {
642 Dmsg0(5, "Bad restore object command\n");
643 pm_strcpy(jcr->errmsg, dir->msg);
644 Jmsg1(jcr, M_FATAL, 0, _("Bad RestoreObject command: %s\n"), jcr->errmsg);
648 // Dmsg5(000, "Recv object: JobId=%u objlen=%d objinx=%d objtype=%d FI=%d\n",
649 // JobId, object_len, object_index, object_type, FileIndex);
650 /* Read Object name */
651 if (dir->recv() < 0) {
654 // Dmsg2(000, "Recv Fname object: len=%d Oname=%s\n", dir->msglen, dir->msg);
655 rop.object_name = bstrdup(dir->msg);
657 // Dmsg2(000, "Recv Path object: len=%d Path=%s\n", dir->msglen, dir->msg);
660 if (dir->recv() < 0) {
663 rop.object = dir->msg;
664 // Dmsg2(000, "Recv Object: len=%d Object=%s\n", dir->msglen, dir->msg);
667 generate_plugin_event(jcr, bEventRestoreObject, (void *)&rop);
669 if (rop.object_name) {
670 free(rop.object_name);
673 dir->msg = get_pool_memory(PM_MESSAGE);
677 Dmsg1(100, "Send: %s", OKRestoreObject);
681 dir->fsend(_("2909 Bad RestoreObject command.\n"));
688 static bool init_fileset(JCR *jcr)
691 findFILESET *fileset;
700 fileset = (findFILESET *)malloc(sizeof(findFILESET));
701 memset(fileset, 0, sizeof(findFILESET));
702 ff->fileset = fileset;
703 fileset->state = state_none;
704 fileset->include_list.init(1, true);
705 fileset->exclude_list.init(1, true);
709 static findFOPTS *start_options(FF_PKT *ff)
711 int state = ff->fileset->state;
712 findINCEXE *incexe = ff->fileset->incexe;
714 if (state != state_options) {
715 ff->fileset->state = state_options;
716 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
717 memset(fo, 0, sizeof(findFOPTS));
718 fo->regex.init(1, true);
719 fo->regexdir.init(1, true);
720 fo->regexfile.init(1, true);
721 fo->wild.init(1, true);
722 fo->wilddir.init(1, true);
723 fo->wildfile.init(1, true);
724 fo->wildbase.init(1, true);
725 fo->base.init(1, true);
726 fo->fstype.init(1, true);
727 fo->drivetype.init(1, true);
728 incexe->current_opts = fo;
729 incexe->opts_list.append(fo);
731 return incexe->current_opts;
736 * Add fname to include/exclude fileset list. First check for
737 * | and < and if necessary perform command.
739 void add_file_to_fileset(JCR *jcr, const char *fname, findFILESET *fileset,
754 p++; /* skip over | */
755 fn = get_pool_memory(PM_FNAME);
756 fn = edit_job_codes(jcr, fn, p, "");
757 bpipe = open_bpipe(fn, 0, "r");
760 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
762 free_pool_memory(fn);
765 free_pool_memory(fn);
766 while (fgets(buf, sizeof(buf), bpipe->rfd)) {
767 strip_trailing_junk(buf);
769 fileset->incexe->name_list.append(new_dlistString(buf));
771 fileset->incexe->plugin_list.append(new_dlistString(buf));
774 if ((stat=close_bpipe(bpipe)) != 0) {
776 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. stat=%d: ERR=%s\n"),
777 p, be.code(stat), be.bstrerror(stat));
782 Dmsg1(100, "Doing < of '%s' include on client.\n", p + 1);
783 p++; /* skip over < */
784 if ((ffd = fopen(p, "rb")) == NULL) {
786 Jmsg(jcr, M_FATAL, 0, _("Cannot open FileSet input file: %s. ERR=%s\n"),
790 while (fgets(buf, sizeof(buf), ffd)) {
791 strip_trailing_junk(buf);
792 Dmsg1(100, "%s\n", buf);
794 fileset->incexe->name_list.append(new_dlistString(buf));
796 fileset->incexe->plugin_list.append(new_dlistString(buf));
803 fileset->incexe->name_list.append(new_dlistString(fname));
805 if (me->plugin_directory) {
806 fileset->incexe->plugin_list.append(new_dlistString(fname));
808 Jmsg(jcr, M_FATAL, 0, _("Plugin Directory not defined. Cannot use plugin: \"%\"\n"),
817 * Define a new Exclude block in the FileSet
819 findFILESET *new_exclude(JCR *jcr)
821 FF_PKT *ff = jcr->ff;
822 findFILESET *fileset = ff->fileset;
825 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
826 memset(fileset->incexe, 0, sizeof(findINCEXE));
827 fileset->incexe->opts_list.init(1, true);
828 fileset->incexe->name_list.init();
829 fileset->incexe->plugin_list.init();
830 fileset->exclude_list.append(fileset->incexe);
835 static void add_fileset(JCR *jcr, const char *item)
837 FF_PKT *ff = jcr->ff;
838 findFILESET *fileset = ff->fileset;
839 int state = fileset->state;
840 findFOPTS *current_opts;
842 /* Get code, optional subcode, and position item past the dividing space */
843 Dmsg1(100, "%s\n", item);
848 int subcode = ' '; /* A space is always a valid subcode */
849 if (item[0] != '\0' && item[0] != ' ') {
857 /* Skip all lines we receive after an error */
858 if (state == state_error) {
859 Dmsg0(100, "State=error return\n");
864 * The switch tests the code for validity.
865 * The subcode is always good if it is a space, otherwise we must confirm.
866 * We set state to state_error first assuming the subcode is invalid,
867 * requiring state to be set in cases below that handle subcodes.
869 if (subcode != ' ') {
871 Dmsg0(100, "Set state=error or double code.\n");
876 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
877 memset(fileset->incexe, 0, sizeof(findINCEXE));
878 fileset->incexe->opts_list.init(1, true);
879 fileset->incexe->name_list.init(); /* for dlist; was 1,true for alist */
880 fileset->incexe->plugin_list.init();
881 fileset->include_list.append(fileset->incexe);
884 fileset = new_exclude(jcr);
890 /* File item to include or exclude list */
891 state = state_include;
892 add_file_to_fileset(jcr, item, fileset, true);
895 /* Plugin item to include list */
896 state = state_include;
897 add_file_to_fileset(jcr, item, fileset, false);
900 current_opts = start_options(ff);
904 preg = (regex_t *)malloc(sizeof(regex_t));
905 if (current_opts->flags & FO_IGNORECASE) {
906 rc = regcomp(preg, item, REG_EXTENDED|REG_ICASE);
908 rc = regcomp(preg, item, REG_EXTENDED);
911 regerror(rc, preg, prbuf, sizeof(prbuf));
914 Jmsg(jcr, M_FATAL, 0, _("REGEX %s compile error. ERR=%s\n"), item, prbuf);
918 state = state_options;
919 if (subcode == ' ') {
920 current_opts->regex.append(preg);
921 } else if (subcode == 'D') {
922 current_opts->regexdir.append(preg);
923 } else if (subcode == 'F') {
924 current_opts->regexfile.append(preg);
930 current_opts = start_options(ff);
931 current_opts->base.append(bstrdup(item));
932 state = state_options;
935 current_opts = start_options(ff);
936 state = state_options;
937 if (subcode == ' ') {
938 current_opts->fstype.append(bstrdup(item));
939 } else if (subcode == 'D') {
940 current_opts->drivetype.append(bstrdup(item));
946 current_opts = start_options(ff);
947 state = state_options;
948 if (subcode == ' ') {
949 current_opts->wild.append(bstrdup(item));
950 } else if (subcode == 'D') {
951 current_opts->wilddir.append(bstrdup(item));
952 } else if (subcode == 'F') {
953 current_opts->wildfile.append(bstrdup(item));
954 } else if (subcode == 'B') {
955 current_opts->wildbase.append(bstrdup(item));
961 current_opts = start_options(ff);
962 set_options(current_opts, item);
963 state = state_options;
966 state = state_include;
967 fileset->incexe->ignoredir = bstrdup(item);
970 current_opts = start_options(ff);
971 // current_opts->reader = bstrdup(item);
972 state = state_options;
975 current_opts = start_options(ff);
976 // current_opts->writer = bstrdup(item);
977 state = state_options;
980 Jmsg(jcr, M_FATAL, 0, _("Invalid FileSet command: %s\n"), item);
984 ff->fileset->state = state;
987 static bool term_fileset(JCR *jcr)
989 FF_PKT *ff = jcr->ff;
991 #ifdef xxx_DEBUG_CODE
992 findFILESET *fileset = ff->fileset;
995 for (i=0; i<fileset->include_list.size(); i++) {
996 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
998 for (j=0; j<incexe->opts_list.size(); j++) {
999 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
1000 for (k=0; k<fo->regex.size(); k++) {
1001 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
1003 for (k=0; k<fo->regexdir.size(); k++) {
1004 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
1006 for (k=0; k<fo->regexfile.size(); k++) {
1007 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
1009 for (k=0; k<fo->wild.size(); k++) {
1010 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1012 for (k=0; k<fo->wilddir.size(); k++) {
1013 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1015 for (k=0; k<fo->wildfile.size(); k++) {
1016 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1018 for (k=0; k<fo->wildbase.size(); k++) {
1019 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1021 for (k=0; k<fo->base.size(); k++) {
1022 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1024 for (k=0; k<fo->fstype.size(); k++) {
1025 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1027 for (k=0; k<fo->drivetype.size(); k++) {
1028 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1031 if (incexe->ignoredir) {
1032 Dmsg1(400, "Z %s\n", incexe->ignoredir);
1035 foreach_dlist(node, &incexe->name_list) {
1036 Dmsg1(400, "F %s\n", node->c_str());
1038 foreach_dlist(node, &incexe->plugin_list) {
1039 Dmsg1(400, "P %s\n", node->c_str());
1042 for (i=0; i<fileset->exclude_list.size(); i++) {
1043 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
1045 for (j=0; j<incexe->opts_list.size(); j++) {
1046 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
1047 for (k=0; k<fo->regex.size(); k++) {
1048 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
1050 for (k=0; k<fo->regexdir.size(); k++) {
1051 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
1053 for (k=0; k<fo->regexfile.size(); k++) {
1054 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
1056 for (k=0; k<fo->wild.size(); k++) {
1057 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1059 for (k=0; k<fo->wilddir.size(); k++) {
1060 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1062 for (k=0; k<fo->wildfile.size(); k++) {
1063 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1065 for (k=0; k<fo->wildbase.size(); k++) {
1066 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1068 for (k=0; k<fo->base.size(); k++) {
1069 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1071 for (k=0; k<fo->fstype.size(); k++) {
1072 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1074 for (k=0; k<fo->drivetype.size(); k++) {
1075 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1079 foreach_dlist(node, incexe->name_list) {
1080 Dmsg1(400, "F %s\n", node->c_str());
1082 foreach_dlist(node, &incexe->plugin_list) {
1083 Dmsg1(400, "P %s\n", node->c_str());
1087 return ff->fileset->state != state_error;
1092 * As an optimization, we should do this during
1093 * "compile" time in filed/job.c, and keep only a bit mask
1094 * and the Verify options.
1096 static void set_options(findFOPTS *fo, const char *opts)
1102 // Commented out as it is not backward compatible - KES
1104 // fo->flags |= FO_IGNORECASE; /* always ignorecase under windows */
1107 for (p=opts; *p; p++) {
1109 case 'a': /* alway replace */
1110 case '0': /* no option */
1113 fo->flags |= FO_EXCLUDE;
1116 fo->flags |= FO_MULTIFS;
1118 case 'h': /* no recursion */
1119 fo->flags |= FO_NO_RECURSION;
1121 case 'H': /* no hard link handling */
1122 fo->flags |= FO_NO_HARDLINK;
1125 fo->flags |= FO_IGNORECASE;
1128 fo->flags |= FO_MD5;
1131 fo->flags |= FO_NOREPLACE;
1133 case 'p': /* use portable data format */
1134 fo->flags |= FO_PORTABLE;
1136 case 'R': /* Resource forks and Finder Info */
1137 fo->flags |= FO_HFSPLUS;
1138 case 'r': /* read fifo */
1139 fo->flags |= FO_READFIFO;
1144 fo->flags |= FO_SHA1;
1149 fo->flags |= FO_SHA256;
1153 fo->flags |= FO_SHA512;
1159 * If 2 or 3 is seen here, SHA2 is not configured, so
1160 * eat the option, and drop back to SHA-1.
1162 if (p[1] == '2' || p[1] == '3') {
1165 fo->flags |= FO_SHA1;
1170 fo->flags |= FO_SPARSE;
1173 fo->flags |= FO_MTIMEONLY;
1176 fo->flags |= FO_KEEPATIME;
1179 fo->flags |= FO_ACL;
1181 case 'V': /* verify options */
1182 /* Copy Verify Options */
1183 for (j=0; *p && *p != ':'; p++) {
1184 fo->VerifyOpts[j] = *p;
1185 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
1189 fo->VerifyOpts[j] = 0;
1191 case 'C': /* accurate options */
1192 /* Copy Accurate Options */
1193 for (j=0; *p && *p != ':'; p++) {
1194 fo->AccurateOpts[j] = *p;
1195 if (j < (int)sizeof(fo->AccurateOpts) - 1) {
1199 fo->AccurateOpts[j] = 0;
1201 case 'J': /* Basejob options */
1202 /* Copy BaseJob Options */
1203 for (j=0; *p && *p != ':'; p++) {
1204 fo->BaseJobOpts[j] = *p;
1205 if (j < (int)sizeof(fo->BaseJobOpts) - 1) {
1209 fo->BaseJobOpts[j] = 0;
1211 case 'P': /* strip path */
1214 for (j=0; *p && *p != ':'; p++) {
1216 if (j < (int)sizeof(strip) - 1) {
1221 fo->strip_path = atoi(strip);
1222 fo->flags |= FO_STRIPPATH;
1223 Dmsg2(100, "strip=%s strip_path=%d\n", strip, fo->strip_path);
1226 fo->flags |= FO_IF_NEWER;
1229 fo->flags |= FO_ENHANCEDWILD;
1231 case 'Z': /* gzip compression */
1232 fo->flags |= FO_GZIP;
1233 fo->GZIP_level = *++p - '0';
1236 fo->flags |= FO_NOATIME;
1239 fo->flags |= FO_CHKCHANGES;
1242 fo->flags |= FO_HONOR_NODUMP;
1245 fo->flags |= FO_XATTR;
1248 Emsg1(M_ERROR, 0, _("Unknown include/exclude option: %c\n"), *p);
1256 * Director is passing his Fileset
1258 static int fileset_cmd(JCR *jcr)
1260 BSOCK *dir = jcr->dir_bsock;
1262 #if defined(WIN32_VSS)
1265 sscanf(dir->msg, "fileset vss=%d", &vss);
1269 if (!init_fileset(jcr)) {
1272 while (dir->recv() >= 0) {
1273 strip_trailing_junk(dir->msg);
1274 Dmsg1(500, "Fileset: %s\n", dir->msg);
1275 add_fileset(jcr, dir->msg);
1277 if (!term_fileset(jcr)) {
1280 return dir->fsend(OKinc);
1283 static void free_bootstrap(JCR *jcr)
1285 if (jcr->RestoreBootstrap) {
1286 unlink(jcr->RestoreBootstrap);
1287 free_pool_memory(jcr->RestoreBootstrap);
1288 jcr->RestoreBootstrap = NULL;
1293 static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER;
1294 static uint32_t bsr_uniq = 0;
1297 * The Director sends us the bootstrap file, which
1298 * we will in turn pass to the SD.
1299 * Deprecated. The bsr is now sent directly from the
1300 * Director to the SD.
1302 static int bootstrap_cmd(JCR *jcr)
1304 BSOCK *dir = jcr->dir_bsock;
1305 POOLMEM *fname = get_pool_memory(PM_FNAME);
1308 free_bootstrap(jcr);
1311 Mmsg(fname, "%s/%s.%s.%d.bootstrap", me->working_directory, me->hdr.name,
1312 jcr->Job, bsr_uniq);
1314 Dmsg1(400, "bootstrap=%s\n", fname);
1315 jcr->RestoreBootstrap = fname;
1316 bs = fopen(fname, "a+b"); /* create file */
1319 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
1320 jcr->RestoreBootstrap, be.bstrerror());
1322 * Suck up what he is sending to us so that he will then
1323 * read our error message.
1325 while (dir->recv() >= 0)
1327 free_bootstrap(jcr);
1328 set_jcr_job_status(jcr, JS_ErrorTerminated);
1332 while (dir->recv() >= 0) {
1333 Dmsg1(200, "filed<dird: bootstrap: %s", dir->msg);
1334 fputs(dir->msg, bs);
1338 * Note, do not free the bootstrap yet -- it needs to be
1341 return dir->fsend(OKbootstrap);
1346 * Get backup level from Director
1349 static int level_cmd(JCR *jcr)
1351 BSOCK *dir = jcr->dir_bsock;
1352 POOLMEM *level, *buf = NULL;
1355 level = get_memory(dir->msglen+1);
1356 Dmsg1(100, "level_cmd: %s", dir->msg);
1358 /* keep compatibility with older directors */
1359 if (strstr(dir->msg, "accurate")) {
1360 jcr->accurate = true;
1362 if (sscanf(dir->msg, "level = %s ", level) != 1) {
1365 /* Base backup requested? */
1366 if (strcmp(level, "base") == 0) {
1367 jcr->set_JobLevel(L_BASE);
1368 /* Full backup requested? */
1369 } else if (strcmp(level, "full") == 0) {
1370 jcr->set_JobLevel(L_FULL);
1371 } else if (strstr(level, "differential")) {
1372 jcr->set_JobLevel(L_DIFFERENTIAL);
1375 } else if (strstr(level, "incremental")) {
1376 jcr->set_JobLevel(L_INCREMENTAL);
1380 * We get his UTC since time, then sync the clocks and correct it
1381 * to agree with our clock.
1383 } else if (strcmp(level, "since_utime") == 0) {
1384 buf = get_memory(dir->msglen+1);
1385 utime_t since_time, adj;
1386 btime_t his_time, bt_start, rt=0, bt_adj=0;
1387 if (jcr->getJobLevel() == L_NONE) {
1388 jcr->set_JobLevel(L_SINCE); /* if no other job level set, do it now */
1390 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
1391 buf, &mtime_only) != 2) {
1394 since_time = str_to_uint64(buf); /* this is the since time */
1395 Dmsg1(100, "since_time=%lld\n", since_time);
1396 char ed1[50], ed2[50];
1398 * Sync clocks by polling him for the time. We take
1399 * 10 samples of his time throwing out the first two.
1401 for (int i=0; i<10; i++) {
1402 bt_start = get_current_btime();
1403 dir->signal(BNET_BTIME); /* poll for time */
1404 if (dir->recv() <= 0) { /* get response */
1407 if (sscanf(dir->msg, "btime %s", buf) != 1) {
1410 if (i < 2) { /* toss first two results */
1413 his_time = str_to_uint64(buf);
1414 rt = get_current_btime() - bt_start; /* compute round trip time */
1415 Dmsg2(100, "Dirtime=%s FDtime=%s\n", edit_uint64(his_time, ed1),
1416 edit_uint64(bt_start, ed2));
1417 bt_adj += bt_start - his_time - rt/2;
1418 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1421 bt_adj = bt_adj / 8; /* compute average time */
1422 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1423 adj = btime_to_utime(bt_adj);
1424 since_time += adj; /* adjust for clock difference */
1425 /* Don't notify if time within 3 seconds */
1426 if (adj > 3 || adj < -3) {
1428 if (adj > 600 || adj < -600) {
1433 Jmsg(jcr, type, 0, _("DIR and FD clocks differ by %lld seconds, FD automatically compensating.\n"), adj);
1435 dir->signal(BNET_EOD);
1437 Dmsg2(100, "adj=%lld since_time=%lld\n", adj, since_time);
1438 jcr->incremental = 1; /* set incremental or decremental backup */
1439 jcr->mtime = since_time; /* set since time */
1440 generate_plugin_event(jcr, bEventSince, (void *)(time_t)jcr->mtime);
1442 Jmsg1(jcr, M_FATAL, 0, _("Unknown backup level: %s\n"), level);
1450 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1451 return dir->fsend(OKlevel);
1454 pm_strcpy(jcr->errmsg, dir->msg);
1455 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
1464 * Get session parameters from Director -- this is for a Restore command
1465 * This is deprecated. It is now passed via the bsr.
1467 static int session_cmd(JCR *jcr)
1469 BSOCK *dir = jcr->dir_bsock;
1471 Dmsg1(100, "SessionCmd: %s", dir->msg);
1472 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1473 &jcr->VolSessionId, &jcr->VolSessionTime,
1474 &jcr->StartFile, &jcr->EndFile,
1475 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1476 pm_strcpy(jcr->errmsg, dir->msg);
1477 Jmsg(jcr, M_FATAL, 0, _("Bad session command: %s"), jcr->errmsg);
1481 return dir->fsend(OKsession);
1484 static void set_storage_auth_key(JCR *jcr, char *key)
1486 /* if no key don't update anything */
1492 * We can be contacting multiple storage daemons.
1493 * So, make sure that any old jcr->store_bsock is cleaned up.
1495 if (jcr->store_bsock) {
1496 jcr->store_bsock->destroy();
1497 jcr->store_bsock = NULL;
1501 * We can be contacting multiple storage daemons.
1502 * So, make sure that any old jcr->sd_auth_key is cleaned up.
1504 if (jcr->sd_auth_key) {
1506 * If we already have a Authorization key, director can do multi
1509 Dmsg0(5, "set multi_restore=true\n");
1510 jcr->multi_restore = true;
1511 bfree(jcr->sd_auth_key);
1514 jcr->sd_auth_key = bstrdup(key);
1515 Dmsg0(5, "set sd auth key\n");
1519 * Get address of storage daemon from Director
1522 static int storage_cmd(JCR *jcr)
1524 int stored_port; /* storage daemon port */
1525 int enable_ssl; /* enable ssl to sd */
1526 POOL_MEM sd_auth_key(PM_MESSAGE);
1527 BSOCK *dir = jcr->dir_bsock;
1528 BSOCK *sd = new_bsock(); /* storage daemon bsock */
1531 Dmsg1(100, "StorageCmd: %s", dir->msg);
1532 sd_auth_key.check_size(dir->msglen);
1533 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port,
1534 &enable_ssl, sd_auth_key.c_str()) != 4) {
1535 if (sscanf(dir->msg, storaddr_v1, &jcr->stored_addr,
1536 &stored_port, &enable_ssl) != 3) {
1537 pm_strcpy(jcr->errmsg, dir->msg);
1538 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1543 set_storage_auth_key(jcr, sd_auth_key.c_str());
1545 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port,
1547 /* Open command communications with Storage daemon */
1548 /* Try to connect for 1 hour at 10 second intervals */
1550 sd->set_source_address(me->FDsrc_addr);
1551 if (!sd->connect(jcr, 10, (int)me->SDConnectTimeout, me->heartbeat_interval,
1552 _("Storage daemon"), jcr->stored_addr, NULL, stored_port, 1)) {
1558 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1559 jcr->stored_addr, stored_port);
1560 Dmsg2(100, "Failed to connect to Storage daemon: %s:%d\n",
1561 jcr->stored_addr, stored_port);
1564 Dmsg0(110, "Connection OK to SD.\n");
1566 jcr->store_bsock = sd;
1568 sd->fsend("Hello Start Job %s\n", jcr->Job);
1569 if (!authenticate_storagedaemon(jcr)) {
1570 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1573 Dmsg0(110, "Authenticated with SD.\n");
1575 /* Send OK to Director */
1576 return dir->fsend(OKstore);
1579 dir->fsend(BADcmd, "storage");
1588 static int backup_cmd(JCR *jcr)
1590 BSOCK *dir = jcr->dir_bsock;
1591 BSOCK *sd = jcr->store_bsock;
1595 #if defined(WIN32_VSS)
1596 // capture state here, if client is backed up by multiple directors
1597 // and one enables vss and the other does not then enable_vss can change
1598 // between here and where its evaluated after the job completes.
1599 jcr->VSS = g_pVSSClient && enable_vss;
1601 /* Run only one at a time */
1607 * Validate some options given to the backup make sense for the compiled in
1608 * options of this filed.
1610 if (jcr->ff->flags & FO_ACL && !have_acl) {
1611 Jmsg(jcr, M_FATAL, 0, _("ACL support not configured for your machine.\n"));
1614 if (jcr->ff->flags & FO_XATTR && !have_xattr) {
1615 Jmsg(jcr, M_FATAL, 0, _("XATTR support not configured for your machine.\n"));
1619 set_jcr_job_status(jcr, JS_Blocked);
1620 jcr->set_JobType(JT_BACKUP);
1621 Dmsg1(100, "begin backup ff=%p\n", jcr->ff);
1624 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1625 dir->fsend(BADcmd, "backup");
1629 dir->fsend(OKbackup);
1630 Dmsg1(110, "filed>dird: %s", dir->msg);
1633 * Send Append Open Session to Storage daemon
1635 sd->fsend(append_open);
1636 Dmsg1(110, ">stored: %s", sd->msg);
1638 * Expect to receive back the Ticket number
1640 if (bget_msg(sd) >= 0) {
1641 Dmsg1(110, "<stored: %s", sd->msg);
1642 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1643 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1646 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1648 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1653 * Send Append data command to Storage daemon
1655 sd->fsend(append_data, jcr->Ticket);
1656 Dmsg1(110, ">stored: %s", sd->msg);
1659 * Expect to get OK data
1661 Dmsg1(110, "<stored: %s", sd->msg);
1662 if (!response(jcr, sd, OK_data, "Append Data")) {
1666 generate_daemon_event(jcr, "JobStart");
1667 generate_plugin_event(jcr, bEventStartBackupJob);
1669 #if defined(WIN32_VSS)
1670 /* START VSS ON WIN32 */
1672 if (g_pVSSClient->InitializeForBackup(jcr)) {
1673 generate_plugin_event(jcr, bEventVssBackupAddComponents);
1674 /* tell vss which drives to snapshot */
1675 char szWinDriveLetters[27];
1676 if (get_win32_driveletters(jcr->ff, szWinDriveLetters)) {
1677 Jmsg(jcr, M_INFO, 0, _("Generate VSS snapshots. Driver=\"%s\", Drive(s)=\"%s\"\n"), g_pVSSClient->GetDriverName(), szWinDriveLetters);
1678 if (!g_pVSSClient->CreateSnapshots(szWinDriveLetters)) {
1679 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshots failed.\n"));
1682 /* tell user if snapshot creation of a specific drive failed */
1684 for (i=0; i < (int)strlen(szWinDriveLetters); i++) {
1685 if (islower(szWinDriveLetters[i])) {
1686 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshot of drive \"%c:\\\" failed. VSS support is disabled on this drive.\n"), szWinDriveLetters[i]);
1690 /* inform user about writer states */
1691 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++)
1692 if (g_pVSSClient->GetWriterState(i) < 1) {
1693 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PrepareForBackup): %s\n"), g_pVSSClient->GetWriterInfo(i));
1698 Jmsg(jcr, M_INFO, 0, _("No drive letters found for generating VSS snapshots.\n"));
1702 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
1704 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
1709 * Send Files to Storage daemon
1711 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1712 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1713 set_jcr_job_status(jcr, JS_ErrorTerminated);
1714 bnet_suppress_error_messages(sd, 1);
1715 Dmsg0(110, "Error in blast_data.\n");
1717 set_jcr_job_status(jcr, JS_Terminated);
1718 /* Note, the above set status will not override an error */
1719 if (!(jcr->JobStatus == JS_Terminated || jcr->JobStatus == JS_Warnings)) {
1720 bnet_suppress_error_messages(sd, 1);
1721 goto cleanup; /* bail out now */
1724 * Expect to get response to append_data from Storage daemon
1726 if (!response(jcr, sd, OK_append, "Append Data")) {
1727 set_jcr_job_status(jcr, JS_ErrorTerminated);
1732 * Send Append End Data to Storage daemon
1734 sd->fsend(append_end, jcr->Ticket);
1736 if (!response(jcr, sd, OK_end, "Append End")) {
1737 set_jcr_job_status(jcr, JS_ErrorTerminated);
1742 * Send Append Close to Storage daemon
1744 sd->fsend(append_close, jcr->Ticket);
1745 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1746 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1748 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1752 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1755 if (!(SDJobStatus == JS_Terminated || SDJobStatus == JS_Warnings)) {
1756 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1762 #if defined(WIN32_VSS)
1764 Win32ConvCleanupCache();
1769 generate_plugin_event(jcr, bEventEndBackupJob);
1770 return 0; /* return and stop command loop */
1774 * Do a Verify for Director
1777 static int verify_cmd(JCR *jcr)
1779 BSOCK *dir = jcr->dir_bsock;
1780 BSOCK *sd = jcr->store_bsock;
1783 jcr->set_JobType(JT_VERIFY);
1784 if (sscanf(dir->msg, verifycmd, level) != 1) {
1785 dir->fsend(_("2994 Bad verify command: %s\n"), dir->msg);
1789 if (strcasecmp(level, "init") == 0) {
1790 jcr->set_JobLevel(L_VERIFY_INIT);
1791 } else if (strcasecmp(level, "catalog") == 0){
1792 jcr->set_JobLevel(L_VERIFY_CATALOG);
1793 } else if (strcasecmp(level, "volume") == 0){
1794 jcr->set_JobLevel(L_VERIFY_VOLUME_TO_CATALOG);
1795 } else if (strcasecmp(level, "data") == 0){
1796 jcr->set_JobLevel(L_VERIFY_DATA);
1797 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1798 jcr->set_JobLevel(L_VERIFY_DISK_TO_CATALOG);
1800 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1804 dir->fsend(OKverify);
1806 generate_daemon_event(jcr, "JobStart");
1807 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1808 generate_plugin_event(jcr, bEventStartVerifyJob);
1810 Dmsg1(110, "filed>dird: %s", dir->msg);
1812 switch (jcr->getJobLevel()) {
1814 case L_VERIFY_CATALOG:
1817 case L_VERIFY_VOLUME_TO_CATALOG:
1818 if (!open_sd_read_session(jcr)) {
1821 start_dir_heartbeat(jcr);
1822 do_verify_volume(jcr);
1823 stop_dir_heartbeat(jcr);
1825 * Send Close session command to Storage daemon
1827 sd->fsend(read_close, jcr->Ticket);
1828 Dmsg1(130, "filed>stored: %s", sd->msg);
1830 /* ****FIXME**** check response */
1831 bget_msg(sd); /* get OK */
1833 /* Inform Storage daemon that we are done */
1834 sd->signal(BNET_TERMINATE);
1837 case L_VERIFY_DISK_TO_CATALOG:
1841 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1845 dir->signal(BNET_EOD);
1846 generate_plugin_event(jcr, bEventEndVerifyJob);
1847 return 0; /* return and terminate command loop */
1851 static bool vss_restore_init_callback(JCR *jcr, int init_type)
1853 switch (init_type) {
1854 case VSS_INIT_RESTORE_AFTER_INIT:
1855 generate_plugin_event(jcr, bEventVssRestoreLoadComponentMetadata);
1857 case VSS_INIT_RESTORE_AFTER_GATHER:
1858 generate_plugin_event(jcr, bEventVssRestoreSetComponentsSelected);
1868 * Do a Restore for Director
1871 static int restore_cmd(JCR *jcr)
1873 BSOCK *dir = jcr->dir_bsock;
1874 BSOCK *sd = jcr->store_bsock;
1876 bool use_regexwhere=false;
1881 * Scan WHERE (base directory for restore) from command
1883 Dmsg0(100, "restore command\n");
1884 #if defined(WIN32_VSS)
1886 /* TODO: this should be given from the director */
1889 Dmsg2(50, "g_pVSSClient = %p, enable_vss = %d\n", g_pVSSClient, enable_vss);
1890 // capture state here, if client is backed up by multiple directors
1891 // and one enables vss and the other does not then enable_vss can change
1892 // between here and where its evaluated after the job completes.
1893 jcr->VSS = g_pVSSClient && enable_vss;
1895 /* Run only one at a time */
1899 /* Pickup where string */
1900 args = get_memory(dir->msglen+1);
1903 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, args) != 3) {
1904 if (sscanf(dir->msg, restorecmdR, &replace, &prefix_links, args) != 3){
1905 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
1906 pm_strcpy(jcr->errmsg, dir->msg);
1907 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
1912 use_regexwhere = true;
1914 /* Turn / into nothing */
1915 if (IsPathSeparator(args[0]) && args[1] == '\0') {
1919 Dmsg2(150, "Got replace %c, where=%s\n", replace, args);
1920 unbash_spaces(args);
1922 if (use_regexwhere) {
1923 jcr->where_bregexp = get_bregexps(args);
1924 if (!jcr->where_bregexp) {
1925 Jmsg(jcr, M_FATAL, 0, _("Bad where regexp. where=%s\n"), args);
1926 free_pool_memory(args);
1930 jcr->where = bstrdup(args);
1933 free_pool_memory(args);
1934 jcr->replace = replace;
1935 jcr->prefix_links = prefix_links;
1937 dir->fsend(OKrestore);
1938 Dmsg1(110, "filed>dird: %s", dir->msg);
1940 jcr->set_JobType(JT_RESTORE);
1942 set_jcr_job_status(jcr, JS_Blocked);
1944 if (!open_sd_read_session(jcr)) {
1945 set_jcr_job_status(jcr, JS_ErrorTerminated);
1949 set_jcr_job_status(jcr, JS_Running);
1952 * Do restore of files and data
1954 start_dir_heartbeat(jcr);
1955 generate_daemon_event(jcr, "JobStart");
1956 generate_plugin_event(jcr, bEventStartRestoreJob);
1958 #if defined(WIN32_VSS)
1959 /* START VSS ON WIN32 */
1961 if (g_pVSSClient->InitializeForRestore(jcr, vss_restore_init_callback)) {
1962 /* inform user about writer states */
1964 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++) {
1965 int msg_type = M_INFO;
1966 if (g_pVSSClient->GetWriterState(i) < 1) {
1967 msg_type = M_WARNING;
1970 if (g_pVSSClient->GetWriterState(i) < 1) {
1971 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PreRestore): %s\n"), g_pVSSClient->GetWriterInfo(i));
1977 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
1979 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
1984 stop_dir_heartbeat(jcr);
1986 set_jcr_job_status(jcr, JS_Terminated);
1987 if (jcr->JobStatus != JS_Terminated) {
1988 bnet_suppress_error_messages(sd, 1);
1992 * Send Close session command to Storage daemon
1994 sd->fsend(read_close, jcr->Ticket);
1995 Dmsg1(100, "filed>stored: %s", sd->msg);
1997 bget_msg(sd); /* get OK */
1999 /* Inform Storage daemon that we are done */
2000 sd->signal(BNET_TERMINATE);
2002 #if defined(WIN32_VSS)
2003 /* STOP VSS ON WIN32 */
2004 /* tell vss to close the restore session */
2005 Dmsg0(0, "About to call CloseRestore\n");
2007 Dmsg0(0, "Really about to call CloseRestore\n");
2008 if (g_pVSSClient->CloseRestore()) {
2009 Dmsg0(0, "CloseRestore success\n");
2010 /* inform user about writer states */
2011 for (int i=0; i<(int)g_pVSSClient->GetWriterCount(); i++) {
2012 int msg_type = M_INFO;
2013 if (g_pVSSClient->GetWriterState(i) < 1) {
2014 msg_type = M_WARNING;
2017 Jmsg(jcr, msg_type, 0, _("VSS Writer (RestoreComplete): %s\n"), g_pVSSClient->GetWriterInfo(i));
2021 Dmsg1(0, "CloseRestore fail - %08x\n", errno);
2027 bfree_and_null(jcr->where);
2029 if (jcr->JobErrors) {
2030 set_jcr_job_status(jcr, JS_ErrorTerminated);
2033 Dmsg0(100, "Done in job.c\n");
2036 if (jcr->multi_restore) {
2037 Dmsg0(100, OKstoreend);
2038 dir->fsend(OKstoreend);
2039 ret = 1; /* we continue the loop, waiting for next part */
2041 end_restore_cmd(jcr);
2042 ret = 0; /* we stop here */
2048 static int end_restore_cmd(JCR *jcr)
2050 Dmsg0(5, "end_restore_cmd\n");
2051 generate_plugin_event(jcr, bEventEndRestoreJob);
2052 return 0; /* return and terminate command loop */
2055 static int open_sd_read_session(JCR *jcr)
2057 BSOCK *sd = jcr->store_bsock;
2060 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
2063 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
2064 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
2065 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
2067 * Open Read Session with Storage daemon
2069 sd->fsend(read_open, "DummyVolume",
2070 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
2071 jcr->StartBlock, jcr->EndBlock);
2072 Dmsg1(110, ">stored: %s", sd->msg);
2077 if (bget_msg(sd) >= 0) {
2078 Dmsg1(110, "filed<stored: %s", sd->msg);
2079 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
2080 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
2083 Dmsg1(110, "filed: got Ticket=%d\n", jcr->Ticket);
2085 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
2089 if (!send_bootstrap_file(jcr)) {
2094 * Start read of data with Storage daemon
2096 sd->fsend(read_data, jcr->Ticket);
2097 Dmsg1(110, ">stored: %s", sd->msg);
2102 if (!response(jcr, sd, OK_data, "Read Data")) {
2109 * Destroy the Job Control Record and associated
2110 * resources (sockets).
2112 static void filed_free_jcr(JCR *jcr)
2114 if (jcr->store_bsock) {
2115 jcr->store_bsock->close();
2117 free_bootstrap(jcr);
2118 if (jcr->last_fname) {
2119 free_pool_memory(jcr->last_fname);
2121 free_runscripts(jcr->RunScripts);
2122 delete jcr->RunScripts;
2124 if (jcr->JobId != 0)
2125 write_state_file(me->working_directory, "bacula-fd", get_first_port_host_order(me->FDaddrs));
2131 * Get response from Storage daemon to a command we
2132 * sent. Check that the response is OK.
2134 * Returns: 0 on failure
2137 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
2142 if (bget_msg(sd) > 0) {
2143 Dmsg0(110, sd->msg);
2144 if (strcmp(sd->msg, resp) == 0) {
2148 if (job_canceled(jcr)) {
2149 return 0; /* if canceled avoid useless error messages */
2151 if (is_bnet_error(sd)) {
2152 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
2153 cmd, bnet_strerror(sd));
2155 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
2156 cmd, resp, sd->msg);
2161 static int send_bootstrap_file(JCR *jcr)
2165 BSOCK *sd = jcr->store_bsock;
2166 const char *bootstrap = "bootstrap\n";
2169 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
2170 if (!jcr->RestoreBootstrap) {
2173 bs = fopen(jcr->RestoreBootstrap, "rb");
2176 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
2177 jcr->RestoreBootstrap, be.bstrerror());
2178 set_jcr_job_status(jcr, JS_ErrorTerminated);
2181 sd->msglen = pm_strcpy(sd->msg, bootstrap);
2183 while (fgets(buf, sizeof(buf), bs)) {
2184 sd->msglen = Mmsg(sd->msg, "%s", buf);
2187 sd->signal(BNET_EOD);
2189 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
2190 set_jcr_job_status(jcr, JS_ErrorTerminated);
2196 free_bootstrap(jcr);