2 * Copyright (C) 2008-2011 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
11 #include <sys/types.h>
25 #include "gcc-compat.h"
39 /** Command line and config file options. */
40 static struct gengetopt_args_info conf;
41 /** Non-NULL if we log to a file. */
43 /** The read end of the signal pipe */
44 static int signal_pipe;
45 /** Process id of current pre-create-hook/rsync/post-create-hook process. */
46 static pid_t create_pid;
47 /** Whether the pre-create-hook/rsync/post-create-hook is currently stopped. */
48 static int create_process_stopped;
49 /** How many times in a row the rsync command failed. */
50 static int num_consecutive_rsync_errors;
51 /** Process id of current pre-remove/rm/post-remove process. */
52 static pid_t remove_pid;
53 /** When the next snapshot is due. */
54 static int64_t next_snapshot_time;
55 /** When to try to remove something. */
56 static struct timeval next_removal_check;
57 /** Creation time of the snapshot currently being created. */
58 static int64_t current_snapshot_creation_time;
59 /** The snapshot currently being removed. */
60 struct snapshot *snapshot_currently_being_removed;
61 /** Needed by the post-create hook. */
62 static char *path_to_last_complete_snapshot;
63 static char *name_of_reference_snapshot;
64 /** \sa \ref snap.h for details. */
65 enum hook_status snapshot_creation_status;
66 /** \sa \ref snap.h for details. */
67 enum hook_status snapshot_removal_status;
71 static const char *hook_status_description[] = {HOOK_STATUS_ARRAY};
73 /* may be called with ds == NULL. */
74 static int disk_space_low(struct disk_space *ds)
76 struct disk_space ds_struct;
79 int ret = get_disk_space(".", &ds_struct);
84 if (conf.min_free_mb_arg)
85 if (ds->free_mb < conf.min_free_mb_arg)
87 if (conf.min_free_percent_arg)
88 if (ds->percent_free < conf.min_free_percent_arg)
90 if (conf.min_free_percent_inodes_arg)
91 if (ds->percent_free_inodes < conf.min_free_percent_inodes_arg)
96 static void dump_dss_config(const char *msg)
98 const char dash[] = "-----------------------------";
100 FILE *log = logfile? logfile : stderr;
101 struct disk_space ds;
102 int64_t now = get_current_time();
104 if (conf.loglevel_arg > INFO)
107 fprintf(log, "%s <%s config> %s\n", dash, msg, dash);
108 fprintf(log, "\n*** disk space ***\n\n");
109 ret = get_disk_space(".", &ds);
111 DSS_INFO_LOG(("disk space low: %s\n", disk_space_low(&ds)?
115 DSS_ERROR_LOG(("can not get free disk space: %s\n",
116 dss_strerror(-ret)));
118 /* we continue on errors from get_disk_space */
120 fprintf(log, "\n*** command line and config file options ***\n\n");
121 cmdline_parser_dump(log, &conf);
122 fprintf(log, "\n*** internal state ***\n\n");
126 "snapshot_currently_being_removed: %s\n"
127 "path_to_last_complete_snapshot: %s\n"
128 "reference_snapshot: %s\n"
129 "snapshot_creation_status: %s\n"
130 "snapshot_removal_status: %s\n"
131 "num_consecutive_rsync_errors: %d\n"
134 logfile? conf.logfile_arg : "stderr",
135 snapshot_currently_being_removed?
136 snapshot_currently_being_removed->name : "(none)",
137 path_to_last_complete_snapshot?
138 path_to_last_complete_snapshot : "(none)",
139 name_of_reference_snapshot?
140 name_of_reference_snapshot : "(none)",
141 hook_status_description[snapshot_creation_status],
142 hook_status_description[snapshot_removal_status],
143 num_consecutive_rsync_errors
147 "create_pid: %" PRId32 "\n"
148 "create process is %sstopped\n"
151 create_process_stopped? "" : "not "
154 fprintf(log, "remove_pid: %" PRId32 "\n", remove_pid);
155 if (next_snapshot_time != 0)
156 fprintf(log, "next snapshot due in %" PRId64 " seconds\n",
157 next_snapshot_time - now);
158 if (current_snapshot_creation_time != 0)
159 fprintf(log, "current_snapshot_creation_time: %"
160 PRId64 " (%" PRId64 " seconds ago)\n",
161 current_snapshot_creation_time,
162 now - current_snapshot_creation_time
164 if (next_removal_check.tv_sec != 0) {
165 fprintf(log, "next removal check: %llu (%llu seconds ago)\n",
166 (long long unsigned)next_removal_check.tv_sec,
167 now - (long long unsigned)next_removal_check.tv_sec
171 fprintf(log, "%s </%s config> %s\n", dash, msg, dash);
174 /* a litte cpp magic helps to DRY */
183 #define COMMAND(x) static int com_ ##x(void);
186 #define COMMAND(x) if (conf.x ##_given) return com_ ##x();
187 static int call_command_handler(void)
190 DSS_EMERG_LOG(("BUG: did not find command handler\n"));
196 static int loglevel = -1;
197 static const char *location_file = NULL;
198 static int location_line = -1;
199 static const char *location_func = NULL;
201 void dss_log_set_params(int ll, const char *file, int line, const char *func)
204 location_file = file;
205 location_line = line;
206 location_func = func;
210 * The log function of dss.
212 * \param ll Loglevel.
213 * \param fml Usual format string.
215 * All DSS_XXX_LOG() macros use this function.
217 __printf_1_2 void dss_log(const char* fmt,...)
225 if (loglevel < conf.loglevel_arg)
227 outfd = logfile? logfile : stderr;
230 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
231 fprintf(outfd, "%s ", str);
232 if (conf.loglevel_arg <= INFO)
233 fprintf(outfd, "%i: ", loglevel);
234 #ifdef DSS_NO_FUNC_NAMES
235 fprintf(outfd, "%s:%d: ", location_file, location_line);
237 fprintf(outfd, "%s: ", location_func);
240 vfprintf(outfd, fmt, argp);
245 * Print a message either to stdout or to the log file.
247 static __printf_1_2 void dss_msg(const char* fmt,...)
249 FILE *outfd = conf.daemon_given? logfile : stdout;
252 vfprintf(outfd, fmt, argp);
256 static char *get_config_file_name(void)
258 char *home, *config_file;
260 if (conf.config_file_given)
261 return dss_strdup(conf.config_file_arg);
262 home = get_homedir();
263 config_file = make_message("%s/.dssrc", home);
268 static int send_signal(int sig)
271 char *config_file = get_config_file_name();
272 int ret = get_dss_pid(config_file, &pid);
277 if (conf.dry_run_given) {
278 dss_msg("%d\n", (int)pid);
281 ret = kill(pid, sig);
283 return -ERRNO_TO_DSS_ERROR(errno);
287 static int com_kill(void)
289 return send_signal(SIGTERM);
292 static int com_reload(void)
294 return send_signal(SIGHUP);
297 static void dss_get_snapshot_list(struct snapshot_list *sl)
299 get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
302 static int64_t compute_next_snapshot_time(void)
304 int64_t x = 0, now = get_current_time(), unit_interval
305 = 24 * 3600 * conf.unit_interval_arg, ret;
306 unsigned wanted = desired_number_of_snapshots(0, conf.num_intervals_arg),
309 struct snapshot *s = NULL;
310 struct snapshot_list sl;
312 dss_get_snapshot_list(&sl);
313 FOR_EACH_SNAPSHOT(s, i, &sl) {
314 if (!(s->flags & SS_COMPLETE))
317 x += s->completion_time - s->creation_time;
322 if (num_complete == 0)
324 x /= num_complete; /* avg time to create one snapshot */
325 if (unit_interval < x * wanted) /* oops, no sleep at all */
327 ret = s->completion_time + unit_interval / wanted - x;
329 free_snapshot_list(&sl);
333 static inline void invalidate_next_snapshot_time(void)
335 next_snapshot_time = 0;
338 static inline int next_snapshot_time_is_valid(void)
340 return next_snapshot_time != 0;
343 static int next_snapshot_is_due(void)
345 int64_t now = get_current_time();
347 if (!next_snapshot_time_is_valid())
348 next_snapshot_time = compute_next_snapshot_time();
349 if (next_snapshot_time <= now) {
350 DSS_DEBUG_LOG(("next snapshot: now\n"));
353 DSS_DEBUG_LOG(("next snapshot due in %" PRId64 " seconds\n",
354 next_snapshot_time - now));
358 static void pre_create_hook(void)
360 assert(snapshot_creation_status == HS_READY);
361 /* make sure that the next snapshot time will be recomputed */
362 invalidate_next_snapshot_time();
363 DSS_DEBUG_LOG(("executing %s\n", conf.pre_create_hook_arg));
364 dss_exec_cmdline_pid(&create_pid, conf.pre_create_hook_arg);
365 snapshot_creation_status = HS_PRE_RUNNING;
368 static void pre_remove_hook(struct snapshot *s, const char *why)
374 DSS_DEBUG_LOG(("%s snapshot %s\n", why, s->name));
375 assert(snapshot_removal_status == HS_READY);
376 assert(remove_pid == 0);
377 assert(!snapshot_currently_being_removed);
379 snapshot_currently_being_removed = dss_malloc(sizeof(struct snapshot));
380 *snapshot_currently_being_removed = *s;
381 snapshot_currently_being_removed->name = dss_strdup(s->name);
383 cmd = make_message("%s %s/%s", conf.pre_remove_hook_arg,
384 conf.dest_dir_arg, s->name);
385 DSS_DEBUG_LOG(("executing %s\n", cmd));
386 dss_exec_cmdline_pid(&remove_pid, cmd);
388 snapshot_removal_status = HS_PRE_RUNNING;
391 static int exec_rm(void)
393 struct snapshot *s = snapshot_currently_being_removed;
394 char *new_name = being_deleted_name(s);
403 assert(snapshot_removal_status == HS_PRE_SUCCESS);
404 assert(remove_pid == 0);
406 DSS_NOTICE_LOG(("removing %s (interval = %i)\n", s->name, s->interval));
407 ret = dss_rename(s->name, new_name);
410 dss_exec(&remove_pid, argv[0], argv);
411 snapshot_removal_status = HS_RUNNING;
417 static int snapshot_is_being_created(struct snapshot *s)
419 return s->creation_time == current_snapshot_creation_time;
422 static struct snapshot *find_orphaned_snapshot(struct snapshot_list *sl)
427 DSS_DEBUG_LOG(("looking for orphaned snapshots\n"));
428 FOR_EACH_SNAPSHOT(s, i, sl) {
429 if (snapshot_is_being_created(s))
432 * We know that no rm is currently running, so if s is marked
433 * as being deleted, a previously started rm must have failed.
435 if (s->flags & SS_BEING_DELETED)
438 if (s->flags & SS_COMPLETE) /* good snapshot */
441 * This snapshot is incomplete and it is not the snapshot
442 * currently being created. However, we must not remove it if
443 * rsync is about to be restarted. As only the newest snapshot
444 * can be restarted, this snapshot is orphaned if it is not the
445 * newest snapshot or if we are not about to restart rsync.
447 if (get_newest_snapshot(sl) != s)
449 if (snapshot_creation_status != HS_NEEDS_RESTART)
452 /* no orphaned snapshots */
456 static int is_reference_snapshot(struct snapshot *s)
458 if (!name_of_reference_snapshot)
460 return strcmp(s->name, name_of_reference_snapshot)? 0 : 1;
464 * return: 0: no redundant snapshots, 1: rm process started, negative: error
466 static struct snapshot *find_redundant_snapshot(struct snapshot_list *sl)
470 unsigned missing = 0;
472 DSS_DEBUG_LOG(("looking for intervals containing too many snapshots\n"));
473 for (interval = conf.num_intervals_arg - 1; interval >= 0; interval--) {
474 unsigned keep = desired_number_of_snapshots(interval, conf.num_intervals_arg);
475 unsigned num = sl->interval_count[interval];
476 struct snapshot *victim = NULL, *prev = NULL;
477 int64_t score = LONG_MAX;
480 missing += keep - num;
481 if (keep + missing >= num)
483 /* redundant snapshot in this interval, pick snapshot with lowest score */
484 FOR_EACH_SNAPSHOT(s, i, sl) {
487 if (snapshot_is_being_created(s))
489 if (is_reference_snapshot(s))
491 if (s->interval > interval) {
495 if (s->interval < interval)
503 /* check if s is a better victim */
504 this_score = s->creation_time - prev->creation_time;
505 assert(this_score >= 0);
506 if (this_score < score) {
518 static struct snapshot *find_outdated_snapshot(struct snapshot_list *sl)
523 DSS_DEBUG_LOG(("looking for snapshots belonging to intervals >= %d\n",
524 conf.num_intervals_arg));
525 FOR_EACH_SNAPSHOT(s, i, sl) {
526 if (snapshot_is_being_created(s))
528 if (is_reference_snapshot(s))
530 if (s->interval < conf.num_intervals_arg)
537 static struct snapshot *find_oldest_removable_snapshot(struct snapshot_list *sl)
540 struct snapshot *s, *ref = NULL;
542 num_complete = num_complete_snapshots(sl);
543 if (num_complete <= conf.min_complete_arg)
545 FOR_EACH_SNAPSHOT(s, i, sl) {
546 if (snapshot_is_being_created(s))
548 if (is_reference_snapshot(s)) { /* avoid this one */
552 DSS_INFO_LOG(("oldest removable snapshot: %s\n", s->name));
556 DSS_WARNING_LOG(("removing reference snapshot %s\n", ref->name));
560 static int rename_incomplete_snapshot(int64_t start)
567 * We don't want the dss_rename() below to fail with EEXIST because the
568 * last complete snapshot was created (and completed) in the same
569 * second as this one.
571 while ((now = get_current_time()) == start)
573 free(path_to_last_complete_snapshot);
574 ret = complete_name(start, now, &path_to_last_complete_snapshot);
577 old_name = incomplete_name(start);
578 ret = dss_rename(old_name, path_to_last_complete_snapshot);
580 DSS_NOTICE_LOG(("%s -> %s\n", old_name,
581 path_to_last_complete_snapshot));
586 static int try_to_free_disk_space(void)
589 struct snapshot_list sl;
590 struct snapshot *victim;
595 ret = disk_space_low(NULL);
598 low_disk_space = ret;
599 gettimeofday(&now, NULL);
600 if (tv_diff(&next_removal_check, &now, NULL) > 0)
602 if (!low_disk_space) {
603 if (conf.keep_redundant_given)
605 if (snapshot_creation_status != HS_READY)
607 if (next_snapshot_is_due())
611 * Idle and --keep_redundant not given, or low disk space. Look at
612 * existing snapshots.
614 dss_get_snapshot_list(&sl);
617 * Don't remove anything if there is free space and we have fewer
618 * snapshots than configured, plus one. This way there is always one
619 * snapshot that can be recycled.
621 if (!low_disk_space && sl.num_snapshots <= 1 << conf.num_intervals_arg)
624 victim = find_outdated_snapshot(&sl);
628 victim = find_redundant_snapshot(&sl);
632 victim = find_orphaned_snapshot(&sl);
635 /* try harder only if disk space is low */
638 DSS_WARNING_LOG(("disk space low and nothing obvious to remove\n"));
639 victim = find_oldest_removable_snapshot(&sl);
642 DSS_CRIT_LOG(("uhuhu: disk space low and nothing to remove\n"));
643 ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
646 pre_remove_hook(victim, why);
648 free_snapshot_list(&sl);
652 static void post_create_hook(void)
654 char *cmd = make_message("%s %s/%s", conf.post_create_hook_arg,
655 conf.dest_dir_arg, path_to_last_complete_snapshot);
656 DSS_NOTICE_LOG(("executing %s\n", cmd));
657 dss_exec_cmdline_pid(&create_pid, cmd);
659 snapshot_creation_status = HS_POST_RUNNING;
662 static void post_remove_hook(void)
665 struct snapshot *s = snapshot_currently_being_removed;
669 cmd = make_message("%s %s/%s", conf.post_remove_hook_arg,
670 conf.dest_dir_arg, s->name);
671 DSS_NOTICE_LOG(("executing %s\n", cmd));
672 dss_exec_cmdline_pid(&remove_pid, cmd);
674 snapshot_removal_status = HS_POST_RUNNING;
677 static void dss_kill(pid_t pid, int sig, const char *msg)
679 const char *signame, *process_name;
684 case SIGTERM: signame = "TERM"; break;
685 case SIGSTOP: signame = "STOP"; break;
686 case SIGCONT: signame = "CONT"; break;
687 default: signame = "????";
690 if (pid == create_pid)
691 process_name = "create";
692 else if (pid == remove_pid)
693 process_name = "remove";
694 else process_name = "??????";
697 DSS_INFO_LOG(("%s\n", msg));
698 DSS_DEBUG_LOG(("sending signal %d (%s) to pid %d (%s process)\n",
699 sig, signame, (int)pid, process_name));
700 if (kill(pid, sig) >= 0)
702 DSS_INFO_LOG(("failed to send signal %d (%s) to pid %d (%s process)\n",
703 sig, signame, (int)pid, process_name));
706 static void stop_create_process(void)
708 if (create_process_stopped)
710 dss_kill(create_pid, SIGSTOP, "suspending create process");
711 create_process_stopped = 1;
714 static void restart_create_process(void)
716 if (!create_process_stopped)
718 dss_kill(create_pid, SIGCONT, "resuming create process");
719 create_process_stopped = 0;
723 * Print a log message about the exit status of a child.
725 static void log_termination_msg(pid_t pid, int status)
727 if (WIFEXITED(status))
728 DSS_INFO_LOG(("child %i exited. Exit status: %i\n", (int)pid,
729 WEXITSTATUS(status)));
730 else if (WIFSIGNALED(status))
731 DSS_NOTICE_LOG(("child %i was killed by signal %i\n", (int)pid,
734 DSS_WARNING_LOG(("child %i terminated abormally\n", (int)pid));
737 static int wait_for_process(pid_t pid, int *status)
741 DSS_DEBUG_LOG(("Waiting for process %d to terminate\n", (int)pid));
746 FD_SET(signal_pipe, &rfds);
747 ret = dss_select(signal_pipe + 1, &rfds, NULL, NULL);
753 if (ret == SIGCHLD) {
754 ret = waitpid(pid, status, 0);
757 if (errno != EINTR) { /* error */
758 ret = -ERRNO_TO_DSS_ERROR(errno);
762 /* SIGINT or SIGTERM */
763 dss_kill(pid, SIGTERM, "killing child process");
766 DSS_ERROR_LOG(("failed to wait for process %d\n", (int)pid));
768 log_termination_msg(pid, *status);
772 static void handle_pre_remove_exit(int status)
774 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
775 snapshot_removal_status = HS_READY;
776 gettimeofday(&next_removal_check, NULL);
777 next_removal_check.tv_sec += 60;
780 snapshot_removal_status = HS_PRE_SUCCESS;
783 static int handle_rm_exit(int status)
785 if (!WIFEXITED(status)) {
786 snapshot_removal_status = HS_READY;
787 return -E_INVOLUNTARY_EXIT;
789 if (WEXITSTATUS(status)) {
790 snapshot_removal_status = HS_READY;
791 return -E_BAD_EXIT_CODE;
793 snapshot_removal_status = HS_SUCCESS;
797 static void handle_post_remove_exit(void)
799 snapshot_removal_status = HS_READY;
802 static int handle_remove_exit(int status)
805 struct snapshot *s = snapshot_currently_being_removed;
808 switch (snapshot_removal_status) {
810 handle_pre_remove_exit(status);
814 ret = handle_rm_exit(status);
816 case HS_POST_RUNNING:
817 handle_post_remove_exit();
823 if (snapshot_removal_status == HS_READY) {
826 snapshot_currently_being_removed = NULL;
832 static int wait_for_remove_process(void)
838 snapshot_removal_status == HS_PRE_RUNNING ||
839 snapshot_removal_status == HS_RUNNING ||
840 snapshot_removal_status == HS_POST_RUNNING
842 ret = wait_for_process(remove_pid, &status);
845 return handle_remove_exit(status);
848 static int handle_rsync_exit(int status)
852 if (!WIFEXITED(status)) {
853 DSS_ERROR_LOG(("rsync process %d died involuntary\n", (int)create_pid));
854 ret = -E_INVOLUNTARY_EXIT;
855 snapshot_creation_status = HS_READY;
858 es = WEXITSTATUS(status);
860 * Restart rsync on non-fatal errors:
861 * 24: Partial transfer due to vanished source files
863 if (es != 0 && es != 24) {
864 DSS_WARNING_LOG(("rsync exit code %d, error count %d\n",
865 es, ++num_consecutive_rsync_errors));
866 if (conf.create_given) {
867 ret = -E_BAD_EXIT_CODE;
870 if (num_consecutive_rsync_errors > conf.max_rsync_errors_arg) {
871 ret = -E_TOO_MANY_RSYNC_ERRORS;
872 snapshot_creation_status = HS_READY;
875 DSS_WARNING_LOG(("restarting rsync process\n"));
876 snapshot_creation_status = HS_NEEDS_RESTART;
877 next_snapshot_time = get_current_time() + 60;
881 num_consecutive_rsync_errors = 0;
882 ret = rename_incomplete_snapshot(current_snapshot_creation_time);
885 snapshot_creation_status = HS_SUCCESS;
886 free(name_of_reference_snapshot);
887 name_of_reference_snapshot = NULL;
889 create_process_stopped = 0;
893 static int handle_pre_create_hook_exit(int status)
896 static int warn_count;
898 if (!WIFEXITED(status)) {
899 snapshot_creation_status = HS_READY;
900 ret = -E_INVOLUNTARY_EXIT;
903 es = WEXITSTATUS(status);
906 DSS_NOTICE_LOG(("pre_create_hook %s returned %d\n",
907 conf.pre_create_hook_arg, es));
908 DSS_NOTICE_LOG(("deferring snapshot creation...\n"));
909 warn_count = 60; /* warn only once per hour */
911 next_snapshot_time = get_current_time() + 60;
912 snapshot_creation_status = HS_READY;
917 snapshot_creation_status = HS_PRE_SUCCESS;
923 static int handle_sigchld(void)
926 int status, ret = reap_child(&pid, &status);
931 if (pid == create_pid) {
932 switch (snapshot_creation_status) {
934 ret = handle_pre_create_hook_exit(status);
937 ret = handle_rsync_exit(status);
939 case HS_POST_RUNNING:
940 snapshot_creation_status = HS_READY;
944 DSS_EMERG_LOG(("BUG: create can't die in status %d\n",
945 snapshot_creation_status));
951 if (pid == remove_pid) {
952 ret = handle_remove_exit(status);
957 DSS_EMERG_LOG(("BUG: unknown process %d died\n", (int)pid));
961 static int check_config(void)
963 if (conf.unit_interval_arg <= 0) {
964 DSS_ERROR_LOG(("bad unit interval: %i\n", conf.unit_interval_arg));
965 return -E_INVALID_NUMBER;
967 DSS_DEBUG_LOG(("unit interval: %i day(s)\n", conf.unit_interval_arg));
968 if (conf.num_intervals_arg <= 0 || conf.num_intervals_arg > 30) {
969 DSS_ERROR_LOG(("bad number of intervals: %i\n",
970 conf.num_intervals_arg));
971 return -E_INVALID_NUMBER;
973 DSS_DEBUG_LOG(("number of intervals: %i\n", conf.num_intervals_arg));
978 * Returns < 0 on errors, 0 if no config file is given and > 0 if the config
979 * file was read successfully.
981 static int parse_config_file(bool sighup)
983 int ret, config_file_exists;
984 char *config_file = get_config_file_name();
986 char *old_logfile_arg = NULL;
987 int old_daemon_given = 0;
990 if (conf.logfile_given)
991 old_logfile_arg = dss_strdup(conf.logfile_arg);
992 old_daemon_given = conf.daemon_given;
995 config_file_exists = !stat(config_file, &statbuf);
996 if (!config_file_exists && conf.config_file_given) {
997 ret = -ERRNO_TO_DSS_ERROR(errno);
998 DSS_ERROR_LOG(("failed to stat config file %s\n", config_file));
1001 if (config_file_exists) {
1002 struct cmdline_parser_params params;
1003 params.override = sighup;
1004 params.initialize = 0;
1005 params.check_required = 1;
1006 params.check_ambiguity = 0;
1007 params.print_errors = 1;
1008 if (sighup) { /* invalidate all rsync options */
1011 for (i = 0; i < conf.rsync_option_given; i++) {
1012 free(conf.rsync_option_arg[i]);
1013 conf.rsync_option_arg[i] = NULL;
1015 conf.rsync_option_given = 0;
1017 cmdline_parser_config_file(config_file, &conf, ¶ms);
1019 ret = check_config();
1023 /* don't change daemon mode on SIGHUP */
1024 conf.daemon_given = old_daemon_given;
1027 if (conf.logfile_given)
1028 free(old_logfile_arg);
1029 else if (conf.daemon_given) { /* re-use old logfile */
1030 conf.logfile_arg = old_logfile_arg;
1031 conf.logfile_given = 1;
1034 if (conf.logfile_given && conf.run_given && conf.daemon_given) {
1035 logfile = open_log(conf.logfile_arg);
1036 log_welcome(conf.loglevel_arg);
1038 DSS_DEBUG_LOG(("loglevel: %d\n", conf.loglevel_arg));
1039 ret = config_file_exists;
1043 DSS_EMERG_LOG(("%s\n", dss_strerror(-ret)));
1047 static int change_to_dest_dir(void)
1049 DSS_INFO_LOG(("changing cwd to %s\n", conf.dest_dir_arg));
1050 return dss_chdir(conf.dest_dir_arg);
1053 static int handle_sighup(void)
1057 DSS_NOTICE_LOG(("SIGHUP, re-reading config\n"));
1058 dump_dss_config("old");
1059 ret = parse_config_file(true /* SIGHUP */);
1062 dump_dss_config("reloaded");
1063 invalidate_next_snapshot_time();
1064 return change_to_dest_dir();
1067 static void kill_children(void)
1069 restart_create_process();
1070 dss_kill(create_pid, SIGTERM, NULL);
1071 dss_kill(remove_pid, SIGTERM, NULL);
1074 static int handle_signal(void)
1076 int sig, ret = next_signal();
1088 ret = handle_sighup();
1091 ret = handle_sigchld();
1096 DSS_ERROR_LOG(("%s\n", dss_strerror(-ret)));
1101 * We can not use rsync locally if the local user is different from the remote
1102 * user or if the src dir is not on the local host (or both).
1104 static int use_rsync_locally(char *logname)
1106 char *h = conf.remote_host_arg;
1108 if (strcmp(h, "localhost") && strcmp(h, "127.0.0.1"))
1110 if (conf.remote_user_given && strcmp(conf.remote_user_arg, logname))
1115 static int rename_resume_snap(int64_t creation_time)
1117 struct snapshot_list sl;
1118 struct snapshot *s = NULL;
1119 char *new_name = incomplete_name(creation_time);
1123 sl.num_snapshots = 0;
1126 if (conf.no_resume_given)
1128 dss_get_snapshot_list(&sl);
1130 * Snapshot recycling: We first look at the newest snapshot. If this
1131 * snapshot happens to be incomplete, the last rsync process was
1132 * aborted and we reuse this one. Otherwise we look at snapshots which
1133 * could be removed (outdated and redundant snapshots) as candidates
1134 * for recycling. If no outdated/redundant snapshot exists, we check if
1135 * there is an orphaned snapshot, which likely is useless anyway.
1137 * Only if no existing snapshot is suitable for recycling, we bite the
1138 * bullet and create a new one.
1140 s = get_newest_snapshot(&sl);
1141 if (!s) /* no snapshots at all */
1143 /* re-use last snapshot if it is incomplete */
1145 if ((s->flags & SS_COMPLETE) == 0)
1148 s = find_outdated_snapshot(&sl);
1152 s = find_redundant_snapshot(&sl);
1156 s = find_orphaned_snapshot(&sl);
1159 DSS_INFO_LOG(("reusing %s snapshot %s\n", why, s->name));
1160 ret = dss_rename(s->name, new_name);
1163 DSS_NOTICE_LOG(("creating new snapshot %s\n", new_name));
1165 free_snapshot_list(&sl);
1169 static void create_rsync_argv(char ***argv, int64_t *num)
1173 struct snapshot_list sl;
1175 dss_get_snapshot_list(&sl);
1176 assert(!name_of_reference_snapshot);
1177 name_of_reference_snapshot = name_of_newest_complete_snapshot(&sl);
1178 free_snapshot_list(&sl);
1180 *argv = dss_malloc((15 + conf.rsync_option_given) * sizeof(char *));
1181 (*argv)[i++] = dss_strdup("rsync");
1182 (*argv)[i++] = dss_strdup("-a");
1183 (*argv)[i++] = dss_strdup("--delete");
1184 for (j = 0; j < conf.rsync_option_given; j++)
1185 (*argv)[i++] = dss_strdup(conf.rsync_option_arg[j]);
1186 if (name_of_reference_snapshot) {
1187 DSS_INFO_LOG(("using %s as reference\n", name_of_reference_snapshot));
1188 (*argv)[i++] = make_message("--link-dest=../%s",
1189 name_of_reference_snapshot);
1191 DSS_INFO_LOG(("no suitable reference snapshot found\n"));
1192 logname = dss_logname();
1193 if (use_rsync_locally(logname))
1194 (*argv)[i++] = dss_strdup(conf.source_dir_arg);
1196 (*argv)[i++] = make_message("%s@%s:%s/", conf.remote_user_given?
1197 conf.remote_user_arg : logname,
1198 conf.remote_host_arg, conf.source_dir_arg);
1200 *num = get_current_time();
1201 (*argv)[i++] = incomplete_name(*num);
1202 (*argv)[i++] = NULL;
1203 for (j = 0; j < i; j++)
1204 DSS_DEBUG_LOG(("argv[%d] = %s\n", j, (*argv)[j]));
1207 static void free_rsync_argv(char **argv)
1213 for (i = 0; argv[i]; i++)
1218 static int create_snapshot(char **argv)
1222 ret = rename_resume_snap(current_snapshot_creation_time);
1225 dss_exec(&create_pid, argv[0], argv);
1226 snapshot_creation_status = HS_RUNNING;
1230 static int select_loop(void)
1233 /* check every 60 seconds for free disk space */
1235 char **rsync_argv = NULL;
1239 struct timeval *tvp;
1242 tvp = NULL; /* sleep until rm hook/process dies */
1243 else { /* sleep one minute */
1249 FD_SET(signal_pipe, &rfds);
1250 ret = dss_select(signal_pipe + 1, &rfds, NULL, tvp);
1253 if (FD_ISSET(signal_pipe, &rfds)) {
1254 ret = handle_signal();
1260 if (snapshot_removal_status == HS_PRE_SUCCESS) {
1266 if (snapshot_removal_status == HS_SUCCESS) {
1270 ret = try_to_free_disk_space();
1273 if (snapshot_removal_status != HS_READY) {
1274 stop_create_process();
1277 restart_create_process();
1278 switch (snapshot_creation_status) {
1280 if (!next_snapshot_is_due())
1284 case HS_PRE_RUNNING:
1286 case HS_POST_RUNNING:
1288 case HS_PRE_SUCCESS:
1289 if (!name_of_reference_snapshot) {
1290 free_rsync_argv(rsync_argv);
1291 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1293 ret = create_snapshot(rsync_argv);
1297 case HS_NEEDS_RESTART:
1298 if (!next_snapshot_is_due())
1300 ret = create_snapshot(rsync_argv);
1313 static void exit_hook(int exit_code)
1318 argv[0] = conf.exit_hook_arg;
1319 argv[1] = dss_strerror(-exit_code);
1322 DSS_NOTICE_LOG(("executing %s %s\n", argv[0], argv[1]));
1323 dss_exec(&pid, conf.exit_hook_arg, argv);
1326 static void lock_dss_or_die(void)
1328 char *config_file = get_config_file_name();
1329 int ret = lock_dss(config_file);
1333 DSS_EMERG_LOG(("failed to lock: %s\n", dss_strerror(-ret)));
1338 static int com_run(void)
1343 if (conf.dry_run_given) {
1344 DSS_ERROR_LOG(("dry_run not supported by this command\n"));
1347 ret = install_sighandler(SIGHUP);
1350 ret = select_loop();
1351 if (ret >= 0) /* impossible */
1358 static int com_prune(void)
1361 struct snapshot_list sl;
1362 struct snapshot *victim;
1363 struct disk_space ds;
1367 ret = get_disk_space(".", &ds);
1370 log_disk_space(&ds);
1371 dss_get_snapshot_list(&sl);
1373 victim = find_outdated_snapshot(&sl);
1377 victim = find_redundant_snapshot(&sl);
1383 if (conf.dry_run_given) {
1384 dss_msg("%s snapshot %s (interval = %i)\n",
1385 why, victim->name, victim->interval);
1389 pre_remove_hook(victim, why);
1390 if (snapshot_removal_status == HS_PRE_RUNNING) {
1391 ret = wait_for_remove_process();
1394 if (snapshot_removal_status != HS_PRE_SUCCESS)
1400 ret = wait_for_remove_process();
1403 if (snapshot_removal_status != HS_SUCCESS)
1406 if (snapshot_removal_status != HS_POST_RUNNING)
1408 ret = wait_for_remove_process();
1413 free_snapshot_list(&sl);
1417 static int com_create(void)
1423 if (conf.dry_run_given) {
1426 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1427 for (i = 0; rsync_argv[i]; i++) {
1429 msg = make_message("%s%s%s", tmp? tmp : "",
1430 tmp? " " : "", rsync_argv[i]);
1433 free_rsync_argv(rsync_argv);
1434 dss_msg("%s\n", msg);
1440 ret = wait_for_process(create_pid, &status);
1443 ret = handle_pre_create_hook_exit(status);
1444 if (ret <= 0) /* error, or pre-create failed */
1447 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1448 ret = create_snapshot(rsync_argv);
1451 ret = wait_for_process(create_pid, &status);
1454 ret = handle_rsync_exit(status);
1459 ret = wait_for_process(create_pid, &status);
1461 free_rsync_argv(rsync_argv);
1465 static int com_ls(void)
1468 struct snapshot_list sl;
1471 dss_get_snapshot_list(&sl);
1472 FOR_EACH_SNAPSHOT(s, i, &sl) {
1474 if (s->flags & SS_COMPLETE)
1475 d = (s->completion_time - s->creation_time) / 60;
1476 dss_msg("%u\t%s\t%3" PRId64 ":%02" PRId64 "\n", s->interval, s->name, d/60, d%60);
1478 free_snapshot_list(&sl);
1482 static int setup_signal_handling(void)
1486 DSS_INFO_LOG(("setting up signal handlers\n"));
1487 signal_pipe = signal_init(); /* always successful */
1488 ret = install_sighandler(SIGINT);
1491 ret = install_sighandler(SIGTERM);
1494 return install_sighandler(SIGCHLD);
1497 int main(int argc, char **argv)
1500 struct cmdline_parser_params params;
1502 params.override = 0;
1503 params.initialize = 1;
1504 params.check_required = 0;
1505 params.check_ambiguity = 0;
1506 params.print_errors = 1;
1508 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1509 ret = parse_config_file(0);
1510 ret = parse_config_file(false /* no SIGHUP */);
1513 if (ret == 0) { /* no config file given */
1515 * Parse the command line options again, but this time check
1516 * that all required options are given.
1518 struct cmdline_parser_params params;
1519 params.override = 1;
1520 params.initialize = 1;
1521 params.check_required = 1;
1522 params.check_ambiguity = 1;
1523 params.print_errors = 1;
1524 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1526 if (conf.daemon_given)
1528 ret = change_to_dest_dir();
1531 dump_dss_config("startup");
1532 ret = setup_signal_handling();
1535 ret = call_command_handler();
1539 DSS_EMERG_LOG(("%s\n", dss_strerror(-ret)));
1540 exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);