show human readable snapshot creation duration when listing snapshots.
[dss.git] / dss.c
1 /*
2 * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6 #include <string.h>
7 #include <stdlib.h>
8 #include <stdarg.h>
9 #include <assert.h>
10 #include <errno.h>
11 #include <sys/types.h>
12 #include <signal.h>
13 #include <ctype.h>
14 #include <sys/stat.h>
15 #include <unistd.h>
16 #include <inttypes.h>
17 #include <sys/time.h>
18 #include <time.h>
19 #include <sys/wait.h>
20 #include <fnmatch.h>
21 #include <limits.h>
22
23
24 #include "gcc-compat.h"
25 #include "cmdline.h"
26 #include "log.h"
27 #include "string.h"
28 #include "error.h"
29 #include "fd.h"
30 #include "exec.h"
31 #include "daemon.h"
32 #include "signal.h"
33 #include "df.h"
34 #include "time.h"
35 #include "snap.h"
36
37 /** Command line and config file options. */
38 static struct gengetopt_args_info conf;
39 /** Non-NULL if we log to a file. */
40 static FILE *logfile;
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. */
48 static pid_t rm_pid;
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;
61
62
63 DEFINE_DSS_ERRLIST;
64
65
66 /* a litte cpp magic helps to DRY */
67 #define COMMANDS \
68 COMMAND(ls) \
69 COMMAND(create) \
70 COMMAND(prune) \
71 COMMAND(run)
72 #define COMMAND(x) static int com_ ##x(void);
73 COMMANDS
74 #undef COMMAND
75 #define COMMAND(x) if (conf.x ##_given) return com_ ##x();
76 static int call_command_handler(void)
77 {
78 COMMANDS
79 DSS_EMERG_LOG("BUG: did not find command handler\n");
80 return -E_BUG;
81 }
82 #undef COMMAND
83 #undef COMMANDS
84
85 /**
86 * The log function of dss.
87 *
88 * \param ll Loglevel.
89 * \param fml Usual format string.
90 *
91 * All DSS_XXX_LOG() macros use this function.
92 */
93 __printf_2_3 void dss_log(int ll, const char* fmt,...)
94 {
95 va_list argp;
96 FILE *outfd;
97 struct tm *tm;
98 time_t t1;
99 char str[255] = "";
100
101 if (ll < conf.loglevel_arg)
102 return;
103 outfd = logfile? logfile : stderr;
104 time(&t1);
105 tm = localtime(&t1);
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);
110 va_start(argp, fmt);
111 vfprintf(outfd, fmt, argp);
112 va_end(argp);
113 }
114
115 /**
116 * Print a message either to stdout or to the log file.
117 */
118 static __printf_1_2 void dss_msg(const char* fmt,...)
119 {
120 FILE *outfd = conf.daemon_given? logfile : stdout;
121 va_list argp;
122 va_start(argp, fmt);
123 vfprintf(outfd, fmt, argp);
124 va_end(argp);
125 }
126
127 static int disk_space_low(void)
128 {
129 struct disk_space ds;
130 int ret = get_disk_space(".", &ds);
131
132 if (ret < 0)
133 return ret;
134 if (conf.min_free_mb_arg)
135 if (ds.free_mb < conf.min_free_mb_arg)
136 return 1;
137 if (conf.min_free_percent_arg)
138 if (ds.percent_free < conf.min_free_percent_arg)
139 return 1;
140 if (conf.min_free_percent_inodes_arg)
141 if (ds.percent_free_inodes < conf.min_free_percent_inodes_arg)
142 return 1;
143 return 0;
144 }
145
146 static void dss_get_snapshot_list(struct snapshot_list *sl)
147 {
148 get_snapshot_list(sl, conf.unit_interval_arg, conf.num_intervals_arg);
149 }
150
151 static void compute_next_snapshot_time(void)
152 {
153 struct timeval now, unit_interval = {.tv_sec = 24 * 3600 * conf.unit_interval_arg},
154 tmp, diff;
155 int64_t x = 0;
156 unsigned wanted = desired_number_of_snapshots(0, conf.num_intervals_arg),
157 num_complete_snapshots = 0;
158 int i, ret;
159 struct snapshot *s = NULL;
160 struct snapshot_list sl;
161
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))
167 continue;
168 num_complete_snapshots++;
169 x += s->completion_time - s->creation_time;
170 }
171 assert(x >= 0);
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 */
175 tmp.tv_sec = x;
176 tmp.tv_usec = 0;
177 ret = tv_diff(&unit_interval, &tmp, &diff); /* total sleep time per unit interval */
178 gettimeofday(&now, NULL);
179 if (ret < 0 || !s)
180 goto min_sleep;
181 tv_divide(wanted, &diff, &tmp); /* sleep time betweeen two snapshots */
182 diff.tv_sec = s->completion_time;
183 diff.tv_usec = 0;
184 tv_add(&diff, &tmp, &next_snapshot_time);
185 if (tv_diff(&now, &next_snapshot_time, NULL) < 0)
186 goto out;
187 min_sleep:
188 next_snapshot_time = now;
189 next_snapshot_time.tv_sec += 60;
190 out:
191 free_snapshot_list(&sl);
192 }
193
194
195 static int remove_snapshot(struct snapshot *s)
196 {
197 int fds[3] = {0, 0, 0};
198 assert(!rm_pid);
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};
202
203 if (ret < 0)
204 goto out;
205 DSS_NOTICE_LOG("removing %s (interval = %i)\n", s->name, s->interval);
206 ret = dss_exec(&rm_pid, argv[0], argv, fds);
207 out:
208 free(new_name);
209 return ret;
210 }
211
212 /*
213 * return: 0: no redundant snapshots, 1: rm process started, negative: error
214 */
215 static int remove_redundant_snapshot(struct snapshot_list *sl)
216 {
217 int ret, i, interval;
218 struct snapshot *s;
219 unsigned missing = 0;
220
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;
227
228 if (keep >= num)
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)
233 continue;
234 /* redundant snapshot in this interval, pick snapshot with lowest score */
235 FOR_EACH_SNAPSHOT(s, i, sl) {
236 int64_t this_score;
237
238 //DSS_DEBUG_LOG("checking %s\n", s->name);
239 if (s->interval > interval) {
240 prev = s;
241 continue;
242 }
243 if (s->interval < interval)
244 break;
245 if (!victim) {
246 victim = s;
247 prev = s;
248 continue;
249 }
250 assert(prev);
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) {
256 score = this_score;
257 victim = s;
258 }
259 prev = s;
260 }
261 assert(victim);
262 if (conf.dry_run_given) {
263 dss_msg("%s would be removed (interval = %i)\n",
264 victim->name, victim->interval);
265 continue;
266 }
267 ret = remove_snapshot(victim);
268 return ret < 0? ret : 1;
269 }
270 return 0;
271 }
272
273 static int remove_outdated_snapshot(struct snapshot_list *sl)
274 {
275 int i, ret;
276 struct snapshot *s;
277
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)
282 continue;
283 if (conf.dry_run_given) {
284 dss_msg("%s would be removed (interval = %i)\n",
285 s->name, s->interval);
286 continue;
287 }
288 ret = remove_snapshot(s);
289 if (ret < 0)
290 return ret;
291 return 1;
292 }
293 return 0;
294 }
295
296 static int remove_oldest_snapshot(struct snapshot_list *sl)
297 {
298 struct snapshot *s = get_oldest_snapshot(sl);
299
300 if (!s) /* no snapshot found */
301 return 0;
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);
306 }
307
308 static int rename_incomplete_snapshot(int64_t start)
309 {
310 char *old_name;
311 int ret;
312
313 free(path_to_last_complete_snapshot);
314 ret = complete_name(start, get_current_time(),
315 &path_to_last_complete_snapshot);
316 if (ret < 0)
317 return ret;
318 old_name = incomplete_name(start);
319 ret = dss_rename(old_name, path_to_last_complete_snapshot);
320 if (ret >= 0)
321 DSS_NOTICE_LOG("%s -> %s\n", old_name,
322 path_to_last_complete_snapshot);
323 free(old_name);
324 return ret;
325 }
326
327 static int try_to_free_disk_space(int low_disk_space)
328 {
329 int ret;
330 struct snapshot_list sl;
331
332 if (!low_disk_space && conf.keep_redundant_given)
333 return 0;
334 dss_get_snapshot_list(&sl);
335 ret = remove_outdated_snapshot(&sl);
336 if (ret) /* error, or we are removing something */
337 goto out;
338 /* no outdated snapshot */
339 ret = remove_redundant_snapshot(&sl);
340 if (ret)
341 goto out;
342 ret = 0;
343 if (!low_disk_space)
344 goto out;
345 DSS_WARNING_LOG("disk space low and nothing obvious to remove\n");
346 ret = remove_oldest_snapshot(&sl);
347 if (ret)
348 goto out;
349 DSS_CRIT_LOG("uhuhu: not enough disk space for a single snapshot\n");
350 ret = -ERRNO_TO_DSS_ERROR(ENOSPC);
351 out:
352 free_snapshot_list(&sl);
353 return ret;
354 }
355
356 static int pre_create_hook(void)
357 {
358 int ret, fds[3] = {0, 0, 0};
359
360 if (!conf.pre_create_hook_given) {
361 snapshot_creation_status = SCS_PRE_HOOK_SUCCESS;
362 return 0;
363 }
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);
367 if (ret < 0)
368 return ret;
369 snapshot_creation_status = SCS_PRE_HOOK_RUNNING;
370 return ret;
371 }
372
373 static int post_create_hook(void)
374 {
375 int ret, fds[3] = {0, 0, 0};
376 char *cmd;
377
378 if (!conf.post_create_hook_given) {
379 snapshot_creation_status = SCS_READY;
380 compute_next_snapshot_time();
381 return 0;
382 }
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);
387 free(cmd);
388 if (ret < 0)
389 return ret;
390 snapshot_creation_status = SCS_POST_HOOK_RUNNING;
391 return ret;
392 }
393
394 static void kill_process(pid_t pid)
395 {
396 if (!pid)
397 return;
398 DSS_WARNING_LOG("sending SIGTERM to pid %d\n", (int)pid);
399 kill(pid, SIGTERM);
400 }
401
402 static void stop_rsync_process(void)
403 {
404 if (!rsync_pid || rsync_stopped)
405 return;
406 kill(SIGSTOP, rsync_pid);
407 rsync_stopped = 1;
408 }
409
410 static void restart_rsync_process(void)
411 {
412 if (!rsync_pid || !rsync_stopped)
413 return;
414 kill (SIGCONT, rsync_pid);
415 rsync_stopped = 0;
416 }
417
418
419 /**
420 * Print a log message about the exit status of a child.
421 */
422 static void log_termination_msg(pid_t pid, int status)
423 {
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,
429 WTERMSIG(status));
430 else
431 DSS_WARNING_LOG("child %i terminated abormally\n", (int)pid);
432 }
433
434 static int wait_for_process(pid_t pid, int *status)
435 {
436 int ret;
437
438 DSS_DEBUG_LOG("Waiting for process %d to terminate\n", (int)pid);
439 for (;;) {
440 fd_set rfds;
441
442 FD_ZERO(&rfds);
443 FD_SET(signal_pipe, &rfds);
444 ret = dss_select(signal_pipe + 1, &rfds, NULL, NULL);
445 if (ret < 0)
446 break;
447 ret = next_signal();
448 if (!ret)
449 continue;
450 if (ret == SIGCHLD) {
451 ret = waitpid(pid, status, 0);
452 if (ret >= 0)
453 break;
454 if (errno != EINTR) { /* error */
455 ret = -ERRNO_TO_DSS_ERROR(errno);
456 break;
457 }
458 }
459 /* SIGINT or SIGTERM */
460 DSS_WARNING_LOG("sending SIGTERM to pid %d\n", (int)pid);
461 kill(pid, SIGTERM);
462 }
463 if (ret < 0)
464 DSS_ERROR_LOG("failed to wait for process %d\n", (int)pid);
465 else
466 log_termination_msg(pid, *status);
467 return ret;
468 }
469
470 static int handle_rm_exit(int status)
471 {
472 rm_pid = 0;
473 if (!WIFEXITED(status))
474 return -E_INVOLUNTARY_EXIT;
475 if (WEXITSTATUS(status))
476 return -E_BAD_EXIT_CODE;
477 return 1;
478 }
479
480 static int wait_for_rm_process(void)
481 {
482 int status, ret = wait_for_process(rm_pid, &status);
483
484 if (ret < 0)
485 return ret;
486 return handle_rm_exit(status);
487 }
488
489 static int handle_rsync_exit(int status)
490 {
491 int es, ret;
492
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();
498 goto out;
499 }
500 es = WEXITSTATUS(status);
501 if (es == 13) { /* Errors with program diagnostics */
502 DSS_WARNING_LOG("rsync process %d returned %d -- restarting\n",
503 (int)rsync_pid, es);
504 snapshot_creation_status = SCS_RSYNC_NEEDS_RESTART;
505 ret = 1;
506 goto out;
507 }
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();
513 goto out;
514 }
515 ret = rename_incomplete_snapshot(current_snapshot_creation_time);
516 if (ret < 0)
517 goto out;
518 snapshot_creation_status = SCS_RSYNC_SUCCESS;
519 out:
520 rsync_pid = 0;
521 rsync_stopped = 0;
522 return ret;
523 }
524
525 static int handle_pre_create_hook_exit(int status)
526 {
527 int es, ret;
528
529 if (!WIFEXITED(status)) {
530 snapshot_creation_status = SCS_READY;
531 compute_next_snapshot_time();
532 ret = -E_INVOLUNTARY_EXIT;
533 goto out;
534 }
535 es = WEXITSTATUS(status);
536 if (es) {
537 snapshot_creation_status = SCS_READY;
538 compute_next_snapshot_time();
539 ret = -E_BAD_EXIT_CODE;
540 goto out;
541 }
542 snapshot_creation_status = SCS_PRE_HOOK_SUCCESS;
543 ret = 1;
544 out:
545 pre_create_hook_pid = 0;
546 return ret;
547 }
548
549 static int handle_sigchld(void)
550 {
551 pid_t pid;
552 int status, ret = reap_child(&pid, &status);
553
554 if (ret <= 0)
555 return ret;
556 if (pid == rsync_pid)
557 return handle_rsync_exit(status);
558 if (pid == rm_pid)
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();
565 return 1;
566 }
567 DSS_EMERG_LOG("BUG: unknown process %d died\n", (int)pid);
568 return -E_BUG;
569 }
570
571 static int check_config(void)
572 {
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;
576 }
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;
581 }
582 DSS_DEBUG_LOG("number of intervals: %i\n", conf.num_intervals_arg);
583 return 1;
584 }
585
586 static int parse_config_file(int override)
587 {
588 int ret;
589 char *config_file;
590 struct stat statbuf;
591 char *old_logfile_arg = NULL;
592 int old_daemon_given = 0;
593
594 if (conf.config_file_given)
595 config_file = dss_strdup(conf.config_file_arg);
596 else {
597 char *home = get_homedir();
598 config_file = make_message("%s/.dssrc", home);
599 free(home);
600 }
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;
605 }
606
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);
611 goto out;
612 }
613 if (!ret) {
614 struct cmdline_parser_params params = {
615 .override = override,
616 .initialize = 0,
617 .check_required = 1,
618 .check_ambiguity = 0,
619 .print_errors = 1
620 };
621 cmdline_parser_config_file(config_file, &conf, &params);
622 }
623 ret = check_config();
624 if (ret < 0)
625 goto out;
626 if (override) {
627 /* don't change daemon mode on SIGHUP */
628 conf.daemon_given = old_daemon_given;
629 close_log(logfile);
630 logfile = NULL;
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;
636 }
637 }
638 if (conf.logfile_given) {
639 logfile = open_log(conf.logfile_arg);
640 log_welcome(conf.loglevel_arg);
641 }
642 DSS_DEBUG_LOG("loglevel: %d\n", conf.loglevel_arg);
643 // cmdline_parser_dump(logfile? logfile : stdout, &conf);
644 out:
645 free(config_file);
646 if (ret < 0)
647 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
648 return ret;
649 }
650
651 static int change_to_dest_dir(void)
652 {
653 DSS_INFO_LOG("changing cwd to %s\n", conf.dest_dir_arg);
654 return dss_chdir(conf.dest_dir_arg);
655 }
656
657 static int handle_sighup(void)
658 {
659 int ret;
660
661 DSS_NOTICE_LOG("SIGHUP\n");
662 ret = parse_config_file(1);
663 if (ret < 0)
664 return ret;
665 return change_to_dest_dir();
666 }
667
668 static int handle_signal(void)
669 {
670 int sig, ret = next_signal();
671
672 if (ret <= 0)
673 goto out;
674 sig = ret;
675 switch (sig) {
676 case SIGINT:
677 case SIGTERM:
678 restart_rsync_process();
679 kill_process(rsync_pid);
680 kill_process(rm_pid);
681 ret = -E_SIGNAL;
682 break;
683 case SIGHUP:
684 ret = handle_sighup();
685 break;
686 case SIGCHLD:
687 ret = handle_sigchld();
688 break;
689 }
690 out:
691 if (ret < 0)
692 DSS_ERROR_LOG("%s\n", dss_strerror(-ret));
693 return ret;
694 }
695
696 static void create_rsync_argv(char ***argv, int64_t *num)
697 {
698 char *logname, *newest;
699 int i = 0, j;
700 struct snapshot_list sl;
701
702 dss_get_snapshot_list(&sl);
703 newest = name_of_newest_complete_snapshot(&sl);
704 free_snapshot_list(&sl);
705
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]);
712 if (newest) {
713 DSS_INFO_LOG("using %s as reference snapshot\n", newest);
714 (*argv)[i++] = make_message("--link-dest=../%s", newest);
715 free(newest);
716 } else
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);
721 else
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);
725 free(logname);
726 *num = get_current_time();
727 (*argv)[i++] = incomplete_name(*num);
728 (*argv)[i++] = NULL;
729 for (j = 0; j < i; j++)
730 DSS_DEBUG_LOG("argv[%d] = %s\n", j, (*argv)[j]);
731 }
732
733 static void free_rsync_argv(char **argv)
734 {
735 int i;
736
737 if (!argv)
738 return;
739 for (i = 0; argv[i]; i++)
740 free(argv[i]);
741 free(argv);
742 }
743
744 static int create_snapshot(char **argv)
745 {
746 int ret, fds[3] = {0, 0, 0};
747 char *name;
748
749 name = incomplete_name(current_snapshot_creation_time);
750 DSS_NOTICE_LOG("creating new snapshot %s\n", name);
751 free(name);
752 ret = dss_exec(&rsync_pid, argv[0], argv, fds);
753 if (ret < 0)
754 return ret;
755 snapshot_creation_status = SCS_RSYNC_RUNNING;
756 return ret;
757 }
758
759 static int select_loop(void)
760 {
761 int ret;
762 /* check every 60 seconds for free disk space */
763 struct timeval tv;
764 char **rsync_argv = NULL;
765
766 for (;;) {
767 fd_set rfds;
768 int low_disk_space;
769 struct timeval now, *tvp;
770
771 if (rm_pid)
772 tvp = NULL; /* sleep until rm process dies */
773 else { /* sleep one minute */
774 tv.tv_sec = 60;
775 tv.tv_usec = 0;
776 tvp = &tv;
777 }
778 FD_ZERO(&rfds);
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);
782 if (ret < 0)
783 goto out;
784 if (FD_ISSET(signal_pipe, &rfds)) {
785 ret = handle_signal();
786 if (ret < 0)
787 goto out;
788 }
789 if (rm_pid)
790 continue;
791 ret = disk_space_low();
792 if (ret < 0)
793 goto out;
794 low_disk_space = ret;
795 ret = try_to_free_disk_space(low_disk_space);
796 if (ret < 0)
797 goto out;
798 if (rm_pid) {
799 stop_rsync_process();
800 continue;
801 }
802 restart_rsync_process();
803 gettimeofday(&now, NULL);
804 if (tv_diff(&next_snapshot_time, &now, NULL) > 0)
805 continue;
806 switch (snapshot_creation_status) {
807 case SCS_READY:
808 ret = pre_create_hook();
809 if (ret < 0)
810 goto out;
811 continue;
812 case SCS_PRE_HOOK_RUNNING:
813 continue;
814 case SCS_RSYNC_NEEDS_RESTART:
815 ret = create_snapshot(rsync_argv);
816 if (ret < 0)
817 goto out;
818 continue;
819 case SCS_PRE_HOOK_SUCCESS:
820 free_rsync_argv(rsync_argv);
821 create_rsync_argv(&rsync_argv, &current_snapshot_creation_time);
822 ret = create_snapshot(rsync_argv);
823 if (ret < 0)
824 goto out;
825 continue;
826 case SCS_RSYNC_RUNNING:
827 continue;
828 case SCS_RSYNC_SUCCESS:
829 ret = post_create_hook();
830 if (ret < 0)
831 goto out;
832 continue;
833 case SCS_POST_HOOK_RUNNING:
834 continue;
835 }
836 }
837 out:
838 return ret;
839 }
840
841 static void exit_hook(int exit_code)
842 {
843 int fds[3] = {0, 0, 0};
844 char *argv[] = {conf.exit_hook_arg, dss_strerror(-exit_code), NULL};
845 pid_t pid;
846
847 if (!conf.exit_hook_given)
848 return;
849 DSS_NOTICE_LOG("executing %s %s\n", argv[0], argv[1]);
850 dss_exec(&pid, conf.exit_hook_arg, argv, fds);
851 }
852
853 static int com_run(void)
854 {
855 int ret;
856
857 if (conf.dry_run_given) {
858 DSS_ERROR_LOG("dry_run not supported by this command\n");
859 return -E_SYNTAX;
860 }
861 ret = install_sighandler(SIGHUP);
862 if (ret < 0)
863 return ret;
864 compute_next_snapshot_time();
865 ret = select_loop();
866 if (ret >= 0) /* impossible */
867 ret = -E_BUG;
868 exit_hook(ret);
869 return ret;
870 }
871
872 static int com_prune(void)
873 {
874 int ret;
875 struct snapshot_list sl;
876 struct disk_space ds;
877
878 ret = get_disk_space(".", &ds);
879 if (ret < 0)
880 return ret;
881 log_disk_space(&ds);
882 for (;;) {
883 dss_get_snapshot_list(&sl);
884 ret = remove_outdated_snapshot(&sl);
885 free_snapshot_list(&sl);
886 if (ret < 0)
887 return ret;
888 if (!ret)
889 break;
890 ret = wait_for_rm_process();
891 if (ret < 0)
892 goto out;
893 }
894 for (;;) {
895 dss_get_snapshot_list(&sl);
896 ret = remove_redundant_snapshot(&sl);
897 free_snapshot_list(&sl);
898 if (ret < 0)
899 return ret;
900 if (!ret)
901 break;
902 ret = wait_for_rm_process();
903 if (ret < 0)
904 goto out;
905 }
906 return 1;
907 out:
908 return ret;
909 }
910
911 static int com_create(void)
912 {
913 int ret, status;
914 char **rsync_argv;
915
916 if (conf.dry_run_given) {
917 int i;
918 char *msg = NULL;
919 create_rsync_argv(&rsync_argv, &current_snapshot_creation_time);
920 for (i = 0; rsync_argv[i]; i++) {
921 char *tmp = msg;
922 msg = make_message("%s%s%s", tmp? tmp : "",
923 tmp? " " : "", rsync_argv[i]);
924 free(tmp);
925 }
926 free_rsync_argv(rsync_argv);
927 dss_msg("%s\n", msg);
928 free(msg);
929 return 1;
930 }
931 ret = pre_create_hook();
932 if (ret < 0)
933 return ret;
934 if (pre_create_hook_pid) {
935 ret = wait_for_process(pre_create_hook_pid, &status);
936 if (ret < 0)
937 return ret;
938 ret = handle_pre_create_hook_exit(status);
939 if (ret < 0)
940 return ret;
941 }
942 create_rsync_argv(&rsync_argv, &current_snapshot_creation_time);
943 ret = create_snapshot(rsync_argv);
944 if (ret < 0)
945 goto out;
946 ret = wait_for_process(rsync_pid, &status);
947 if (ret < 0)
948 goto out;
949 ret = handle_rsync_exit(status);
950 if (ret < 0)
951 goto out;
952 post_create_hook();
953 if (post_create_hook_pid)
954 ret = wait_for_process(post_create_hook_pid, &status);
955 out:
956 free_rsync_argv(rsync_argv);
957 return ret;
958 }
959
960 static int com_ls(void)
961 {
962 int i;
963 struct snapshot_list sl;
964 struct snapshot *s;
965
966 dss_get_snapshot_list(&sl);
967 FOR_EACH_SNAPSHOT(s, i, &sl) {
968 int64_t d = 0;
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);
972 };
973 free_snapshot_list(&sl);
974 return 1;
975 }
976
977 static int setup_signal_handling(void)
978 {
979 int ret;
980
981 DSS_INFO_LOG("setting up signal handlers\n");
982 signal_pipe = signal_init(); /* always successful */
983 ret = install_sighandler(SIGINT);
984 if (ret < 0)
985 return ret;
986 ret = install_sighandler(SIGTERM);
987 if (ret < 0)
988 return ret;
989 return install_sighandler(SIGCHLD);
990 }
991
992 /**
993 * The main function of dss.
994 *
995 * \param argc Usual argument count.
996 * \param argv Usual argument vector.
997 */
998 int main(int argc, char **argv)
999 {
1000 int ret;
1001 struct cmdline_parser_params params = {
1002 .override = 0,
1003 .initialize = 1,
1004 .check_required = 0,
1005 .check_ambiguity = 0,
1006 .print_errors = 1
1007 };
1008
1009 cmdline_parser_ext(argc, argv, &conf, &params); /* aborts on errors */
1010 ret = parse_config_file(0);
1011 if (ret < 0)
1012 goto out;
1013 if (conf.daemon_given)
1014 daemon_init();
1015 ret = change_to_dest_dir();
1016 if (ret < 0)
1017 goto out;
1018 ret = setup_signal_handling();
1019 if (ret < 0)
1020 goto out;
1021 ret = call_command_handler();
1022 out:
1023 if (ret < 0)
1024 DSS_EMERG_LOG("%s\n", dss_strerror(-ret));
1025 exit(ret >= 0? EXIT_SUCCESS : EXIT_FAILURE);
1026 }