2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 John Walker.
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.
30 * Bacula Director -- fd_cmds.c -- send commands to File daemon
32 * Kern Sibbald, October MM
34 * This routine is run as a separate thread. There may be more
35 * work to be done to make it totally reentrant!!!!
37 * Utility functions for sending info to File Daemon.
38 * These functions are used by both backup and verify.
45 #include "findlib/find.h"
47 const int dbglvl = 400;
49 /* Commands sent to File daemon */
50 static char filesetcmd[] = "fileset%s\n"; /* set full fileset */
51 static char jobcmd[] = "JobId=%s Job=%s SDid=%u SDtime=%u Authorization=%s\n";
52 /* Note, mtime_only is not used here -- implemented as file option */
53 static char levelcmd[] = "level = %s%s mtime_only=%d\n";
54 static char runscript[] = "Run OnSuccess=%u OnFailure=%u AbortOnError=%u When=%u Command=%s\n";
55 static char runbeforenow[]= "RunBeforeNow\n";
57 /* Responses received from File daemon */
58 static char OKinc[] = "2000 OK include\n";
59 static char OKjob[] = "2000 OK Job";
60 static char OKlevel[] = "2000 OK level\n";
61 static char OKRunScript[] = "2000 OK RunScript\n";
62 static char OKRunBeforeNow[] = "2000 OK RunBeforeNow\n";
64 /* Forward referenced functions */
65 static bool send_list_item(JCR *jcr, const char *code, char *item, BSOCK *fd);
67 /* External functions */
68 extern DIRRES *director;
69 extern int FDConnectTimeout;
75 * Open connection with File daemon.
76 * Try connecting every retry_interval (default 10 sec), and
77 * give up after max_retry_time (default 30 mins).
80 int connect_to_file_daemon(JCR *jcr, int retry_interval, int max_retry_time,
87 if (jcr->client->heartbeat_interval) {
88 heart_beat = jcr->client->heartbeat_interval;
90 heart_beat = director->heartbeat_interval;
93 if (!jcr->file_bsock) {
94 char name[MAX_NAME_LENGTH + 100];
95 bstrncpy(name, _("Client: "), sizeof(name));
96 bstrncat(name, jcr->client->name(), sizeof(name));
97 fd = bnet_connect(jcr, retry_interval, max_retry_time, heart_beat,
98 name, jcr->client->address, NULL, jcr->client->FDport, verbose);
100 set_jcr_job_status(jcr, JS_ErrorTerminated);
103 Dmsg0(10, "Opened connection with File daemon\n");
105 fd = jcr->file_bsock; /* use existing connection */
107 fd->res = (RES *)jcr->client; /* save resource in BSOCK */
108 jcr->file_bsock = fd;
109 set_jcr_job_status(jcr, JS_Running);
111 if (!authenticate_file_daemon(jcr)) {
112 set_jcr_job_status(jcr, JS_ErrorTerminated);
117 * Now send JobId and authorization key
119 fd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job, jcr->VolSessionId,
120 jcr->VolSessionTime, jcr->sd_auth_key);
121 if (strcmp(jcr->sd_auth_key, "dummy") != 0) {
122 memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
124 Dmsg1(100, ">filed: %s", fd->msg);
125 if (bget_dirmsg(fd) > 0) {
126 Dmsg1(110, "<filed: %s", fd->msg);
127 if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
128 Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
129 jcr->client->hdr.name, fd->msg);
130 set_jcr_job_status(jcr, JS_ErrorTerminated);
132 } else if (jcr->db) {
134 memset(&cr, 0, sizeof(cr));
135 bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
136 cr.AutoPrune = jcr->client->AutoPrune;
137 cr.FileRetention = jcr->client->FileRetention;
138 cr.JobRetention = jcr->client->JobRetention;
139 bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
140 if (!db_update_client_record(jcr, jcr->db, &cr)) {
141 Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
142 db_strerror(jcr->db));
146 Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
148 set_jcr_job_status(jcr, JS_ErrorTerminated);
155 * This subroutine edits the last job start time into a
156 * "since=date/time" buffer that is returned in the
157 * variable since. This is used for display purposes in
158 * the job report. The time in jcr->stime is later
159 * passed to tell the File daemon what to do.
161 void get_level_since_time(JCR *jcr, char *since, int since_len)
166 /* If job cloned and a since time already given, use it */
167 if (jcr->cloned && jcr->stime && jcr->stime[0]) {
168 bstrncpy(since, _(", since="), since_len);
169 bstrncat(since, jcr->stime, since_len);
172 /* Make sure stime buffer is allocated */
174 jcr->stime = get_pool_memory(PM_MESSAGE);
177 /* Lookup the last FULL backup job to get the time/date for a
178 * differential or incremental save.
180 switch (jcr->JobLevel) {
183 /* Look up start time of last job */
184 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
185 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
186 /* No job found, so upgrade this one to Full */
187 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
188 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found in catalog. Doing FULL backup.\n"));
189 bsnprintf(since, since_len, _(" (upgraded from %s)"),
190 level_to_str(jcr->JobLevel));
191 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
193 if (jcr->job->rerun_failed_levels) {
194 if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr, jcr->stime, JobLevel)) {
195 Jmsg(jcr, M_INFO, 0, _("Prior failed job found in catalog. Upgrading to %s.\n"),
196 level_to_str(JobLevel));
197 bsnprintf(since, since_len, _(" (upgraded from %s)"),
198 level_to_str(jcr->JobLevel));
199 jcr->JobLevel = jcr->jr.JobLevel = JobLevel;
200 jcr->jr.JobId = jcr->JobId;
204 bstrncpy(since, _(", since="), since_len);
205 bstrncat(since, jcr->stime, since_len);
207 jcr->jr.JobId = jcr->JobId;
210 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
213 static void send_since_time(JCR *jcr)
215 BSOCK *fd = jcr->file_bsock;
219 stime = str_to_utime(jcr->stime);
220 fd->fsend(levelcmd, NT_("since_utime "), edit_uint64(stime, ed1), 0);
221 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
222 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
228 * Send level command to FD.
229 * Used for backup jobs and estimate command.
231 bool send_level_command(JCR *jcr)
233 BSOCK *fd = jcr->file_bsock;
235 * Send Level command to File daemon
237 switch (jcr->JobLevel) {
239 fd->fsend(levelcmd, "base", " ", 0);
241 /* L_NONE is the console, sending something off to the FD */
244 fd->fsend(levelcmd, "full", " ", 0);
247 fd->fsend(levelcmd, "differential", " ", 0);
248 send_since_time(jcr);
251 fd->fsend(levelcmd, "incremental", " ", 0);
252 send_since_time(jcr);
256 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
257 jcr->JobLevel, jcr->JobLevel);
260 Dmsg1(120, ">filed: %s", fd->msg);
261 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
268 * Send either an Included or an Excluded list to FD
270 static bool send_fileset(JCR *jcr)
272 FILESET *fileset = jcr->fileset;
273 BSOCK *fd = jcr->file_bsock;
279 num = fileset->num_includes;
281 num = fileset->num_excludes;
283 for (int i=0; i<num; i++) {
289 ie = fileset->include_items[i];
292 ie = fileset->exclude_items[i];
295 for (j=0; j<ie->num_opts; j++) {
296 FOPTS *fo = ie->opts_list[j];
297 fd->fsend("O %s\n", fo->opts);
299 bool enhanced_wild = false;
300 for (k=0; fo->opts[k]!='\0'; k++) {
301 if (fo->opts[k]=='W') {
302 enhanced_wild = true;
307 for (k=0; k<fo->regex.size(); k++) {
308 fd->fsend("R %s\n", fo->regex.get(k));
310 for (k=0; k<fo->regexdir.size(); k++) {
311 fd->fsend("RD %s\n", fo->regexdir.get(k));
313 for (k=0; k<fo->regexfile.size(); k++) {
314 fd->fsend("RF %s\n", fo->regexfile.get(k));
316 for (k=0; k<fo->wild.size(); k++) {
317 fd->fsend("W %s\n", fo->wild.get(k));
319 for (k=0; k<fo->wilddir.size(); k++) {
320 fd->fsend("WD %s\n", fo->wilddir.get(k));
322 for (k=0; k<fo->wildfile.size(); k++) {
323 fd->fsend("WF %s\n", fo->wildfile.get(k));
325 for (k=0; k<fo->wildbase.size(); k++) {
326 fd->fsend("W%c %s\n", enhanced_wild ? 'B' : 'F', fo->wildbase.get(k));
328 for (k=0; k<fo->base.size(); k++) {
329 fd->fsend("B %s\n", fo->base.get(k));
331 for (k=0; k<fo->fstype.size(); k++) {
332 fd->fsend("X %s\n", fo->fstype.get(k));
334 for (k=0; k<fo->drivetype.size(); k++) {
335 fd->fsend("XD %s\n", fo->drivetype.get(k));
338 fd->fsend("G %s\n", fo->plugin);
341 fd->fsend("D %s\n", fo->reader);
344 fd->fsend("T %s\n", fo->writer);
349 for (j=0; j<ie->name_list.size(); j++) {
350 item = (char *)ie->name_list.get(j);
351 if (!send_list_item(jcr, "F ", item, fd)) {
356 for (j=0; j<ie->plugin_list.size(); j++) {
357 item = (char *)ie->plugin_list.get(j);
358 if (!send_list_item(jcr, "P ", item, fd)) {
364 if (!include) { /* If we just did excludes */
365 break; /* all done */
367 include = false; /* Now do excludes */
370 fd->signal(BNET_EOD); /* end of data */
371 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
377 set_jcr_job_status(jcr, JS_ErrorTerminated);
382 static bool send_list_item(JCR *jcr, const char *code, char *item, BSOCK *fd)
392 p++; /* skip over the | */
393 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
394 bpipe = open_bpipe(fd->msg, 0, "r");
397 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
401 bstrncpy(buf, code, sizeof(buf));
402 Dmsg1(500, "code=%s\n", buf);
403 optlen = strlen(buf);
404 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
405 fd->msglen = Mmsg(fd->msg, "%s", buf);
406 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
407 if (!bnet_send(fd)) {
408 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
412 if ((stat=close_bpipe(bpipe)) != 0) {
414 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
415 p, be.bstrerror(stat));
420 p++; /* skip over < */
421 if ((ffd = fopen(p, "rb")) == NULL) {
423 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
427 bstrncpy(buf, code, sizeof(buf));
428 Dmsg1(500, "code=%s\n", buf);
429 optlen = strlen(buf);
430 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
431 fd->msglen = Mmsg(fd->msg, "%s", buf);
432 if (!bnet_send(fd)) {
433 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
440 p++; /* skip over \ */
441 /* Note, fall through wanted */
443 pm_strcpy(fd->msg, code);
444 fd->msglen = pm_strcat(fd->msg, p);
445 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
447 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
457 * Send include list to File daemon
459 bool send_include_list(JCR *jcr)
461 BSOCK *fd = jcr->file_bsock;
462 if (jcr->fileset->new_include) {
463 fd->fsend(filesetcmd, jcr->fileset->enable_vss ? " vss=1" : "");
464 return send_fileset(jcr);
471 * Send exclude list to File daemon
472 * Under the new scheme, the Exclude list
473 * is part of the FileSet sent with the
474 * "include_list" above.
476 bool send_exclude_list(JCR *jcr)
483 * Send bootstrap file if any to the socket given (FD or SD).
484 * This is used for restore, verify VolumeToCatalog, and
487 bool send_bootstrap_file(JCR *jcr, BSOCK *sock)
491 const char *bootstrap = "bootstrap\n";
493 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
494 if (!jcr->RestoreBootstrap) {
497 bs = fopen(jcr->RestoreBootstrap, "rb");
500 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
501 jcr->RestoreBootstrap, be.bstrerror());
502 set_jcr_job_status(jcr, JS_ErrorTerminated);
505 sock->fsend(bootstrap);
506 while (fgets(buf, sizeof(buf), bs)) {
507 sock->fsend("%s", buf);
509 sock->signal(BNET_EOD);
511 if (jcr->unlink_bsr) {
512 unlink(jcr->RestoreBootstrap);
513 jcr->unlink_bsr = false;
518 /* TODO: drop this with runscript.old_proto in bacula 1.42 */
519 static char runbefore[] = "RunBeforeJob %s\n";
520 static char runafter[] = "RunAfterJob %s\n";
521 static char OKRunBefore[] = "2000 OK RunBefore\n";
522 static char OKRunAfter[] = "2000 OK RunAfter\n";
524 int send_runscript_with_old_proto(JCR *jcr, int when, POOLMEM *msg)
527 Dmsg1(120, "bdird: sending old runcommand to fd '%s'\n",msg);
528 if (when & SCRIPT_Before) {
529 bnet_fsend(jcr->file_bsock, runbefore, msg);
530 ret = response(jcr, jcr->file_bsock, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR);
532 bnet_fsend(jcr->file_bsock, runafter, msg);
533 ret = response(jcr, jcr->file_bsock, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR);
539 * Send RunScripts to File daemon
540 * 1) We send all runscript to FD, they can be executed Before, After, or twice
541 * 2) Then, we send a "RunBeforeNow" command to the FD to tell him to do the
542 * first run_script() call. (ie ClientRunBeforeJob)
544 int send_runscripts_commands(JCR *jcr)
546 POOLMEM *msg = get_pool_memory(PM_FNAME);
547 BSOCK *fd = jcr->file_bsock;
549 bool launch_before_cmd = false;
550 POOLMEM *ehost = get_pool_memory(PM_FNAME);
553 Dmsg0(120, "bdird: sending runscripts to fd\n");
555 foreach_alist(cmd, jcr->job->RunScripts) {
556 if (cmd->can_run_at_level(jcr->JobLevel) && cmd->target) {
557 ehost = edit_job_codes(jcr, ehost, cmd->target, "");
558 Dmsg2(200, "bdird: runscript %s -> %s\n", cmd->target, ehost);
560 if (strcmp(ehost, jcr->client->name()) == 0) {
561 pm_strcpy(msg, cmd->command);
564 Dmsg1(120, "bdird: sending runscripts to fd '%s'\n", cmd->command);
566 /* TODO: remove this with bacula 1.42 */
567 if (cmd->old_proto) {
568 result = send_runscript_with_old_proto(jcr, cmd->when, msg);
571 fd->fsend(runscript, cmd->on_success,
577 result = response(jcr, fd, OKRunScript, "RunScript", DISPLAY_ERROR);
578 launch_before_cmd = true;
585 /* TODO : we have to play with other client */
588 send command to an other client
594 /* Tell the FD to execute the ClientRunBeforeJob */
595 if (launch_before_cmd) {
596 fd->fsend(runbeforenow);
597 if (!response(jcr, fd, OKRunBeforeNow, "RunBeforeNow", DISPLAY_ERROR)) {
601 free_pool_memory(msg);
602 free_pool_memory(ehost);
606 Jmsg(jcr, M_FATAL, 0, _("Client \"%s\" RunScript failed.\n"), ehost);
607 free_pool_memory(msg);
608 free_pool_memory(ehost);
615 * Read the attributes from the File daemon for
616 * a Verify job and store them in the catalog.
618 int get_attributes_and_put_in_catalog(JCR *jcr)
623 char digest[MAXSTRING];
625 fd = jcr->file_bsock;
626 jcr->jr.FirstIndex = 1;
628 /* Start transaction allocates jcr->attr and jcr->ar if needed */
629 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
632 Dmsg0(120, "bdird: waiting to receive file attributes\n");
633 /* Pickup file attributes and digest */
634 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
638 char Digest[MAXSTRING]; /* either Verify opts or MD5/SHA1 digest */
640 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
641 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Digest)) != 3) {
642 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
643 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
644 set_jcr_job_status(jcr, JS_ErrorTerminated);
648 /* The following three fields were sscanf'ed above so skip them */
649 skip_nonspaces(&p); /* skip FileIndex */
651 skip_nonspaces(&p); /* skip Stream */
653 skip_nonspaces(&p); /* skip Opts_Digest */
654 p++; /* skip space */
655 Dmsg1(dbglvl, "Stream=%d\n", stream);
656 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
657 if (jcr->cached_attribute) {
658 Dmsg3(dbglvl, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname,
660 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
661 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
664 /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
667 *fn++ = *p++; /* copy filename */
669 *fn = *p++; /* term filename and point p to attribs */
670 pm_strcpy(jcr->attr, p); /* save attributes */
672 jcr->FileIndex = file_index;
673 ar->attr = jcr->attr;
674 ar->fname = jcr->fname;
675 ar->FileIndex = file_index;
678 ar->JobId = jcr->JobId;
679 ar->ClientId = jcr->ClientId;
683 ar->DigestType = CRYPTO_DIGEST_NONE;
684 jcr->cached_attribute = true;
686 Dmsg2(dbglvl, "dird<filed: stream=%d %s\n", stream, jcr->fname);
687 Dmsg1(dbglvl, "dird<filed: attr=%s\n", ar->attr);
688 jcr->FileId = ar->FileId;
690 * First, get STREAM_UNIX_ATTRIBUTES and fill ATTR_DBR structure
691 * Next, we CAN have a CRYPTO_DIGEST, so we fill ATTR_DBR with it (or not)
692 * When we get a new STREAM_UNIX_ATTRIBUTES, we known that we can add file to the catalog
693 * At the end, we have to add the last file
695 } else if (crypto_digest_stream_type(stream) != CRYPTO_DIGEST_NONE) {
696 if (jcr->FileIndex != (uint32_t)file_index) {
697 Jmsg3(jcr, M_ERROR, 0, _("%s index %d not same as attributes %d\n"),
698 stream_to_ascii(stream), file_index, jcr->FileIndex);
702 ar->DigestType = crypto_digest_stream_type(stream);
703 db_escape_string(jcr, jcr->db, digest, Digest, strlen(Digest));
704 Dmsg4(dbglvl, "stream=%d DigestLen=%d Digest=%s type=%d\n", stream,
705 strlen(digest), digest, ar->DigestType);
707 jcr->jr.JobFiles = jcr->JobFiles = file_index;
708 jcr->jr.LastIndex = file_index;
710 if (is_bnet_error(fd)) {
711 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
715 if (jcr->cached_attribute) {
716 Dmsg3(dbglvl, "Cached attr with digest. Stream=%d fname=%s attr=%s\n", ar->Stream,
717 ar->fname, ar->attr);
718 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
719 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
721 jcr->cached_attribute = false;
723 set_jcr_job_status(jcr, JS_Terminated);