/*
Bacula® - The Network Backup Solution
- Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
+ Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
The main author of Bacula is Kern Sibbald, with contributions from
many others, a complete list can be found in the file AUTHORS.
This program is Free Software; you can redistribute it and/or
- modify it under the terms of version two of the GNU General Public
+ modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
- Bacula® is a registered trademark of John Walker.
+ Bacula® is a registered trademark of Kern Sibbald.
The licensor of Bacula is the Free Software Foundation Europe
(FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
Switzerland, email:ftf@fsfeurope.org.
*/
-/*
+/**
* Bacula Director -- restore.c -- responsible for restoring files
*
* Kern Sibbald, November MM
* to do the restore.
* Update the DB according to what files where restored????
*
- * Version $Id$
*/
#include "dird.h"
/* Commands sent to File daemon */
-static char restorecmd[] = "restore replace=%c prelinks=%d where=%s\n";
+static char restorecmd[] = "restore replace=%c prelinks=%d where=%s\n";
static char restorecmdR[] = "restore replace=%c prelinks=%d regexwhere=%s\n";
-static char storaddr[] = "storage address=%s port=%d ssl=0\n";
+static char storaddr[] = "storage address=%s port=%d ssl=0 Authorization=%s\n";
/* Responses received from File daemon */
static char OKrestore[] = "2000 OK restore\n";
static char OKstore[] = "2000 OK storage\n";
-static char OKbootstrap[] = "2000 OK bootstrap\n";
+static char OKstoreend[] = "2000 OK storage end\n";
-/*
- * Do a restore of the specified files
- *
- * Returns: 0 on failure
- * 1 on success
- */
-bool do_restore(JCR *jcr)
+/* Responses received from the Storage daemon */
+static char OKbootstrap[] = "3000 OK bootstrap\n";
+
+static void build_restore_command(JCR *jcr, POOL_MEM &ret)
{
- BSOCK *fd;
- JOB_DBR rjr; /* restore job record */
+ char replace, *where, *cmd;
+ char empty = '\0';
- free_wstorage(jcr); /* we don't write */
+ /* Build the restore command */
- memset(&rjr, 0, sizeof(rjr));
- jcr->jr.JobLevel = L_FULL; /* Full restore */
- if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
- Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
- restore_cleanup(jcr, JS_ErrorTerminated);
- return false;
+ if (jcr->replace != 0) {
+ replace = jcr->replace;
+ } else if (jcr->job->replace != 0) {
+ replace = jcr->job->replace;
+ } else {
+ replace = REPLACE_ALWAYS; /* always replace */
}
- Dmsg0(20, "Updated job start record\n");
+
+ if (jcr->RegexWhere) {
+ where = jcr->RegexWhere; /* override */
+ cmd = restorecmdR;
+ } else if (jcr->job->RegexWhere) {
+ where = jcr->job->RegexWhere; /* no override take from job */
+ cmd = restorecmdR;
- Dmsg1(20, "RestoreJobId=%d\n", jcr->job->RestoreJobId);
+ } else if (jcr->where) {
+ where = jcr->where; /* override */
+ cmd = restorecmd;
+ } else if (jcr->job->RestoreWhere) {
+ where = jcr->job->RestoreWhere; /* no override take from job */
+ cmd = restorecmd;
+
+ } else { /* nothing was specified */
+ where = ∅ /* use default */
+ cmd = restorecmd;
+ }
+
+ jcr->prefix_links = jcr->job->PrefixLinks;
+
+ bash_spaces(where);
+ Mmsg(ret, cmd, replace, jcr->prefix_links, where);
+ unbash_spaces(where);
+}
+
+struct bootstrap_info
+{
+ FILE *bs;
+ UAContext *ua;
+ char storage[MAX_NAME_LENGTH+1];
+};
+
+#define UA_CMD_SIZE 1000
+
+/**
+ * Open the bootstrap file and find the first Storage=
+ * Returns ok if able to open
+ * It fills the storage name (should be the first line)
+ * and the file descriptor to the bootstrap file,
+ * it should be used for next operations, and need to be closed
+ * at the end.
+ */
+static bool open_bootstrap_file(JCR *jcr, bootstrap_info &info)
+{
+ FILE *bs;
+ UAContext *ua;
+ info.bs = NULL;
+ info.ua = NULL;
if (!jcr->RestoreBootstrap) {
- Jmsg0(jcr, M_FATAL, 0, _("Cannot restore without a bootstrap file.\n"
- "You probably ran a restore job directly. All restore jobs must\n"
- "be run using the restore command.\n"));
- restore_cleanup(jcr, JS_ErrorTerminated);
+ return false;
+ }
+ strncpy(info.storage, jcr->rstore->name(), MAX_NAME_LENGTH);
+
+ bs = fopen(jcr->RestoreBootstrap, "rb");
+ if (!bs) {
+ berrno be;
+ Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
+ jcr->RestoreBootstrap, be.bstrerror());
+ jcr->setJobStatus(JS_ErrorTerminated);
return false;
}
+ ua = new_ua_context(jcr);
+ ua->cmd = check_pool_memory_size(ua->cmd, UA_CMD_SIZE+1);
+ while (!fgets(ua->cmd, UA_CMD_SIZE, bs)) {
+ parse_ua_args(ua);
+ if (ua->argc != 1) {
+ continue;
+ }
+ if (!strcasecmp(ua->argk[0], "Storage")) {
+ strncpy(info.storage, ua->argv[0], MAX_NAME_LENGTH);
+ break;
+ }
+ }
+ info.bs = bs;
+ info.ua = ua;
+ fseek(bs, 0, SEEK_SET); /* return to the top of the file */
+ return true;
+}
- /* Print Job Start message */
- Jmsg(jcr, M_INFO, 0, _("Start Restore Job %s\n"), jcr->Job);
+/**
+ * This function compare the given storage name with the
+ * the current one. We compare the name and the address:port.
+ * Returns true if we use the same storage.
+ */
+static bool is_on_same_storage(JCR *jcr, char *new_one)
+{
+ STORE *new_store;
- /*
- * Open a message channel connection with the Storage
- * daemon. This is to let him know that our client
- * will be contacting him for a backup session.
- *
- */
- Dmsg0(10, "Open connection with storage daemon\n");
- set_jcr_job_status(jcr, JS_WaitSD);
- /*
- * Start conversation with Storage daemon
- */
- if (!connect_to_storage_daemon(jcr, 10, SDConnectTimeout, 1)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
+ /* with old FD, we send the whole bootstrap to the storage */
+ if (jcr->FDVersion < 2) {
+ return true;
+ }
+ /* we are in init loop ? shoudn't fail here */
+ if (!*new_one) {
+ return true;
+ }
+ /* same name */
+ if (!strcmp(new_one, jcr->rstore->name())) {
+ return true;
+ }
+ new_store = (STORE *)GetResWithName(R_STORAGE, new_one);
+ if (!new_store) {
+ Jmsg(jcr, M_WARNING, 0,
+ _("Could not get storage resource '%s'.\n"), new_one);
return false;
}
- /*
- * Now start a job with the Storage daemon
+ /* if Port and Hostname/IP are same, we are talking to the same
+ * Storage Daemon
*/
- if (!start_storage_daemon_job(jcr, jcr->rstorage, NULL)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
+ if (jcr->rstore->SDport != new_store->SDport ||
+ strcmp(jcr->rstore->address, new_store->address))
+ {
return false;
}
- if (!bnet_fsend(jcr->store_bsock, "run")) {
+ return true;
+}
+
+/**
+ * Check if the current line contains Storage="xxx", and compare the
+ * result to the current storage. We use UAContext to analyse the bsr
+ * string.
+ *
+ * Returns true if we need to change the storage, and it set the new
+ * Storage resource name in "storage" arg.
+ */
+static bool check_for_new_storage(JCR *jcr, bootstrap_info &info)
+{
+ UAContext *ua = info.ua;
+ parse_ua_args(ua);
+ if (ua->argc != 1) {
return false;
}
- /*
- * Now start a Storage daemon message thread
- */
- if (!start_storage_daemon_message_thread(jcr)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
- return false;
+ if (!strcasecmp(ua->argk[0], "Storage")) {
+ /* Continue if this is a volume from the same storage. */
+ if (is_on_same_storage(jcr, ua->argv[0])) {
+ return false;
+ }
+ /* note the next storage name */
+ strncpy(info.storage, ua->argv[0], MAX_NAME_LENGTH);
+ Dmsg1(5, "Change storage to %s\n", info.storage);
+ return true;
}
- Dmsg0(50, "Storage daemon connection OK\n");
+ return false;
+}
+/**
+ * Send bootstrap file to Storage daemon section by section.
+ */
+static bool send_bootstrap_file(JCR *jcr, BSOCK *sock,
+ bootstrap_info &info)
+{
+ boffset_t pos;
+ const char *bootstrap = "bootstrap\n";
+ UAContext *ua = info.ua;
+ FILE *bs = info.bs;
- /*
- * Start conversation with File daemon
- */
- set_jcr_job_status(jcr, JS_WaitFD);
- if (!connect_to_file_daemon(jcr, 10, FDConnectTimeout, 1)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
+ Dmsg1(400, "send_bootstrap_file: %s\n", jcr->RestoreBootstrap);
+ if (!jcr->RestoreBootstrap) {
return false;
}
+ sock->fsend(bootstrap);
+ pos = ftello(bs);
+ while(fgets(ua->cmd, UA_CMD_SIZE, bs)) {
+ if (check_for_new_storage(jcr, info)) {
+ /* Otherwise, we need to contact another storage daemon.
+ * Reset bs to the beginning of the current segment.
+ */
+ fseeko(bs, pos, SEEK_SET);
+ break;
+ }
+ sock->fsend("%s", ua->cmd);
+ pos = ftello(bs);
+ }
+ sock->signal(BNET_EOD);
+ return true;
+}
- fd = jcr->file_bsock;
- set_jcr_job_status(jcr, JS_Running);
+#define MAX_TRIES 6 * 360 /* 6 hours */
- /*
- * send Storage daemon address to the File daemon,
- * then wait for File daemon to make connection
- * with Storage daemon.
- */
- if (jcr->rstore->SDDport == 0) {
- jcr->rstore->SDDport = jcr->rstore->SDport;
+/**
+ * Change the read storage resource for the current job.
+ */
+static bool select_rstore(JCR *jcr, bootstrap_info &info)
+{
+ USTORE ustore;
+ int i;
+
+
+ if (!strcmp(jcr->rstore->name(), info.storage)) {
+ return true; /* same SD nothing to change */
}
- bnet_fsend(fd, storaddr, jcr->rstore->address, jcr->rstore->SDDport);
- Dmsg1(6, "dird>filed: %s\n", fd->msg);
- if (!response(jcr, fd, OKstore, "Storage", DISPLAY_ERROR)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
+
+ if (!(ustore.store = (STORE *)GetResWithName(R_STORAGE,info.storage))) {
+ Jmsg(jcr, M_FATAL, 0,
+ _("Could not get storage resource '%s'.\n"), info.storage);
+ jcr->setJobStatus(JS_ErrorTerminated);
return false;
}
-
+
/*
- * Send the bootstrap file -- what Volumes/files to restore
+ * What does this do??????????? KES
*/
- if (!send_bootstrap_file(jcr, fd) ||
- !response(jcr, fd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
- return false;
+ if (jcr->store_bsock) {
+ jcr->store_bsock->destroy();
+ jcr->store_bsock = NULL;
+ }
+
+ /*
+ * release current read storage and get a new one
+ */
+ dec_read_store(jcr);
+ free_rstorage(jcr);
+ set_rstorage(jcr, &ustore);
+ jcr->setJobStatus(JS_WaitSD);
+ /*
+ * Wait for up to 6 hours to increment read stoage counter
+ */
+ for (i=0; i < MAX_TRIES; i++) {
+ /* try to get read storage counter incremented */
+ if (inc_read_store(jcr)) {
+ jcr->setJobStatus(JS_Running);
+ return true;
+ }
+ bmicrosleep(10, 0); /* sleep 10 secs */
+ if (job_canceled(jcr)) {
+ free_rstorage(jcr);
+ return false;
+ }
}
+ /* Failed to inc_read_store() */
+ free_rstorage(jcr);
+ Jmsg(jcr, M_FATAL, 0,
+ _("Could not acquire read storage lock for \"%s\""), info.storage);
+ return false;
+}
+/*
+ * Clean the bootstrap_info struct
+ */
+static void close_bootstrap_file(bootstrap_info &info)
+{
+ if (info.bs) {
+ fclose(info.bs);
+ }
+ if (info.ua) {
+ free_ua_context(info.ua);
+ }
+}
- if (!send_runscripts_commands(jcr)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
- return false;
+/**
+ * The bootstrap is stored in a file, so open the file, and loop
+ * through it processing each storage device in turn. If the
+ * storage is different from the prior one, we open a new connection
+ * to the new storage and do a restore for that part.
+ * This permits handling multiple storage daemons for a single
+ * restore. E.g. your Full is stored on tape, and Incrementals
+ * on disk.
+ */
+bool restore_bootstrap(JCR *jcr)
+{
+ BSOCK *fd = NULL;
+ BSOCK *sd;
+ bool first_time = true;
+ bootstrap_info info;
+ POOL_MEM restore_cmd(PM_MESSAGE);
+ bool ret = false;
+
+ /* this command is used for each part */
+ build_restore_command(jcr, restore_cmd);
+
+ /* Open the bootstrap file */
+ if (!open_bootstrap_file(jcr, info)) {
+ goto bail_out;
}
+ /* Read the bootstrap file */
+ while (!feof(info.bs)) {
+
+ if (!select_rstore(jcr, info)) {
+ goto bail_out;
+ }
- /* Send restore command */
- char replace, *where, *cmd=NULL;
- char empty = '\0';
+ /**
+ * Open a message channel connection with the Storage
+ * daemon. This is to let him know that our client
+ * will be contacting him for a backup session.
+ *
+ */
+ Dmsg0(10, "Open connection with storage daemon\n");
+ jcr->setJobStatus(JS_WaitSD);
+ /*
+ * Start conversation with Storage daemon
+ */
+ if (!connect_to_storage_daemon(jcr, 10, SDConnectTimeout, 1)) {
+ goto bail_out;
+ }
+ sd = jcr->store_bsock;
+ /*
+ * Now start a job with the Storage daemon
+ */
+ if (!start_storage_daemon_job(jcr, jcr->rstorage, NULL)) {
+ goto bail_out;
+ }
- if (jcr->replace != 0) {
- replace = jcr->replace;
- } else if (jcr->job->replace != 0) {
- replace = jcr->job->replace;
- } else {
- replace = REPLACE_ALWAYS; /* always replace */
+ if (first_time) {
+ /*
+ * Start conversation with File daemon
+ */
+ jcr->setJobStatus(JS_WaitFD);
+ jcr->keep_sd_auth_key = true; /* don't clear the sd_auth_key now */
+ if (!connect_to_file_daemon(jcr, 10, FDConnectTimeout, 1)) {
+ goto bail_out;
+ }
+ fd = jcr->file_bsock;
+ }
+
+ jcr->setJobStatus(JS_Running);
+
+ /*
+ * Send the bootstrap file -- what Volumes/files to restore
+ */
+ if (!send_bootstrap_file(jcr, sd, info) ||
+ !response(jcr, sd, OKbootstrap, "Bootstrap", DISPLAY_ERROR)) {
+ goto bail_out;
+ }
+
+ if (!sd->fsend("run")) {
+ goto bail_out;
+ }
+ /*
+ * Now start a Storage daemon message thread
+ */
+ if (!start_storage_daemon_message_thread(jcr)) {
+ goto bail_out;
+ }
+ Dmsg0(50, "Storage daemon connection OK\n");
+
+ /*
+ * send Storage daemon address to the File daemon,
+ * then wait for File daemon to make connection
+ * with Storage daemon.
+ */
+ if (jcr->rstore->SDDport == 0) {
+ jcr->rstore->SDDport = jcr->rstore->SDport;
+ }
+ fd->fsend(storaddr, jcr->rstore->address, jcr->rstore->SDDport,
+ jcr->sd_auth_key);
+ memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
+
+ Dmsg1(6, "dird>filed: %s\n", fd->msg);
+ if (!response(jcr, fd, OKstore, "Storage", DISPLAY_ERROR)) {
+ goto bail_out;
+ }
+
+ /* Only pass "global" commands to the FD once */
+ if (first_time) {
+ first_time = false;
+ if (!send_runscripts_commands(jcr)) {
+ goto bail_out;
+ }
+ if (!send_restore_objects(jcr)) {
+ Dmsg0(000, "FAIL: Send restore objects\n");
+ goto bail_out;
+ }
+ }
+
+ fd->fsend("%s", restore_cmd.c_str());
+
+ if (!response(jcr, fd, OKrestore, "Restore", DISPLAY_ERROR)) {
+ goto bail_out;
+ }
+
+ if (jcr->FDVersion < 2) { /* Old FD */
+ break; /* we do only one loop */
+ } else {
+ if (!response(jcr, fd, OKstoreend, "Store end", DISPLAY_ERROR)) {
+ goto bail_out;
+ }
+ wait_for_storage_daemon_termination(jcr);
+ }
+ } /* the whole boostrap has been send */
+
+ if (fd && jcr->FDVersion >= 2) {
+ fd->fsend("endrestore");
}
-
- where = ∅ /* default */
- if (jcr->RegexWhere) {
- where = jcr->RegexWhere; /* override */
- cmd = restorecmdR;
- } else if (jcr->job->RegexWhere) {
- where = jcr->job->RegexWhere; /* no override take from job */
- cmd = restorecmdR;
+ ret = true;
- } else if (jcr->where) {
- where = jcr->where; /* override */
- cmd = restorecmd;
- } else if (jcr->job->RestoreWhere) {
- where = jcr->job->RestoreWhere; /* no override take from job */
- cmd = restorecmd;
- }
-
- jcr->prefix_links = jcr->job->PrefixLinks;
+bail_out:
+ close_bootstrap_file(info);
+ return ret;
+}
- bash_spaces(where);
- bnet_fsend(fd, cmd, replace, jcr->prefix_links, where);
- unbash_spaces(where);
+/**
+ * Do a restore of the specified files
+ *
+ * Returns: 0 on failure
+ * 1 on success
+ */
+bool do_restore(JCR *jcr)
+{
+ JOB_DBR rjr; /* restore job record */
+ int stat;
- if (!response(jcr, fd, OKrestore, "Restore", DISPLAY_ERROR)) {
- restore_cleanup(jcr, JS_ErrorTerminated);
- return false;
+ free_wstorage(jcr); /* we don't write */
+
+ if (!allow_duplicate_job(jcr)) {
+ goto bail_out;
+ }
+
+ memset(&rjr, 0, sizeof(rjr));
+ jcr->jr.JobLevel = L_FULL; /* Full restore */
+ if (!db_update_job_start_record(jcr, jcr->db, &jcr->jr)) {
+ Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
+ goto bail_out;
+ }
+ Dmsg0(20, "Updated job start record\n");
+
+ Dmsg1(20, "RestoreJobId=%d\n", jcr->job->RestoreJobId);
+
+ if (!jcr->RestoreBootstrap) {
+ Jmsg(jcr, M_FATAL, 0, _("Cannot restore without a bootstrap file.\n"
+ "You probably ran a restore job directly. All restore jobs must\n"
+ "be run using the restore command.\n"));
+ goto bail_out;
+ }
+
+
+ /* Print Job Start message */
+ Jmsg(jcr, M_INFO, 0, _("Start Restore Job %s\n"), jcr->Job);
+
+ /* Read the bootstrap file and do the restore */
+ if (!restore_bootstrap(jcr)) {
+ goto bail_out;
}
/* Wait for Job Termination */
- int stat = wait_for_job_termination(jcr);
+ stat = wait_for_job_termination(jcr);
restore_cleanup(jcr, stat);
-
return true;
+
+bail_out:
+ restore_cleanup(jcr, JS_ErrorTerminated);
+ return false;
}
bool do_restore_init(JCR *jcr)
return true;
}
-/*
+/**
* Release resources allocated during restore.
*
*/
term_msg = _("Restore OK");
}
break;
+ case JS_Warnings:
+ term_msg = _("Restore OK -- with warnings");
+ break;
case JS_FatalError:
case JS_ErrorTerminated:
term_msg = _("*** Restore Error ***");
msg_type = M_ERROR; /* Generate error message */
if (jcr->store_bsock) {
- bnet_sig(jcr->store_bsock, BNET_TERMINATE);
+ jcr->store_bsock->signal(BNET_TERMINATE);
if (jcr->SD_msg_chan) {
pthread_cancel(jcr->SD_msg_chan);
}
case JS_Canceled:
term_msg = _("Restore Canceled");
if (jcr->store_bsock) {
- bnet_sig(jcr->store_bsock, BNET_TERMINATE);
+ jcr->store_bsock->signal(BNET_TERMINATE);
if (jcr->SD_msg_chan) {
pthread_cancel(jcr->SD_msg_chan);
}
jobstatus_to_ascii(jcr->FDJobStatus, fd_term_msg, sizeof(fd_term_msg));
jobstatus_to_ascii(jcr->SDJobStatus, sd_term_msg, sizeof(sd_term_msg));
- Jmsg(jcr, msg_type, 0, _("Bacula %s %s (%s): %s\n"
+ Jmsg(jcr, msg_type, 0, _("%s %s %s (%s):\n"
" Build OS: %s %s %s\n"
" JobId: %d\n"
" Job: %s\n"
" FD termination status: %s\n"
" SD termination status: %s\n"
" Termination: %s\n\n"),
- my_name, VERSION, LSMDATE, edt,
+ BACULA, my_name, VERSION, LSMDATE,
HOST_OS, DISTNAME, DISTVER,
jcr->jr.JobId,
jcr->jr.Job,
edit_uint64_with_commas((uint64_t)jcr->jr.JobFiles, ec2),
edit_uint64_with_commas(jcr->jr.JobBytes, ec3),
(float)kbps,
- jcr->Errors,
+ jcr->JobErrors,
fd_term_msg,
sd_term_msg,
term_msg);