2 * Copyright (C) 2008-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
11 #include <sys/types.h>
24 #include "gcc-compat.h"
37 /** Command line and config file options. */
38 static struct gengetopt_args_info conf;
39 /** Non-NULL if we log to a file. */
41 /** The read end of the signal pipe */
42 static int signal_pipe;
43 /** Process id of current pre-create-hook/rsync/post-create-hook process. */
44 static pid_t create_pid;
45 /** Whether the pre-create-hook/rsync/post-create-hook is currently stopped. */
46 static int create_process_stopped;
47 /** Process id of current pre-remove/rm/post-remove process. */
48 static pid_t remove_pid;
49 /** When the next snapshot is due. */
50 static int64_t next_snapshot_time;
51 /** When to try to remove something. */
52 static struct timeval next_removal_check;
53 /** Creation time of the snapshot currently being created. */
54 static int64_t current_snapshot_creation_time;
55 /** The snapshot currently being removed. */
56 struct snapshot *snapshot_currently_being_removed;
57 /** Needed by the post-create hook. */
58 static char *path_to_last_complete_snapshot;
59 static char *name_of_reference_snapshot;
60 /** \sa \ref snap.h for details. */
61 enum hook_status snapshot_creation_status;
62 /** \sa \ref snap.h for details. */
63 enum hook_status snapshot_removal_status;
69 /* a litte cpp magic helps to DRY */
75 #define COMMAND(x) static int com_ ##x(void);
78 #define COMMAND(x) if (conf.x ##_given) return com_ ##x();
79 static int call_command_handler(void)
82 DSS_EMERG_LOG("BUG: did not find command handler\n");
89 * The log function of dss.
92 * \param fml Usual format string.
94 * All DSS_XXX_LOG() macros use this function.
96 __printf_2_3 void dss_log(int ll, const char* fmt,...)
104 if (ll < conf.loglevel_arg)
106 outfd = logfile? logfile : stderr;
109 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
110 fprintf(outfd, "%s ", str);
111 if (conf.loglevel_arg <= INFO)
112 fprintf(outfd, "%i: ", ll);
114 vfprintf(outfd, fmt, argp);
119 * Print a message either to stdout or to the log file.
121 static __printf_1_2 void dss_msg(const char* fmt,...)
123 FILE *outfd = conf.daemon_given? logfile : stdout;
126 vfprintf(outfd, fmt, argp);
130 static int disk_space_low(void)
132 struct disk_space ds;
133 int ret = get_disk_space(".", &ds);
137 if (conf.min_free_mb_arg)
138 if (ds.free_mb < conf.min_free_mb_arg)
140 if (conf.min_free_percent_arg)
141 if (ds.percent_free < conf.min_free_percent_arg)
143 if (conf.min_free_percent_inodes_arg)
144 if (ds.percent_free_inodes < conf.min_free_percent_inodes_arg)
149 static void dss_get_snapshot_list(struct snapshot_list *sl)
151 get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
154 static int64_t compute_next_snapshot_time(void)
156 int64_t x = 0, now = get_current_time(), unit_interval
157 = 24 * 3600 * conf.unit_interval_arg, ret;
158 unsigned wanted = desired_number_of_snapshots(0, conf.num_intervals_arg),
159 num_complete_snapshots = 0;
161 struct snapshot *s = NULL;
162 struct snapshot_list sl;
164 dss_get_snapshot_list(&sl);
165 FOR_EACH_SNAPSHOT(s, i, &sl) {
166 if (!(s->flags & SS_COMPLETE))
168 num_complete_snapshots++;
169 x += s->completion_time - s->creation_time;
174 if (num_complete_snapshots == 0)
176 x /= num_complete_snapshots; /* avg time to create one snapshot */
177 if (unit_interval < x * wanted) /* oops, no sleep at all */
179 ret = s->completion_time + unit_interval / wanted - x;
181 free_snapshot_list(&sl);
185 static inline void invalidate_next_snapshot_time(void)
187 next_snapshot_time = 0;
190 static inline int next_snapshot_time_is_valid(void)
192 return next_snapshot_time != 0;
195 static int next_snapshot_is_due(void)
197 int64_t now = get_current_time();
199 if (!next_snapshot_time_is_valid())
200 next_snapshot_time = compute_next_snapshot_time();
201 if (next_snapshot_time <= now) {
202 DSS_DEBUG_LOG("next snapshot: now\n");
205 DSS_DEBUG_LOG("next snapshot due in %" PRId64 " seconds\n",
206 next_snapshot_time - now);
210 static int pre_create_hook(void)
212 int ret, fds[3] = {0, 0, 0};
214 assert(snapshot_creation_status == HS_READY);
215 /* make sure that the next snapshot time will be recomputed */
216 invalidate_next_snapshot_time();
217 DSS_DEBUG_LOG("executing %s\n", conf.pre_create_hook_arg);
218 ret = dss_exec_cmdline_pid(&create_pid,
219 conf.pre_create_hook_arg, fds);
222 snapshot_creation_status = HS_PRE_RUNNING;
226 static int pre_remove_hook(struct snapshot *s, const char *why)
228 int ret, fds[3] = {0, 0, 0};
233 DSS_DEBUG_LOG("%s snapshot %s\n", why, s->name);
234 assert(snapshot_removal_status == HS_READY);
235 assert(remove_pid == 0);
236 assert(!snapshot_currently_being_removed);
238 snapshot_currently_being_removed = dss_malloc(sizeof(struct snapshot));
239 *snapshot_currently_being_removed = *s;
240 snapshot_currently_being_removed->name = dss_strdup(s->name);
242 cmd = make_message("%s %s/%s", conf.pre_remove_hook_arg,
243 conf.dest_dir_arg, s->name);
244 DSS_DEBUG_LOG("executing %s\n", cmd);
245 ret = dss_exec_cmdline_pid(&remove_pid, cmd, fds);
249 snapshot_removal_status = HS_PRE_RUNNING;
253 static int exec_rm(void)
255 struct snapshot *s = snapshot_currently_being_removed;
256 int fds[3] = {0, 0, 0};
257 char *new_name = being_deleted_name(s);
258 char *argv[] = {"rm", "-rf", new_name, NULL};
261 assert(snapshot_removal_status == HS_PRE_SUCCESS);
262 assert(remove_pid == 0);
264 DSS_NOTICE_LOG("removing %s (interval = %i)\n", s->name, s->interval);
265 ret = dss_rename(s->name, new_name);
268 ret = dss_exec(&remove_pid, argv[0], argv, fds);
271 snapshot_removal_status = HS_RUNNING;
277 static int snapshot_is_being_created(struct snapshot *s)
279 return s->creation_time == current_snapshot_creation_time;
282 static struct snapshot *find_orphaned_snapshot(struct snapshot_list *sl)
287 DSS_DEBUG_LOG("looking for orphaned snapshots\n");
288 FOR_EACH_SNAPSHOT(s, i, sl) {
289 if (snapshot_is_being_created(s))
292 * We know that no rm is currently running, so if s is marked
293 * as being deleted, a previously started rm must have failed.
295 if (s->flags & SS_BEING_DELETED)
298 if (s->flags & SS_COMPLETE) /* good snapshot */
301 * This snapshot is incomplete and it is not the snapshot
302 * currently being created. However, we must not remove it if
303 * rsync is about to be restarted. As only the newest snapshot
304 * can be restarted, this snapshot is orphaned if it is not the
305 * newest snapshot or if we are not about to restart rsync.
307 if (get_newest_snapshot(sl) != s)
309 if (snapshot_creation_status != HS_NEEDS_RESTART)
312 /* no orphaned snapshots */
316 static int is_reference_snapshot(struct snapshot *s)
318 if (!name_of_reference_snapshot)
320 return strcmp(s->name, name_of_reference_snapshot)? 0 : 1;
324 * return: 0: no redundant snapshots, 1: rm process started, negative: error
326 static struct snapshot *find_redundant_snapshot(struct snapshot_list *sl)
330 unsigned missing = 0;
332 DSS_DEBUG_LOG("looking for intervals containing too many snapshots\n");
333 for (interval = conf.num_intervals_arg - 1; interval >= 0; interval--) {
334 unsigned keep = desired_number_of_snapshots(interval, conf.num_intervals_arg);
335 unsigned num = sl->interval_count[interval];
336 struct snapshot *victim = NULL, *prev = NULL;
337 int64_t score = LONG_MAX;
340 missing += keep - num;
341 // DSS_DEBUG_LOG("interval %i: keep: %u, have: %u, missing: %u\n",
342 // interval, keep, num, missing);
343 if (keep + missing >= num)
345 /* redundant snapshot in this interval, pick snapshot with lowest score */
346 FOR_EACH_SNAPSHOT(s, i, sl) {
349 if (snapshot_is_being_created(s))
351 if (is_reference_snapshot(s))
353 //DSS_DEBUG_LOG("checking %s\n", s->name);
354 if (s->interval > interval) {
358 if (s->interval < interval)
366 /* check if s is a better victim */
367 this_score = s->creation_time - prev->creation_time;
368 assert(this_score >= 0);
369 //DSS_DEBUG_LOG("%s: score %lli\n", s->name, (long long)score);
370 if (this_score < score) {
382 static struct snapshot *find_outdated_snapshot(struct snapshot_list *sl)
387 DSS_DEBUG_LOG("looking for snapshots belonging to intervals >= %d\n",
388 conf.num_intervals_arg);
389 FOR_EACH_SNAPSHOT(s, i, sl) {
390 if (snapshot_is_being_created(s))
392 if (is_reference_snapshot(s))
394 if (s->interval < conf.num_intervals_arg)
401 struct snapshot *find_oldest_removable_snapshot(struct snapshot_list *sl)
405 FOR_EACH_SNAPSHOT(s, i, sl) {
406 if (snapshot_is_being_created(s))
408 if (is_reference_snapshot(s))
410 DSS_INFO_LOG("oldest removable snapshot: %s\n", s->name);
416 static int rename_incomplete_snapshot(int64_t start)
421 free(path_to_last_complete_snapshot);
422 ret = complete_name(start, get_current_time(),
423 &path_to_last_complete_snapshot);
426 old_name = incomplete_name(start);
427 ret = dss_rename(old_name, path_to_last_complete_snapshot);
429 DSS_NOTICE_LOG("%s -> %s\n", old_name,
430 path_to_last_complete_snapshot);
435 static int try_to_free_disk_space(void)
438 struct snapshot_list sl;
439 struct snapshot *victim;
444 ret = disk_space_low();
447 low_disk_space = ret;
448 gettimeofday(&now, NULL);
449 if (tv_diff(&next_removal_check, &now, NULL) > 0)
451 if (!low_disk_space) {
452 if (conf.keep_redundant_given)
454 if (snapshot_creation_status != HS_READY)
456 if (next_snapshot_is_due())
459 dss_get_snapshot_list(&sl);
461 if (!low_disk_space && sl.num_snapshots <= 1)
464 victim = find_outdated_snapshot(&sl);
468 victim = find_redundant_snapshot(&sl);
471 /* try harder only if disk space is low */
475 victim = find_orphaned_snapshot(&sl);
478 DSS_WARNING_LOG("disk space low and nothing obvious to remove\n");
479 victim = find_oldest_removable_snapshot(&sl);
482 DSS_CRIT_LOG("uhuhu: disk space low and nothing to remove\n");
483 ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
486 ret = pre_remove_hook(victim, why);
488 free_snapshot_list(&sl);
492 static int post_create_hook(void)
494 int ret, fds[3] = {0, 0, 0};
497 cmd = make_message("%s %s/%s", conf.post_create_hook_arg,
498 conf.dest_dir_arg, path_to_last_complete_snapshot);
499 DSS_NOTICE_LOG("executing %s\n", cmd);
500 ret = dss_exec_cmdline_pid(&create_pid, cmd, fds);
504 snapshot_creation_status = HS_POST_RUNNING;
508 static int post_remove_hook(void)
510 int ret, fds[3] = {0, 0, 0};
512 struct snapshot *s = snapshot_currently_being_removed;
516 cmd = make_message("%s %s/%s", conf.post_remove_hook_arg,
517 conf.dest_dir_arg, s->name);
518 DSS_NOTICE_LOG("executing %s\n", cmd);
519 ret = dss_exec_cmdline_pid(&remove_pid, cmd, fds);
523 snapshot_removal_status = HS_POST_RUNNING;
527 static void dss_kill(pid_t pid, int sig, const char *msg)
529 const char *signame, *process_name;
534 case SIGTERM: signame = "TERM"; break;
535 case SIGSTOP: signame = "STOP"; break;
536 case SIGCONT: signame = "CONT"; break;
537 default: signame = "????";
540 if (pid == create_pid)
541 process_name = "create";
542 else if (pid == remove_pid)
543 process_name = "remove";
544 else process_name = "??????";
547 DSS_INFO_LOG("%s\n", msg);
548 DSS_DEBUG_LOG("sending signal %d (%s) to pid %d (%s process)\n",
549 sig, signame, (int)pid, process_name);
550 if (kill(pid, sig) >= 0)
552 DSS_INFO_LOG("failed to send signal %d (%s) to pid %d (%s process)\n",
553 sig, signame, (int)pid, process_name);
556 static void stop_create_process(void)
558 if (create_process_stopped)
560 dss_kill(create_pid, SIGSTOP, "suspending create process");
561 create_process_stopped = 1;
564 static void restart_create_process(void)
566 if (!create_process_stopped)
568 dss_kill(create_pid, SIGCONT, "resuming create process");
569 create_process_stopped = 0;
573 * Print a log message about the exit status of a child.
575 static void log_termination_msg(pid_t pid, int status)
577 if (WIFEXITED(status))
578 DSS_INFO_LOG("child %i exited. Exit status: %i\n", (int)pid,
579 WEXITSTATUS(status));
580 else if (WIFSIGNALED(status))
581 DSS_NOTICE_LOG("child %i was killed by signal %i\n", (int)pid,
584 DSS_WARNING_LOG("child %i terminated abormally\n", (int)pid);
587 static int wait_for_process(pid_t pid, int *status)
591 DSS_DEBUG_LOG("Waiting for process %d to terminate\n", (int)pid);
596 FD_SET(signal_pipe, &rfds);
597 ret = dss_select(signal_pipe + 1, &rfds, NULL, NULL);
603 if (ret == SIGCHLD) {
604 ret = waitpid(pid, status, 0);
607 if (errno != EINTR) { /* error */
608 ret = -ERRNO_TO_DSS_ERROR(errno);
612 /* SIGINT or SIGTERM */
613 dss_kill(pid, SIGTERM, "killing child process");
616 DSS_ERROR_LOG("failed to wait for process %d\n", (int)pid);
618 log_termination_msg(pid, *status);
622 static void handle_pre_remove_exit(int status)
624 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
625 snapshot_removal_status = HS_READY;
626 gettimeofday(&next_removal_check, NULL);
627 next_removal_check.tv_sec += 60;
630 snapshot_removal_status = HS_PRE_SUCCESS;
633 static int handle_rm_exit(int status)
635 if (!WIFEXITED(status)) {
636 snapshot_removal_status = HS_READY;
637 return -E_INVOLUNTARY_EXIT;
639 if (WEXITSTATUS(status)) {
640 snapshot_removal_status = HS_READY;
641 return -E_BAD_EXIT_CODE;
643 snapshot_removal_status = HS_SUCCESS;
647 static void handle_post_remove_exit(void)
649 snapshot_removal_status = HS_READY;
652 static int handle_remove_exit(int status)
655 struct snapshot *s = snapshot_currently_being_removed;
658 switch (snapshot_removal_status) {
660 handle_pre_remove_exit(status);
664 ret = handle_rm_exit(status);
666 case HS_POST_RUNNING:
667 handle_post_remove_exit();
673 if (snapshot_removal_status == HS_READY) {
676 snapshot_currently_being_removed = NULL;
682 static int wait_for_remove_process(void)
688 snapshot_removal_status == HS_PRE_RUNNING ||
689 snapshot_removal_status == HS_RUNNING ||
690 snapshot_removal_status == HS_POST_RUNNING
692 ret = wait_for_process(remove_pid, &status);
695 return handle_remove_exit(status);
698 static int handle_rsync_exit(int status)
702 if (!WIFEXITED(status)) {
703 DSS_ERROR_LOG("rsync process %d died involuntary\n", (int)create_pid);
704 ret = -E_INVOLUNTARY_EXIT;
705 snapshot_creation_status = HS_READY;
708 es = WEXITSTATUS(status);
710 * Restart rsync on non-fatal errors:
711 * 12: Error in rsync protocol data stream
712 * 13: Errors with program diagnostics
714 if (es == 12 || es == 13) {
715 DSS_WARNING_LOG("rsync process %d returned %d -- restarting\n",
716 (int)create_pid, es);
717 snapshot_creation_status = HS_NEEDS_RESTART;
718 next_snapshot_time = get_current_time() + 60;
722 if (es != 0 && es != 23 && es != 24) {
723 DSS_ERROR_LOG("rsync process %d returned %d\n", (int)create_pid, es);
724 ret = -E_BAD_EXIT_CODE;
725 snapshot_creation_status = HS_READY;
728 ret = rename_incomplete_snapshot(current_snapshot_creation_time);
731 snapshot_creation_status = HS_SUCCESS;
732 free(name_of_reference_snapshot);
733 name_of_reference_snapshot = NULL;
735 create_process_stopped = 0;
739 static int handle_pre_create_hook_exit(int status)
742 static int warn_count;
744 if (!WIFEXITED(status)) {
745 snapshot_creation_status = HS_READY;
746 ret = -E_INVOLUNTARY_EXIT;
749 es = WEXITSTATUS(status);
752 DSS_NOTICE_LOG("pre_create_hook %s returned %d\n",
753 conf.pre_create_hook_arg, es);
754 DSS_NOTICE_LOG("deferring snapshot creation...\n");
755 warn_count = 60; /* warn only once per hour */
757 next_snapshot_time = get_current_time() + 60;
758 snapshot_creation_status = HS_READY;
763 snapshot_creation_status = HS_PRE_SUCCESS;
769 static int handle_sigchld(void)
772 int status, ret = reap_child(&pid, &status);
777 if (pid == create_pid) {
778 switch (snapshot_creation_status) {
780 ret = handle_pre_create_hook_exit(status);
783 ret = handle_rsync_exit(status);
785 case HS_POST_RUNNING:
786 snapshot_creation_status = HS_READY;
790 DSS_EMERG_LOG("BUG: create can't die in status %d\n",
791 snapshot_creation_status);
797 if (pid == remove_pid) {
798 ret = handle_remove_exit(status);
803 DSS_EMERG_LOG("BUG: unknown process %d died\n", (int)pid);
807 static int check_config(void)
809 if (conf.unit_interval_arg <= 0) {
810 DSS_ERROR_LOG("bad unit interval: %i\n", conf.unit_interval_arg);
811 return -E_INVALID_NUMBER;
813 DSS_DEBUG_LOG("unit interval: %i day(s)\n", conf.unit_interval_arg);
814 if (conf.num_intervals_arg <= 0) {
815 DSS_ERROR_LOG("bad number of intervals %i\n", conf.num_intervals_arg);
816 return -E_INVALID_NUMBER;
818 DSS_DEBUG_LOG("number of intervals: %i\n", conf.num_intervals_arg);
823 * Returns < 0 on errors, 0 if no config file is given and > 0 if the config
824 * file was read successfully.
826 static int parse_config_file(int override)
828 int ret, config_file_exists;
831 char *old_logfile_arg = NULL;
832 int old_daemon_given = 0;
834 if (conf.config_file_given)
835 config_file = dss_strdup(conf.config_file_arg);
837 char *home = get_homedir();
838 config_file = make_message("%s/.dssrc", home);
841 if (override) { /* SIGHUP */
842 if (conf.logfile_given)
843 old_logfile_arg = dss_strdup(conf.logfile_arg);
844 old_daemon_given = conf.daemon_given;
847 config_file_exists = !stat(config_file, &statbuf);
848 if (!config_file_exists && conf.config_file_given) {
849 ret = -ERRNO_TO_DSS_ERROR(errno);
850 DSS_ERROR_LOG("failed to stat config file %s\n", config_file);
853 if (config_file_exists) {
854 struct cmdline_parser_params params = {
855 .override = override,
858 .check_ambiguity = 0,
861 if (override) { /* invalidate all rsync options */
864 for (i = 0; i < conf.rsync_option_given; i++) {
865 free(conf.rsync_option_arg[i]);
866 conf.rsync_option_arg[i] = NULL;
868 conf.rsync_option_given = 0;
870 cmdline_parser_config_file(config_file, &conf, ¶ms);
872 ret = check_config();
876 /* don't change daemon mode on SIGHUP */
877 conf.daemon_given = old_daemon_given;
880 if (conf.logfile_given)
881 free(old_logfile_arg);
882 else if (conf.daemon_given) { /* re-use old logfile */
883 conf.logfile_arg = old_logfile_arg;
884 conf.logfile_given = 1;
887 if (conf.logfile_given) {
888 logfile = open_log(conf.logfile_arg);
889 log_welcome(conf.loglevel_arg);
891 DSS_DEBUG_LOG("loglevel: %d\n", conf.loglevel_arg);
892 ret = config_file_exists;
896 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
900 static int change_to_dest_dir(void)
902 DSS_INFO_LOG("changing cwd to %s\n", conf.dest_dir_arg);
903 return dss_chdir(conf.dest_dir_arg);
906 static void dump_dss_config(const char *msg)
908 if (conf.loglevel_arg > INFO)
910 DSS_INFO_LOG("%s\n", msg);
911 cmdline_parser_dump(logfile? logfile : stderr, &conf);
914 static int handle_sighup(void)
918 DSS_NOTICE_LOG("SIGHUP, re-reading config\n");
919 dump_dss_config("current config");
920 ret = parse_config_file(1);
923 dump_dss_config("new config");
924 invalidate_next_snapshot_time();
925 return change_to_dest_dir();
928 static int handle_signal(void)
930 int sig, ret = next_signal();
938 restart_create_process();
939 dss_kill(create_pid, SIGTERM, NULL);
940 dss_kill(remove_pid, SIGTERM, NULL);
944 ret = handle_sighup();
947 ret = handle_sigchld();
952 DSS_ERROR_LOG("%s\n", dss_strerror(-ret));
957 * We can not use rsync locally if the local user is different from the remote
958 * user or if the src dir is not on the local host (or both).
960 static int use_rsync_locally(char *logname)
962 char *h = conf.remote_host_arg;
964 if (strcmp(h, "localhost") && strcmp(h, "127.0.0.1"))
966 if (conf.remote_user_given && strcmp(conf.remote_user_arg, logname))
971 static int rename_resume_snap(int64_t creation_time)
973 struct snapshot_list sl = {.num_snapshots = 0};
975 char *new_name = incomplete_name(creation_time);
979 if (conf.no_resume_given)
981 dss_get_snapshot_list(&sl);
982 s = get_newest_snapshot(&sl);
985 if ((s->flags & SS_COMPLETE) != 0) /* complete */
987 DSS_INFO_LOG("resuming: reusing %s as destination dir\n", s->name);
988 ret = dss_rename(s->name, new_name);
991 DSS_NOTICE_LOG("creating new snapshot %s\n", new_name);
993 free_snapshot_list(&sl);
997 static void create_rsync_argv(char ***argv, int64_t *num)
1001 struct snapshot_list sl;
1003 dss_get_snapshot_list(&sl);
1004 assert(!name_of_reference_snapshot);
1005 name_of_reference_snapshot = name_of_newest_complete_snapshot(&sl);
1006 free_snapshot_list(&sl);
1008 *argv = dss_malloc((15 + conf.rsync_option_given) * sizeof(char *));
1009 (*argv)[i++] = dss_strdup("rsync");
1010 (*argv)[i++] = dss_strdup("-aq");
1011 (*argv)[i++] = dss_strdup("--delete");
1012 for (j = 0; j < conf.rsync_option_given; j++)
1013 (*argv)[i++] = dss_strdup(conf.rsync_option_arg[j]);
1014 if (name_of_reference_snapshot) {
1015 DSS_INFO_LOG("using %s as reference\n", name_of_reference_snapshot);
1016 (*argv)[i++] = make_message("--link-dest=../%s",
1017 name_of_reference_snapshot);
1019 DSS_INFO_LOG("no suitable reference snapshot found\n");
1020 logname = dss_logname();
1021 if (use_rsync_locally(logname))
1022 (*argv)[i++] = dss_strdup(conf.source_dir_arg);
1024 (*argv)[i++] = make_message("%s@%s:%s/", conf.remote_user_given?
1025 conf.remote_user_arg : logname,
1026 conf.remote_host_arg, conf.source_dir_arg);
1028 *num = get_current_time();
1029 (*argv)[i++] = incomplete_name(*num);
1030 (*argv)[i++] = NULL;
1031 for (j = 0; j < i; j++)
1032 DSS_DEBUG_LOG("argv[%d] = %s\n", j, (*argv)[j]);
1035 static void free_rsync_argv(char **argv)
1041 for (i = 0; argv[i]; i++)
1046 static int create_snapshot(char **argv)
1048 int ret, fds[3] = {0, 0, 0};
1050 ret = rename_resume_snap(current_snapshot_creation_time);
1053 ret = dss_exec(&create_pid, argv[0], argv, fds);
1056 snapshot_creation_status = HS_RUNNING;
1060 static int select_loop(void)
1063 /* check every 60 seconds for free disk space */
1065 char **rsync_argv = NULL;
1069 struct timeval *tvp;
1072 tvp = NULL; /* sleep until rm hook/process dies */
1073 else { /* sleep one minute */
1079 FD_SET(signal_pipe, &rfds);
1080 ret = dss_select(signal_pipe + 1, &rfds, NULL, tvp);
1083 if (FD_ISSET(signal_pipe, &rfds)) {
1084 ret = handle_signal();
1090 if (snapshot_removal_status == HS_PRE_SUCCESS) {
1096 if (snapshot_removal_status == HS_SUCCESS) {
1097 ret = post_remove_hook();
1102 ret = try_to_free_disk_space();
1105 if (snapshot_removal_status != HS_READY) {
1106 stop_create_process();
1109 restart_create_process();
1110 switch (snapshot_creation_status) {
1112 if (!next_snapshot_is_due())
1114 ret = pre_create_hook();
1118 case HS_PRE_RUNNING:
1120 case HS_POST_RUNNING:
1122 case HS_PRE_SUCCESS:
1123 if (!name_of_reference_snapshot) {
1124 free_rsync_argv(rsync_argv);
1125 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1127 ret = create_snapshot(rsync_argv);
1131 case HS_NEEDS_RESTART:
1132 if (!next_snapshot_is_due())
1134 ret = create_snapshot(rsync_argv);
1139 ret = post_create_hook();
1149 static void exit_hook(int exit_code)
1151 int fds[3] = {0, 0, 0};
1152 char *argv[] = {conf.exit_hook_arg, dss_strerror(-exit_code), NULL};
1155 DSS_NOTICE_LOG("executing %s %s\n", argv[0], argv[1]);
1156 dss_exec(&pid, conf.exit_hook_arg, argv, fds);
1159 static int com_run(void)
1163 if (conf.dry_run_given) {
1164 DSS_ERROR_LOG("dry_run not supported by this command\n");
1167 ret = install_sighandler(SIGHUP);
1170 ret = select_loop();
1171 if (ret >= 0) /* impossible */
1177 static int com_prune(void)
1180 struct snapshot_list sl;
1181 struct snapshot *victim;
1182 struct disk_space ds;
1185 ret = get_disk_space(".", &ds);
1188 log_disk_space(&ds);
1189 dss_get_snapshot_list(&sl);
1191 victim = find_outdated_snapshot(&sl);
1195 victim = find_redundant_snapshot(&sl);
1201 if (conf.dry_run_given) {
1202 dss_msg("%s snapshot %s (interval = %i)\n",
1203 why, victim->name, victim->interval);
1207 ret = pre_remove_hook(victim, why);
1210 if (snapshot_removal_status == HS_PRE_RUNNING) {
1211 ret = wait_for_remove_process();
1214 if (snapshot_removal_status != HS_PRE_SUCCESS)
1220 ret = wait_for_remove_process();
1223 if (snapshot_removal_status != HS_SUCCESS)
1225 ret = post_remove_hook();
1228 if (snapshot_removal_status != HS_POST_RUNNING)
1230 ret = wait_for_remove_process();
1235 free_snapshot_list(&sl);
1239 static int com_create(void)
1244 if (conf.dry_run_given) {
1247 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1248 for (i = 0; rsync_argv[i]; i++) {
1250 msg = make_message("%s%s%s", tmp? tmp : "",
1251 tmp? " " : "", rsync_argv[i]);
1254 free_rsync_argv(rsync_argv);
1255 dss_msg("%s\n", msg);
1259 ret = pre_create_hook();
1263 ret = wait_for_process(create_pid, &status);
1266 ret = handle_pre_create_hook_exit(status);
1267 if (ret <= 0) /* error, or pre-create failed */
1270 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1271 ret = create_snapshot(rsync_argv);
1274 ret = wait_for_process(create_pid, &status);
1277 ret = handle_rsync_exit(status);
1282 ret = wait_for_process(create_pid, &status);
1284 free_rsync_argv(rsync_argv);
1288 static int com_ls(void)
1291 struct snapshot_list sl;
1294 dss_get_snapshot_list(&sl);
1295 FOR_EACH_SNAPSHOT(s, i, &sl) {
1297 if (s->flags & SS_COMPLETE)
1298 d = (s->completion_time - s->creation_time) / 60;
1299 dss_msg("%u\t%s\t%3" PRId64 ":%02" PRId64 "\n", s->interval, s->name, d/60, d%60);
1301 free_snapshot_list(&sl);
1305 static int setup_signal_handling(void)
1309 DSS_INFO_LOG("setting up signal handlers\n");
1310 signal_pipe = signal_init(); /* always successful */
1311 ret = install_sighandler(SIGINT);
1314 ret = install_sighandler(SIGTERM);
1317 return install_sighandler(SIGCHLD);
1321 * The main function of dss.
1323 * \param argc Usual argument count.
1324 * \param argv Usual argument vector.
1326 int main(int argc, char **argv)
1329 struct cmdline_parser_params params = {
1332 .check_required = 0,
1333 .check_ambiguity = 0,
1337 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1338 ret = parse_config_file(0);
1341 if (ret == 0) { /* no config file given */
1343 * Parse the command line options again, but this time check
1344 * that all required options are given.
1346 params = (struct cmdline_parser_params) {
1349 .check_required = 1,
1350 .check_ambiguity = 1,
1353 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1355 if (conf.daemon_given)
1357 dump_dss_config("dss configuration");
1358 ret = change_to_dest_dir();
1361 ret = setup_signal_handling();
1364 ret = call_command_handler();
1367 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
1368 exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);