+/*
+ * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
#include <string.h>
#include <stdlib.h>
#include <stdarg.h>
#include "time.h"
#include "snap.h"
-
+/** Command line and config file options. */
static struct gengetopt_args_info conf;
+/** Non-NULL if we log to a file. */
static FILE *logfile;
+/** The read end of the signal pipe */
static int signal_pipe;
-
/** Process id of current rsync process. */
static pid_t rsync_pid;
/** Whether the rsync process is currently stopped */
/** Process id of current rm process. */
static pid_t rm_pid;
/** When the next snapshot is due. */
-struct timeval next_snapshot_time;
+static struct timeval next_snapshot_time;
/** The pid of the pre-create hook. */
-pid_t pre_create_hook_pid;
+static pid_t pre_create_hook_pid;
/** The pid of the post-create hook. */
-pid_t post_create_hook_pid;
-/* Creation time of the snapshot currently being created. */
-int64_t current_snapshot_creation_time;
-
+static pid_t post_create_hook_pid;
+/** Creation time of the snapshot currently being created. */
+static int64_t current_snapshot_creation_time;
+/** Needed by the post-create hook. */
static char *path_to_last_complete_snapshot;
-
+/** \sa \ref snap.h for details. */
static unsigned snapshot_creation_status;
COMMAND(create) \
COMMAND(prune) \
COMMAND(run)
-#define COMMAND(x) int com_ ##x(void);
+#define COMMAND(x) static int com_ ##x(void);
COMMANDS
#undef COMMAND
#define COMMAND(x) if (conf.x ##_given) return com_ ##x();
-int call_command_handler(void)
+static int call_command_handler(void)
{
COMMANDS
DSS_EMERG_LOG("BUG: did not find command handler\n");
- exit(EXIT_FAILURE);
+ return -E_BUG;
}
#undef COMMAND
#undef COMMANDS
+/**
+ * The log function of dss.
+ *
+ * \param ll Loglevel.
+ * \param fml Usual format string.
+ *
+ * All DSS_XXX_LOG() macros use this function.
+ */
__printf_2_3 void dss_log(int ll, const char* fmt,...)
{
va_list argp;
/**
* Print a message either to stdout or to the log file.
*/
-__printf_1_2 void dss_msg(const char* fmt,...)
+static __printf_1_2 void dss_msg(const char* fmt,...)
{
FILE *outfd = conf.daemon_given? logfile : stdout;
va_list argp;
va_end(argp);
}
-/* TODO: Also consider number of inodes. */
-int disk_space_low(void)
+static int disk_space_low(void)
{
struct disk_space ds;
int ret = get_disk_space(".", &ds);
if (conf.min_free_percent_arg)
if (ds.percent_free < conf.min_free_percent_arg)
return 1;
+ if (conf.min_free_percent_inodes_arg)
+ if (ds.percent_free_inodes < conf.min_free_percent_inodes_arg)
+ return 1;
return 0;
}
-void dss_get_snapshot_list(struct snapshot_list *sl)
+static void dss_get_snapshot_list(struct snapshot_list *sl)
{
get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
}
-void compute_next_snapshot_time(void)
+static void compute_next_snapshot_time(void)
{
struct timeval now, unit_interval = {.tv_sec = 24 * 3600 * conf.unit_interval_arg},
tmp, diff;
tmp.tv_sec = x;
tmp.tv_usec = 0;
ret = tv_diff(&unit_interval, &tmp, &diff); /* total sleep time per unit interval */
- gettimeofday(&now, NULL);
- if (ret < 0 || !s)
+ if (ret < 0 || !s) /* unit_interval < tmp or no snapshot */
goto min_sleep;
tv_divide(wanted, &diff, &tmp); /* sleep time betweeen two snapshots */
- diff.tv_sec = s->completion_time;
+ diff.tv_sec = s->completion_time; /* completion time of the the latest snaphot */
diff.tv_usec = 0;
tv_add(&diff, &tmp, &next_snapshot_time);
+ gettimeofday(&now, NULL);
if (tv_diff(&now, &next_snapshot_time, NULL) < 0)
goto out;
min_sleep:
}
-int remove_snapshot(struct snapshot *s)
+static int remove_snapshot(struct snapshot *s)
{
int fds[3] = {0, 0, 0};
assert(!rm_pid);
/*
* return: 0: no redundant snapshots, 1: rm process started, negative: error
*/
-int remove_redundant_snapshot(struct snapshot_list *sl)
+static int remove_redundant_snapshot(struct snapshot_list *sl)
{
int ret, i, interval;
struct snapshot *s;
unsigned missing = 0;
- DSS_INFO_LOG("looking for intervals containing too many snapshots\n");
+ DSS_DEBUG_LOG("looking for intervals containing too many snapshots\n");
for (interval = conf.num_intervals_arg - 1; interval >= 0; interval--) {
unsigned keep = desired_number_of_snapshots(interval, conf.num_intervals_arg);
unsigned num = sl->interval_count[interval];
return 0;
}
-int remove_outdated_snapshot(struct snapshot_list *sl)
+static int remove_outdated_snapshot(struct snapshot_list *sl)
{
int i, ret;
struct snapshot *s;
- DSS_INFO_LOG("looking for snapshots belonging to intervals greater than %d\n",
+ DSS_DEBUG_LOG("looking for snapshots belonging to intervals greater than %d\n",
conf.num_intervals_arg);
FOR_EACH_SNAPSHOT(s, i, sl) {
if (s->interval <= conf.num_intervals_arg)
return 0;
}
-int remove_oldest_snapshot(struct snapshot_list *sl)
+static int remove_oldest_snapshot(struct snapshot_list *sl)
{
struct snapshot *s = get_oldest_snapshot(sl);
return remove_snapshot(s);
}
-int rename_incomplete_snapshot(int64_t start)
+static int rename_incomplete_snapshot(int64_t start)
{
char *old_name;
int ret;
return ret;
}
-int try_to_free_disk_space(int low_disk_space)
+static int try_to_free_disk_space(int low_disk_space)
{
int ret;
struct snapshot_list sl;
+ if (!low_disk_space && conf.keep_redundant_given)
+ return 0;
dss_get_snapshot_list(&sl);
ret = remove_outdated_snapshot(&sl);
if (ret) /* error, or we are removing something */
if (ret)
goto out;
DSS_CRIT_LOG("uhuhu: not enough disk space for a single snapshot\n");
- ret= -ENOSPC;
+ ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
out:
free_snapshot_list(&sl);
return ret;
}
-int pre_create_hook(void)
+static int pre_create_hook(void)
{
int ret, fds[3] = {0, 0, 0};
return ret;
}
-int post_create_hook(void)
+static int post_create_hook(void)
{
int ret, fds[3] = {0, 0, 0};
char *cmd;
return ret;
}
-void kill_process(pid_t pid)
+static void kill_process(pid_t pid)
{
if (!pid)
return;
kill(pid, SIGTERM);
}
-void stop_rsync_process(void)
+static void stop_rsync_process(void)
{
if (!rsync_pid || rsync_stopped)
return;
rsync_stopped = 1;
}
-void restart_rsync_process(void)
+static void restart_rsync_process(void)
{
if (!rsync_pid || !rsync_stopped)
return;
/**
* Print a log message about the exit status of a child.
*/
-void log_termination_msg(pid_t pid, int status)
+static void log_termination_msg(pid_t pid, int status)
{
if (WIFEXITED(status))
DSS_INFO_LOG("child %i exited. Exit status: %i\n", (int)pid,
DSS_WARNING_LOG("child %i terminated abormally\n", (int)pid);
}
-int wait_for_process(pid_t pid, int *status)
+static int wait_for_process(pid_t pid, int *status)
{
int ret;
log_termination_msg(pid, *status);
return ret;
}
-int handle_rm_exit(int status)
+
+static int handle_rm_exit(int status)
{
rm_pid = 0;
if (!WIFEXITED(status))
return 1;
}
-int wait_for_rm_process(void)
+static int wait_for_rm_process(void)
{
int status, ret = wait_for_process(rm_pid, &status);
return handle_rm_exit(status);
}
-int handle_rsync_exit(int status)
+static int handle_rsync_exit(int status)
{
int es, ret;
goto out;
}
es = WEXITSTATUS(status);
+ if (es == 13) { /* Errors with program diagnostics */
+ DSS_WARNING_LOG("rsync process %d returned %d -- restarting\n",
+ (int)rsync_pid, es);
+ snapshot_creation_status = SCS_RSYNC_NEEDS_RESTART;
+ gettimeofday(&next_snapshot_time, NULL);
+ next_snapshot_time.tv_sec += 60;
+ ret = 1;
+ goto out;
+ }
if (es != 0 && es != 23 && es != 24) {
DSS_ERROR_LOG("rsync process %d returned %d\n", (int)rsync_pid, es);
ret = -E_BAD_EXIT_CODE;
return ret;
}
-int handle_pre_create_hook_exit(int status)
+static int handle_pre_create_hook_exit(int status)
{
int es, ret;
return ret;
}
-int handle_sigchld(void)
+static int handle_sigchld(void)
{
pid_t pid;
int status, ret = reap_child(&pid, &status);
return 1;
}
DSS_EMERG_LOG("BUG: unknown process %d died\n", (int)pid);
- exit(EXIT_FAILURE);
+ return -E_BUG;
}
-
-int check_config(void)
+static int check_config(void)
{
if (conf.unit_interval_arg <= 0) {
DSS_ERROR_LOG("bad unit interval: %i\n", conf.unit_interval_arg);
return 1;
}
-/* exits on errors */
-void parse_config_file(int override)
+static int parse_config_file(int override)
{
int ret;
char *config_file;
.override = override,
.initialize = 0,
.check_required = 1,
- .check_ambiguity = 0
+ .check_ambiguity = 0,
+ .print_errors = 1
};
cmdline_parser_config_file(config_file, &conf, ¶ms);
}
logfile = open_log(conf.logfile_arg);
log_welcome(conf.loglevel_arg);
}
- DSS_EMERG_LOG("loglevel: %d\n", conf.loglevel_arg);
+ DSS_DEBUG_LOG("loglevel: %d\n", conf.loglevel_arg);
// cmdline_parser_dump(logfile? logfile : stdout, &conf);
- ret = dss_chdir(conf.dest_dir_arg);
out:
free(config_file);
- if (ret >= 0)
- return;
- DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
- exit(EXIT_FAILURE);
+ if (ret < 0)
+ DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
+ return ret;
}
-void handle_sighup(void)
+static int change_to_dest_dir(void)
{
+ DSS_INFO_LOG("changing cwd to %s\n", conf.dest_dir_arg);
+ return dss_chdir(conf.dest_dir_arg);
+}
+
+static int handle_sighup(void)
+{
+ int ret;
+
DSS_NOTICE_LOG("SIGHUP\n");
- parse_config_file(1);
+ ret = parse_config_file(1);
+ if (ret < 0)
+ return ret;
+ return change_to_dest_dir();
}
-void handle_signal(void)
+static int handle_signal(void)
{
int sig, ret = next_signal();
restart_rsync_process();
kill_process(rsync_pid);
kill_process(rm_pid);
- exit(EXIT_FAILURE);
+ ret = -E_SIGNAL;
+ break;
case SIGHUP:
- handle_sighup();
- ret = 1;
+ ret = handle_sighup();
break;
case SIGCHLD:
ret = handle_sigchld();
out:
if (ret < 0)
DSS_ERROR_LOG("%s\n", dss_strerror(-ret));
+ return ret;
}
-void create_rsync_argv(char ***argv, int64_t *num)
+/*
+ * We can not use rsync locally if the local user is different from the remote
+ * user or if the src dir is not on the local host (or both).
+ */
+static int use_rsync_locally(char *logname)
+{
+ char *h = conf.remote_host_arg;
+
+ if (strcmp(h, "localhost") && strcmp(h, "127.0.0.1"))
+ return 0;
+ if (conf.remote_user_given && strcmp(conf.remote_user_arg, logname))
+ return 0;
+ return 1;
+}
+
+static void create_rsync_argv(char ***argv, int64_t *num)
{
char *logname, *newest;
int i = 0, j;
free(newest);
} else
DSS_INFO_LOG("no previous snapshot found\n");
- if (conf.exclude_patterns_given) {
- (*argv)[i++] = dss_strdup("--exclude-from");
- (*argv)[i++] = dss_strdup(conf.exclude_patterns_arg);
-
- }
logname = dss_logname();
- if (conf.remote_user_given && !strcmp(conf.remote_user_arg, logname))
+ if (use_rsync_locally(logname))
(*argv)[i++] = dss_strdup(conf.source_dir_arg);
else
(*argv)[i++] = make_message("%s@%s:%s/", conf.remote_user_given?
DSS_DEBUG_LOG("argv[%d] = %s\n", j, (*argv)[j]);
}
-void free_rsync_argv(char **argv)
+static void free_rsync_argv(char **argv)
{
int i;
+
+ if (!argv)
+ return;
for (i = 0; argv[i]; i++)
free(argv[i]);
free(argv);
}
-int create_snapshot(char **argv)
+static int create_snapshot(char **argv)
{
int ret, fds[3] = {0, 0, 0};
char *name;
return ret;
}
-int select_loop(void)
+static int select_loop(void)
{
int ret;
- struct timeval tv = {.tv_sec = 0, .tv_usec = 0};
+ /* check every 60 seconds for free disk space */
+ struct timeval tv;
+ char **rsync_argv = NULL;
for (;;) {
fd_set rfds;
int low_disk_space;
- char **rsync_argv;
- struct timeval now, *tvp = &tv;
+ struct timeval now, *tvp;
- if (rsync_pid)
- tv.tv_sec = 60; /* check every 60 seconds for free disk space */
- else if (rm_pid)
+ if (rm_pid)
tvp = NULL; /* sleep until rm process dies */
+ else { /* sleep one minute */
+ tv.tv_sec = 60;
+ tv.tv_usec = 0;
+ tvp = &tv;
+ }
FD_ZERO(&rfds);
FD_SET(signal_pipe, &rfds);
- DSS_DEBUG_LOG("tvp: %p, tv_sec: %lu\n", tvp, (long unsigned) tv.tv_sec);
+ DSS_DEBUG_LOG("tvp: %p, tv_sec : %lu\n", tvp, (long unsigned) tv.tv_sec);
ret = dss_select(signal_pipe + 1, &rfds, NULL, tvp);
if (ret < 0)
- return ret;
- if (FD_ISSET(signal_pipe, &rfds))
- handle_signal();
+ goto out;
+ if (FD_ISSET(signal_pipe, &rfds)) {
+ ret = handle_signal();
+ if (ret < 0)
+ goto out;
+ }
if (rm_pid)
continue;
ret = disk_space_low();
if (ret < 0)
- break;
+ goto out;
low_disk_space = ret;
ret = try_to_free_disk_space(low_disk_space);
if (ret < 0)
- break;
+ goto out;
if (rm_pid) {
stop_rsync_process();
continue;
}
restart_rsync_process();
gettimeofday(&now, NULL);
- if (tv_diff(&next_snapshot_time, &now, &tv) > 0)
+ if (tv_diff(&next_snapshot_time, &now, NULL) > 0)
continue;
switch (snapshot_creation_status) {
case SCS_READY:
continue;
case SCS_PRE_HOOK_RUNNING:
continue;
+ case SCS_RSYNC_NEEDS_RESTART:
+ ret = create_snapshot(rsync_argv);
+ if (ret < 0)
+ goto out;
+ continue;
case SCS_PRE_HOOK_SUCCESS:
+ free_rsync_argv(rsync_argv);
create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
ret = create_snapshot(rsync_argv);
- free_rsync_argv(rsync_argv);
if (ret < 0)
goto out;
continue;
return ret;
}
-int com_run(void)
+static void exit_hook(int exit_code)
+{
+ int fds[3] = {0, 0, 0};
+ char *argv[] = {conf.exit_hook_arg, dss_strerror(-exit_code), NULL};
+ pid_t pid;
+
+ if (!conf.exit_hook_given)
+ return;
+ DSS_NOTICE_LOG("executing %s %s\n", argv[0], argv[1]);
+ dss_exec(&pid, conf.exit_hook_arg, argv, fds);
+}
+
+static int com_run(void)
{
int ret;
if (ret < 0)
return ret;
compute_next_snapshot_time();
- return select_loop();
+ ret = select_loop();
+ if (ret >= 0) /* impossible */
+ ret = -E_BUG;
+ exit_hook(ret);
+ return ret;
}
-int com_prune(void)
+static int com_prune(void)
{
int ret;
struct snapshot_list sl;
return ret;
}
-int com_create(void)
+static int com_create(void)
{
int ret, status;
char **rsync_argv;
return ret;
}
-int com_ls(void)
+static int com_ls(void)
{
int i;
struct snapshot_list sl;
struct snapshot *s;
dss_get_snapshot_list(&sl);
- FOR_EACH_SNAPSHOT(s, i, &sl)
- dss_msg("%u\t%s\n", s->interval, s->name);
+ FOR_EACH_SNAPSHOT(s, i, &sl) {
+ int64_t d = 0;
+ if (s->flags & SS_COMPLETE)
+ d = (s->completion_time - s->creation_time) / 60;
+ dss_msg("%u\t%s\t%3" PRId64 ":%02" PRId64 "\n", s->interval, s->name, d/60, d%60);
+ };
free_snapshot_list(&sl);
return 1;
}
-static void setup_signal_handling(void)
+static int setup_signal_handling(void)
{
int ret;
signal_pipe = signal_init(); /* always successful */
ret = install_sighandler(SIGINT);
if (ret < 0)
- goto err;
+ return ret;
ret = install_sighandler(SIGTERM);
if (ret < 0)
- goto err;
- ret = install_sighandler(SIGCHLD);
- if (ret < 0)
- goto err;
- return;
-err:
- DSS_EMERG_LOG("could not install signal handlers\n");
- exit(EXIT_FAILURE);
+ return ret;
+ return install_sighandler(SIGCHLD);
}
-
+/**
+ * The main function of dss.
+ *
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ */
int main(int argc, char **argv)
{
int ret;
.override = 0,
.initialize = 1,
.check_required = 0,
- .check_ambiguity = 0
+ .check_ambiguity = 0,
+ .print_errors = 1
};
cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
- parse_config_file(0);
-
+ ret = parse_config_file(0);
+ if (ret < 0)
+ goto out;
if (conf.daemon_given)
daemon_init();
- setup_signal_handling();
+ ret = change_to_dest_dir();
+ if (ret < 0)
+ goto out;
+ ret = setup_signal_handling();
+ if (ret < 0)
+ goto out;
ret = call_command_handler();
+out:
if (ret < 0)
DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);
projects / dss.git / blobdiff