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 int 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 */
320 free_and_null_pool_memory(jcr->job_metadata);
322 /* Clean up fileset */
323 FF_PKT *ff = jcr->ff;
324 findFILESET *fileset = ff->fileset;
327 /* Delete FileSet Include lists */
328 for (i=0; i<fileset->include_list.size(); i++) {
329 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
330 for (j=0; j<incexe->opts_list.size(); j++) {
331 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
332 for (k=0; k<fo->regex.size(); k++) {
333 regfree((regex_t *)fo->regex.get(k));
335 for (k=0; k<fo->regexdir.size(); k++) {
336 regfree((regex_t *)fo->regexdir.get(k));
338 for (k=0; k<fo->regexfile.size(); k++) {
339 regfree((regex_t *)fo->regexfile.get(k));
342 fo->regexdir.destroy();
343 fo->regexfile.destroy();
345 fo->wilddir.destroy();
346 fo->wildfile.destroy();
347 fo->wildbase.destroy();
349 fo->fstype.destroy();
350 fo->drivetype.destroy();
352 incexe->opts_list.destroy();
353 incexe->name_list.destroy();
354 incexe->plugin_list.destroy();
355 if (incexe->ignoredir) {
356 free(incexe->ignoredir);
359 fileset->include_list.destroy();
361 /* Delete FileSet Exclude lists */
362 for (i=0; i<fileset->exclude_list.size(); i++) {
363 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
364 for (j=0; j<incexe->opts_list.size(); j++) {
365 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
367 fo->regexdir.destroy();
368 fo->regexfile.destroy();
370 fo->wilddir.destroy();
371 fo->wildfile.destroy();
372 fo->wildbase.destroy();
374 fo->fstype.destroy();
375 fo->drivetype.destroy();
377 incexe->opts_list.destroy();
378 incexe->name_list.destroy();
379 incexe->plugin_list.destroy();
380 if (incexe->ignoredir) {
381 free(incexe->ignoredir);
384 fileset->exclude_list.destroy();
388 Dmsg0(100, "Calling term_find_files\n");
389 term_find_files(jcr->ff);
390 // save_cwd.restore(jcr);
391 // save_cwd.release();
393 Dmsg0(100, "Done with term_find_files\n");
394 free_jcr(jcr); /* destroy JCR record */
395 Dmsg0(100, "Done with free_jcr\n");
401 * Hello from Director he must identify himself and provide his
404 static int hello_cmd(JCR *jcr)
406 Dmsg0(120, "Calling Authenticate\n");
407 if (!authenticate_director(jcr)) {
410 Dmsg0(120, "OK Authenticate\n");
411 jcr->authenticated = true;
418 static int cancel_cmd(JCR *jcr)
420 BSOCK *dir = jcr->dir_bsock;
421 char Job[MAX_NAME_LENGTH];
424 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
425 if (!(cjcr=get_jcr_by_full_name(Job))) {
426 dir->fsend(_("2901 Job %s not found.\n"), Job);
428 if (cjcr->store_bsock) {
429 cjcr->store_bsock->set_timed_out();
430 cjcr->store_bsock->set_terminated();
431 pthread_kill(cjcr->my_thread_id, TIMEOUT_SIGNAL);
433 generate_plugin_event(cjcr, bEventCancelCommand, NULL);
434 set_jcr_job_status(cjcr, JS_Canceled);
436 dir->fsend(_("2001 Job %s marked to be canceled.\n"), Job);
439 dir->fsend(_("2902 Error scanning cancel command.\n"));
441 dir->signal(BNET_EOD);
447 * Set debug level as requested by the Director
450 static int setdebug_cmd(JCR *jcr)
452 BSOCK *dir = jcr->dir_bsock;
453 int level, trace_flag;
455 Dmsg1(110, "setdebug_cmd: %s", dir->msg);
456 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
457 pm_strcpy(jcr->errmsg, dir->msg);
458 dir->fsend(_("2991 Bad setdebug command: %s\n"), jcr->errmsg);
462 set_trace(trace_flag);
463 return dir->fsend(OKsetdebug, level);
467 static int estimate_cmd(JCR *jcr)
469 BSOCK *dir = jcr->dir_bsock;
470 char ed1[50], ed2[50];
472 if (sscanf(dir->msg, estimatecmd, &jcr->listing) != 1) {
473 pm_strcpy(jcr->errmsg, dir->msg);
474 Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
475 dir->fsend(_("2992 Bad estimate command.\n"));
479 dir->fsend(OKest, edit_uint64_with_commas(jcr->num_files_examined, ed1),
480 edit_uint64_with_commas(jcr->JobBytes, ed2));
481 dir->signal(BNET_EOD);
486 * Get JobId and Storage Daemon Authorization key from Director
488 static int job_cmd(JCR *jcr)
490 BSOCK *dir = jcr->dir_bsock;
491 POOL_MEM sd_auth_key(PM_MESSAGE);
492 sd_auth_key.check_size(dir->msglen);
494 if (sscanf(dir->msg, jobcmd, &jcr->JobId, jcr->Job,
495 &jcr->VolSessionId, &jcr->VolSessionTime,
496 sd_auth_key.c_str()) != 5) {
497 pm_strcpy(jcr->errmsg, dir->msg);
498 Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
502 set_storage_auth_key(jcr, sd_auth_key.c_str());
503 Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
504 Mmsg(jcr->errmsg, "JobId=%d Job=%s", jcr->JobId, jcr->Job);
505 new_plugins(jcr); /* instantiate plugins for this jcr */
506 generate_plugin_event(jcr, bEventJobStart, (void *)jcr->errmsg);
507 return dir->fsend(OKjob, VERSION, LSMDATE, HOST_OS, DISTNAME, DISTVER);
510 static int runbefore_cmd(JCR *jcr)
513 BSOCK *dir = jcr->dir_bsock;
514 POOLMEM *cmd = get_memory(dir->msglen+1);
517 Dmsg1(100, "runbefore_cmd: %s", dir->msg);
518 if (sscanf(dir->msg, runbefore, cmd) != 1) {
519 pm_strcpy(jcr->errmsg, dir->msg);
520 Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
521 dir->fsend(_("2905 Bad RunBeforeJob command.\n"));
527 /* Run the command now */
528 script = new_runscript();
529 script->set_command(cmd);
530 script->when = SCRIPT_Before;
531 ok = script->run(jcr, "ClientRunBeforeJob");
532 free_runscript(script);
536 dir->fsend(OKRunBefore);
539 dir->fsend(_("2905 Bad RunBeforeJob command.\n"));
544 static int runbeforenow_cmd(JCR *jcr)
546 BSOCK *dir = jcr->dir_bsock;
548 run_scripts(jcr, jcr->RunScripts, "ClientBeforeJob");
549 if (job_canceled(jcr)) {
550 dir->fsend(_("2905 Bad RunBeforeNow command.\n"));
551 Dmsg0(100, "Back from run_scripts ClientBeforeJob now: FAILED\n");
554 dir->fsend(OKRunBeforeNow);
555 Dmsg0(100, "Back from run_scripts ClientBeforeJob now: OK\n");
560 static int runafter_cmd(JCR *jcr)
562 BSOCK *dir = jcr->dir_bsock;
563 POOLMEM *msg = get_memory(dir->msglen+1);
566 Dmsg1(100, "runafter_cmd: %s", dir->msg);
567 if (sscanf(dir->msg, runafter, msg) != 1) {
568 pm_strcpy(jcr->errmsg, dir->msg);
569 Jmsg1(jcr, M_FATAL, 0, _("Bad RunAfter command: %s\n"), jcr->errmsg);
570 dir->fsend(_("2905 Bad RunAfterJob command.\n"));
576 cmd = new_runscript();
577 cmd->set_command(msg);
578 cmd->on_success = true;
579 cmd->on_failure = false;
580 cmd->when = SCRIPT_After;
582 jcr->RunScripts->append(cmd);
584 free_pool_memory(msg);
585 return dir->fsend(OKRunAfter);
588 static int runscript_cmd(JCR *jcr)
590 BSOCK *dir = jcr->dir_bsock;
591 POOLMEM *msg = get_memory(dir->msglen+1);
592 int on_success, on_failure, fail_on_error;
594 RUNSCRIPT *cmd = new_runscript() ;
596 Dmsg1(100, "runscript_cmd: '%s'\n", dir->msg);
597 /* Note, we cannot sscanf into bools */
598 if (sscanf(dir->msg, runscript, &on_success,
603 pm_strcpy(jcr->errmsg, dir->msg);
604 Jmsg1(jcr, M_FATAL, 0, _("Bad RunScript command: %s\n"), jcr->errmsg);
605 dir->fsend(_("2905 Bad RunScript command.\n"));
610 cmd->on_success = on_success;
611 cmd->on_failure = on_failure;
612 cmd->fail_on_error = fail_on_error;
615 cmd->set_command(msg);
617 jcr->RunScripts->append(cmd);
619 free_pool_memory(msg);
620 return dir->fsend(OKRunScript);
624 * This reads data sent from the Director from the
625 * RestoreObject table that allows us to get objects
626 * that were backed up (VSS .xml data) and are needed
627 * before starting the restore.
629 static int restore_object_cmd(JCR *jcr)
631 BSOCK *dir = jcr->dir_bsock;
632 POOLMEM *msg = get_memory(dir->msglen+1);
634 restore_object_pkt rop;
636 memset(&rop, 0, sizeof(rop));
637 rop.pkt_size = sizeof(rop);
638 rop.pkt_end = sizeof(rop);
639 Dmsg1(100, "Enter restoreobject_cmd: %s", dir->msg);
640 if (strcmp(dir->msg, endrestoreobjectcmd) == 0) {
641 generate_plugin_event(jcr, bEventRestoreObject, NULL);
643 return dir->fsend(OKRestoreObject);
646 if (sscanf(dir->msg, restoreobjcmd, &rop.JobId, &rop.object_len,
647 &rop.object_index, &rop.object_type, &FileIndex) != 5) {
648 Dmsg0(5, "Bad restore object command\n");
649 pm_strcpy(jcr->errmsg, dir->msg);
650 Jmsg1(jcr, M_FATAL, 0, _("Bad RestoreObject command: %s\n"), jcr->errmsg);
654 Dmsg5(100, "Recv object: JobId=%u objlen=%d objinx=%d objtype=%d FI=%d\n",
655 rop.JobId, rop.object_len, rop.object_index, rop.object_type, FileIndex);
656 /* Read Object name */
657 if (dir->recv() < 0) {
660 Dmsg2(100, "Recv Oname object: len=%d Oname=%s\n", dir->msglen, dir->msg);
661 rop.object_name = bstrdup(dir->msg);
664 if (dir->recv() < 0) {
667 rop.object = dir->msg;
668 Dmsg2(100, "Recv Object: len=%d Object=%s\n", dir->msglen, dir->msg);
670 if (strcmp(rop.object_name, "job_metadata.xml") == 0) {
671 Dmsg0(100, "got job metadata\n");
672 free_and_null_pool_memory(jcr->job_metadata);
673 jcr->job_metadata = rop.object;
677 generate_plugin_event(jcr, bEventRestoreObject, (void *)&rop);
680 if (rop.object_name) {
681 free(rop.object_name);
684 dir->msg = get_pool_memory(PM_MESSAGE);
688 Dmsg1(100, "Send: %s", OKRestoreObject);
692 dir->fsend(_("2909 Bad RestoreObject command.\n"));
699 static bool init_fileset(JCR *jcr)
702 findFILESET *fileset;
711 fileset = (findFILESET *)malloc(sizeof(findFILESET));
712 memset(fileset, 0, sizeof(findFILESET));
713 ff->fileset = fileset;
714 fileset->state = state_none;
715 fileset->include_list.init(1, true);
716 fileset->exclude_list.init(1, true);
722 * Add fname to include/exclude fileset list. First check for
723 * | and < and if necessary perform command.
725 void add_file_to_fileset(JCR *jcr, const char *fname, bool is_file)
727 findFILESET *fileset = jcr->ff->fileset;
740 p++; /* skip over | */
741 fn = get_pool_memory(PM_FNAME);
742 fn = edit_job_codes(jcr, fn, p, "");
743 bpipe = open_bpipe(fn, 0, "r");
746 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
748 free_pool_memory(fn);
751 free_pool_memory(fn);
752 while (fgets(buf, sizeof(buf), bpipe->rfd)) {
753 strip_trailing_junk(buf);
755 fileset->incexe->name_list.append(new_dlistString(buf));
757 fileset->incexe->plugin_list.append(new_dlistString(buf));
760 if ((stat=close_bpipe(bpipe)) != 0) {
762 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. stat=%d: ERR=%s\n"),
763 p, be.code(stat), be.bstrerror(stat));
768 Dmsg1(100, "Doing < of '%s' include on client.\n", p + 1);
769 p++; /* skip over < */
770 if ((ffd = fopen(p, "rb")) == NULL) {
772 Jmsg(jcr, M_FATAL, 0, _("Cannot open FileSet input file: %s. ERR=%s\n"),
776 while (fgets(buf, sizeof(buf), ffd)) {
777 strip_trailing_junk(buf);
778 Dmsg1(100, "%s\n", buf);
780 fileset->incexe->name_list.append(new_dlistString(buf));
782 fileset->incexe->plugin_list.append(new_dlistString(buf));
789 fileset->incexe->name_list.append(new_dlistString(fname));
791 if (me->plugin_directory) {
792 fileset->incexe->plugin_list.append(new_dlistString(fname));
794 Jmsg(jcr, M_FATAL, 0, _("Plugin Directory not defined. Cannot use plugin: \"%\"\n"),
802 void set_incexe(JCR *jcr, findINCEXE *incexe)
804 findFILESET *fileset = jcr->ff->fileset;
805 fileset->incexe = incexe;
810 * Define a new Exclude block in the FileSet
812 findINCEXE *new_exclude(JCR *jcr)
814 findFILESET *fileset = jcr->ff->fileset;
817 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
818 memset(fileset->incexe, 0, sizeof(findINCEXE));
819 fileset->incexe->opts_list.init(1, true);
820 fileset->incexe->name_list.init();
821 fileset->incexe->plugin_list.init();
822 fileset->exclude_list.append(fileset->incexe);
823 return fileset->incexe;
827 * Define a new Include block in the FileSet
829 findINCEXE *new_include(JCR *jcr)
831 findFILESET *fileset = jcr->ff->fileset;
834 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
835 memset(fileset->incexe, 0, sizeof(findINCEXE));
836 fileset->incexe->opts_list.init(1, true);
837 fileset->incexe->name_list.init(); /* for dlist; was 1,true for alist */
838 fileset->incexe->plugin_list.init();
839 fileset->include_list.append(fileset->incexe);
840 return fileset->incexe;
844 * Define a new preInclude block in the FileSet
845 * That is the include is prepended to the other
846 * Includes. This is used for plugin exclusions.
848 findINCEXE *new_preinclude(JCR *jcr)
850 findFILESET *fileset = jcr->ff->fileset;
852 /* New pre-include */
853 fileset->incexe = (findINCEXE *)malloc(sizeof(findINCEXE));
854 memset(fileset->incexe, 0, sizeof(findINCEXE));
855 fileset->incexe->opts_list.init(1, true);
856 fileset->incexe->name_list.init(); /* for dlist; was 1,true for alist */
857 fileset->incexe->plugin_list.init();
858 fileset->include_list.prepend(fileset->incexe);
859 return fileset->incexe;
862 static findFOPTS *start_options(FF_PKT *ff)
864 int state = ff->fileset->state;
865 findINCEXE *incexe = ff->fileset->incexe;
867 if (state != state_options) {
868 ff->fileset->state = state_options;
869 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
870 memset(fo, 0, sizeof(findFOPTS));
871 fo->regex.init(1, true);
872 fo->regexdir.init(1, true);
873 fo->regexfile.init(1, true);
874 fo->wild.init(1, true);
875 fo->wilddir.init(1, true);
876 fo->wildfile.init(1, true);
877 fo->wildbase.init(1, true);
878 fo->base.init(1, true);
879 fo->fstype.init(1, true);
880 fo->drivetype.init(1, true);
881 incexe->current_opts = fo;
882 incexe->opts_list.append(fo);
884 return incexe->current_opts;
888 * Used by plugins to define a new options block
890 void new_options(JCR *jcr, findINCEXE *incexe)
892 findFOPTS *fo = (findFOPTS *)malloc(sizeof(findFOPTS));
893 memset(fo, 0, sizeof(findFOPTS));
894 fo->regex.init(1, true);
895 fo->regexdir.init(1, true);
896 fo->regexfile.init(1, true);
897 fo->wild.init(1, true);
898 fo->wilddir.init(1, true);
899 fo->wildfile.init(1, true);
900 fo->wildbase.init(1, true);
901 fo->base.init(1, true);
902 fo->fstype.init(1, true);
903 fo->drivetype.init(1, true);
904 incexe->current_opts = fo;
905 incexe->opts_list.append(fo);
906 jcr->ff->fileset->state = state_options;
910 * Add a regex to the current fileset
912 int add_regex_to_fileset(JCR *jcr, const char *item, int type)
914 findFOPTS *current_opts = start_options(jcr->ff);
919 preg = (regex_t *)malloc(sizeof(regex_t));
920 if (current_opts->flags & FO_IGNORECASE) {
921 rc = regcomp(preg, item, REG_EXTENDED|REG_ICASE);
923 rc = regcomp(preg, item, REG_EXTENDED);
926 regerror(rc, preg, prbuf, sizeof(prbuf));
929 Jmsg(jcr, M_FATAL, 0, _("REGEX %s compile error. ERR=%s\n"), item, prbuf);
933 current_opts->regex.append(preg);
934 } else if (type == 'D') {
935 current_opts->regexdir.append(preg);
936 } else if (type == 'F') {
937 current_opts->regexfile.append(preg);
941 return state_options;
945 * Add a wild card to the current fileset
947 int add_wild_to_fileset(JCR *jcr, const char *item, int type)
949 findFOPTS *current_opts = start_options(jcr->ff);
952 current_opts->wild.append(bstrdup(item));
953 } else if (type == 'D') {
954 current_opts->wilddir.append(bstrdup(item));
955 } else if (type == 'F') {
956 current_opts->wildfile.append(bstrdup(item));
957 } else if (type == 'B') {
958 current_opts->wildbase.append(bstrdup(item));
962 return state_options;
967 * Add options to the current fileset
969 int add_options_to_fileset(JCR *jcr, const char *item)
971 findFOPTS *current_opts = start_options(jcr->ff);
973 set_options(current_opts, item);
974 return state_options;
977 static void add_fileset(JCR *jcr, const char *item)
979 FF_PKT *ff = jcr->ff;
980 findFILESET *fileset = ff->fileset;
981 int state = fileset->state;
982 findFOPTS *current_opts;
984 /* Get code, optional subcode, and position item past the dividing space */
985 Dmsg1(100, "%s\n", item);
990 int subcode = ' '; /* A space is always a valid subcode */
991 if (item[0] != '\0' && item[0] != ' ') {
999 /* Skip all lines we receive after an error */
1000 if (state == state_error) {
1001 Dmsg0(100, "State=error return\n");
1006 * The switch tests the code for validity.
1007 * The subcode is always good if it is a space, otherwise we must confirm.
1008 * We set state to state_error first assuming the subcode is invalid,
1009 * requiring state to be set in cases below that handle subcodes.
1011 if (subcode != ' ') {
1012 state = state_error;
1013 Dmsg0(100, "Set state=error or double code.\n");
1017 (void)new_include(jcr);
1020 (void)new_exclude(jcr);
1022 case 'N': /* null */
1025 case 'F': /* file = */
1026 /* File item to include or exclude list */
1027 state = state_include;
1028 add_file_to_fileset(jcr, item, true);
1030 case 'P': /* plugin */
1031 /* Plugin item to include list */
1032 state = state_include;
1033 add_file_to_fileset(jcr, item, false);
1035 case 'R': /* regex */
1036 state = add_regex_to_fileset(jcr, item, subcode);
1039 current_opts = start_options(ff);
1040 current_opts->base.append(bstrdup(item));
1041 state = state_options;
1043 case 'X': /* Filetype or Drive type */
1044 current_opts = start_options(ff);
1045 state = state_options;
1046 if (subcode == ' ') {
1047 current_opts->fstype.append(bstrdup(item));
1048 } else if (subcode == 'D') {
1049 current_opts->drivetype.append(bstrdup(item));
1051 state = state_error;
1054 case 'W': /* wild cards */
1055 state = add_wild_to_fileset(jcr, item, subcode);
1057 case 'O': /* Options */
1058 state = add_options_to_fileset(jcr, item);
1060 case 'Z': /* ignore dir */
1061 state = state_include;
1062 fileset->incexe->ignoredir = bstrdup(item);
1065 current_opts = start_options(ff);
1066 // current_opts->reader = bstrdup(item); /* deprecated */
1067 state = state_options;
1070 current_opts = start_options(ff);
1071 // current_opts->writer = bstrdup(item); /* deprecated */
1072 state = state_options;
1075 Jmsg(jcr, M_FATAL, 0, _("Invalid FileSet command: %s\n"), item);
1076 state = state_error;
1079 ff->fileset->state = state;
1082 static bool term_fileset(JCR *jcr)
1084 FF_PKT *ff = jcr->ff;
1086 #ifdef xxx_DEBUG_CODE
1087 findFILESET *fileset = ff->fileset;
1090 for (i=0; i<fileset->include_list.size(); i++) {
1091 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
1093 for (j=0; j<incexe->opts_list.size(); j++) {
1094 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
1095 for (k=0; k<fo->regex.size(); k++) {
1096 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
1098 for (k=0; k<fo->regexdir.size(); k++) {
1099 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
1101 for (k=0; k<fo->regexfile.size(); k++) {
1102 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
1104 for (k=0; k<fo->wild.size(); k++) {
1105 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1107 for (k=0; k<fo->wilddir.size(); k++) {
1108 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1110 for (k=0; k<fo->wildfile.size(); k++) {
1111 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1113 for (k=0; k<fo->wildbase.size(); k++) {
1114 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1116 for (k=0; k<fo->base.size(); k++) {
1117 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1119 for (k=0; k<fo->fstype.size(); k++) {
1120 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1122 for (k=0; k<fo->drivetype.size(); k++) {
1123 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1126 if (incexe->ignoredir) {
1127 Dmsg1(400, "Z %s\n", incexe->ignoredir);
1130 foreach_dlist(node, &incexe->name_list) {
1131 Dmsg1(400, "F %s\n", node->c_str());
1133 foreach_dlist(node, &incexe->plugin_list) {
1134 Dmsg1(400, "P %s\n", node->c_str());
1137 for (i=0; i<fileset->exclude_list.size(); i++) {
1138 findINCEXE *incexe = (findINCEXE *)fileset->exclude_list.get(i);
1140 for (j=0; j<incexe->opts_list.size(); j++) {
1141 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
1142 for (k=0; k<fo->regex.size(); k++) {
1143 Dmsg1(400, "R %s\n", (char *)fo->regex.get(k));
1145 for (k=0; k<fo->regexdir.size(); k++) {
1146 Dmsg1(400, "RD %s\n", (char *)fo->regexdir.get(k));
1148 for (k=0; k<fo->regexfile.size(); k++) {
1149 Dmsg1(400, "RF %s\n", (char *)fo->regexfile.get(k));
1151 for (k=0; k<fo->wild.size(); k++) {
1152 Dmsg1(400, "W %s\n", (char *)fo->wild.get(k));
1154 for (k=0; k<fo->wilddir.size(); k++) {
1155 Dmsg1(400, "WD %s\n", (char *)fo->wilddir.get(k));
1157 for (k=0; k<fo->wildfile.size(); k++) {
1158 Dmsg1(400, "WF %s\n", (char *)fo->wildfile.get(k));
1160 for (k=0; k<fo->wildbase.size(); k++) {
1161 Dmsg1(400, "WB %s\n", (char *)fo->wildbase.get(k));
1163 for (k=0; k<fo->base.size(); k++) {
1164 Dmsg1(400, "B %s\n", (char *)fo->base.get(k));
1166 for (k=0; k<fo->fstype.size(); k++) {
1167 Dmsg1(400, "X %s\n", (char *)fo->fstype.get(k));
1169 for (k=0; k<fo->drivetype.size(); k++) {
1170 Dmsg1(400, "XD %s\n", (char *)fo->drivetype.get(k));
1174 foreach_dlist(node, incexe->name_list) {
1175 Dmsg1(400, "F %s\n", node->c_str());
1177 foreach_dlist(node, &incexe->plugin_list) {
1178 Dmsg1(400, "P %s\n", node->c_str());
1182 return ff->fileset->state != state_error;
1187 * As an optimization, we should do this during
1188 * "compile" time in filed/job.c, and keep only a bit mask
1189 * and the Verify options.
1191 static int set_options(findFOPTS *fo, const char *opts)
1197 // Commented out as it is not backward compatible - KES
1199 // fo->flags |= FO_IGNORECASE; /* always ignorecase under windows */
1202 for (p=opts; *p; p++) {
1204 case 'a': /* alway replace */
1205 case '0': /* no option */
1208 fo->flags |= FO_EXCLUDE;
1211 fo->flags |= FO_MULTIFS;
1213 case 'h': /* no recursion */
1214 fo->flags |= FO_NO_RECURSION;
1216 case 'H': /* no hard link handling */
1217 fo->flags |= FO_NO_HARDLINK;
1220 fo->flags |= FO_IGNORECASE;
1223 fo->flags |= FO_MD5;
1226 fo->flags |= FO_NOREPLACE;
1228 case 'p': /* use portable data format */
1229 fo->flags |= FO_PORTABLE;
1231 case 'R': /* Resource forks and Finder Info */
1232 fo->flags |= FO_HFSPLUS;
1233 case 'r': /* read fifo */
1234 fo->flags |= FO_READFIFO;
1239 fo->flags |= FO_SHA1;
1244 fo->flags |= FO_SHA256;
1248 fo->flags |= FO_SHA512;
1254 * If 2 or 3 is seen here, SHA2 is not configured, so
1255 * eat the option, and drop back to SHA-1.
1257 if (p[1] == '2' || p[1] == '3') {
1260 fo->flags |= FO_SHA1;
1265 fo->flags |= FO_SPARSE;
1268 fo->flags |= FO_MTIMEONLY;
1271 fo->flags |= FO_KEEPATIME;
1274 fo->flags |= FO_ACL;
1276 case 'V': /* verify options */
1277 /* Copy Verify Options */
1278 for (j=0; *p && *p != ':'; p++) {
1279 fo->VerifyOpts[j] = *p;
1280 if (j < (int)sizeof(fo->VerifyOpts) - 1) {
1284 fo->VerifyOpts[j] = 0;
1286 case 'C': /* accurate options */
1287 /* Copy Accurate Options */
1288 for (j=0; *p && *p != ':'; p++) {
1289 fo->AccurateOpts[j] = *p;
1290 if (j < (int)sizeof(fo->AccurateOpts) - 1) {
1294 fo->AccurateOpts[j] = 0;
1296 case 'J': /* Basejob options */
1297 /* Copy BaseJob Options */
1298 for (j=0; *p && *p != ':'; p++) {
1299 fo->BaseJobOpts[j] = *p;
1300 if (j < (int)sizeof(fo->BaseJobOpts) - 1) {
1304 fo->BaseJobOpts[j] = 0;
1306 case 'P': /* strip path */
1309 for (j=0; *p && *p != ':'; p++) {
1311 if (j < (int)sizeof(strip) - 1) {
1316 fo->strip_path = atoi(strip);
1317 fo->flags |= FO_STRIPPATH;
1318 Dmsg2(100, "strip=%s strip_path=%d\n", strip, fo->strip_path);
1321 fo->flags |= FO_IF_NEWER;
1324 fo->flags |= FO_ENHANCEDWILD;
1326 case 'Z': /* gzip compression */
1327 fo->flags |= FO_GZIP;
1328 fo->GZIP_level = *++p - '0';
1331 fo->flags |= FO_NOATIME;
1334 fo->flags |= FO_CHKCHANGES;
1337 fo->flags |= FO_HONOR_NODUMP;
1340 fo->flags |= FO_XATTR;
1343 Emsg1(M_ERROR, 0, _("Unknown include/exclude option: %c\n"), *p);
1347 return state_options;
1352 * Director is passing his Fileset
1354 static int fileset_cmd(JCR *jcr)
1356 BSOCK *dir = jcr->dir_bsock;
1359 #if defined(WIN32_VSS)
1362 sscanf(dir->msg, "fileset vss=%d", &vss);
1366 if (!init_fileset(jcr)) {
1369 while (dir->recv() >= 0) {
1370 strip_trailing_junk(dir->msg);
1371 Dmsg1(500, "Fileset: %s\n", dir->msg);
1372 add_fileset(jcr, dir->msg);
1374 if (!term_fileset(jcr)) {
1377 rtnstat = dir->fsend(OKinc);
1378 generate_plugin_event(jcr, bEventEndFileSet);
1382 static void free_bootstrap(JCR *jcr)
1384 if (jcr->RestoreBootstrap) {
1385 unlink(jcr->RestoreBootstrap);
1386 free_pool_memory(jcr->RestoreBootstrap);
1387 jcr->RestoreBootstrap = NULL;
1392 static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER;
1393 static uint32_t bsr_uniq = 0;
1396 * The Director sends us the bootstrap file, which
1397 * we will in turn pass to the SD.
1398 * Deprecated. The bsr is now sent directly from the
1399 * Director to the SD.
1401 static int bootstrap_cmd(JCR *jcr)
1403 BSOCK *dir = jcr->dir_bsock;
1404 POOLMEM *fname = get_pool_memory(PM_FNAME);
1407 free_bootstrap(jcr);
1410 Mmsg(fname, "%s/%s.%s.%d.bootstrap", me->working_directory, me->hdr.name,
1411 jcr->Job, bsr_uniq);
1413 Dmsg1(400, "bootstrap=%s\n", fname);
1414 jcr->RestoreBootstrap = fname;
1415 bs = fopen(fname, "a+b"); /* create file */
1418 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
1419 jcr->RestoreBootstrap, be.bstrerror());
1421 * Suck up what he is sending to us so that he will then
1422 * read our error message.
1424 while (dir->recv() >= 0)
1426 free_bootstrap(jcr);
1427 set_jcr_job_status(jcr, JS_ErrorTerminated);
1431 while (dir->recv() >= 0) {
1432 Dmsg1(200, "filed<dird: bootstrap: %s", dir->msg);
1433 fputs(dir->msg, bs);
1437 * Note, do not free the bootstrap yet -- it needs to be
1440 return dir->fsend(OKbootstrap);
1445 * Get backup level from Director
1448 static int level_cmd(JCR *jcr)
1450 BSOCK *dir = jcr->dir_bsock;
1451 POOLMEM *level, *buf = NULL;
1454 level = get_memory(dir->msglen+1);
1455 Dmsg1(100, "level_cmd: %s", dir->msg);
1457 /* keep compatibility with older directors */
1458 if (strstr(dir->msg, "accurate")) {
1459 jcr->accurate = true;
1461 if (sscanf(dir->msg, "level = %s ", level) != 1) {
1464 /* Base backup requested? */
1465 if (strcmp(level, "base") == 0) {
1466 jcr->set_JobLevel(L_BASE);
1467 /* Full backup requested? */
1468 } else if (strcmp(level, "full") == 0) {
1469 jcr->set_JobLevel(L_FULL);
1470 } else if (strstr(level, "differential")) {
1471 jcr->set_JobLevel(L_DIFFERENTIAL);
1474 } else if (strstr(level, "incremental")) {
1475 jcr->set_JobLevel(L_INCREMENTAL);
1479 * We get his UTC since time, then sync the clocks and correct it
1480 * to agree with our clock.
1482 } else if (strcmp(level, "since_utime") == 0) {
1483 buf = get_memory(dir->msglen+1);
1484 utime_t since_time, adj;
1485 btime_t his_time, bt_start, rt=0, bt_adj=0;
1486 if (jcr->getJobLevel() == L_NONE) {
1487 jcr->set_JobLevel(L_SINCE); /* if no other job level set, do it now */
1489 if (sscanf(dir->msg, "level = since_utime %s mtime_only=%d",
1490 buf, &mtime_only) != 2) {
1493 since_time = str_to_uint64(buf); /* this is the since time */
1494 Dmsg1(100, "since_time=%lld\n", since_time);
1495 char ed1[50], ed2[50];
1497 * Sync clocks by polling him for the time. We take
1498 * 10 samples of his time throwing out the first two.
1500 for (int i=0; i<10; i++) {
1501 bt_start = get_current_btime();
1502 dir->signal(BNET_BTIME); /* poll for time */
1503 if (dir->recv() <= 0) { /* get response */
1506 if (sscanf(dir->msg, "btime %s", buf) != 1) {
1509 if (i < 2) { /* toss first two results */
1512 his_time = str_to_uint64(buf);
1513 rt = get_current_btime() - bt_start; /* compute round trip time */
1514 Dmsg2(100, "Dirtime=%s FDtime=%s\n", edit_uint64(his_time, ed1),
1515 edit_uint64(bt_start, ed2));
1516 bt_adj += bt_start - his_time - rt/2;
1517 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1520 bt_adj = bt_adj / 8; /* compute average time */
1521 Dmsg2(100, "rt=%s adj=%s\n", edit_uint64(rt, ed1), edit_uint64(bt_adj, ed2));
1522 adj = btime_to_utime(bt_adj);
1523 since_time += adj; /* adjust for clock difference */
1524 /* Don't notify if time within 3 seconds */
1525 if (adj > 3 || adj < -3) {
1527 if (adj > 600 || adj < -600) {
1532 Jmsg(jcr, type, 0, _("DIR and FD clocks differ by %lld seconds, FD automatically compensating.\n"), adj);
1534 dir->signal(BNET_EOD);
1536 Dmsg2(100, "adj=%lld since_time=%lld\n", adj, since_time);
1537 jcr->incremental = 1; /* set incremental or decremental backup */
1538 jcr->mtime = since_time; /* set since time */
1539 generate_plugin_event(jcr, bEventSince, (void *)(time_t)jcr->mtime);
1541 Jmsg1(jcr, M_FATAL, 0, _("Unknown backup level: %s\n"), level);
1549 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1550 return dir->fsend(OKlevel);
1553 pm_strcpy(jcr->errmsg, dir->msg);
1554 Jmsg1(jcr, M_FATAL, 0, _("Bad level command: %s\n"), jcr->errmsg);
1563 * Get session parameters from Director -- this is for a Restore command
1564 * This is deprecated. It is now passed via the bsr.
1566 static int session_cmd(JCR *jcr)
1568 BSOCK *dir = jcr->dir_bsock;
1570 Dmsg1(100, "SessionCmd: %s", dir->msg);
1571 if (sscanf(dir->msg, sessioncmd, jcr->VolumeName,
1572 &jcr->VolSessionId, &jcr->VolSessionTime,
1573 &jcr->StartFile, &jcr->EndFile,
1574 &jcr->StartBlock, &jcr->EndBlock) != 7) {
1575 pm_strcpy(jcr->errmsg, dir->msg);
1576 Jmsg(jcr, M_FATAL, 0, _("Bad session command: %s"), jcr->errmsg);
1580 return dir->fsend(OKsession);
1583 static void set_storage_auth_key(JCR *jcr, char *key)
1585 /* if no key don't update anything */
1591 * We can be contacting multiple storage daemons.
1592 * So, make sure that any old jcr->store_bsock is cleaned up.
1594 if (jcr->store_bsock) {
1595 jcr->store_bsock->destroy();
1596 jcr->store_bsock = NULL;
1600 * We can be contacting multiple storage daemons.
1601 * So, make sure that any old jcr->sd_auth_key is cleaned up.
1603 if (jcr->sd_auth_key) {
1605 * If we already have a Authorization key, director can do multi
1608 Dmsg0(5, "set multi_restore=true\n");
1609 jcr->multi_restore = true;
1610 bfree(jcr->sd_auth_key);
1613 jcr->sd_auth_key = bstrdup(key);
1614 Dmsg0(5, "set sd auth key\n");
1618 * Get address of storage daemon from Director
1621 static int storage_cmd(JCR *jcr)
1623 int stored_port; /* storage daemon port */
1624 int enable_ssl; /* enable ssl to sd */
1625 POOL_MEM sd_auth_key(PM_MESSAGE);
1626 BSOCK *dir = jcr->dir_bsock;
1627 BSOCK *sd = new_bsock(); /* storage daemon bsock */
1630 Dmsg1(100, "StorageCmd: %s", dir->msg);
1631 sd_auth_key.check_size(dir->msglen);
1632 if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port,
1633 &enable_ssl, sd_auth_key.c_str()) != 4) {
1634 if (sscanf(dir->msg, storaddr_v1, &jcr->stored_addr,
1635 &stored_port, &enable_ssl) != 3) {
1636 pm_strcpy(jcr->errmsg, dir->msg);
1637 Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg);
1642 set_storage_auth_key(jcr, sd_auth_key.c_str());
1644 Dmsg3(110, "Open storage: %s:%d ssl=%d\n", jcr->stored_addr, stored_port,
1646 /* Open command communications with Storage daemon */
1647 /* Try to connect for 1 hour at 10 second intervals */
1649 sd->set_source_address(me->FDsrc_addr);
1650 if (!sd->connect(jcr, 10, (int)me->SDConnectTimeout, me->heartbeat_interval,
1651 _("Storage daemon"), jcr->stored_addr, NULL, stored_port, 1)) {
1657 Jmsg(jcr, M_FATAL, 0, _("Failed to connect to Storage daemon: %s:%d\n"),
1658 jcr->stored_addr, stored_port);
1659 Dmsg2(100, "Failed to connect to Storage daemon: %s:%d\n",
1660 jcr->stored_addr, stored_port);
1663 Dmsg0(110, "Connection OK to SD.\n");
1665 jcr->store_bsock = sd;
1667 sd->fsend("Hello Start Job %s\n", jcr->Job);
1668 if (!authenticate_storagedaemon(jcr)) {
1669 Jmsg(jcr, M_FATAL, 0, _("Failed to authenticate Storage daemon.\n"));
1672 Dmsg0(110, "Authenticated with SD.\n");
1674 /* Send OK to Director */
1675 return dir->fsend(OKstore);
1678 dir->fsend(BADcmd, "storage");
1687 static int backup_cmd(JCR *jcr)
1689 BSOCK *dir = jcr->dir_bsock;
1690 BSOCK *sd = jcr->store_bsock;
1694 #if defined(WIN32_VSS)
1695 // capture state here, if client is backed up by multiple directors
1696 // and one enables vss and the other does not then enable_vss can change
1697 // between here and where its evaluated after the job completes.
1698 jcr->VSS = g_pVSSClient && enable_vss;
1700 /* Run only one at a time */
1706 * Validate some options given to the backup make sense for the compiled in
1707 * options of this filed.
1709 if (jcr->ff->flags & FO_ACL && !have_acl) {
1710 Jmsg(jcr, M_FATAL, 0, _("ACL support not configured for your machine.\n"));
1713 if (jcr->ff->flags & FO_XATTR && !have_xattr) {
1714 Jmsg(jcr, M_FATAL, 0, _("XATTR support not configured for your machine.\n"));
1718 set_jcr_job_status(jcr, JS_Blocked);
1719 jcr->set_JobType(JT_BACKUP);
1720 Dmsg1(100, "begin backup ff=%p\n", jcr->ff);
1723 Jmsg(jcr, M_FATAL, 0, _("Cannot contact Storage daemon\n"));
1724 dir->fsend(BADcmd, "backup");
1728 dir->fsend(OKbackup);
1729 Dmsg1(110, "filed>dird: %s", dir->msg);
1732 * Send Append Open Session to Storage daemon
1734 sd->fsend(append_open);
1735 Dmsg1(110, ">stored: %s", sd->msg);
1737 * Expect to receive back the Ticket number
1739 if (bget_msg(sd) >= 0) {
1740 Dmsg1(110, "<stored: %s", sd->msg);
1741 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
1742 Jmsg(jcr, M_FATAL, 0, _("Bad response to append open: %s\n"), sd->msg);
1745 Dmsg1(110, "Got Ticket=%d\n", jcr->Ticket);
1747 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to open command\n"));
1752 * Send Append data command to Storage daemon
1754 sd->fsend(append_data, jcr->Ticket);
1755 Dmsg1(110, ">stored: %s", sd->msg);
1758 * Expect to get OK data
1760 Dmsg1(110, "<stored: %s", sd->msg);
1761 if (!response(jcr, sd, OK_data, "Append Data")) {
1765 generate_daemon_event(jcr, "JobStart");
1766 generate_plugin_event(jcr, bEventStartBackupJob);
1768 #if defined(WIN32_VSS)
1769 /* START VSS ON WIN32 */
1771 if (g_pVSSClient->InitializeForBackup(jcr)) {
1772 generate_plugin_event(jcr, bEventVssBackupAddComponents);
1773 /* tell vss which drives to snapshot */
1774 char szWinDriveLetters[27];
1775 if (get_win32_driveletters(jcr->ff, szWinDriveLetters)) {
1776 Jmsg(jcr, M_INFO, 0, _("Generate VSS snapshots. Driver=\"%s\", Drive(s)=\"%s\"\n"), g_pVSSClient->GetDriverName(), szWinDriveLetters);
1777 if (!g_pVSSClient->CreateSnapshots(szWinDriveLetters)) {
1778 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshots failed.\n"));
1781 /* tell user if snapshot creation of a specific drive failed */
1783 for (i=0; i < (int)strlen(szWinDriveLetters); i++) {
1784 if (islower(szWinDriveLetters[i])) {
1785 Jmsg(jcr, M_WARNING, 0, _("Generate VSS snapshot of drive \"%c:\\\" failed. VSS support is disabled on this drive.\n"), szWinDriveLetters[i]);
1789 /* inform user about writer states */
1790 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++)
1791 if (g_pVSSClient->GetWriterState(i) < 1) {
1792 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PrepareForBackup): %s\n"), g_pVSSClient->GetWriterInfo(i));
1797 Jmsg(jcr, M_INFO, 0, _("No drive letters found for generating VSS snapshots.\n"));
1801 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
1803 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
1808 * Send Files to Storage daemon
1810 Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff);
1811 if (!blast_data_to_storage_daemon(jcr, NULL)) {
1812 set_jcr_job_status(jcr, JS_ErrorTerminated);
1813 bnet_suppress_error_messages(sd, 1);
1814 Dmsg0(110, "Error in blast_data.\n");
1816 set_jcr_job_status(jcr, JS_Terminated);
1817 /* Note, the above set status will not override an error */
1818 if (!(jcr->JobStatus == JS_Terminated || jcr->JobStatus == JS_Warnings)) {
1819 bnet_suppress_error_messages(sd, 1);
1820 goto cleanup; /* bail out now */
1823 * Expect to get response to append_data from Storage daemon
1825 if (!response(jcr, sd, OK_append, "Append Data")) {
1826 set_jcr_job_status(jcr, JS_ErrorTerminated);
1831 * Send Append End Data to Storage daemon
1833 sd->fsend(append_end, jcr->Ticket);
1835 if (!response(jcr, sd, OK_end, "Append End")) {
1836 set_jcr_job_status(jcr, JS_ErrorTerminated);
1841 * Send Append Close to Storage daemon
1843 sd->fsend(append_close, jcr->Ticket);
1844 while (bget_msg(sd) >= 0) { /* stop on signal or error */
1845 if (sscanf(sd->msg, OK_close, &SDJobStatus) == 1) {
1847 Dmsg2(200, "SDJobStatus = %d %c\n", SDJobStatus, (char)SDJobStatus);
1851 Jmsg(jcr, M_FATAL, 0, _("Append Close with SD failed.\n"));
1854 if (!(SDJobStatus == JS_Terminated || SDJobStatus == JS_Warnings)) {
1855 Jmsg(jcr, M_FATAL, 0, _("Bad status %d returned from Storage Daemon.\n"),
1861 #if defined(WIN32_VSS)
1863 Win32ConvCleanupCache();
1868 generate_plugin_event(jcr, bEventEndBackupJob);
1869 return 0; /* return and stop command loop */
1873 * Do a Verify for Director
1876 static int verify_cmd(JCR *jcr)
1878 BSOCK *dir = jcr->dir_bsock;
1879 BSOCK *sd = jcr->store_bsock;
1882 jcr->set_JobType(JT_VERIFY);
1883 if (sscanf(dir->msg, verifycmd, level) != 1) {
1884 dir->fsend(_("2994 Bad verify command: %s\n"), dir->msg);
1888 if (strcasecmp(level, "init") == 0) {
1889 jcr->set_JobLevel(L_VERIFY_INIT);
1890 } else if (strcasecmp(level, "catalog") == 0){
1891 jcr->set_JobLevel(L_VERIFY_CATALOG);
1892 } else if (strcasecmp(level, "volume") == 0){
1893 jcr->set_JobLevel(L_VERIFY_VOLUME_TO_CATALOG);
1894 } else if (strcasecmp(level, "data") == 0){
1895 jcr->set_JobLevel(L_VERIFY_DATA);
1896 } else if (strcasecmp(level, "disk_to_catalog") == 0) {
1897 jcr->set_JobLevel(L_VERIFY_DISK_TO_CATALOG);
1899 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1903 dir->fsend(OKverify);
1905 generate_daemon_event(jcr, "JobStart");
1906 generate_plugin_event(jcr, bEventLevel, (void *)jcr->getJobLevel());
1907 generate_plugin_event(jcr, bEventStartVerifyJob);
1909 Dmsg1(110, "filed>dird: %s", dir->msg);
1911 switch (jcr->getJobLevel()) {
1913 case L_VERIFY_CATALOG:
1916 case L_VERIFY_VOLUME_TO_CATALOG:
1917 if (!open_sd_read_session(jcr)) {
1920 start_dir_heartbeat(jcr);
1921 do_verify_volume(jcr);
1922 stop_dir_heartbeat(jcr);
1924 * Send Close session command to Storage daemon
1926 sd->fsend(read_close, jcr->Ticket);
1927 Dmsg1(130, "filed>stored: %s", sd->msg);
1929 /* ****FIXME**** check response */
1930 bget_msg(sd); /* get OK */
1932 /* Inform Storage daemon that we are done */
1933 sd->signal(BNET_TERMINATE);
1936 case L_VERIFY_DISK_TO_CATALOG:
1940 dir->fsend(_("2994 Bad verify level: %s\n"), dir->msg);
1944 dir->signal(BNET_EOD);
1945 generate_plugin_event(jcr, bEventEndVerifyJob);
1946 return 0; /* return and terminate command loop */
1950 static bool vss_restore_init_callback(JCR *jcr, int init_type)
1952 switch (init_type) {
1953 case VSS_INIT_RESTORE_AFTER_INIT:
1954 generate_plugin_event(jcr, bEventVssRestoreLoadComponentMetadata);
1956 case VSS_INIT_RESTORE_AFTER_GATHER:
1957 generate_plugin_event(jcr, bEventVssRestoreSetComponentsSelected);
1967 * Do a Restore for Director
1970 static int restore_cmd(JCR *jcr)
1972 BSOCK *dir = jcr->dir_bsock;
1973 BSOCK *sd = jcr->store_bsock;
1975 bool use_regexwhere=false;
1980 * Scan WHERE (base directory for restore) from command
1982 Dmsg0(100, "restore command\n");
1983 #if defined(WIN32_VSS)
1985 /* TODO: this should be given from the director */
1988 Dmsg2(50, "g_pVSSClient = %p, enable_vss = %d\n", g_pVSSClient, enable_vss);
1989 // capture state here, if client is backed up by multiple directors
1990 // and one enables vss and the other does not then enable_vss can change
1991 // between here and where its evaluated after the job completes.
1992 jcr->VSS = g_pVSSClient && enable_vss;
1994 /* Run only one at a time */
1998 /* Pickup where string */
1999 args = get_memory(dir->msglen+1);
2002 if (sscanf(dir->msg, restorecmd, &replace, &prefix_links, args) != 3) {
2003 if (sscanf(dir->msg, restorecmdR, &replace, &prefix_links, args) != 3){
2004 if (sscanf(dir->msg, restorecmd1, &replace, &prefix_links) != 2) {
2005 pm_strcpy(jcr->errmsg, dir->msg);
2006 Jmsg(jcr, M_FATAL, 0, _("Bad replace command. CMD=%s\n"), jcr->errmsg);
2011 use_regexwhere = true;
2013 /* Turn / into nothing */
2014 if (IsPathSeparator(args[0]) && args[1] == '\0') {
2018 Dmsg2(150, "Got replace %c, where=%s\n", replace, args);
2019 unbash_spaces(args);
2021 if (use_regexwhere) {
2022 jcr->where_bregexp = get_bregexps(args);
2023 if (!jcr->where_bregexp) {
2024 Jmsg(jcr, M_FATAL, 0, _("Bad where regexp. where=%s\n"), args);
2025 free_pool_memory(args);
2029 jcr->where = bstrdup(args);
2032 free_pool_memory(args);
2033 jcr->replace = replace;
2034 jcr->prefix_links = prefix_links;
2036 dir->fsend(OKrestore);
2037 Dmsg1(110, "filed>dird: %s", dir->msg);
2039 jcr->set_JobType(JT_RESTORE);
2041 set_jcr_job_status(jcr, JS_Blocked);
2043 if (!open_sd_read_session(jcr)) {
2044 set_jcr_job_status(jcr, JS_ErrorTerminated);
2048 set_jcr_job_status(jcr, JS_Running);
2051 * Do restore of files and data
2053 start_dir_heartbeat(jcr);
2054 generate_daemon_event(jcr, "JobStart");
2055 generate_plugin_event(jcr, bEventStartRestoreJob);
2057 #if defined(WIN32_VSS)
2058 /* START VSS ON WIN32 */
2060 if (g_pVSSClient->InitializeForRestore(jcr, vss_restore_init_callback,
2061 (WCHAR *)jcr->job_metadata)) {
2062 /* inform user about writer states */
2064 for (i=0; i < (int)g_pVSSClient->GetWriterCount(); i++) {
2065 int msg_type = M_INFO;
2066 if (g_pVSSClient->GetWriterState(i) < 1) {
2067 msg_type = M_WARNING;
2070 if (g_pVSSClient->GetWriterState(i) < 1) {
2071 Jmsg(jcr, M_WARNING, 0, _("VSS Writer (PreRestore): %s\n"), g_pVSSClient->GetWriterInfo(i));
2077 Jmsg(jcr, M_WARNING, 0, _("VSS was not initialized properly. VSS support is disabled. ERR=%s\n"), be.bstrerror());
2079 free_and_null_pool_memory(jcr->job_metadata);
2080 run_scripts(jcr, jcr->RunScripts, "ClientAfterVSS");
2085 stop_dir_heartbeat(jcr);
2087 set_jcr_job_status(jcr, JS_Terminated);
2088 if (jcr->JobStatus != JS_Terminated) {
2089 bnet_suppress_error_messages(sd, 1);
2093 * Send Close session command to Storage daemon
2095 sd->fsend(read_close, jcr->Ticket);
2096 Dmsg1(100, "filed>stored: %s", sd->msg);
2098 bget_msg(sd); /* get OK */
2100 /* Inform Storage daemon that we are done */
2101 sd->signal(BNET_TERMINATE);
2103 #if defined(WIN32_VSS)
2104 /* STOP VSS ON WIN32 */
2105 /* tell vss to close the restore session */
2106 Dmsg0(0, "About to call CloseRestore\n");
2108 Dmsg0(0, "Really about to call CloseRestore\n");
2109 if (g_pVSSClient->CloseRestore()) {
2110 Dmsg0(0, "CloseRestore success\n");
2111 /* inform user about writer states */
2112 for (int i=0; i<(int)g_pVSSClient->GetWriterCount(); i++) {
2113 int msg_type = M_INFO;
2114 if (g_pVSSClient->GetWriterState(i) < 1) {
2115 msg_type = M_WARNING;
2118 Jmsg(jcr, msg_type, 0, _("VSS Writer (RestoreComplete): %s\n"), g_pVSSClient->GetWriterInfo(i));
2122 Dmsg1(0, "CloseRestore fail - %08x\n", errno);
2128 bfree_and_null(jcr->where);
2130 if (jcr->JobErrors) {
2131 set_jcr_job_status(jcr, JS_ErrorTerminated);
2134 Dmsg0(100, "Done in job.c\n");
2137 if (jcr->multi_restore) {
2138 Dmsg0(100, OKstoreend);
2139 dir->fsend(OKstoreend);
2140 ret = 1; /* we continue the loop, waiting for next part */
2142 end_restore_cmd(jcr);
2143 ret = 0; /* we stop here */
2149 static int end_restore_cmd(JCR *jcr)
2151 Dmsg0(5, "end_restore_cmd\n");
2152 generate_plugin_event(jcr, bEventEndRestoreJob);
2153 return 0; /* return and terminate command loop */
2156 static int open_sd_read_session(JCR *jcr)
2158 BSOCK *sd = jcr->store_bsock;
2161 Jmsg(jcr, M_FATAL, 0, _("Improper calling sequence.\n"));
2164 Dmsg4(120, "VolSessId=%ld VolsessT=%ld SF=%ld EF=%ld\n",
2165 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile);
2166 Dmsg2(120, "JobId=%d vol=%s\n", jcr->JobId, "DummyVolume");
2168 * Open Read Session with Storage daemon
2170 sd->fsend(read_open, "DummyVolume",
2171 jcr->VolSessionId, jcr->VolSessionTime, jcr->StartFile, jcr->EndFile,
2172 jcr->StartBlock, jcr->EndBlock);
2173 Dmsg1(110, ">stored: %s", sd->msg);
2178 if (bget_msg(sd) >= 0) {
2179 Dmsg1(110, "filed<stored: %s", sd->msg);
2180 if (sscanf(sd->msg, OK_open, &jcr->Ticket) != 1) {
2181 Jmsg(jcr, M_FATAL, 0, _("Bad response to SD read open: %s\n"), sd->msg);
2184 Dmsg1(110, "filed: got Ticket=%d\n", jcr->Ticket);
2186 Jmsg(jcr, M_FATAL, 0, _("Bad response from stored to read open command\n"));
2190 if (!send_bootstrap_file(jcr)) {
2195 * Start read of data with Storage daemon
2197 sd->fsend(read_data, jcr->Ticket);
2198 Dmsg1(110, ">stored: %s", sd->msg);
2203 if (!response(jcr, sd, OK_data, "Read Data")) {
2210 * Destroy the Job Control Record and associated
2211 * resources (sockets).
2213 static void filed_free_jcr(JCR *jcr)
2215 if (jcr->store_bsock) {
2216 jcr->store_bsock->close();
2218 free_bootstrap(jcr);
2219 if (jcr->last_fname) {
2220 free_pool_memory(jcr->last_fname);
2222 free_runscripts(jcr->RunScripts);
2223 delete jcr->RunScripts;
2225 if (jcr->JobId != 0)
2226 write_state_file(me->working_directory, "bacula-fd", get_first_port_host_order(me->FDaddrs));
2232 * Get response from Storage daemon to a command we
2233 * sent. Check that the response is OK.
2235 * Returns: 0 on failure
2238 int response(JCR *jcr, BSOCK *sd, char *resp, const char *cmd)
2243 if (bget_msg(sd) > 0) {
2244 Dmsg0(110, sd->msg);
2245 if (strcmp(sd->msg, resp) == 0) {
2249 if (job_canceled(jcr)) {
2250 return 0; /* if canceled avoid useless error messages */
2252 if (is_bnet_error(sd)) {
2253 Jmsg2(jcr, M_FATAL, 0, _("Comm error with SD. bad response to %s. ERR=%s\n"),
2254 cmd, bnet_strerror(sd));
2256 Jmsg3(jcr, M_FATAL, 0, _("Bad response to %s command. Wanted %s, got %s\n"),
2257 cmd, resp, sd->msg);
2262 static int send_bootstrap_file(JCR *jcr)
2266 BSOCK *sd = jcr->store_bsock;
2267 const char *bootstrap = "bootstrap\n";
2270 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
2271 if (!jcr->RestoreBootstrap) {
2274 bs = fopen(jcr->RestoreBootstrap, "rb");
2277 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
2278 jcr->RestoreBootstrap, be.bstrerror());
2279 set_jcr_job_status(jcr, JS_ErrorTerminated);
2282 sd->msglen = pm_strcpy(sd->msg, bootstrap);
2284 while (fgets(buf, sizeof(buf), bs)) {
2285 sd->msglen = Mmsg(sd->msg, "%s", buf);
2288 sd->signal(BNET_EOD);
2290 if (!response(jcr, sd, OKSDbootstrap, "Bootstrap")) {
2291 set_jcr_job_status(jcr, JS_ErrorTerminated);
2297 free_bootstrap(jcr);