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 */
66 /* External functions */
67 extern DIRRES *director;
68 extern int FDConnectTimeout;
74 * Open connection with File daemon.
75 * Try connecting every retry_interval (default 10 sec), and
76 * give up after max_retry_time (default 30 mins).
79 int connect_to_file_daemon(JCR *jcr, int retry_interval, int max_retry_time,
86 if (jcr->client->heartbeat_interval) {
87 heart_beat = jcr->client->heartbeat_interval;
89 heart_beat = director->heartbeat_interval;
92 if (!jcr->file_bsock) {
93 char name[MAX_NAME_LENGTH + 100];
94 bstrncpy(name, _("Client: "), sizeof(name));
95 bstrncat(name, jcr->client->name(), sizeof(name));
96 fd = bnet_connect(jcr, retry_interval, max_retry_time, heart_beat,
97 name, jcr->client->address, NULL, jcr->client->FDport, verbose);
99 set_jcr_job_status(jcr, JS_ErrorTerminated);
102 Dmsg0(10, "Opened connection with File daemon\n");
104 fd = jcr->file_bsock; /* use existing connection */
106 fd->res = (RES *)jcr->client; /* save resource in BSOCK */
107 jcr->file_bsock = fd;
108 set_jcr_job_status(jcr, JS_Running);
110 if (!authenticate_file_daemon(jcr)) {
111 set_jcr_job_status(jcr, JS_ErrorTerminated);
116 * Now send JobId and authorization key
118 fd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job, jcr->VolSessionId,
119 jcr->VolSessionTime, jcr->sd_auth_key);
120 if (strcmp(jcr->sd_auth_key, "dummy") != 0) {
121 memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
123 Dmsg1(100, ">filed: %s", fd->msg);
124 if (bget_dirmsg(fd) > 0) {
125 Dmsg1(110, "<filed: %s", fd->msg);
126 if (strncmp(fd->msg, OKjob, strlen(OKjob)) != 0) {
127 Jmsg(jcr, M_FATAL, 0, _("File daemon \"%s\" rejected Job command: %s\n"),
128 jcr->client->hdr.name, fd->msg);
129 set_jcr_job_status(jcr, JS_ErrorTerminated);
131 } else if (jcr->db) {
133 memset(&cr, 0, sizeof(cr));
134 bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
135 cr.AutoPrune = jcr->client->AutoPrune;
136 cr.FileRetention = jcr->client->FileRetention;
137 cr.JobRetention = jcr->client->JobRetention;
138 bstrncpy(cr.Uname, fd->msg+strlen(OKjob)+1, sizeof(cr.Uname));
139 if (!db_update_client_record(jcr, jcr->db, &cr)) {
140 Jmsg(jcr, M_WARNING, 0, _("Error updating Client record. ERR=%s\n"),
141 db_strerror(jcr->db));
145 Jmsg(jcr, M_FATAL, 0, _("FD gave bad response to JobId command: %s\n"),
147 set_jcr_job_status(jcr, JS_ErrorTerminated);
154 * This subroutine edits the last job start time into a
155 * "since=date/time" buffer that is returned in the
156 * variable since. This is used for display purposes in
157 * the job report. The time in jcr->stime is later
158 * passed to tell the File daemon what to do.
160 void get_level_since_time(JCR *jcr, char *since, int since_len)
166 if (jcr->stime && jcr->stime[0]) {
167 bstrncpy(since, _(", since="), since_len);
168 bstrncat(since, jcr->stime, since_len);
173 jcr->stime = get_pool_memory(PM_MESSAGE);
176 /* Lookup the last FULL backup job to get the time/date for a
177 * differential or incremental save.
179 switch (jcr->JobLevel) {
182 /* Look up start time of last job */
183 jcr->jr.JobId = 0; /* flag for db_find_job_start time */
184 if (!db_find_job_start_time(jcr, jcr->db, &jcr->jr, &jcr->stime)) {
185 /* No job found, so upgrade this one to Full */
186 Jmsg(jcr, M_INFO, 0, "%s", db_strerror(jcr->db));
187 Jmsg(jcr, M_INFO, 0, _("No prior or suitable Full backup found in catalog. Doing FULL backup.\n"));
188 bsnprintf(since, since_len, _(" (upgraded from %s)"),
189 level_to_str(jcr->JobLevel));
190 jcr->JobLevel = jcr->jr.JobLevel = L_FULL;
192 if (jcr->job->rerun_failed_levels) {
193 if (db_find_failed_job_since(jcr, jcr->db, &jcr->jr, jcr->stime, JobLevel)) {
194 Jmsg(jcr, M_INFO, 0, _("Prior failed job found in catalog. Upgrading to %s.\n"),
195 level_to_str(JobLevel));
196 bsnprintf(since, since_len, _(" (upgraded from %s)"),
197 level_to_str(jcr->JobLevel));
198 jcr->JobLevel = jcr->jr.JobLevel = JobLevel;
199 jcr->jr.JobId = jcr->JobId;
203 bstrncpy(since, _(", since="), since_len);
204 bstrncat(since, jcr->stime, since_len);
206 jcr->jr.JobId = jcr->JobId;
209 Dmsg2(100, "Level=%c last start time=%s\n", jcr->JobLevel, jcr->stime);
212 static void send_since_time(JCR *jcr)
214 BSOCK *fd = jcr->file_bsock;
218 stime = str_to_utime(jcr->stime);
219 bnet_fsend(fd, levelcmd, NT_("since_utime "), edit_uint64(stime, ed1), 0);
220 while (bget_dirmsg(fd) >= 0) { /* allow him to poll us to sync clocks */
221 Jmsg(jcr, M_INFO, 0, "%s\n", fd->msg);
227 * Send level command to FD.
228 * Used for backup jobs and estimate command.
230 bool send_level_command(JCR *jcr)
232 BSOCK *fd = jcr->file_bsock;
234 * Send Level command to File daemon
236 switch (jcr->JobLevel) {
238 bnet_fsend(fd, levelcmd, "base", " ", 0);
240 /* L_NONE is the console, sending something off to the FD */
243 bnet_fsend(fd, levelcmd, "full", " ", 0);
246 bnet_fsend(fd, levelcmd, "differential", " ", 0);
247 send_since_time(jcr);
250 bnet_fsend(fd, levelcmd, "incremental", " ", 0);
251 send_since_time(jcr);
255 Jmsg2(jcr, M_FATAL, 0, _("Unimplemented backup level %d %c\n"),
256 jcr->JobLevel, jcr->JobLevel);
259 Dmsg1(120, ">filed: %s", fd->msg);
260 if (!response(jcr, fd, OKlevel, "Level", DISPLAY_ERROR)) {
267 * Send either an Included or an Excluded list to FD
269 static bool send_fileset(JCR *jcr)
271 FILESET *fileset = jcr->fileset;
272 BSOCK *fd = jcr->file_bsock;
278 num = fileset->num_includes;
280 num = fileset->num_excludes;
282 for (int i=0; i<num; i++) {
292 ie = fileset->include_items[i];
293 bnet_fsend(fd, "I\n");
295 ie = fileset->exclude_items[i];
296 bnet_fsend(fd, "E\n");
298 for (j=0; j<ie->num_opts; j++) {
299 FOPTS *fo = ie->opts_list[j];
300 bnet_fsend(fd, "O %s\n", fo->opts);
302 bool enhanced_wild = false;
303 for (k=0; fo->opts[k]!='\0'; k++) {
304 if (fo->opts[k]=='W') {
305 enhanced_wild = true;
310 for (k=0; k<fo->regex.size(); k++) {
311 bnet_fsend(fd, "R %s\n", fo->regex.get(k));
313 for (k=0; k<fo->regexdir.size(); k++) {
314 bnet_fsend(fd, "RD %s\n", fo->regexdir.get(k));
316 for (k=0; k<fo->regexfile.size(); k++) {
317 bnet_fsend(fd, "RF %s\n", fo->regexfile.get(k));
319 for (k=0; k<fo->wild.size(); k++) {
320 bnet_fsend(fd, "W %s\n", fo->wild.get(k));
322 for (k=0; k<fo->wilddir.size(); k++) {
323 bnet_fsend(fd, "WD %s\n", fo->wilddir.get(k));
325 for (k=0; k<fo->wildfile.size(); k++) {
326 bnet_fsend(fd, "WF %s\n", fo->wildfile.get(k));
328 for (k=0; k<fo->wildbase.size(); k++) {
329 bnet_fsend(fd, "W%c %s\n", enhanced_wild ? 'B' : 'F', fo->wildbase.get(k));
331 for (k=0; k<fo->base.size(); k++) {
332 bnet_fsend(fd, "B %s\n", fo->base.get(k));
334 for (k=0; k<fo->fstype.size(); k++) {
335 bnet_fsend(fd, "X %s\n", fo->fstype.get(k));
337 for (k=0; k<fo->drivetype.size(); k++) {
338 bnet_fsend(fd, "XD %s\n", fo->drivetype.get(k));
341 bnet_fsend(fd, "D %s\n", fo->reader);
344 bnet_fsend(fd, "T %s\n", fo->writer);
346 bnet_fsend(fd, "N\n");
349 for (j=0; j<ie->name_list.size(); j++) {
350 p = (char *)ie->name_list.get(j);
353 p++; /* skip over the | */
354 fd->msg = edit_job_codes(jcr, fd->msg, p, "");
355 bpipe = open_bpipe(fd->msg, 0, "r");
358 Jmsg(jcr, M_FATAL, 0, _("Cannot run program: %s. ERR=%s\n"),
362 bstrncpy(buf, "F ", sizeof(buf));
363 Dmsg1(500, "Opts=%s\n", buf);
364 optlen = strlen(buf);
365 while (fgets(buf+optlen, sizeof(buf)-optlen, bpipe->rfd)) {
366 fd->msglen = Mmsg(fd->msg, "%s", buf);
367 Dmsg2(500, "Inc/exc len=%d: %s", fd->msglen, fd->msg);
368 if (!bnet_send(fd)) {
369 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
373 if ((stat=close_bpipe(bpipe)) != 0) {
375 Jmsg(jcr, M_FATAL, 0, _("Error running program: %s. ERR=%s\n"),
376 p, be.bstrerror(stat));
381 p++; /* skip over < */
382 if ((ffd = fopen(p, "rb")) == NULL) {
384 Jmsg(jcr, M_FATAL, 0, _("Cannot open included file: %s. ERR=%s\n"),
388 bstrncpy(buf, "F ", sizeof(buf));
389 Dmsg1(500, "Opts=%s\n", buf);
390 optlen = strlen(buf);
391 while (fgets(buf+optlen, sizeof(buf)-optlen, ffd)) {
392 fd->msglen = Mmsg(fd->msg, "%s", buf);
393 if (!bnet_send(fd)) {
394 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
401 p++; /* skip over \ */
402 /* Note, fall through wanted */
404 pm_strcpy(fd->msg, "F ");
405 fd->msglen = pm_strcat(fd->msg, p);
406 Dmsg1(500, "Inc/Exc name=%s\n", fd->msg);
407 if (!bnet_send(fd)) {
408 Jmsg(jcr, M_FATAL, 0, _(">filed: write error on socket\n"));
414 bnet_fsend(fd, "N\n");
416 if (!include) { /* If we just did excludes */
417 break; /* all done */
419 include = false; /* Now do excludes */
422 bnet_sig(fd, BNET_EOD); /* end of data */
423 if (!response(jcr, fd, OKinc, "Include", DISPLAY_ERROR)) {
429 set_jcr_job_status(jcr, JS_ErrorTerminated);
436 * Send include list to File daemon
438 bool send_include_list(JCR *jcr)
440 BSOCK *fd = jcr->file_bsock;
441 if (jcr->fileset->new_include) {
442 fd->fsend(filesetcmd, jcr->fileset->enable_vss ? " vss=1" : "");
443 return send_fileset(jcr);
450 * Send exclude list to File daemon
451 * Under the new scheme, the Exclude list
452 * is part of the FileSet sent with the
453 * "include_list" above.
455 bool send_exclude_list(JCR *jcr)
462 * Send bootstrap file if any to the socket given (FD or SD).
463 * This is used for restore, verify VolumeToCatalog, and
466 bool send_bootstrap_file(JCR *jcr, BSOCK *sock)
470 const char *bootstrap = "bootstrap\n";
472 Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
473 if (!jcr->RestoreBootstrap) {
476 bs = fopen(jcr->RestoreBootstrap, "rb");
479 Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
480 jcr->RestoreBootstrap, be.bstrerror());
481 set_jcr_job_status(jcr, JS_ErrorTerminated);
484 sock->fsend(bootstrap);
485 while (fgets(buf, sizeof(buf), bs)) {
486 sock->fsend("%s", buf);
488 sock->signal(BNET_EOD);
490 if (jcr->unlink_bsr) {
491 unlink(jcr->RestoreBootstrap);
492 jcr->unlink_bsr = false;
497 /* TODO: drop this with runscript.old_proto in bacula 1.42 */
498 static char runbefore[] = "RunBeforeJob %s\n";
499 static char runafter[] = "RunAfterJob %s\n";
500 static char OKRunBefore[] = "2000 OK RunBefore\n";
501 static char OKRunAfter[] = "2000 OK RunAfter\n";
503 int send_runscript_with_old_proto(JCR *jcr, int when, POOLMEM *msg)
506 Dmsg1(120, "bdird: sending old runcommand to fd '%s'\n",msg);
507 if (when & SCRIPT_Before) {
508 bnet_fsend(jcr->file_bsock, runbefore, msg);
509 ret = response(jcr, jcr->file_bsock, OKRunBefore, "ClientRunBeforeJob", DISPLAY_ERROR);
511 bnet_fsend(jcr->file_bsock, runafter, msg);
512 ret = response(jcr, jcr->file_bsock, OKRunAfter, "ClientRunAfterJob", DISPLAY_ERROR);
518 * Send RunScripts to File daemon
519 * 1) We send all runscript to FD, they can be executed Before, After, or twice
520 * 2) Then, we send a "RunBeforeNow" command to the FD to tell him to do the
521 * first run_script() call. (ie ClientRunBeforeJob)
523 int send_runscripts_commands(JCR *jcr)
525 POOLMEM *msg = get_pool_memory(PM_FNAME);
526 BSOCK *fd = jcr->file_bsock;
528 bool launch_before_cmd = false;
529 POOLMEM *ehost = get_pool_memory(PM_FNAME);
532 Dmsg0(120, "bdird: sending runscripts to fd\n");
534 foreach_alist(cmd, jcr->job->RunScripts) {
535 if (cmd->can_run_at_level(jcr->JobLevel) && cmd->target) {
536 ehost = edit_job_codes(jcr, ehost, cmd->target, "");
537 Dmsg2(200, "bdird: runscript %s -> %s\n", cmd->target, ehost);
539 if (strcmp(ehost, jcr->client->name()) == 0) {
540 pm_strcpy(msg, cmd->command);
543 Dmsg1(120, "bdird: sending runscripts to fd '%s'\n", cmd->command);
545 /* TODO: remove this with bacula 1.42 */
546 if (cmd->old_proto) {
547 result = send_runscript_with_old_proto(jcr, cmd->when, msg);
550 fd->fsend(runscript, cmd->on_success,
556 result = response(jcr, fd, OKRunScript, "RunScript", DISPLAY_ERROR);
557 launch_before_cmd = true;
564 /* TODO : we have to play with other client */
567 send command to an other client
573 /* Tell the FD to execute the ClientRunBeforeJob */
574 if (launch_before_cmd) {
575 fd->fsend(runbeforenow);
576 if (!response(jcr, fd, OKRunBeforeNow, "RunBeforeNow", DISPLAY_ERROR)) {
580 free_pool_memory(msg);
581 free_pool_memory(ehost);
585 Jmsg(jcr, M_FATAL, 0, _("Client \"%s\" RunScript failed.\n"), ehost);
586 free_pool_memory(msg);
587 free_pool_memory(ehost);
594 * Read the attributes from the File daemon for
595 * a Verify job and store them in the catalog.
597 int get_attributes_and_put_in_catalog(JCR *jcr)
602 char digest[MAXSTRING];
604 fd = jcr->file_bsock;
605 jcr->jr.FirstIndex = 1;
607 /* Start transaction allocates jcr->attr and jcr->ar if needed */
608 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
611 Dmsg0(120, "bdird: waiting to receive file attributes\n");
612 /* Pickup file attributes and digest */
613 while (!fd->errors && (n = bget_dirmsg(fd)) > 0) {
617 char Digest[MAXSTRING]; /* either Verify opts or MD5/SHA1 digest */
619 jcr->fname = check_pool_memory_size(jcr->fname, fd->msglen);
620 if ((len = sscanf(fd->msg, "%ld %d %s", &file_index, &stream, Digest)) != 3) {
621 Jmsg(jcr, M_FATAL, 0, _("<filed: bad attributes, expected 3 fields got %d\n"
622 "msglen=%d msg=%s\n"), len, fd->msglen, fd->msg);
623 set_jcr_job_status(jcr, JS_ErrorTerminated);
627 /* The following three fields were sscanf'ed above so skip them */
628 skip_nonspaces(&p); /* skip FileIndex */
630 skip_nonspaces(&p); /* skip Stream */
632 skip_nonspaces(&p); /* skip Opts_Digest */
633 p++; /* skip space */
634 Dmsg1(dbglvl, "Stream=%d\n", stream);
635 if (stream == STREAM_UNIX_ATTRIBUTES || stream == STREAM_UNIX_ATTRIBUTES_EX) {
636 if (jcr->cached_attribute) {
637 Dmsg3(dbglvl, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname,
639 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
640 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
643 /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
646 *fn++ = *p++; /* copy filename */
648 *fn = *p++; /* term filename and point p to attribs */
649 pm_strcpy(jcr->attr, p); /* save attributes */
651 jcr->FileIndex = file_index;
652 ar->attr = jcr->attr;
653 ar->fname = jcr->fname;
654 ar->FileIndex = file_index;
657 ar->JobId = jcr->JobId;
658 ar->ClientId = jcr->ClientId;
662 ar->DigestType = CRYPTO_DIGEST_NONE;
663 jcr->cached_attribute = true;
665 Dmsg2(dbglvl, "dird<filed: stream=%d %s\n", stream, jcr->fname);
666 Dmsg1(dbglvl, "dird<filed: attr=%s\n", ar->attr);
667 jcr->FileId = ar->FileId;
669 * First, get STREAM_UNIX_ATTRIBUTES and fill ATTR_DBR structure
670 * Next, we CAN have a CRYPTO_DIGEST, so we fill ATTR_DBR with it (or not)
671 * When we get a new STREAM_UNIX_ATTRIBUTES, we known that we can add file to the catalog
672 * At the end, we have to add the last file
674 } else if (crypto_digest_stream_type(stream) != CRYPTO_DIGEST_NONE) {
675 if (jcr->FileIndex != (uint32_t)file_index) {
676 Jmsg3(jcr, M_ERROR, 0, _("%s index %d not same as attributes %d\n"),
677 stream_to_ascii(stream), file_index, jcr->FileIndex);
681 ar->DigestType = crypto_digest_stream_type(stream);
682 db_escape_string(jcr, jcr->db, digest, Digest, strlen(Digest));
683 Dmsg4(dbglvl, "stream=%d DigestLen=%d Digest=%s type=%d\n", stream,
684 strlen(digest), digest, ar->DigestType);
686 jcr->jr.JobFiles = jcr->JobFiles = file_index;
687 jcr->jr.LastIndex = file_index;
689 if (is_bnet_error(fd)) {
690 Jmsg1(jcr, M_FATAL, 0, _("<filed: Network error getting attributes. ERR=%s\n"),
694 if (jcr->cached_attribute) {
695 Dmsg3(dbglvl, "Cached attr with digest. Stream=%d fname=%s attr=%s\n", ar->Stream,
696 ar->fname, ar->attr);
697 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
698 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
700 jcr->cached_attribute = false;
702 set_jcr_job_status(jcr, JS_Terminated);