2 * Copyright (C) 2008-2011 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"
38 /** Command line and config file options. */
39 static struct gengetopt_args_info conf;
40 /** Non-NULL if we log to a file. */
42 /** The read end of the signal pipe */
43 static int signal_pipe;
44 /** Process id of current pre-create-hook/rsync/post-create-hook process. */
45 static pid_t create_pid;
46 /** Whether the pre-create-hook/rsync/post-create-hook is currently stopped. */
47 static int create_process_stopped;
48 /** Process id of current pre-remove/rm/post-remove process. */
49 static pid_t remove_pid;
50 /** When the next snapshot is due. */
51 static int64_t next_snapshot_time;
52 /** When to try to remove something. */
53 static struct timeval next_removal_check;
54 /** Creation time of the snapshot currently being created. */
55 static int64_t current_snapshot_creation_time;
56 /** The snapshot currently being removed. */
57 struct snapshot *snapshot_currently_being_removed;
58 /** Needed by the post-create hook. */
59 static char *path_to_last_complete_snapshot;
60 static char *name_of_reference_snapshot;
61 /** \sa \ref snap.h for details. */
62 enum hook_status snapshot_creation_status;
63 /** \sa \ref snap.h for details. */
64 enum hook_status snapshot_removal_status;
68 static const char *hook_status_description[] = {HOOK_STATUS_ARRAY};
70 /* may be called with ds == NULL. */
71 static int disk_space_low(struct disk_space *ds)
73 struct disk_space ds_struct;
76 int ret = get_disk_space(".", &ds_struct);
81 if (conf.min_free_mb_arg)
82 if (ds->free_mb < conf.min_free_mb_arg)
84 if (conf.min_free_percent_arg)
85 if (ds->percent_free < conf.min_free_percent_arg)
87 if (conf.min_free_percent_inodes_arg)
88 if (ds->percent_free_inodes < conf.min_free_percent_inodes_arg)
93 static void dump_dss_config(const char *msg)
95 const char dash[] = "-----------------------------";
97 FILE *log = logfile? logfile : stderr;
99 int64_t now = get_current_time();
101 if (conf.loglevel_arg > INFO)
104 fprintf(log, "%s <%s config> %s\n", dash, msg, dash);
105 fprintf(log, "\n*** disk space ***\n\n");
106 ret = get_disk_space(".", &ds);
108 DSS_INFO_LOG(("disk space low: %s\n", disk_space_low(&ds)?
112 DSS_ERROR_LOG(("can not get free disk space: %s\n",
113 dss_strerror(-ret)));
115 /* we continue on errors from get_disk_space */
117 fprintf(log, "\n*** command line and config file options ***\n\n");
118 cmdline_parser_dump(log, &conf);
119 fprintf(log, "\n*** internal state ***\n\n");
123 "snapshot_currently_being_removed: %s\n"
124 "path_to_last_complete_snapshot: %s\n"
125 "reference_snapshot: %s\n"
126 "snapshot_creation_status: %s\n"
127 "snapshot_removal_status: %s\n"
130 logfile? conf.logfile_arg : "stderr",
131 snapshot_currently_being_removed?
132 snapshot_currently_being_removed->name : "(none)",
133 path_to_last_complete_snapshot?
134 path_to_last_complete_snapshot : "(none)",
135 name_of_reference_snapshot?
136 name_of_reference_snapshot : "(none)",
137 hook_status_description[snapshot_creation_status],
138 hook_status_description[snapshot_removal_status]
142 "create_pid: %" PRId32 "\n"
143 "create process is %sstopped\n"
146 create_process_stopped? "" : "not "
149 fprintf(log, "remove_pid: %" PRId32 "\n", remove_pid);
150 if (next_snapshot_time != 0)
151 fprintf(log, "next snapshot due in %" PRId64 " seconds\n",
152 next_snapshot_time - now);
153 if (current_snapshot_creation_time != 0)
154 fprintf(log, "current_snapshot_creation_time: %"
155 PRId64 " (%" PRId64 " seconds ago)\n",
156 current_snapshot_creation_time,
157 now - current_snapshot_creation_time
159 if (next_removal_check.tv_sec != 0) {
160 fprintf(log, "next removal check: %llu (%llu seconds ago)\n",
161 (long long unsigned)next_removal_check.tv_sec,
162 now - (long long unsigned)next_removal_check.tv_sec
166 fprintf(log, "%s </%s config> %s\n", dash, msg, dash);
169 /* a litte cpp magic helps to DRY */
178 #define COMMAND(x) static int com_ ##x(void);
181 #define COMMAND(x) if (conf.x ##_given) return com_ ##x();
182 static int call_command_handler(void)
185 DSS_EMERG_LOG(("BUG: did not find command handler\n"));
191 static int loglevel = -1;
192 static const char *location_file = NULL;
193 static int location_line = -1;
194 static const char *location_func = NULL;
196 void dss_log_set_params(int ll, const char *file, int line, const char *func)
199 location_file = file;
200 location_line = line;
201 location_func = func;
205 * The log function of dss.
207 * \param ll Loglevel.
208 * \param fml Usual format string.
210 * All DSS_XXX_LOG() macros use this function.
212 __printf_1_2 void dss_log(const char* fmt,...)
220 if (loglevel < conf.loglevel_arg)
222 outfd = logfile? logfile : stderr;
225 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
226 fprintf(outfd, "%s ", str);
227 if (conf.loglevel_arg <= INFO)
228 fprintf(outfd, "%i: ", loglevel);
229 #ifdef DSS_NO_FUNC_NAMES
230 fprintf(outfd, "%s:%d: ", location_file, location_line);
232 fprintf(outfd, "%s: ", location_func);
235 vfprintf(outfd, fmt, argp);
240 * Print a message either to stdout or to the log file.
242 static __printf_1_2 void dss_msg(const char* fmt,...)
244 FILE *outfd = conf.daemon_given? logfile : stdout;
247 vfprintf(outfd, fmt, argp);
251 static char *get_config_file_name(void)
253 char *home, *config_file;
255 if (conf.config_file_given)
256 return dss_strdup(conf.config_file_arg);
257 home = get_homedir();
258 config_file = make_message("%s/.dssrc", home);
263 static int send_signal(int sig)
266 char *config_file = get_config_file_name();
267 int ret = get_dss_pid(config_file, &pid);
272 if (conf.dry_run_given) {
273 dss_msg("%d\n", (int)pid);
276 ret = kill(pid, sig);
278 return -ERRNO_TO_DSS_ERROR(errno);
282 static int com_kill(void)
284 return send_signal(SIGTERM);
287 static int com_reload(void)
289 return send_signal(SIGHUP);
292 static void dss_get_snapshot_list(struct snapshot_list *sl)
294 get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
297 static int64_t compute_next_snapshot_time(void)
299 int64_t x = 0, now = get_current_time(), unit_interval
300 = 24 * 3600 * conf.unit_interval_arg, ret;
301 unsigned wanted = desired_number_of_snapshots(0, conf.num_intervals_arg),
302 num_complete_snapshots = 0;
304 struct snapshot *s = NULL;
305 struct snapshot_list sl;
307 dss_get_snapshot_list(&sl);
308 FOR_EACH_SNAPSHOT(s, i, &sl) {
309 if (!(s->flags & SS_COMPLETE))
311 num_complete_snapshots++;
312 x += s->completion_time - s->creation_time;
317 if (num_complete_snapshots == 0)
319 x /= num_complete_snapshots; /* avg time to create one snapshot */
320 if (unit_interval < x * wanted) /* oops, no sleep at all */
322 ret = s->completion_time + unit_interval / wanted - x;
324 free_snapshot_list(&sl);
328 static inline void invalidate_next_snapshot_time(void)
330 next_snapshot_time = 0;
333 static inline int next_snapshot_time_is_valid(void)
335 return next_snapshot_time != 0;
338 static int next_snapshot_is_due(void)
340 int64_t now = get_current_time();
342 if (!next_snapshot_time_is_valid())
343 next_snapshot_time = compute_next_snapshot_time();
344 if (next_snapshot_time <= now) {
345 DSS_DEBUG_LOG(("next snapshot: now\n"));
348 DSS_DEBUG_LOG(("next snapshot due in %" PRId64 " seconds\n",
349 next_snapshot_time - now));
353 static void pre_create_hook(void)
355 assert(snapshot_creation_status == HS_READY);
356 /* make sure that the next snapshot time will be recomputed */
357 invalidate_next_snapshot_time();
358 DSS_DEBUG_LOG(("executing %s\n", conf.pre_create_hook_arg));
359 dss_exec_cmdline_pid(&create_pid, conf.pre_create_hook_arg);
360 snapshot_creation_status = HS_PRE_RUNNING;
363 static void pre_remove_hook(struct snapshot *s, const char *why)
369 DSS_DEBUG_LOG(("%s snapshot %s\n", why, s->name));
370 assert(snapshot_removal_status == HS_READY);
371 assert(remove_pid == 0);
372 assert(!snapshot_currently_being_removed);
374 snapshot_currently_being_removed = dss_malloc(sizeof(struct snapshot));
375 *snapshot_currently_being_removed = *s;
376 snapshot_currently_being_removed->name = dss_strdup(s->name);
378 cmd = make_message("%s %s/%s", conf.pre_remove_hook_arg,
379 conf.dest_dir_arg, s->name);
380 DSS_DEBUG_LOG(("executing %s\n", cmd));
381 dss_exec_cmdline_pid(&remove_pid, cmd);
383 snapshot_removal_status = HS_PRE_RUNNING;
386 static int exec_rm(void)
388 struct snapshot *s = snapshot_currently_being_removed;
389 char *new_name = being_deleted_name(s);
398 assert(snapshot_removal_status == HS_PRE_SUCCESS);
399 assert(remove_pid == 0);
401 DSS_NOTICE_LOG(("removing %s (interval = %i)\n", s->name, s->interval));
402 ret = dss_rename(s->name, new_name);
405 dss_exec(&remove_pid, argv[0], argv);
406 snapshot_removal_status = HS_RUNNING;
412 static int snapshot_is_being_created(struct snapshot *s)
414 return s->creation_time == current_snapshot_creation_time;
417 static struct snapshot *find_orphaned_snapshot(struct snapshot_list *sl)
422 DSS_DEBUG_LOG(("looking for orphaned snapshots\n"));
423 FOR_EACH_SNAPSHOT(s, i, sl) {
424 if (snapshot_is_being_created(s))
427 * We know that no rm is currently running, so if s is marked
428 * as being deleted, a previously started rm must have failed.
430 if (s->flags & SS_BEING_DELETED)
433 if (s->flags & SS_COMPLETE) /* good snapshot */
436 * This snapshot is incomplete and it is not the snapshot
437 * currently being created. However, we must not remove it if
438 * rsync is about to be restarted. As only the newest snapshot
439 * can be restarted, this snapshot is orphaned if it is not the
440 * newest snapshot or if we are not about to restart rsync.
442 if (get_newest_snapshot(sl) != s)
444 if (snapshot_creation_status != HS_NEEDS_RESTART)
447 /* no orphaned snapshots */
451 static int is_reference_snapshot(struct snapshot *s)
453 if (!name_of_reference_snapshot)
455 return strcmp(s->name, name_of_reference_snapshot)? 0 : 1;
459 * return: 0: no redundant snapshots, 1: rm process started, negative: error
461 static struct snapshot *find_redundant_snapshot(struct snapshot_list *sl)
465 unsigned missing = 0;
467 DSS_DEBUG_LOG(("looking for intervals containing too many snapshots\n"));
468 for (interval = conf.num_intervals_arg - 1; interval >= 0; interval--) {
469 unsigned keep = desired_number_of_snapshots(interval, conf.num_intervals_arg);
470 unsigned num = sl->interval_count[interval];
471 struct snapshot *victim = NULL, *prev = NULL;
472 int64_t score = LONG_MAX;
475 missing += keep - num;
476 if (keep + missing >= num)
478 /* redundant snapshot in this interval, pick snapshot with lowest score */
479 FOR_EACH_SNAPSHOT(s, i, sl) {
482 if (snapshot_is_being_created(s))
484 if (is_reference_snapshot(s))
486 if (s->interval > interval) {
490 if (s->interval < interval)
498 /* check if s is a better victim */
499 this_score = s->creation_time - prev->creation_time;
500 assert(this_score >= 0);
501 if (this_score < score) {
513 static struct snapshot *find_outdated_snapshot(struct snapshot_list *sl)
518 DSS_DEBUG_LOG(("looking for snapshots belonging to intervals >= %d\n",
519 conf.num_intervals_arg));
520 FOR_EACH_SNAPSHOT(s, i, sl) {
521 if (snapshot_is_being_created(s))
523 if (is_reference_snapshot(s))
525 if (s->interval < conf.num_intervals_arg)
532 static struct snapshot *find_oldest_removable_snapshot(struct snapshot_list *sl)
536 FOR_EACH_SNAPSHOT(s, i, sl) {
537 if (snapshot_is_being_created(s))
539 if (is_reference_snapshot(s))
541 DSS_INFO_LOG(("oldest removable snapshot: %s\n", s->name));
547 static int rename_incomplete_snapshot(int64_t start)
554 * We don't want the dss_rename() below to fail with EEXIST because the
555 * last complete snapshot was created (and completed) in the same
556 * second as this one.
558 while ((now = get_current_time()) == start)
560 free(path_to_last_complete_snapshot);
561 ret = complete_name(start, now, &path_to_last_complete_snapshot);
564 old_name = incomplete_name(start);
565 ret = dss_rename(old_name, path_to_last_complete_snapshot);
567 DSS_NOTICE_LOG(("%s -> %s\n", old_name,
568 path_to_last_complete_snapshot));
573 static int try_to_free_disk_space(void)
576 struct snapshot_list sl;
577 struct snapshot *victim;
582 ret = disk_space_low(NULL);
585 low_disk_space = ret;
586 gettimeofday(&now, NULL);
587 if (tv_diff(&next_removal_check, &now, NULL) > 0)
589 if (!low_disk_space) {
590 if (conf.keep_redundant_given)
592 if (snapshot_creation_status != HS_READY)
594 if (next_snapshot_is_due())
597 dss_get_snapshot_list(&sl);
599 if (!low_disk_space && sl.num_snapshots <= 1)
602 victim = find_outdated_snapshot(&sl);
606 victim = find_redundant_snapshot(&sl);
609 /* try harder only if disk space is low */
613 victim = find_orphaned_snapshot(&sl);
616 DSS_WARNING_LOG(("disk space low and nothing obvious to remove\n"));
617 victim = find_oldest_removable_snapshot(&sl);
620 DSS_CRIT_LOG(("uhuhu: disk space low and nothing to remove\n"));
621 ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
624 pre_remove_hook(victim, why);
626 free_snapshot_list(&sl);
630 static void post_create_hook(void)
632 char *cmd = make_message("%s %s/%s", conf.post_create_hook_arg,
633 conf.dest_dir_arg, path_to_last_complete_snapshot);
634 DSS_NOTICE_LOG(("executing %s\n", cmd));
635 dss_exec_cmdline_pid(&create_pid, cmd);
637 snapshot_creation_status = HS_POST_RUNNING;
640 static void post_remove_hook(void)
643 struct snapshot *s = snapshot_currently_being_removed;
647 cmd = make_message("%s %s/%s", conf.post_remove_hook_arg,
648 conf.dest_dir_arg, s->name);
649 DSS_NOTICE_LOG(("executing %s\n", cmd));
650 dss_exec_cmdline_pid(&remove_pid, cmd);
652 snapshot_removal_status = HS_POST_RUNNING;
655 static void dss_kill(pid_t pid, int sig, const char *msg)
657 const char *signame, *process_name;
662 case SIGTERM: signame = "TERM"; break;
663 case SIGSTOP: signame = "STOP"; break;
664 case SIGCONT: signame = "CONT"; break;
665 default: signame = "????";
668 if (pid == create_pid)
669 process_name = "create";
670 else if (pid == remove_pid)
671 process_name = "remove";
672 else process_name = "??????";
675 DSS_INFO_LOG(("%s\n", msg));
676 DSS_DEBUG_LOG(("sending signal %d (%s) to pid %d (%s process)\n",
677 sig, signame, (int)pid, process_name));
678 if (kill(pid, sig) >= 0)
680 DSS_INFO_LOG(("failed to send signal %d (%s) to pid %d (%s process)\n",
681 sig, signame, (int)pid, process_name));
684 static void stop_create_process(void)
686 if (create_process_stopped)
688 dss_kill(create_pid, SIGSTOP, "suspending create process");
689 create_process_stopped = 1;
692 static void restart_create_process(void)
694 if (!create_process_stopped)
696 dss_kill(create_pid, SIGCONT, "resuming create process");
697 create_process_stopped = 0;
701 * Print a log message about the exit status of a child.
703 static void log_termination_msg(pid_t pid, int status)
705 if (WIFEXITED(status))
706 DSS_INFO_LOG(("child %i exited. Exit status: %i\n", (int)pid,
707 WEXITSTATUS(status)));
708 else if (WIFSIGNALED(status))
709 DSS_NOTICE_LOG(("child %i was killed by signal %i\n", (int)pid,
712 DSS_WARNING_LOG(("child %i terminated abormally\n", (int)pid));
715 static int wait_for_process(pid_t pid, int *status)
719 DSS_DEBUG_LOG(("Waiting for process %d to terminate\n", (int)pid));
724 FD_SET(signal_pipe, &rfds);
725 ret = dss_select(signal_pipe + 1, &rfds, NULL, NULL);
731 if (ret == SIGCHLD) {
732 ret = waitpid(pid, status, 0);
735 if (errno != EINTR) { /* error */
736 ret = -ERRNO_TO_DSS_ERROR(errno);
740 /* SIGINT or SIGTERM */
741 dss_kill(pid, SIGTERM, "killing child process");
744 DSS_ERROR_LOG(("failed to wait for process %d\n", (int)pid));
746 log_termination_msg(pid, *status);
750 static void handle_pre_remove_exit(int status)
752 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
753 snapshot_removal_status = HS_READY;
754 gettimeofday(&next_removal_check, NULL);
755 next_removal_check.tv_sec += 60;
758 snapshot_removal_status = HS_PRE_SUCCESS;
761 static int handle_rm_exit(int status)
763 if (!WIFEXITED(status)) {
764 snapshot_removal_status = HS_READY;
765 return -E_INVOLUNTARY_EXIT;
767 if (WEXITSTATUS(status)) {
768 snapshot_removal_status = HS_READY;
769 return -E_BAD_EXIT_CODE;
771 snapshot_removal_status = HS_SUCCESS;
775 static void handle_post_remove_exit(void)
777 snapshot_removal_status = HS_READY;
780 static int handle_remove_exit(int status)
783 struct snapshot *s = snapshot_currently_being_removed;
786 switch (snapshot_removal_status) {
788 handle_pre_remove_exit(status);
792 ret = handle_rm_exit(status);
794 case HS_POST_RUNNING:
795 handle_post_remove_exit();
801 if (snapshot_removal_status == HS_READY) {
804 snapshot_currently_being_removed = NULL;
810 static int wait_for_remove_process(void)
816 snapshot_removal_status == HS_PRE_RUNNING ||
817 snapshot_removal_status == HS_RUNNING ||
818 snapshot_removal_status == HS_POST_RUNNING
820 ret = wait_for_process(remove_pid, &status);
823 return handle_remove_exit(status);
826 static int handle_rsync_exit(int status)
830 if (!WIFEXITED(status)) {
831 DSS_ERROR_LOG(("rsync process %d died involuntary\n", (int)create_pid));
832 ret = -E_INVOLUNTARY_EXIT;
833 snapshot_creation_status = HS_READY;
836 es = WEXITSTATUS(status);
838 * Restart rsync on non-fatal errors:
839 * 12: Error in rsync protocol data stream
840 * 13: Errors with program diagnostics
842 if (es == 12 || es == 13) {
843 DSS_WARNING_LOG(("rsync process %d returned %d -- restarting\n",
844 (int)create_pid, es));
845 snapshot_creation_status = HS_NEEDS_RESTART;
846 next_snapshot_time = get_current_time() + 60;
850 if (es != 0 && es != 23 && es != 24) {
851 DSS_ERROR_LOG(("rsync process %d returned %d\n", (int)create_pid, es));
852 ret = -E_BAD_EXIT_CODE;
853 snapshot_creation_status = HS_READY;
856 ret = rename_incomplete_snapshot(current_snapshot_creation_time);
859 snapshot_creation_status = HS_SUCCESS;
860 free(name_of_reference_snapshot);
861 name_of_reference_snapshot = NULL;
863 create_process_stopped = 0;
867 static int handle_pre_create_hook_exit(int status)
870 static int warn_count;
872 if (!WIFEXITED(status)) {
873 snapshot_creation_status = HS_READY;
874 ret = -E_INVOLUNTARY_EXIT;
877 es = WEXITSTATUS(status);
880 DSS_NOTICE_LOG(("pre_create_hook %s returned %d\n",
881 conf.pre_create_hook_arg, es));
882 DSS_NOTICE_LOG(("deferring snapshot creation...\n"));
883 warn_count = 60; /* warn only once per hour */
885 next_snapshot_time = get_current_time() + 60;
886 snapshot_creation_status = HS_READY;
891 snapshot_creation_status = HS_PRE_SUCCESS;
897 static int handle_sigchld(void)
900 int status, ret = reap_child(&pid, &status);
905 if (pid == create_pid) {
906 switch (snapshot_creation_status) {
908 ret = handle_pre_create_hook_exit(status);
911 ret = handle_rsync_exit(status);
913 case HS_POST_RUNNING:
914 snapshot_creation_status = HS_READY;
918 DSS_EMERG_LOG(("BUG: create can't die in status %d\n",
919 snapshot_creation_status));
925 if (pid == remove_pid) {
926 ret = handle_remove_exit(status);
931 DSS_EMERG_LOG(("BUG: unknown process %d died\n", (int)pid));
935 static int check_config(void)
937 if (conf.unit_interval_arg <= 0) {
938 DSS_ERROR_LOG(("bad unit interval: %i\n", conf.unit_interval_arg));
939 return -E_INVALID_NUMBER;
941 DSS_DEBUG_LOG(("unit interval: %i day(s)\n", conf.unit_interval_arg));
942 if (conf.num_intervals_arg <= 0 || conf.num_intervals_arg > 30) {
943 DSS_ERROR_LOG(("bad number of intervals: %i\n",
944 conf.num_intervals_arg));
945 return -E_INVALID_NUMBER;
947 DSS_DEBUG_LOG(("number of intervals: %i\n", conf.num_intervals_arg));
952 * Returns < 0 on errors, 0 if no config file is given and > 0 if the config
953 * file was read successfully.
955 static int parse_config_file(int override)
957 int ret, config_file_exists;
958 char *config_file = get_config_file_name();
960 char *old_logfile_arg = NULL;
961 int old_daemon_given = 0;
963 if (override) { /* SIGHUP */
964 if (conf.logfile_given)
965 old_logfile_arg = dss_strdup(conf.logfile_arg);
966 old_daemon_given = conf.daemon_given;
969 config_file_exists = !stat(config_file, &statbuf);
970 if (!config_file_exists && conf.config_file_given) {
971 ret = -ERRNO_TO_DSS_ERROR(errno);
972 DSS_ERROR_LOG(("failed to stat config file %s\n", config_file));
975 if (config_file_exists) {
976 struct cmdline_parser_params params;
977 params.override = override;
978 params.initialize = 0;
979 params.check_required = 1;
980 params.check_ambiguity = 0;
981 params.print_errors = 1;
982 if (override) { /* invalidate all rsync options */
985 for (i = 0; i < conf.rsync_option_given; i++) {
986 free(conf.rsync_option_arg[i]);
987 conf.rsync_option_arg[i] = NULL;
989 conf.rsync_option_given = 0;
991 cmdline_parser_config_file(config_file, &conf, ¶ms);
993 ret = check_config();
997 /* don't change daemon mode on SIGHUP */
998 conf.daemon_given = old_daemon_given;
1001 if (conf.logfile_given)
1002 free(old_logfile_arg);
1003 else if (conf.daemon_given) { /* re-use old logfile */
1004 conf.logfile_arg = old_logfile_arg;
1005 conf.logfile_given = 1;
1008 if (conf.logfile_given && conf.run_given && conf.daemon_given) {
1009 logfile = open_log(conf.logfile_arg);
1010 log_welcome(conf.loglevel_arg);
1012 DSS_DEBUG_LOG(("loglevel: %d\n", conf.loglevel_arg));
1013 ret = config_file_exists;
1017 DSS_EMERG_LOG(("%s\n", dss_strerror(-ret)));
1021 static int change_to_dest_dir(void)
1023 DSS_INFO_LOG(("changing cwd to %s\n", conf.dest_dir_arg));
1024 return dss_chdir(conf.dest_dir_arg);
1027 static int handle_sighup(void)
1031 DSS_NOTICE_LOG(("SIGHUP, re-reading config\n"));
1032 dump_dss_config("old");
1033 ret = parse_config_file(1);
1036 dump_dss_config("reloaded");
1037 invalidate_next_snapshot_time();
1038 return change_to_dest_dir();
1041 static int handle_signal(void)
1043 int sig, ret = next_signal();
1051 restart_create_process();
1052 dss_kill(create_pid, SIGTERM, NULL);
1053 dss_kill(remove_pid, SIGTERM, NULL);
1057 ret = handle_sighup();
1060 ret = handle_sigchld();
1065 DSS_ERROR_LOG(("%s\n", dss_strerror(-ret)));
1070 * We can not use rsync locally if the local user is different from the remote
1071 * user or if the src dir is not on the local host (or both).
1073 static int use_rsync_locally(char *logname)
1075 char *h = conf.remote_host_arg;
1077 if (strcmp(h, "localhost") && strcmp(h, "127.0.0.1"))
1079 if (conf.remote_user_given && strcmp(conf.remote_user_arg, logname))
1084 static int rename_resume_snap(int64_t creation_time)
1086 struct snapshot_list sl;
1087 struct snapshot *s = NULL;
1088 char *new_name = incomplete_name(creation_time);
1092 sl.num_snapshots = 0;
1095 if (conf.no_resume_given)
1097 dss_get_snapshot_list(&sl);
1099 * Snapshot recycling: We first look at the newest snapshot. If this
1100 * snapshot happens to be incomplete, the last rsync process was
1101 * aborted and we reuse this one. Otherwise we look at snapshots which
1102 * could be removed (outdated and redundant snapshots) as candidates
1103 * for recycling. If no outdated/redundant snapshot exists, we check if
1104 * there is an orphaned snapshot, which likely is useless anyway.
1106 * Only if no existing snapshot is suitable for recycling, we bite the
1107 * bullet and create a new one.
1109 s = get_newest_snapshot(&sl);
1110 if (!s) /* no snapshots at all */
1112 /* re-use last snapshot if it is incomplete */
1114 if ((s->flags & SS_COMPLETE) == 0)
1117 s = find_outdated_snapshot(&sl);
1121 s = find_redundant_snapshot(&sl);
1125 s = find_orphaned_snapshot(&sl);
1128 DSS_INFO_LOG(("reusing %s snapshot %s\n", why, s->name));
1129 ret = dss_rename(s->name, new_name);
1132 DSS_NOTICE_LOG(("creating new snapshot %s\n", new_name));
1134 free_snapshot_list(&sl);
1138 static void create_rsync_argv(char ***argv, int64_t *num)
1142 struct snapshot_list sl;
1144 dss_get_snapshot_list(&sl);
1145 assert(!name_of_reference_snapshot);
1146 name_of_reference_snapshot = name_of_newest_complete_snapshot(&sl);
1147 free_snapshot_list(&sl);
1149 *argv = dss_malloc((15 + conf.rsync_option_given) * sizeof(char *));
1150 (*argv)[i++] = dss_strdup("rsync");
1151 (*argv)[i++] = dss_strdup("-a");
1152 (*argv)[i++] = dss_strdup("--delete");
1153 for (j = 0; j < conf.rsync_option_given; j++)
1154 (*argv)[i++] = dss_strdup(conf.rsync_option_arg[j]);
1155 if (name_of_reference_snapshot) {
1156 DSS_INFO_LOG(("using %s as reference\n", name_of_reference_snapshot));
1157 (*argv)[i++] = make_message("--link-dest=../%s",
1158 name_of_reference_snapshot);
1160 DSS_INFO_LOG(("no suitable reference snapshot found\n"));
1161 logname = dss_logname();
1162 if (use_rsync_locally(logname))
1163 (*argv)[i++] = dss_strdup(conf.source_dir_arg);
1165 (*argv)[i++] = make_message("%s@%s:%s/", conf.remote_user_given?
1166 conf.remote_user_arg : logname,
1167 conf.remote_host_arg, conf.source_dir_arg);
1169 *num = get_current_time();
1170 (*argv)[i++] = incomplete_name(*num);
1171 (*argv)[i++] = NULL;
1172 for (j = 0; j < i; j++)
1173 DSS_DEBUG_LOG(("argv[%d] = %s\n", j, (*argv)[j]));
1176 static void free_rsync_argv(char **argv)
1182 for (i = 0; argv[i]; i++)
1187 static int create_snapshot(char **argv)
1191 ret = rename_resume_snap(current_snapshot_creation_time);
1194 dss_exec(&create_pid, argv[0], argv);
1195 snapshot_creation_status = HS_RUNNING;
1199 static int select_loop(void)
1202 /* check every 60 seconds for free disk space */
1204 char **rsync_argv = NULL;
1208 struct timeval *tvp;
1211 tvp = NULL; /* sleep until rm hook/process dies */
1212 else { /* sleep one minute */
1218 FD_SET(signal_pipe, &rfds);
1219 ret = dss_select(signal_pipe + 1, &rfds, NULL, tvp);
1222 if (FD_ISSET(signal_pipe, &rfds)) {
1223 ret = handle_signal();
1229 if (snapshot_removal_status == HS_PRE_SUCCESS) {
1235 if (snapshot_removal_status == HS_SUCCESS) {
1239 ret = try_to_free_disk_space();
1242 if (snapshot_removal_status != HS_READY) {
1243 stop_create_process();
1246 restart_create_process();
1247 switch (snapshot_creation_status) {
1249 if (!next_snapshot_is_due())
1253 case HS_PRE_RUNNING:
1255 case HS_POST_RUNNING:
1257 case HS_PRE_SUCCESS:
1258 if (!name_of_reference_snapshot) {
1259 free_rsync_argv(rsync_argv);
1260 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1262 ret = create_snapshot(rsync_argv);
1266 case HS_NEEDS_RESTART:
1267 if (!next_snapshot_is_due())
1269 ret = create_snapshot(rsync_argv);
1282 static void exit_hook(int exit_code)
1287 argv[0] = conf.exit_hook_arg;
1288 argv[1] = dss_strerror(-exit_code);
1291 DSS_NOTICE_LOG(("executing %s %s\n", argv[0], argv[1]));
1292 dss_exec(&pid, conf.exit_hook_arg, argv);
1295 static void lock_dss_or_die(void)
1297 char *config_file = get_config_file_name();
1298 int ret = lock_dss(config_file);
1302 DSS_EMERG_LOG(("failed to lock: %s\n", dss_strerror(-ret)));
1307 static int com_run(void)
1312 if (conf.dry_run_given) {
1313 DSS_ERROR_LOG(("dry_run not supported by this command\n"));
1316 ret = install_sighandler(SIGHUP);
1319 ret = select_loop();
1320 if (ret >= 0) /* impossible */
1326 static int com_prune(void)
1329 struct snapshot_list sl;
1330 struct snapshot *victim;
1331 struct disk_space ds;
1335 ret = get_disk_space(".", &ds);
1338 log_disk_space(&ds);
1339 dss_get_snapshot_list(&sl);
1341 victim = find_outdated_snapshot(&sl);
1345 victim = find_redundant_snapshot(&sl);
1351 if (conf.dry_run_given) {
1352 dss_msg("%s snapshot %s (interval = %i)\n",
1353 why, victim->name, victim->interval);
1357 pre_remove_hook(victim, why);
1358 if (snapshot_removal_status == HS_PRE_RUNNING) {
1359 ret = wait_for_remove_process();
1362 if (snapshot_removal_status != HS_PRE_SUCCESS)
1368 ret = wait_for_remove_process();
1371 if (snapshot_removal_status != HS_SUCCESS)
1374 if (snapshot_removal_status != HS_POST_RUNNING)
1376 ret = wait_for_remove_process();
1381 free_snapshot_list(&sl);
1385 static int com_create(void)
1391 if (conf.dry_run_given) {
1394 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1395 for (i = 0; rsync_argv[i]; i++) {
1397 msg = make_message("%s%s%s", tmp? tmp : "",
1398 tmp? " " : "", rsync_argv[i]);
1401 free_rsync_argv(rsync_argv);
1402 dss_msg("%s\n", msg);
1408 ret = wait_for_process(create_pid, &status);
1411 ret = handle_pre_create_hook_exit(status);
1412 if (ret <= 0) /* error, or pre-create failed */
1415 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
1416 ret = create_snapshot(rsync_argv);
1419 ret = wait_for_process(create_pid, &status);
1422 ret = handle_rsync_exit(status);
1427 ret = wait_for_process(create_pid, &status);
1429 free_rsync_argv(rsync_argv);
1433 static int com_ls(void)
1436 struct snapshot_list sl;
1439 dss_get_snapshot_list(&sl);
1440 FOR_EACH_SNAPSHOT(s, i, &sl) {
1442 if (s->flags & SS_COMPLETE)
1443 d = (s->completion_time - s->creation_time) / 60;
1444 dss_msg("%u\t%s\t%3" PRId64 ":%02" PRId64 "\n", s->interval, s->name, d/60, d%60);
1446 free_snapshot_list(&sl);
1450 static int setup_signal_handling(void)
1454 DSS_INFO_LOG(("setting up signal handlers\n"));
1455 signal_pipe = signal_init(); /* always successful */
1456 ret = install_sighandler(SIGINT);
1459 ret = install_sighandler(SIGTERM);
1462 return install_sighandler(SIGCHLD);
1466 * The main function of dss.
1468 * \param argc Usual argument count.
1469 * \param argv Usual argument vector.
1471 int main(int argc, char **argv)
1474 struct cmdline_parser_params params;
1476 params.override = 0;
1477 params.initialize = 1;
1478 params.check_required = 0;
1479 params.check_ambiguity = 0;
1480 params.print_errors = 1;
1482 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1483 ret = parse_config_file(0);
1486 if (ret == 0) { /* no config file given */
1488 * Parse the command line options again, but this time check
1489 * that all required options are given.
1491 struct cmdline_parser_params params;
1492 params.override = 1;
1493 params.initialize = 1;
1494 params.check_required = 1;
1495 params.check_ambiguity = 1;
1496 params.print_errors = 1;
1497 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1499 if (conf.daemon_given)
1501 ret = change_to_dest_dir();
1504 dump_dss_config("startup");
1505 ret = setup_signal_handling();
1508 ret = call_command_handler();
1511 DSS_EMERG_LOG(("%s\n", dss_strerror(-ret)));
1512 exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);