dss.c: Remove obsolete TODO item.
[dss.git] / dss.c
diff --git a/dss.c b/dss.c
index 4a14c4b01289958657c1828091948709e0e0f8cf..cd69c27d85a5066a49c00817621db6371c01d31e 100644 (file)
--- a/dss.c
+++ b/dss.c
@@ -1,3 +1,8 @@
+/*
+ * 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 */
@@ -41,16 +47,16 @@ static int rsync_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;
 
 
@@ -63,11 +69,11 @@ DEFINE_DSS_ERRLIST;
        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");
@@ -76,6 +82,14 @@ int call_command_handler(void)
 #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;
@@ -101,7 +115,7 @@ __printf_2_3 void dss_log(int ll, const char* fmt,...)
 /**
  * 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;
@@ -110,8 +124,7 @@ __printf_1_2 void dss_msg(const char* fmt,...)
        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);
@@ -124,15 +137,18 @@ int disk_space_low(void)
        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;
@@ -176,7 +192,7 @@ out:
 }
 
 
-int remove_snapshot(struct snapshot *s)
+static int remove_snapshot(struct snapshot *s)
 {
        int fds[3] = {0, 0, 0};
        assert(!rm_pid);
@@ -196,13 +212,13 @@ out:
 /*
  * 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];
@@ -254,12 +270,12 @@ int remove_redundant_snapshot(struct snapshot_list *sl)
        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)
@@ -277,7 +293,7 @@ int remove_outdated_snapshot(struct snapshot_list *sl)
        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);
 
@@ -289,7 +305,7 @@ int remove_oldest_snapshot(struct snapshot_list *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;
@@ -308,7 +324,7 @@ int rename_incomplete_snapshot(int64_t start)
        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;
@@ -329,13 +345,13 @@ int try_to_free_disk_space(int low_disk_space)
        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};
 
@@ -352,7 +368,7 @@ int pre_create_hook(void)
        return ret;
 }
 
-int post_create_hook(void)
+static int post_create_hook(void)
 {
        int ret, fds[3] = {0, 0, 0};
        char *cmd;
@@ -373,7 +389,7 @@ int post_create_hook(void)
        return ret;
 }
 
-void kill_process(pid_t pid)
+static void kill_process(pid_t pid)
 {
        if (!pid)
                return;
@@ -381,7 +397,7 @@ void kill_process(pid_t pid)
        kill(pid, SIGTERM);
 }
 
-void stop_rsync_process(void)
+static void stop_rsync_process(void)
 {
        if (!rsync_pid || rsync_stopped)
                return;
@@ -389,7 +405,7 @@ void stop_rsync_process(void)
        rsync_stopped = 1;
 }
 
-void restart_rsync_process(void)
+static void restart_rsync_process(void)
 {
        if (!rsync_pid || !rsync_stopped)
                return;
@@ -401,7 +417,7 @@ void restart_rsync_process(void)
 /**
  * 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,
@@ -413,7 +429,7 @@ void log_termination_msg(pid_t pid, int status)
                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;
 
@@ -448,7 +464,8 @@ int wait_for_process(pid_t pid, int *status)
                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))
@@ -458,7 +475,7 @@ int handle_rm_exit(int 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);
 
@@ -467,7 +484,7 @@ int wait_for_rm_process(void)
        return handle_rm_exit(status);
 }
 
-int handle_rsync_exit(int status)
+static int handle_rsync_exit(int status)
 {
        int es, ret;
 
@@ -496,7 +513,7 @@ out:
        return ret;
 }
 
-int handle_pre_create_hook_exit(int status)
+static int handle_pre_create_hook_exit(int status)
 {
        int es, ret;
 
@@ -520,7 +537,7 @@ out:
        return ret;
 }
 
-int handle_sigchld(void)
+static int handle_sigchld(void)
 {
        pid_t pid;
        int status, ret = reap_child(&pid, &status);
@@ -542,8 +559,7 @@ int handle_sigchld(void)
        exit(EXIT_FAILURE);
 }
 
-
-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);
@@ -559,7 +575,7 @@ int check_config(void)
 }
 
 /* exits on errors */
