2 * Copyright (C) 2008 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 rsync process. */
44 static pid_t rsync_pid;
45 /** Whether the rsync process is currently stopped */
46 static int rsync_stopped;
47 /** Process id of current rm process. */
49 /** When the next snapshot is due. */
50 static struct timeval next_snapshot_time;
51 /** The pid of the pre-create hook. */
52 static pid_t pre_create_hook_pid;
53 /** The pid of the post-create hook. */
54 static pid_t post_create_hook_pid;
55 /** Creation time of the snapshot currently being created. */
56 static int64_t current_snapshot_creation_time;
57 /** Needed by the post-create hook. */
58 static char *path_to_last_complete_snapshot;
59 /** \sa \ref snap.h for details. */
60 static unsigned snapshot_creation_status;
66 /* a litte cpp magic helps to DRY */
72 #define COMMAND(x) static int com_ ##x(void);
75 #define COMMAND(x) if (conf.x ##_given) return com_ ##x();
76 static int call_command_handler(void)
79 DSS_EMERG_LOG("BUG: did not find command handler\n");
86 * The log function of dss.
89 * \param fml Usual format string.
91 * All DSS_XXX_LOG() macros use this function.
93 __printf_2_3 void dss_log(int ll, const char* fmt,...)
101 if (ll < conf.loglevel_arg)
103 outfd = logfile? logfile : stderr;
106 strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
107 fprintf(outfd, "%s ", str);
108 if (conf.loglevel_arg <= INFO)
109 fprintf(outfd, "%i: ", ll);
111 vfprintf(outfd, fmt, argp);
116 * Print a message either to stdout or to the log file.
118 static __printf_1_2 void dss_msg(const char* fmt,...)
120 FILE *outfd = conf.daemon_given? logfile : stdout;
123 vfprintf(outfd, fmt, argp);
127 static int disk_space_low(void)
129 struct disk_space ds;
130 int ret = get_disk_space(".", &ds);
134 if (conf.min_free_mb_arg)
135 if (ds.free_mb < conf.min_free_mb_arg)
137 if (conf.min_free_percent_arg)
138 if (ds.percent_free < conf.min_free_percent_arg)
140 if (conf.min_free_percent_inodes_arg)
141 if (ds.percent_free_inodes < conf.min_free_percent_inodes_arg)
146 static void dss_get_snapshot_list(struct snapshot_list *sl)
148 get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
151 static void compute_next_snapshot_time(void)
153 struct timeval now, unit_interval = {.tv_sec = 24 * 3600 * conf.unit_interval_arg},
156 unsigned wanted = desired_number_of_snapshots(0, conf.num_intervals_arg),
157 num_complete_snapshots = 0;
159 struct snapshot *s = NULL;
160 struct snapshot_list sl;
162 assert(snapshot_creation_status == SCS_READY);
163 current_snapshot_creation_time = 0;
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;
172 if (num_complete_snapshots)
173 x /= num_complete_snapshots; /* avg time to create one snapshot */
174 x *= wanted; /* time to create all snapshots in interval 0 */
177 ret = tv_diff(&unit_interval, &tmp, &diff); /* total sleep time per unit interval */
178 gettimeofday(&now, NULL);
181 tv_divide(wanted, &diff, &tmp); /* sleep time betweeen two snapshots */
182 diff.tv_sec = s->completion_time;
184 tv_add(&diff, &tmp, &next_snapshot_time);
185 if (tv_diff(&now, &next_snapshot_time, NULL) < 0)
188 next_snapshot_time = now;
189 next_snapshot_time.tv_sec += 60;
191 free_snapshot_list(&sl);
195 static int remove_snapshot(struct snapshot *s)
197 int fds[3] = {0, 0, 0};
199 char *new_name = being_deleted_name(s);
200 int ret = dss_rename(s->name, new_name);
201 char *argv[] = {"rm", "-rf", new_name, NULL};
205 DSS_NOTICE_LOG("removing %s (interval = %i)\n", s->name, s->interval);
206 ret = dss_exec(&rm_pid, argv[0], argv, fds);
213 * return: 0: no redundant snapshots, 1: rm process started, negative: error
215 static int remove_redundant_snapshot(struct snapshot_list *sl)
217 int ret, i, interval;
219 unsigned missing = 0;
221 DSS_DEBUG_LOG("looking for intervals containing too many snapshots\n");
222 for (interval = conf.num_intervals_arg - 1; interval >= 0; interval--) {
223 unsigned keep = desired_number_of_snapshots(interval, conf.num_intervals_arg);
224 unsigned num = sl->interval_count[interval];
225 struct snapshot *victim = NULL, *prev = NULL;
226 int64_t score = LONG_MAX;
229 missing += keep - num;
230 // DSS_DEBUG_LOG("interval %i: keep: %u, have: %u, missing: %u\n",
231 // interval, keep, num, missing);
232 if (keep + missing >= num)
234 /* redundant snapshot in this interval, pick snapshot with lowest score */
235 FOR_EACH_SNAPSHOT(s, i, sl) {
238 //DSS_DEBUG_LOG("checking %s\n", s->name);
239 if (s->interval > interval) {
243 if (s->interval < interval)
251 /* check if s is a better victim */
252 this_score = s->creation_time - prev->creation_time;
253 assert(this_score >= 0);
254 //DSS_DEBUG_LOG("%s: score %lli\n", s->name, (long long)score);
255 if (this_score < score) {
262 if (conf.dry_run_given) {
263 dss_msg("%s would be removed (interval = %i)\n",
264 victim->name, victim->interval);
267 ret = remove_snapshot(victim);
268 return ret < 0? ret : 1;
273 static int remove_outdated_snapshot(struct snapshot_list *sl)
278 DSS_DEBUG_LOG("looking for snapshots belonging to intervals greater than %d\n",
279 conf.num_intervals_arg);
280 FOR_EACH_SNAPSHOT(s, i, sl) {
281 if (s->interval <= conf.num_intervals_arg)
283 if (conf.dry_run_given) {
284 dss_msg("%s would be removed (interval = %i)\n",
285 s->name, s->interval);
288 ret = remove_snapshot(s);
296 static int remove_oldest_snapshot(struct snapshot_list *sl)
298 struct snapshot *s = get_oldest_snapshot(sl);
300 if (!s) /* no snapshot found */
302 DSS_INFO_LOG("oldest snapshot: %s\n", s->name);
303 if (s->creation_time == current_snapshot_creation_time)
304 return 0; /* do not remove the snapshot currently being created */
305 return remove_snapshot(s);
308 static int rename_incomplete_snapshot(int64_t start)
313 free(path_to_last_complete_snapshot);
314 ret = complete_name(start, get_current_time(),
315 &path_to_last_complete_snapshot);
318 old_name = incomplete_name(start);
319 ret = dss_rename(old_name, path_to_last_complete_snapshot);
321 DSS_NOTICE_LOG("%s -> %s\n", old_name,
322 path_to_last_complete_snapshot);
327 static int try_to_free_disk_space(int low_disk_space)
330 struct snapshot_list sl;
332 if (!low_disk_space && conf.keep_redundant_given)
334 dss_get_snapshot_list(&sl);
335 ret = remove_outdated_snapshot(&sl);
336 if (ret) /* error, or we are removing something */
338 /* no outdated snapshot */
339 ret = remove_redundant_snapshot(&sl);
345 DSS_WARNING_LOG("disk space low and nothing obvious to remove\n");
346 ret = remove_oldest_snapshot(&sl);
349 DSS_CRIT_LOG("uhuhu: not enough disk space for a single snapshot\n");
350 ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
352 free_snapshot_list(&sl);
356 static int pre_create_hook(void)
358 int ret, fds[3] = {0, 0, 0};
360 if (!conf.pre_create_hook_given) {
361 snapshot_creation_status = SCS_PRE_HOOK_SUCCESS;
364 DSS_NOTICE_LOG("executing %s\n", conf.pre_create_hook_arg);
365 ret = dss_exec_cmdline_pid(&pre_create_hook_pid,
366 conf.pre_create_hook_arg, fds);
369 snapshot_creation_status = SCS_PRE_HOOK_RUNNING;
373 static int post_create_hook(void)
375 int ret, fds[3] = {0, 0, 0};
378 if (!conf.post_create_hook_given) {
379 snapshot_creation_status = SCS_READY;
380 compute_next_snapshot_time();
383 cmd = make_message("%s %s", conf.post_create_hook_arg,
384 path_to_last_complete_snapshot);
385 DSS_NOTICE_LOG("executing %s\n", cmd);
386 ret = dss_exec_cmdline_pid(&post_create_hook_pid, cmd, fds);
390 snapshot_creation_status = SCS_POST_HOOK_RUNNING;
394 static void kill_process(pid_t pid)
398 DSS_WARNING_LOG("sending SIGTERM to pid %d\n", (int)pid);
402 static void stop_rsync_process(void)
404 if (!rsync_pid || rsync_stopped)
406 kill(SIGSTOP, rsync_pid);
410 static void restart_rsync_process(void)
412 if (!rsync_pid || !rsync_stopped)
414 kill (SIGCONT, rsync_pid);
420 * Print a log message about the exit status of a child.
422 static void log_termination_msg(pid_t pid, int status)
424 if (WIFEXITED(status))
425 DSS_INFO_LOG("child %i exited. Exit status: %i\n", (int)pid,
426 WEXITSTATUS(status));
427 else if (WIFSIGNALED(status))
428 DSS_NOTICE_LOG("child %i was killed by signal %i\n", (int)pid,
431 DSS_WARNING_LOG("child %i terminated abormally\n", (int)pid);
434 static int wait_for_process(pid_t pid, int *status)
438 DSS_DEBUG_LOG("Waiting for process %d to terminate\n", (int)pid);
443 FD_SET(signal_pipe, &rfds);
444 ret = dss_select(signal_pipe + 1, &rfds, NULL, NULL);
450 if (ret == SIGCHLD) {
451 ret = waitpid(pid, status, 0);
454 if (errno != EINTR) { /* error */
455 ret = -ERRNO_TO_DSS_ERROR(errno);
459 /* SIGINT or SIGTERM */
460 DSS_WARNING_LOG("sending SIGTERM to pid %d\n", (int)pid);
464 DSS_ERROR_LOG("failed to wait for process %d\n", (int)pid);
466 log_termination_msg(pid, *status);
470 static int handle_rm_exit(int status)
473 if (!WIFEXITED(status))
474 return -E_INVOLUNTARY_EXIT;
475 if (WEXITSTATUS(status))
476 return -E_BAD_EXIT_CODE;
480 static int wait_for_rm_process(void)
482 int status, ret = wait_for_process(rm_pid, &status);
486 return handle_rm_exit(status);
489 static int handle_rsync_exit(int status)
493 if (!WIFEXITED(status)) {
494 DSS_ERROR_LOG("rsync process %d died involuntary\n", (int)rsync_pid);
495 ret = -E_INVOLUNTARY_EXIT;
496 snapshot_creation_status = SCS_READY;
497 compute_next_snapshot_time();
500 es = WEXITSTATUS(status);
501 if (es == 13) { /* Errors with program diagnostics */
502 DSS_WARNING_LOG("rsync process %d returned %d -- restarting\n",
504 snapshot_creation_status = SCS_RSYNC_NEEDS_RESTART;
508 if (es != 0 && es != 23 && es != 24) {
509 DSS_ERROR_LOG("rsync process %d returned %d\n", (int)rsync_pid, es);
510 ret = -E_BAD_EXIT_CODE;
511 snapshot_creation_status = SCS_READY;
512 compute_next_snapshot_time();
515 ret = rename_incomplete_snapshot(current_snapshot_creation_time);
518 snapshot_creation_status = SCS_RSYNC_SUCCESS;
525 static int handle_pre_create_hook_exit(int status)
529 if (!WIFEXITED(status)) {
530 snapshot_creation_status = SCS_READY;
531 compute_next_snapshot_time();
532 ret = -E_INVOLUNTARY_EXIT;
535 es = WEXITSTATUS(status);
537 snapshot_creation_status = SCS_READY;
538 compute_next_snapshot_time();
539 ret = -E_BAD_EXIT_CODE;
542 snapshot_creation_status = SCS_PRE_HOOK_SUCCESS;
545 pre_create_hook_pid = 0;
549 static int handle_sigchld(void)
552 int status, ret = reap_child(&pid, &status);
556 if (pid == rsync_pid)
557 return handle_rsync_exit(status);
559 return handle_rm_exit(status);
560 if (pid == pre_create_hook_pid)
561 return handle_pre_create_hook_exit(status);
562 if (pid == post_create_hook_pid) {
563 snapshot_creation_status = SCS_READY;
564 compute_next_snapshot_time();
567 DSS_EMERG_LOG("BUG: unknown process %d died\n", (int)pid);
571 static int check_config(void)
573 if (conf.unit_interval_arg <= 0) {
574 DSS_ERROR_LOG("bad unit interval: %i\n", conf.unit_interval_arg);
575 return -E_INVALID_NUMBER;
577 DSS_DEBUG_LOG("unit interval: %i day(s)\n", conf.unit_interval_arg);
578 if (conf.num_intervals_arg <= 0) {
579 DSS_ERROR_LOG("bad number of intervals %i\n", conf.num_intervals_arg);
580 return -E_INVALID_NUMBER;
582 DSS_DEBUG_LOG("number of intervals: %i\n", conf.num_intervals_arg);
586 static int parse_config_file(int override)
591 char *old_logfile_arg = NULL;
592 int old_daemon_given = 0;
594 if (conf.config_file_given)
595 config_file = dss_strdup(conf.config_file_arg);
597 char *home = get_homedir();
598 config_file = make_message("%s/.dssrc", home);
601 if (override) { /* SIGHUP */
602 if (conf.logfile_given)
603 old_logfile_arg = dss_strdup(conf.logfile_arg);
604 old_daemon_given = conf.daemon_given;
607 ret = stat(config_file, &statbuf);
608 if (ret && conf.config_file_given) {
609 ret = -ERRNO_TO_DSS_ERROR(errno);
610 DSS_ERROR_LOG("failed to stat config file %s\n", config_file);
614 struct cmdline_parser_params params = {
615 .override = override,
618 .check_ambiguity = 0,
621 cmdline_parser_config_file(config_file, &conf, ¶ms);
623 ret = check_config();
627 /* don't change daemon mode on SIGHUP */
628 conf.daemon_given = old_daemon_given;
631 if (conf.logfile_given)
632 free(old_logfile_arg);
633 else if (conf.daemon_given) { /* re-use old logfile */
634 conf.logfile_arg = old_logfile_arg;
635 conf.logfile_given = 1;
638 if (conf.logfile_given) {
639 logfile = open_log(conf.logfile_arg);
640 log_welcome(conf.loglevel_arg);
642 DSS_DEBUG_LOG("loglevel: %d\n", conf.loglevel_arg);
643 // cmdline_parser_dump(logfile? logfile : stdout, &conf);
647 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
651 static int change_to_dest_dir(void)
653 DSS_INFO_LOG("changing cwd to %s\n", conf.dest_dir_arg);
654 return dss_chdir(conf.dest_dir_arg);
657 static int handle_sighup(void)
661 DSS_NOTICE_LOG("SIGHUP\n");
662 ret = parse_config_file(1);
665 return change_to_dest_dir();
668 static int handle_signal(void)
670 int sig, ret = next_signal();
678 restart_rsync_process();
679 kill_process(rsync_pid);
680 kill_process(rm_pid);
684 ret = handle_sighup();
687 ret = handle_sigchld();
692 DSS_ERROR_LOG("%s\n", dss_strerror(-ret));
696 static void create_rsync_argv(char ***argv, int64_t *num)
698 char *logname, *newest;
700 struct snapshot_list sl;
702 dss_get_snapshot_list(&sl);
703 newest = name_of_newest_complete_snapshot(&sl);
704 free_snapshot_list(&sl);
706 *argv = dss_malloc((15 + conf.rsync_option_given) * sizeof(char *));
707 (*argv)[i++] = dss_strdup("rsync");
708 (*argv)[i++] = dss_strdup("-aq");
709 (*argv)[i++] = dss_strdup("--delete");
710 for (j = 0; j < conf.rsync_option_given; j++)
711 (*argv)[i++] = dss_strdup(conf.rsync_option_arg[j]);
713 DSS_INFO_LOG("using %s as reference snapshot\n", newest);
714 (*argv)[i++] = make_message("--link-dest=../%s", newest);
717 DSS_INFO_LOG("no previous snapshot found\n");
718 logname = dss_logname();
719 if (conf.remote_user_given && !strcmp(conf.remote_user_arg, logname))
720 (*argv)[i++] = dss_strdup(conf.source_dir_arg);
722 (*argv)[i++] = make_message("%s@%s:%s/", conf.remote_user_given?
723 conf.remote_user_arg : logname,
724 conf.remote_host_arg, conf.source_dir_arg);
726 *num = get_current_time();
727 (*argv)[i++] = incomplete_name(*num);
729 for (j = 0; j < i; j++)
730 DSS_DEBUG_LOG("argv[%d] = %s\n", j, (*argv)[j]);
733 static void free_rsync_argv(char **argv)
739 for (i = 0; argv[i]; i++)
744 static int create_snapshot(char **argv)
746 int ret, fds[3] = {0, 0, 0};
749 name = incomplete_name(current_snapshot_creation_time);
750 DSS_NOTICE_LOG("creating new snapshot %s\n", name);
752 ret = dss_exec(&rsync_pid, argv[0], argv, fds);
755 snapshot_creation_status = SCS_RSYNC_RUNNING;
759 static int select_loop(void)
762 /* check every 60 seconds for free disk space */
764 char **rsync_argv = NULL;
769 struct timeval now, *tvp;
772 tvp = NULL; /* sleep until rm process dies */
773 else { /* sleep one minute */
779 FD_SET(signal_pipe, &rfds);
780 DSS_DEBUG_LOG("tvp: %p, tv_sec : %lu\n", tvp, (long unsigned) tv.tv_sec);
781 ret = dss_select(signal_pipe + 1, &rfds, NULL, tvp);
784 if (FD_ISSET(signal_pipe, &rfds)) {
785 ret = handle_signal();
791 ret = disk_space_low();
794 low_disk_space = ret;
795 ret = try_to_free_disk_space(low_disk_space);
799 stop_rsync_process();
802 restart_rsync_process();
803 gettimeofday(&now, NULL);
804 if (tv_diff(&next_snapshot_time, &now, NULL) > 0)
806 switch (snapshot_creation_status) {
808 ret = pre_create_hook();
812 case SCS_PRE_HOOK_RUNNING:
814 case SCS_RSYNC_NEEDS_RESTART:
815 ret = create_snapshot(rsync_argv);
819 case SCS_PRE_HOOK_SUCCESS:
820 free_rsync_argv(rsync_argv);
821 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
822 ret = create_snapshot(rsync_argv);
826 case SCS_RSYNC_RUNNING:
828 case SCS_RSYNC_SUCCESS:
829 ret = post_create_hook();
833 case SCS_POST_HOOK_RUNNING:
841 static void exit_hook(int exit_code)
843 int fds[3] = {0, 0, 0};
844 char *argv[] = {conf.exit_hook_arg, dss_strerror(-exit_code), NULL};
847 if (!conf.exit_hook_given)
849 DSS_NOTICE_LOG("executing %s %s\n", argv[0], argv[1]);
850 dss_exec(&pid, conf.exit_hook_arg, argv, fds);
853 static int com_run(void)
857 if (conf.dry_run_given) {
858 DSS_ERROR_LOG("dry_run not supported by this command\n");
861 ret = install_sighandler(SIGHUP);
864 compute_next_snapshot_time();
866 if (ret >= 0) /* impossible */
872 static int com_prune(void)
875 struct snapshot_list sl;
876 struct disk_space ds;
878 ret = get_disk_space(".", &ds);
883 dss_get_snapshot_list(&sl);
884 ret = remove_outdated_snapshot(&sl);
885 free_snapshot_list(&sl);
890 ret = wait_for_rm_process();
895 dss_get_snapshot_list(&sl);
896 ret = remove_redundant_snapshot(&sl);
897 free_snapshot_list(&sl);
902 ret = wait_for_rm_process();
911 static int com_create(void)
916 if (conf.dry_run_given) {
919 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
920 for (i = 0; rsync_argv[i]; i++) {
922 msg = make_message("%s%s%s", tmp? tmp : "",
923 tmp? " " : "", rsync_argv[i]);
926 free_rsync_argv(rsync_argv);
927 dss_msg("%s\n", msg);
931 ret = pre_create_hook();
934 if (pre_create_hook_pid) {
935 ret = wait_for_process(pre_create_hook_pid, &status);
938 ret = handle_pre_create_hook_exit(status);
942 create_rsync_argv(&rsync_argv, ¤t_snapshot_creation_time);
943 ret = create_snapshot(rsync_argv);
946 ret = wait_for_process(rsync_pid, &status);
949 ret = handle_rsync_exit(status);
953 if (post_create_hook_pid)
954 ret = wait_for_process(post_create_hook_pid, &status);
956 free_rsync_argv(rsync_argv);
960 static int com_ls(void)
963 struct snapshot_list sl;
966 dss_get_snapshot_list(&sl);
967 FOR_EACH_SNAPSHOT(s, i, &sl) {
969 if (s->flags & SS_COMPLETE)
970 d = (s->completion_time - s->creation_time) / 60;
971 dss_msg("%u\t%s\t%3" PRId64 ":%02" PRId64 "\n", s->interval, s->name, d/60, d%60);
973 free_snapshot_list(&sl);
977 static int setup_signal_handling(void)
981 DSS_INFO_LOG("setting up signal handlers\n");
982 signal_pipe = signal_init(); /* always successful */
983 ret = install_sighandler(SIGINT);
986 ret = install_sighandler(SIGTERM);
989 return install_sighandler(SIGCHLD);
993 * The main function of dss.
995 * \param argc Usual argument count.
996 * \param argv Usual argument vector.
998 int main(int argc, char **argv)
1001 struct cmdline_parser_params params = {
1004 .check_required = 0,
1005 .check_ambiguity = 0,
1009 cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
1010 ret = parse_config_file(0);
1013 if (conf.daemon_given)
1015 ret = change_to_dest_dir();
1018 ret = setup_signal_handling();
1021 ret = call_command_handler();
1024 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
1025 exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);