-void parse_config_file(int override)
+static void parse_config_file(int override)
 {
        int ret;
        char *config_file;
@@ -591,7 +607,8 @@ void parse_config_file(int override)
                        .override = override,
                        .initialize = 0,
                        .check_required = 1,
-                       .check_ambiguity = 0
+                       .check_ambiguity = 0,
+                       .print_errors = 1
                };
                cmdline_parser_config_file(config_file, &conf, &params);
        }
@@ -616,7 +633,6 @@ void parse_config_file(int override)
        }
        DSS_EMERG_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)
@@ -625,13 +641,26 @@ out:
        exit(EXIT_FAILURE);
 }
 
-void handle_sighup(void)
+static void change_to_dest_dir(void)
+{
+       int ret;
+
+       DSS_INFO_LOG("changing cwd to %s\n", conf.dest_dir_arg);
+       ret = dss_chdir(conf.dest_dir_arg);
+       if (ret >= 0)
+               return;
+       DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
+       exit(EXIT_FAILURE);
+}
+
+static void handle_sighup(void)
 {
        DSS_NOTICE_LOG("SIGHUP\n");
        parse_config_file(1);
+       change_to_dest_dir();
 }
 
-void handle_signal(void)
+static void handle_signal(void)
 {
        int sig, ret = next_signal();
 
@@ -658,7 +687,7 @@ out:
                DSS_ERROR_LOG("%s\n", dss_strerror(-ret));
 }
 
-void create_rsync_argv(char ***argv, int64_t *num)
+static void create_rsync_argv(char ***argv, int64_t *num)
 {
        char *logname, *newest;
        int i = 0, j;
@@ -680,11 +709,6 @@ void create_rsync_argv(char ***argv, int64_t *num)
                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))
                (*argv)[i++] = dss_strdup(conf.source_dir_arg);
@@ -700,7 +724,7 @@ void create_rsync_argv(char ***argv, int64_t *num)
                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;
        for (i = 0; argv[i]; i++)
@@ -708,7 +732,7 @@ void free_rsync_argv(char **argv)
        free(argv);
 }
 
-int create_snapshot(char **argv)
+static int create_snapshot(char **argv)
 {
        int ret, fds[3] = {0, 0, 0};
        char *name;
@@ -723,24 +747,28 @@ int create_snapshot(char **argv)
        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;
 
        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;
@@ -761,7 +789,7 @@ int select_loop(void)
                }
                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:
@@ -793,7 +821,7 @@ out:
        return ret;
 }
 
-int com_run(void)
+static int com_run(void)
 {
        int ret;
 
@@ -808,7 +836,7 @@ int com_run(void)
        return select_loop();
 }
 
-int com_prune(void)
+static int com_prune(void)
 {
        int ret;
        struct snapshot_list sl;
@@ -847,7 +875,7 @@ out:
        return ret;
 }
 
-int com_create(void)
+static int com_create(void)
 {
        int ret, status;
        char **rsync_argv;
@@ -896,7 +924,7 @@ out:
        return ret;
 }
 
-int com_ls(void)
+static int com_ls(void)
 {
        int i;
        struct snapshot_list sl;
@@ -930,7 +958,12 @@ err:
        exit(EXIT_FAILURE);
 }
 
-
+/**
+ * The main function of dss.
+ *
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ */
 int main(int argc, char **argv)
 {
        int ret;
@@ -938,7 +971,8 @@ int main(int argc, char **argv)
                .override = 0,
                .initialize = 1,
                .check_required = 0,
-               .check_ambiguity = 0
+               .check_ambiguity = 0,
+               .print_errors = 1
        };
 
        cmdline_parser_ext(argc, argv, &conf, &params); /* aborts on errors */
@@ -946,6 +980,7 @@ int main(int argc, char **argv)
 
        if (conf.daemon_given)
                daemon_init();
+       change_to_dest_dir();
        setup_signal_handling();
        ret = call_command_handler();
        if (ret < 0)