Merge branch 'rs/diff-parseopts-cleanup'
[git/gitster.git] / builtin / gc.c
blobd3b5ca9bb145026357b59f6faab52fc7348fd404
1 /*
2 * git gc builtin command
4 * Cleanup unreachable files and optimize the repository.
6 * Copyright (c) 2007 James Bowes
8 * Based on git-gc.sh, which is
10 * Copyright (c) 2006 Shawn O. Pearce
13 #include "builtin.h"
14 #include "abspath.h"
15 #include "date.h"
16 #include "environment.h"
17 #include "hex.h"
18 #include "repository.h"
19 #include "config.h"
20 #include "tempfile.h"
21 #include "lockfile.h"
22 #include "parse-options.h"
23 #include "run-command.h"
24 #include "sigchain.h"
25 #include "strvec.h"
26 #include "commit.h"
27 #include "commit-graph.h"
28 #include "packfile.h"
29 #include "object-file.h"
30 #include "object-store-ll.h"
31 #include "pack.h"
32 #include "pack-objects.h"
33 #include "path.h"
34 #include "blob.h"
35 #include "tree.h"
36 #include "promisor-remote.h"
37 #include "refs.h"
38 #include "remote.h"
39 #include "exec-cmd.h"
40 #include "gettext.h"
41 #include "hook.h"
42 #include "setup.h"
43 #include "trace2.h"
45 #define FAILED_RUN "failed to run %s"
47 static const char * const builtin_gc_usage[] = {
48 N_("git gc [<options>]"),
49 NULL
52 static int pack_refs = 1;
53 static int prune_reflogs = 1;
54 static int cruft_packs = 1;
55 static unsigned long max_cruft_size;
56 static int aggressive_depth = 50;
57 static int aggressive_window = 250;
58 static int gc_auto_threshold = 6700;
59 static int gc_auto_pack_limit = 50;
60 static int detach_auto = 1;
61 static timestamp_t gc_log_expire_time;
62 static const char *gc_log_expire = "1.day.ago";
63 static const char *prune_expire = "2.weeks.ago";
64 static const char *prune_worktrees_expire = "3.months.ago";
65 static char *repack_filter;
66 static char *repack_filter_to;
67 static unsigned long big_pack_threshold;
68 static unsigned long max_delta_cache_size = DEFAULT_DELTA_CACHE_SIZE;
70 static struct strvec reflog = STRVEC_INIT;
71 static struct strvec repack = STRVEC_INIT;
72 static struct strvec prune = STRVEC_INIT;
73 static struct strvec prune_worktrees = STRVEC_INIT;
74 static struct strvec rerere = STRVEC_INIT;
76 static struct tempfile *pidfile;
77 static struct lock_file log_lock;
79 static struct string_list pack_garbage = STRING_LIST_INIT_DUP;
81 static void clean_pack_garbage(void)
83 int i;
84 for (i = 0; i < pack_garbage.nr; i++)
85 unlink_or_warn(pack_garbage.items[i].string);
86 string_list_clear(&pack_garbage, 0);
89 static void report_pack_garbage(unsigned seen_bits, const char *path)
91 if (seen_bits == PACKDIR_FILE_IDX)
92 string_list_append(&pack_garbage, path);
95 static void process_log_file(void)
97 struct stat st;
98 if (fstat(get_lock_file_fd(&log_lock), &st)) {
100 * Perhaps there was an i/o error or another
101 * unlikely situation. Try to make a note of
102 * this in gc.log along with any existing
103 * messages.
105 int saved_errno = errno;
106 fprintf(stderr, _("Failed to fstat %s: %s"),
107 get_lock_file_path(&log_lock),
108 strerror(saved_errno));
109 fflush(stderr);
110 commit_lock_file(&log_lock);
111 errno = saved_errno;
112 } else if (st.st_size) {
113 /* There was some error recorded in the lock file */
114 commit_lock_file(&log_lock);
115 } else {
116 /* No error, clean up any old gc.log */
117 unlink(git_path("gc.log"));
118 rollback_lock_file(&log_lock);
122 static void process_log_file_at_exit(void)
124 fflush(stderr);
125 process_log_file();
128 static void process_log_file_on_signal(int signo)
130 process_log_file();
131 sigchain_pop(signo);
132 raise(signo);
135 static int gc_config_is_timestamp_never(const char *var)
137 const char *value;
138 timestamp_t expire;
140 if (!git_config_get_value(var, &value) && value) {
141 if (parse_expiry_date(value, &expire))
142 die(_("failed to parse '%s' value '%s'"), var, value);
143 return expire == 0;
145 return 0;
148 static void gc_config(void)
150 const char *value;
152 if (!git_config_get_value("gc.packrefs", &value)) {
153 if (value && !strcmp(value, "notbare"))
154 pack_refs = -1;
155 else
156 pack_refs = git_config_bool("gc.packrefs", value);
159 if (gc_config_is_timestamp_never("gc.reflogexpire") &&
160 gc_config_is_timestamp_never("gc.reflogexpireunreachable"))
161 prune_reflogs = 0;
163 git_config_get_int("gc.aggressivewindow", &aggressive_window);
164 git_config_get_int("gc.aggressivedepth", &aggressive_depth);
165 git_config_get_int("gc.auto", &gc_auto_threshold);
166 git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit);
167 git_config_get_bool("gc.autodetach", &detach_auto);
168 git_config_get_bool("gc.cruftpacks", &cruft_packs);
169 git_config_get_ulong("gc.maxcruftsize", &max_cruft_size);
170 git_config_get_expiry("gc.pruneexpire", &prune_expire);
171 git_config_get_expiry("gc.worktreepruneexpire", &prune_worktrees_expire);
172 git_config_get_expiry("gc.logexpiry", &gc_log_expire);
174 git_config_get_ulong("gc.bigpackthreshold", &big_pack_threshold);
175 git_config_get_ulong("pack.deltacachesize", &max_delta_cache_size);
177 git_config_get_string("gc.repackfilter", &repack_filter);
178 git_config_get_string("gc.repackfilterto", &repack_filter_to);
180 git_config(git_default_config, NULL);
183 enum schedule_priority {
184 SCHEDULE_NONE = 0,
185 SCHEDULE_WEEKLY = 1,
186 SCHEDULE_DAILY = 2,
187 SCHEDULE_HOURLY = 3,
190 static enum schedule_priority parse_schedule(const char *value)
192 if (!value)
193 return SCHEDULE_NONE;
194 if (!strcasecmp(value, "hourly"))
195 return SCHEDULE_HOURLY;
196 if (!strcasecmp(value, "daily"))
197 return SCHEDULE_DAILY;
198 if (!strcasecmp(value, "weekly"))
199 return SCHEDULE_WEEKLY;
200 return SCHEDULE_NONE;
203 struct maintenance_run_opts {
204 int auto_flag;
205 int quiet;
206 enum schedule_priority schedule;
209 static int pack_refs_condition(void)
212 * The auto-repacking logic for refs is handled by the ref backends and
213 * exposed via `git pack-refs --auto`. We thus always return truish
214 * here and let the backend decide for us.
216 return 1;
219 static int maintenance_task_pack_refs(MAYBE_UNUSED struct maintenance_run_opts *opts)
221 struct child_process cmd = CHILD_PROCESS_INIT;
223 cmd.git_cmd = 1;
224 strvec_pushl(&cmd.args, "pack-refs", "--all", "--prune", NULL);
225 if (opts->auto_flag)
226 strvec_push(&cmd.args, "--auto");
228 return run_command(&cmd);
231 static int too_many_loose_objects(void)
234 * Quickly check if a "gc" is needed, by estimating how
235 * many loose objects there are. Because SHA-1 is evenly
236 * distributed, we can check only one and get a reasonable
237 * estimate.
239 DIR *dir;
240 struct dirent *ent;
241 int auto_threshold;
242 int num_loose = 0;
243 int needed = 0;
244 const unsigned hexsz_loose = the_hash_algo->hexsz - 2;
246 dir = opendir(git_path("objects/17"));
247 if (!dir)
248 return 0;
250 auto_threshold = DIV_ROUND_UP(gc_auto_threshold, 256);
251 while ((ent = readdir(dir)) != NULL) {
252 if (strspn(ent->d_name, "0123456789abcdef") != hexsz_loose ||
253 ent->d_name[hexsz_loose] != '\0')
254 continue;
255 if (++num_loose > auto_threshold) {
256 needed = 1;
257 break;
260 closedir(dir);
261 return needed;
264 static struct packed_git *find_base_packs(struct string_list *packs,
265 unsigned long limit)
267 struct packed_git *p, *base = NULL;
269 for (p = get_all_packs(the_repository); p; p = p->next) {
270 if (!p->pack_local || p->is_cruft)
271 continue;
272 if (limit) {
273 if (p->pack_size >= limit)
274 string_list_append(packs, p->pack_name);
275 } else if (!base || base->pack_size < p->pack_size) {
276 base = p;
280 if (base)
281 string_list_append(packs, base->pack_name);
283 return base;
286 static int too_many_packs(void)
288 struct packed_git *p;
289 int cnt;
291 if (gc_auto_pack_limit <= 0)
292 return 0;
294 for (cnt = 0, p = get_all_packs(the_repository); p; p = p->next) {
295 if (!p->pack_local)
296 continue;
297 if (p->pack_keep)
298 continue;
300 * Perhaps check the size of the pack and count only
301 * very small ones here?
303 cnt++;
305 return gc_auto_pack_limit < cnt;
308 static uint64_t total_ram(void)
310 #if defined(HAVE_SYSINFO)
311 struct sysinfo si;
313 if (!sysinfo(&si))
314 return si.totalram;
315 #elif defined(HAVE_BSD_SYSCTL) && (defined(HW_MEMSIZE) || defined(HW_PHYSMEM))
316 int64_t physical_memory;
317 int mib[2];
318 size_t length;
320 mib[0] = CTL_HW;
321 # if defined(HW_MEMSIZE)
322 mib[1] = HW_MEMSIZE;
323 # else
324 mib[1] = HW_PHYSMEM;
325 # endif
326 length = sizeof(int64_t);
327 if (!sysctl(mib, 2, &physical_memory, &length, NULL, 0))
328 return physical_memory;
329 #elif defined(GIT_WINDOWS_NATIVE)
330 MEMORYSTATUSEX memInfo;
332 memInfo.dwLength = sizeof(MEMORYSTATUSEX);
333 if (GlobalMemoryStatusEx(&memInfo))
334 return memInfo.ullTotalPhys;
335 #endif
336 return 0;
339 static uint64_t estimate_repack_memory(struct packed_git *pack)
341 unsigned long nr_objects = repo_approximate_object_count(the_repository);
342 size_t os_cache, heap;
344 if (!pack || !nr_objects)
345 return 0;
348 * First we have to scan through at least one pack.
349 * Assume enough room in OS file cache to keep the entire pack
350 * or we may accidentally evict data of other processes from
351 * the cache.
353 os_cache = pack->pack_size + pack->index_size;
354 /* then pack-objects needs lots more for book keeping */
355 heap = sizeof(struct object_entry) * nr_objects;
357 * internal rev-list --all --objects takes up some memory too,
358 * let's say half of it is for blobs
360 heap += sizeof(struct blob) * nr_objects / 2;
362 * and the other half is for trees (commits and tags are
363 * usually insignificant)
365 heap += sizeof(struct tree) * nr_objects / 2;
366 /* and then obj_hash[], underestimated in fact */
367 heap += sizeof(struct object *) * nr_objects;
368 /* revindex is used also */
369 heap += (sizeof(off_t) + sizeof(uint32_t)) * nr_objects;
371 * read_sha1_file() (either at delta calculation phase, or
372 * writing phase) also fills up the delta base cache
374 heap += delta_base_cache_limit;
375 /* and of course pack-objects has its own delta cache */
376 heap += max_delta_cache_size;
378 return os_cache + heap;
381 static int keep_one_pack(struct string_list_item *item, void *data UNUSED)
383 strvec_pushf(&repack, "--keep-pack=%s", basename(item->string));
384 return 0;
387 static void add_repack_all_option(struct string_list *keep_pack)
389 if (prune_expire && !strcmp(prune_expire, "now"))
390 strvec_push(&repack, "-a");
391 else if (cruft_packs) {
392 strvec_push(&repack, "--cruft");
393 if (prune_expire)
394 strvec_pushf(&repack, "--cruft-expiration=%s", prune_expire);
395 if (max_cruft_size)
396 strvec_pushf(&repack, "--max-cruft-size=%lu",
397 max_cruft_size);
398 } else {
399 strvec_push(&repack, "-A");
400 if (prune_expire)
401 strvec_pushf(&repack, "--unpack-unreachable=%s", prune_expire);
404 if (keep_pack)
405 for_each_string_list(keep_pack, keep_one_pack, NULL);
407 if (repack_filter && *repack_filter)
408 strvec_pushf(&repack, "--filter=%s", repack_filter);
409 if (repack_filter_to && *repack_filter_to)
410 strvec_pushf(&repack, "--filter-to=%s", repack_filter_to);
413 static void add_repack_incremental_option(void)
415 strvec_push(&repack, "--no-write-bitmap-index");
418 static int need_to_gc(void)
421 * Setting gc.auto to 0 or negative can disable the
422 * automatic gc.
424 if (gc_auto_threshold <= 0)
425 return 0;
428 * If there are too many loose objects, but not too many
429 * packs, we run "repack -d -l". If there are too many packs,
430 * we run "repack -A -d -l". Otherwise we tell the caller
431 * there is no need.
433 if (too_many_packs()) {
434 struct string_list keep_pack = STRING_LIST_INIT_NODUP;
436 if (big_pack_threshold) {
437 find_base_packs(&keep_pack, big_pack_threshold);
438 if (keep_pack.nr >= gc_auto_pack_limit) {
439 big_pack_threshold = 0;
440 string_list_clear(&keep_pack, 0);
441 find_base_packs(&keep_pack, 0);
443 } else {
444 struct packed_git *p = find_base_packs(&keep_pack, 0);
445 uint64_t mem_have, mem_want;
447 mem_have = total_ram();
448 mem_want = estimate_repack_memory(p);
451 * Only allow 1/2 of memory for pack-objects, leave
452 * the rest for the OS and other processes in the
453 * system.
455 if (!mem_have || mem_want < mem_have / 2)
456 string_list_clear(&keep_pack, 0);
459 add_repack_all_option(&keep_pack);
460 string_list_clear(&keep_pack, 0);
461 } else if (too_many_loose_objects())
462 add_repack_incremental_option();
463 else
464 return 0;
466 if (run_hooks("pre-auto-gc"))
467 return 0;
468 return 1;
471 /* return NULL on success, else hostname running the gc */
472 static const char *lock_repo_for_gc(int force, pid_t* ret_pid)
474 struct lock_file lock = LOCK_INIT;
475 char my_host[HOST_NAME_MAX + 1];
476 struct strbuf sb = STRBUF_INIT;
477 struct stat st;
478 uintmax_t pid;
479 FILE *fp;
480 int fd;
481 char *pidfile_path;
483 if (is_tempfile_active(pidfile))
484 /* already locked */
485 return NULL;
487 if (xgethostname(my_host, sizeof(my_host)))
488 xsnprintf(my_host, sizeof(my_host), "unknown");
490 pidfile_path = git_pathdup("gc.pid");
491 fd = hold_lock_file_for_update(&lock, pidfile_path,
492 LOCK_DIE_ON_ERROR);
493 if (!force) {
494 static char locking_host[HOST_NAME_MAX + 1];
495 static char *scan_fmt;
496 int should_exit;
498 if (!scan_fmt)
499 scan_fmt = xstrfmt("%s %%%ds", "%"SCNuMAX, HOST_NAME_MAX);
500 fp = fopen(pidfile_path, "r");
501 memset(locking_host, 0, sizeof(locking_host));
502 should_exit =
503 fp != NULL &&
504 !fstat(fileno(fp), &st) &&
506 * 12 hour limit is very generous as gc should
507 * never take that long. On the other hand we
508 * don't really need a strict limit here,
509 * running gc --auto one day late is not a big
510 * problem. --force can be used in manual gc
511 * after the user verifies that no gc is
512 * running.
514 time(NULL) - st.st_mtime <= 12 * 3600 &&
515 fscanf(fp, scan_fmt, &pid, locking_host) == 2 &&
516 /* be gentle to concurrent "gc" on remote hosts */
517 (strcmp(locking_host, my_host) || !kill(pid, 0) || errno == EPERM);
518 if (fp)
519 fclose(fp);
520 if (should_exit) {
521 if (fd >= 0)
522 rollback_lock_file(&lock);
523 *ret_pid = pid;
524 free(pidfile_path);
525 return locking_host;
529 strbuf_addf(&sb, "%"PRIuMAX" %s",
530 (uintmax_t) getpid(), my_host);
531 write_in_full(fd, sb.buf, sb.len);
532 strbuf_release(&sb);
533 commit_lock_file(&lock);
534 pidfile = register_tempfile(pidfile_path);
535 free(pidfile_path);
536 return NULL;
540 * Returns 0 if there was no previous error and gc can proceed, 1 if
541 * gc should not proceed due to an error in the last run. Prints a
542 * message and returns with a non-[01] status code if an error occurred
543 * while reading gc.log
545 static int report_last_gc_error(void)
547 struct strbuf sb = STRBUF_INIT;
548 int ret = 0;
549 ssize_t len;
550 struct stat st;
551 char *gc_log_path = git_pathdup("gc.log");
553 if (stat(gc_log_path, &st)) {
554 if (errno == ENOENT)
555 goto done;
557 ret = die_message_errno(_("cannot stat '%s'"), gc_log_path);
558 goto done;
561 if (st.st_mtime < gc_log_expire_time)
562 goto done;
564 len = strbuf_read_file(&sb, gc_log_path, 0);
565 if (len < 0)
566 ret = die_message_errno(_("cannot read '%s'"), gc_log_path);
567 else if (len > 0) {
569 * A previous gc failed. Report the error, and don't
570 * bother with an automatic gc run since it is likely
571 * to fail in the same way.
573 warning(_("The last gc run reported the following. "
574 "Please correct the root cause\n"
575 "and remove %s\n"
576 "Automatic cleanup will not be performed "
577 "until the file is removed.\n\n"
578 "%s"),
579 gc_log_path, sb.buf);
580 ret = 1;
582 strbuf_release(&sb);
583 done:
584 free(gc_log_path);
585 return ret;
588 static void gc_before_repack(struct maintenance_run_opts *opts)
591 * We may be called twice, as both the pre- and
592 * post-daemonized phases will call us, but running these
593 * commands more than once is pointless and wasteful.
595 static int done = 0;
596 if (done++)
597 return;
599 if (pack_refs && maintenance_task_pack_refs(opts))
600 die(FAILED_RUN, "pack-refs");
602 if (prune_reflogs) {
603 struct child_process cmd = CHILD_PROCESS_INIT;
605 cmd.git_cmd = 1;
606 strvec_pushv(&cmd.args, reflog.v);
607 if (run_command(&cmd))
608 die(FAILED_RUN, reflog.v[0]);
612 int cmd_gc(int argc, const char **argv, const char *prefix)
614 int aggressive = 0;
615 int quiet = 0;
616 int force = 0;
617 const char *name;
618 pid_t pid;
619 int daemonized = 0;
620 int keep_largest_pack = -1;
621 timestamp_t dummy;
622 struct child_process rerere_cmd = CHILD_PROCESS_INIT;
623 struct maintenance_run_opts opts = {0};
625 struct option builtin_gc_options[] = {
626 OPT__QUIET(&quiet, N_("suppress progress reporting")),
627 { OPTION_STRING, 0, "prune", &prune_expire, N_("date"),
628 N_("prune unreferenced objects"),
629 PARSE_OPT_OPTARG, NULL, (intptr_t)prune_expire },
630 OPT_BOOL(0, "cruft", &cruft_packs, N_("pack unreferenced objects separately")),
631 OPT_MAGNITUDE(0, "max-cruft-size", &max_cruft_size,
632 N_("with --cruft, limit the size of new cruft packs")),
633 OPT_BOOL(0, "aggressive", &aggressive, N_("be more thorough (increased runtime)")),
634 OPT_BOOL_F(0, "auto", &opts.auto_flag, N_("enable auto-gc mode"),
635 PARSE_OPT_NOCOMPLETE),
636 OPT_BOOL_F(0, "force", &force,
637 N_("force running gc even if there may be another gc running"),
638 PARSE_OPT_NOCOMPLETE),
639 OPT_BOOL(0, "keep-largest-pack", &keep_largest_pack,
640 N_("repack all other packs except the largest pack")),
641 OPT_END()
644 if (argc == 2 && !strcmp(argv[1], "-h"))
645 usage_with_options(builtin_gc_usage, builtin_gc_options);
647 strvec_pushl(&reflog, "reflog", "expire", "--all", NULL);
648 strvec_pushl(&repack, "repack", "-d", "-l", NULL);
649 strvec_pushl(&prune, "prune", "--expire", NULL);
650 strvec_pushl(&prune_worktrees, "worktree", "prune", "--expire", NULL);
651 strvec_pushl(&rerere, "rerere", "gc", NULL);
653 /* default expiry time, overwritten in gc_config */
654 gc_config();
655 if (parse_expiry_date(gc_log_expire, &gc_log_expire_time))
656 die(_("failed to parse gc.logExpiry value %s"), gc_log_expire);
658 if (pack_refs < 0)
659 pack_refs = !is_bare_repository();
661 argc = parse_options(argc, argv, prefix, builtin_gc_options,
662 builtin_gc_usage, 0);
663 if (argc > 0)
664 usage_with_options(builtin_gc_usage, builtin_gc_options);
666 if (prune_expire && parse_expiry_date(prune_expire, &dummy))
667 die(_("failed to parse prune expiry value %s"), prune_expire);
669 if (aggressive) {
670 strvec_push(&repack, "-f");
671 if (aggressive_depth > 0)
672 strvec_pushf(&repack, "--depth=%d", aggressive_depth);
673 if (aggressive_window > 0)
674 strvec_pushf(&repack, "--window=%d", aggressive_window);
676 if (quiet)
677 strvec_push(&repack, "-q");
679 if (opts.auto_flag) {
681 * Auto-gc should be least intrusive as possible.
683 if (!need_to_gc())
684 return 0;
685 if (!quiet) {
686 if (detach_auto)
687 fprintf(stderr, _("Auto packing the repository in background for optimum performance.\n"));
688 else
689 fprintf(stderr, _("Auto packing the repository for optimum performance.\n"));
690 fprintf(stderr, _("See \"git help gc\" for manual housekeeping.\n"));
692 if (detach_auto) {
693 int ret = report_last_gc_error();
695 if (ret == 1)
696 /* Last gc --auto failed. Skip this one. */
697 return 0;
698 else if (ret)
699 /* an I/O error occurred, already reported */
700 return ret;
702 if (lock_repo_for_gc(force, &pid))
703 return 0;
704 gc_before_repack(&opts); /* dies on failure */
705 delete_tempfile(&pidfile);
708 * failure to daemonize is ok, we'll continue
709 * in foreground
711 daemonized = !daemonize();
713 } else {
714 struct string_list keep_pack = STRING_LIST_INIT_NODUP;
716 if (keep_largest_pack != -1) {
717 if (keep_largest_pack)
718 find_base_packs(&keep_pack, 0);
719 } else if (big_pack_threshold) {
720 find_base_packs(&keep_pack, big_pack_threshold);
723 add_repack_all_option(&keep_pack);
724 string_list_clear(&keep_pack, 0);
727 name = lock_repo_for_gc(force, &pid);
728 if (name) {
729 if (opts.auto_flag)
730 return 0; /* be quiet on --auto */
731 die(_("gc is already running on machine '%s' pid %"PRIuMAX" (use --force if not)"),
732 name, (uintmax_t)pid);
735 if (daemonized) {
736 hold_lock_file_for_update(&log_lock,
737 git_path("gc.log"),
738 LOCK_DIE_ON_ERROR);
739 dup2(get_lock_file_fd(&log_lock), 2);
740 sigchain_push_common(process_log_file_on_signal);
741 atexit(process_log_file_at_exit);
744 gc_before_repack(&opts);
746 if (!repository_format_precious_objects) {
747 struct child_process repack_cmd = CHILD_PROCESS_INIT;
749 repack_cmd.git_cmd = 1;
750 repack_cmd.close_object_store = 1;
751 strvec_pushv(&repack_cmd.args, repack.v);
752 if (run_command(&repack_cmd))
753 die(FAILED_RUN, repack.v[0]);
755 if (prune_expire) {
756 struct child_process prune_cmd = CHILD_PROCESS_INIT;
758 /* run `git prune` even if using cruft packs */
759 strvec_push(&prune, prune_expire);
760 if (quiet)
761 strvec_push(&prune, "--no-progress");
762 if (repo_has_promisor_remote(the_repository))
763 strvec_push(&prune,
764 "--exclude-promisor-objects");
765 prune_cmd.git_cmd = 1;
766 strvec_pushv(&prune_cmd.args, prune.v);
767 if (run_command(&prune_cmd))
768 die(FAILED_RUN, prune.v[0]);
772 if (prune_worktrees_expire) {
773 struct child_process prune_worktrees_cmd = CHILD_PROCESS_INIT;
775 strvec_push(&prune_worktrees, prune_worktrees_expire);
776 prune_worktrees_cmd.git_cmd = 1;
777 strvec_pushv(&prune_worktrees_cmd.args, prune_worktrees.v);
778 if (run_command(&prune_worktrees_cmd))
779 die(FAILED_RUN, prune_worktrees.v[0]);
782 rerere_cmd.git_cmd = 1;
783 strvec_pushv(&rerere_cmd.args, rerere.v);
784 if (run_command(&rerere_cmd))
785 die(FAILED_RUN, rerere.v[0]);
787 report_garbage = report_pack_garbage;
788 reprepare_packed_git(the_repository);
789 if (pack_garbage.nr > 0) {
790 close_object_store(the_repository->objects);
791 clean_pack_garbage();
794 if (the_repository->settings.gc_write_commit_graph == 1)
795 write_commit_graph_reachable(the_repository->objects->odb,
796 !quiet && !daemonized ? COMMIT_GRAPH_WRITE_PROGRESS : 0,
797 NULL);
799 if (opts.auto_flag && too_many_loose_objects())
800 warning(_("There are too many unreachable loose objects; "
801 "run 'git prune' to remove them."));
803 if (!daemonized)
804 unlink(git_path("gc.log"));
806 return 0;
809 static const char *const builtin_maintenance_run_usage[] = {
810 N_("git maintenance run [--auto] [--[no-]quiet] [--task=<task>] [--schedule]"),
811 NULL
814 static int maintenance_opt_schedule(const struct option *opt, const char *arg,
815 int unset)
817 enum schedule_priority *priority = opt->value;
819 if (unset)
820 die(_("--no-schedule is not allowed"));
822 *priority = parse_schedule(arg);
824 if (!*priority)
825 die(_("unrecognized --schedule argument '%s'"), arg);
827 return 0;
830 /* Remember to update object flag allocation in object.h */
831 #define SEEN (1u<<0)
833 struct cg_auto_data {
834 int num_not_in_graph;
835 int limit;
838 static int dfs_on_ref(const char *refname UNUSED,
839 const struct object_id *oid,
840 int flags UNUSED,
841 void *cb_data)
843 struct cg_auto_data *data = (struct cg_auto_data *)cb_data;
844 int result = 0;
845 struct object_id peeled;
846 struct commit_list *stack = NULL;
847 struct commit *commit;
849 if (!peel_iterated_oid(oid, &peeled))
850 oid = &peeled;
851 if (oid_object_info(the_repository, oid, NULL) != OBJ_COMMIT)
852 return 0;
854 commit = lookup_commit(the_repository, oid);
855 if (!commit)
856 return 0;
857 if (repo_parse_commit(the_repository, commit) ||
858 commit_graph_position(commit) != COMMIT_NOT_FROM_GRAPH)
859 return 0;
861 data->num_not_in_graph++;
863 if (data->num_not_in_graph >= data->limit)
864 return 1;
866 commit_list_append(commit, &stack);
868 while (!result && stack) {
869 struct commit_list *parent;
871 commit = pop_commit(&stack);
873 for (parent = commit->parents; parent; parent = parent->next) {
874 if (repo_parse_commit(the_repository, parent->item) ||
875 commit_graph_position(parent->item) != COMMIT_NOT_FROM_GRAPH ||
876 parent->item->object.flags & SEEN)
877 continue;
879 parent->item->object.flags |= SEEN;
880 data->num_not_in_graph++;
882 if (data->num_not_in_graph >= data->limit) {
883 result = 1;
884 break;
887 commit_list_append(parent->item, &stack);
891 free_commit_list(stack);
892 return result;
895 static int should_write_commit_graph(void)
897 int result;
898 struct cg_auto_data data;
900 data.num_not_in_graph = 0;
901 data.limit = 100;
902 git_config_get_int("maintenance.commit-graph.auto",
903 &data.limit);
905 if (!data.limit)
906 return 0;
907 if (data.limit < 0)
908 return 1;
910 result = for_each_ref(dfs_on_ref, &data);
912 repo_clear_commit_marks(the_repository, SEEN);
914 return result;
917 static int run_write_commit_graph(struct maintenance_run_opts *opts)
919 struct child_process child = CHILD_PROCESS_INIT;
921 child.git_cmd = child.close_object_store = 1;
922 strvec_pushl(&child.args, "commit-graph", "write",
923 "--split", "--reachable", NULL);
925 if (opts->quiet)
926 strvec_push(&child.args, "--no-progress");
928 return !!run_command(&child);
931 static int maintenance_task_commit_graph(struct maintenance_run_opts *opts)
933 prepare_repo_settings(the_repository);
934 if (!the_repository->settings.core_commit_graph)
935 return 0;
937 if (run_write_commit_graph(opts)) {
938 error(_("failed to write commit-graph"));
939 return 1;
942 return 0;
945 static int fetch_remote(struct remote *remote, void *cbdata)
947 struct maintenance_run_opts *opts = cbdata;
948 struct child_process child = CHILD_PROCESS_INIT;
950 if (remote->skip_default_update)
951 return 0;
953 child.git_cmd = 1;
954 strvec_pushl(&child.args, "fetch", remote->name,
955 "--prefetch", "--prune", "--no-tags",
956 "--no-write-fetch-head", "--recurse-submodules=no",
957 NULL);
959 if (opts->quiet)
960 strvec_push(&child.args, "--quiet");
962 return !!run_command(&child);
965 static int maintenance_task_prefetch(struct maintenance_run_opts *opts)
967 if (for_each_remote(fetch_remote, opts)) {
968 error(_("failed to prefetch remotes"));
969 return 1;
972 return 0;
975 static int maintenance_task_gc(struct maintenance_run_opts *opts)
977 struct child_process child = CHILD_PROCESS_INIT;
979 child.git_cmd = child.close_object_store = 1;
980 strvec_push(&child.args, "gc");
982 if (opts->auto_flag)
983 strvec_push(&child.args, "--auto");
984 if (opts->quiet)
985 strvec_push(&child.args, "--quiet");
986 else
987 strvec_push(&child.args, "--no-quiet");
989 return run_command(&child);
992 static int prune_packed(struct maintenance_run_opts *opts)
994 struct child_process child = CHILD_PROCESS_INIT;
996 child.git_cmd = 1;
997 strvec_push(&child.args, "prune-packed");
999 if (opts->quiet)
1000 strvec_push(&child.args, "--quiet");
1002 return !!run_command(&child);
1005 struct write_loose_object_data {
1006 FILE *in;
1007 int count;
1008 int batch_size;
1011 static int loose_object_auto_limit = 100;
1013 static int loose_object_count(const struct object_id *oid UNUSED,
1014 const char *path UNUSED,
1015 void *data)
1017 int *count = (int*)data;
1018 if (++(*count) >= loose_object_auto_limit)
1019 return 1;
1020 return 0;
1023 static int loose_object_auto_condition(void)
1025 int count = 0;
1027 git_config_get_int("maintenance.loose-objects.auto",
1028 &loose_object_auto_limit);
1030 if (!loose_object_auto_limit)
1031 return 0;
1032 if (loose_object_auto_limit < 0)
1033 return 1;
1035 return for_each_loose_file_in_objdir(the_repository->objects->odb->path,
1036 loose_object_count,
1037 NULL, NULL, &count);
1040 static int bail_on_loose(const struct object_id *oid UNUSED,
1041 const char *path UNUSED,
1042 void *data UNUSED)
1044 return 1;
1047 static int write_loose_object_to_stdin(const struct object_id *oid,
1048 const char *path UNUSED,
1049 void *data)
1051 struct write_loose_object_data *d = (struct write_loose_object_data *)data;
1053 fprintf(d->in, "%s\n", oid_to_hex(oid));
1055 return ++(d->count) > d->batch_size;
1058 static int pack_loose(struct maintenance_run_opts *opts)
1060 struct repository *r = the_repository;
1061 int result = 0;
1062 struct write_loose_object_data data;
1063 struct child_process pack_proc = CHILD_PROCESS_INIT;
1066 * Do not start pack-objects process
1067 * if there are no loose objects.
1069 if (!for_each_loose_file_in_objdir(r->objects->odb->path,
1070 bail_on_loose,
1071 NULL, NULL, NULL))
1072 return 0;
1074 pack_proc.git_cmd = 1;
1076 strvec_push(&pack_proc.args, "pack-objects");
1077 if (opts->quiet)
1078 strvec_push(&pack_proc.args, "--quiet");
1079 strvec_pushf(&pack_proc.args, "%s/pack/loose", r->objects->odb->path);
1081 pack_proc.in = -1;
1083 if (start_command(&pack_proc)) {
1084 error(_("failed to start 'git pack-objects' process"));
1085 return 1;
1088 data.in = xfdopen(pack_proc.in, "w");
1089 data.count = 0;
1090 data.batch_size = 50000;
1092 for_each_loose_file_in_objdir(r->objects->odb->path,
1093 write_loose_object_to_stdin,
1094 NULL,
1095 NULL,
1096 &data);
1098 fclose(data.in);
1100 if (finish_command(&pack_proc)) {
1101 error(_("failed to finish 'git pack-objects' process"));
1102 result = 1;
1105 return result;
1108 static int maintenance_task_loose_objects(struct maintenance_run_opts *opts)
1110 return prune_packed(opts) || pack_loose(opts);
1113 static int incremental_repack_auto_condition(void)
1115 struct packed_git *p;
1116 int incremental_repack_auto_limit = 10;
1117 int count = 0;
1119 prepare_repo_settings(the_repository);
1120 if (!the_repository->settings.core_multi_pack_index)
1121 return 0;
1123 git_config_get_int("maintenance.incremental-repack.auto",
1124 &incremental_repack_auto_limit);
1126 if (!incremental_repack_auto_limit)
1127 return 0;
1128 if (incremental_repack_auto_limit < 0)
1129 return 1;
1131 for (p = get_packed_git(the_repository);
1132 count < incremental_repack_auto_limit && p;
1133 p = p->next) {
1134 if (!p->multi_pack_index)
1135 count++;
1138 return count >= incremental_repack_auto_limit;
1141 static int multi_pack_index_write(struct maintenance_run_opts *opts)
1143 struct child_process child = CHILD_PROCESS_INIT;
1145 child.git_cmd = 1;
1146 strvec_pushl(&child.args, "multi-pack-index", "write", NULL);
1148 if (opts->quiet)
1149 strvec_push(&child.args, "--no-progress");
1151 if (run_command(&child))
1152 return error(_("failed to write multi-pack-index"));
1154 return 0;
1157 static int multi_pack_index_expire(struct maintenance_run_opts *opts)
1159 struct child_process child = CHILD_PROCESS_INIT;
1161 child.git_cmd = child.close_object_store = 1;
1162 strvec_pushl(&child.args, "multi-pack-index", "expire", NULL);
1164 if (opts->quiet)
1165 strvec_push(&child.args, "--no-progress");
1167 if (run_command(&child))
1168 return error(_("'git multi-pack-index expire' failed"));
1170 return 0;
1173 #define TWO_GIGABYTES (INT32_MAX)
1175 static off_t get_auto_pack_size(void)
1178 * The "auto" value is special: we optimize for
1179 * one large pack-file (i.e. from a clone) and
1180 * expect the rest to be small and they can be
1181 * repacked quickly.
1183 * The strategy we select here is to select a
1184 * size that is one more than the second largest
1185 * pack-file. This ensures that we will repack
1186 * at least two packs if there are three or more
1187 * packs.
1189 off_t max_size = 0;
1190 off_t second_largest_size = 0;
1191 off_t result_size;
1192 struct packed_git *p;
1193 struct repository *r = the_repository;
1195 reprepare_packed_git(r);
1196 for (p = get_all_packs(r); p; p = p->next) {
1197 if (p->pack_size > max_size) {
1198 second_largest_size = max_size;
1199 max_size = p->pack_size;
1200 } else if (p->pack_size > second_largest_size)
1201 second_largest_size = p->pack_size;
1204 result_size = second_largest_size + 1;
1206 /* But limit ourselves to a batch size of 2g */
1207 if (result_size > TWO_GIGABYTES)
1208 result_size = TWO_GIGABYTES;
1210 return result_size;
1213 static int multi_pack_index_repack(struct maintenance_run_opts *opts)
1215 struct child_process child = CHILD_PROCESS_INIT;
1217 child.git_cmd = child.close_object_store = 1;
1218 strvec_pushl(&child.args, "multi-pack-index", "repack", NULL);
1220 if (opts->quiet)
1221 strvec_push(&child.args, "--no-progress");
1223 strvec_pushf(&child.args, "--batch-size=%"PRIuMAX,
1224 (uintmax_t)get_auto_pack_size());
1226 if (run_command(&child))
1227 return error(_("'git multi-pack-index repack' failed"));
1229 return 0;
1232 static int maintenance_task_incremental_repack(struct maintenance_run_opts *opts)
1234 prepare_repo_settings(the_repository);
1235 if (!the_repository->settings.core_multi_pack_index) {
1236 warning(_("skipping incremental-repack task because core.multiPackIndex is disabled"));
1237 return 0;
1240 if (multi_pack_index_write(opts))
1241 return 1;
1242 if (multi_pack_index_expire(opts))
1243 return 1;
1244 if (multi_pack_index_repack(opts))
1245 return 1;
1246 return 0;
1249 typedef int maintenance_task_fn(struct maintenance_run_opts *opts);
1252 * An auto condition function returns 1 if the task should run
1253 * and 0 if the task should NOT run. See needs_to_gc() for an
1254 * example.
1256 typedef int maintenance_auto_fn(void);
1258 struct maintenance_task {
1259 const char *name;
1260 maintenance_task_fn *fn;
1261 maintenance_auto_fn *auto_condition;
1262 unsigned enabled:1;
1264 enum schedule_priority schedule;
1266 /* -1 if not selected. */
1267 int selected_order;
1270 enum maintenance_task_label {
1271 TASK_PREFETCH,
1272 TASK_LOOSE_OBJECTS,
1273 TASK_INCREMENTAL_REPACK,
1274 TASK_GC,
1275 TASK_COMMIT_GRAPH,
1276 TASK_PACK_REFS,
1278 /* Leave as final value */
1279 TASK__COUNT
1282 static struct maintenance_task tasks[] = {
1283 [TASK_PREFETCH] = {
1284 "prefetch",
1285 maintenance_task_prefetch,
1287 [TASK_LOOSE_OBJECTS] = {
1288 "loose-objects",
1289 maintenance_task_loose_objects,
1290 loose_object_auto_condition,
1292 [TASK_INCREMENTAL_REPACK] = {
1293 "incremental-repack",
1294 maintenance_task_incremental_repack,
1295 incremental_repack_auto_condition,
1297 [TASK_GC] = {
1298 "gc",
1299 maintenance_task_gc,
1300 need_to_gc,
1303 [TASK_COMMIT_GRAPH] = {
1304 "commit-graph",
1305 maintenance_task_commit_graph,
1306 should_write_commit_graph,
1308 [TASK_PACK_REFS] = {
1309 "pack-refs",
1310 maintenance_task_pack_refs,
1311 pack_refs_condition,
1315 static int compare_tasks_by_selection(const void *a_, const void *b_)
1317 const struct maintenance_task *a = a_;
1318 const struct maintenance_task *b = b_;
1320 return b->selected_order - a->selected_order;
1323 static int maintenance_run_tasks(struct maintenance_run_opts *opts)
1325 int i, found_selected = 0;
1326 int result = 0;
1327 struct lock_file lk;
1328 struct repository *r = the_repository;
1329 char *lock_path = xstrfmt("%s/maintenance", r->objects->odb->path);
1331 if (hold_lock_file_for_update(&lk, lock_path, LOCK_NO_DEREF) < 0) {
1333 * Another maintenance command is running.
1335 * If --auto was provided, then it is likely due to a
1336 * recursive process stack. Do not report an error in
1337 * that case.
1339 if (!opts->auto_flag && !opts->quiet)
1340 warning(_("lock file '%s' exists, skipping maintenance"),
1341 lock_path);
1342 free(lock_path);
1343 return 0;
1345 free(lock_path);
1347 for (i = 0; !found_selected && i < TASK__COUNT; i++)
1348 found_selected = tasks[i].selected_order >= 0;
1350 if (found_selected)
1351 QSORT(tasks, TASK__COUNT, compare_tasks_by_selection);
1353 for (i = 0; i < TASK__COUNT; i++) {
1354 if (found_selected && tasks[i].selected_order < 0)
1355 continue;
1357 if (!found_selected && !tasks[i].enabled)
1358 continue;
1360 if (opts->auto_flag &&
1361 (!tasks[i].auto_condition ||
1362 !tasks[i].auto_condition()))
1363 continue;
1365 if (opts->schedule && tasks[i].schedule < opts->schedule)
1366 continue;
1368 trace2_region_enter("maintenance", tasks[i].name, r);
1369 if (tasks[i].fn(opts)) {
1370 error(_("task '%s' failed"), tasks[i].name);
1371 result = 1;
1373 trace2_region_leave("maintenance", tasks[i].name, r);
1376 rollback_lock_file(&lk);
1377 return result;
1380 static void initialize_maintenance_strategy(void)
1382 char *config_str;
1384 if (git_config_get_string("maintenance.strategy", &config_str))
1385 return;
1387 if (!strcasecmp(config_str, "incremental")) {
1388 tasks[TASK_GC].schedule = SCHEDULE_NONE;
1389 tasks[TASK_COMMIT_GRAPH].enabled = 1;
1390 tasks[TASK_COMMIT_GRAPH].schedule = SCHEDULE_HOURLY;
1391 tasks[TASK_PREFETCH].enabled = 1;
1392 tasks[TASK_PREFETCH].schedule = SCHEDULE_HOURLY;
1393 tasks[TASK_INCREMENTAL_REPACK].enabled = 1;
1394 tasks[TASK_INCREMENTAL_REPACK].schedule = SCHEDULE_DAILY;
1395 tasks[TASK_LOOSE_OBJECTS].enabled = 1;
1396 tasks[TASK_LOOSE_OBJECTS].schedule = SCHEDULE_DAILY;
1397 tasks[TASK_PACK_REFS].enabled = 1;
1398 tasks[TASK_PACK_REFS].schedule = SCHEDULE_WEEKLY;
1402 static void initialize_task_config(int schedule)
1404 int i;
1405 struct strbuf config_name = STRBUF_INIT;
1406 gc_config();
1408 if (schedule)
1409 initialize_maintenance_strategy();
1411 for (i = 0; i < TASK__COUNT; i++) {
1412 int config_value;
1413 char *config_str;
1415 strbuf_reset(&config_name);
1416 strbuf_addf(&config_name, "maintenance.%s.enabled",
1417 tasks[i].name);
1419 if (!git_config_get_bool(config_name.buf, &config_value))
1420 tasks[i].enabled = config_value;
1422 strbuf_reset(&config_name);
1423 strbuf_addf(&config_name, "maintenance.%s.schedule",
1424 tasks[i].name);
1426 if (!git_config_get_string(config_name.buf, &config_str)) {
1427 tasks[i].schedule = parse_schedule(config_str);
1428 free(config_str);
1432 strbuf_release(&config_name);
1435 static int task_option_parse(const struct option *opt UNUSED,
1436 const char *arg, int unset)
1438 int i, num_selected = 0;
1439 struct maintenance_task *task = NULL;
1441 BUG_ON_OPT_NEG(unset);
1443 for (i = 0; i < TASK__COUNT; i++) {
1444 if (tasks[i].selected_order >= 0)
1445 num_selected++;
1446 if (!strcasecmp(tasks[i].name, arg)) {
1447 task = &tasks[i];
1451 if (!task) {
1452 error(_("'%s' is not a valid task"), arg);
1453 return 1;
1456 if (task->selected_order >= 0) {
1457 error(_("task '%s' cannot be selected multiple times"), arg);
1458 return 1;
1461 task->selected_order = num_selected + 1;
1463 return 0;
1466 static int maintenance_run(int argc, const char **argv, const char *prefix)
1468 int i;
1469 struct maintenance_run_opts opts;
1470 struct option builtin_maintenance_run_options[] = {
1471 OPT_BOOL(0, "auto", &opts.auto_flag,
1472 N_("run tasks based on the state of the repository")),
1473 OPT_CALLBACK(0, "schedule", &opts.schedule, N_("frequency"),
1474 N_("run tasks based on frequency"),
1475 maintenance_opt_schedule),
1476 OPT_BOOL(0, "quiet", &opts.quiet,
1477 N_("do not report progress or other information over stderr")),
1478 OPT_CALLBACK_F(0, "task", NULL, N_("task"),
1479 N_("run a specific task"),
1480 PARSE_OPT_NONEG, task_option_parse),
1481 OPT_END()
1483 memset(&opts, 0, sizeof(opts));
1485 opts.quiet = !isatty(2);
1487 for (i = 0; i < TASK__COUNT; i++)
1488 tasks[i].selected_order = -1;
1490 argc = parse_options(argc, argv, prefix,
1491 builtin_maintenance_run_options,
1492 builtin_maintenance_run_usage,
1493 PARSE_OPT_STOP_AT_NON_OPTION);
1495 if (opts.auto_flag && opts.schedule)
1496 die(_("use at most one of --auto and --schedule=<frequency>"));
1498 initialize_task_config(opts.schedule);
1500 if (argc != 0)
1501 usage_with_options(builtin_maintenance_run_usage,
1502 builtin_maintenance_run_options);
1503 return maintenance_run_tasks(&opts);
1506 static char *get_maintpath(void)
1508 struct strbuf sb = STRBUF_INIT;
1509 const char *p = the_repository->worktree ?
1510 the_repository->worktree : the_repository->gitdir;
1512 strbuf_realpath(&sb, p, 1);
1513 return strbuf_detach(&sb, NULL);
1516 static char const * const builtin_maintenance_register_usage[] = {
1517 "git maintenance register [--config-file <path>]",
1518 NULL
1521 static int maintenance_register(int argc, const char **argv, const char *prefix)
1523 char *config_file = NULL;
1524 struct option options[] = {
1525 OPT_STRING(0, "config-file", &config_file, N_("file"), N_("use given config file")),
1526 OPT_END(),
1528 int found = 0;
1529 const char *key = "maintenance.repo";
1530 char *maintpath = get_maintpath();
1531 struct string_list_item *item;
1532 const struct string_list *list;
1534 argc = parse_options(argc, argv, prefix, options,
1535 builtin_maintenance_register_usage, 0);
1536 if (argc)
1537 usage_with_options(builtin_maintenance_register_usage,
1538 options);
1540 /* Disable foreground maintenance */
1541 git_config_set("maintenance.auto", "false");
1543 /* Set maintenance strategy, if unset */
1544 if (git_config_get("maintenance.strategy"))
1545 git_config_set("maintenance.strategy", "incremental");
1547 if (!git_config_get_string_multi(key, &list)) {
1548 for_each_string_list_item(item, list) {
1549 if (!strcmp(maintpath, item->string)) {
1550 found = 1;
1551 break;
1556 if (!found) {
1557 int rc;
1558 char *global_config_file = NULL;
1560 if (!config_file) {
1561 global_config_file = git_global_config();
1562 config_file = global_config_file;
1564 if (!config_file)
1565 die(_("$HOME not set"));
1566 rc = git_config_set_multivar_in_file_gently(
1567 config_file, "maintenance.repo", maintpath,
1568 CONFIG_REGEX_NONE, NULL, 0);
1569 free(global_config_file);
1571 if (rc)
1572 die(_("unable to add '%s' value of '%s'"),
1573 key, maintpath);
1576 free(maintpath);
1577 return 0;
1580 static char const * const builtin_maintenance_unregister_usage[] = {
1581 "git maintenance unregister [--config-file <path>] [--force]",
1582 NULL
1585 static int maintenance_unregister(int argc, const char **argv, const char *prefix)
1587 int force = 0;
1588 char *config_file = NULL;
1589 struct option options[] = {
1590 OPT_STRING(0, "config-file", &config_file, N_("file"), N_("use given config file")),
1591 OPT__FORCE(&force,
1592 N_("return success even if repository was not registered"),
1593 PARSE_OPT_NOCOMPLETE),
1594 OPT_END(),
1596 const char *key = "maintenance.repo";
1597 char *maintpath = get_maintpath();
1598 int found = 0;
1599 struct string_list_item *item;
1600 const struct string_list *list;
1601 struct config_set cs = { { 0 } };
1603 argc = parse_options(argc, argv, prefix, options,
1604 builtin_maintenance_unregister_usage, 0);
1605 if (argc)
1606 usage_with_options(builtin_maintenance_unregister_usage,
1607 options);
1609 if (config_file) {
1610 git_configset_init(&cs);
1611 git_configset_add_file(&cs, config_file);
1613 if (!(config_file
1614 ? git_configset_get_string_multi(&cs, key, &list)
1615 : git_config_get_string_multi(key, &list))) {
1616 for_each_string_list_item(item, list) {
1617 if (!strcmp(maintpath, item->string)) {
1618 found = 1;
1619 break;
1624 if (found) {
1625 int rc;
1626 char *global_config_file = NULL;
1628 if (!config_file) {
1629 global_config_file = git_global_config();
1630 config_file = global_config_file;
1632 if (!config_file)
1633 die(_("$HOME not set"));
1634 rc = git_config_set_multivar_in_file_gently(
1635 config_file, key, NULL, maintpath, NULL,
1636 CONFIG_FLAGS_MULTI_REPLACE | CONFIG_FLAGS_FIXED_VALUE);
1637 free(global_config_file);
1639 if (rc &&
1640 (!force || rc == CONFIG_NOTHING_SET))
1641 die(_("unable to unset '%s' value of '%s'"),
1642 key, maintpath);
1643 } else if (!force) {
1644 die(_("repository '%s' is not registered"), maintpath);
1647 git_configset_clear(&cs);
1648 free(maintpath);
1649 return 0;
1652 static const char *get_frequency(enum schedule_priority schedule)
1654 switch (schedule) {
1655 case SCHEDULE_HOURLY:
1656 return "hourly";
1657 case SCHEDULE_DAILY:
1658 return "daily";
1659 case SCHEDULE_WEEKLY:
1660 return "weekly";
1661 default:
1662 BUG("invalid schedule %d", schedule);
1667 * get_schedule_cmd` reads the GIT_TEST_MAINT_SCHEDULER environment variable
1668 * to mock the schedulers that `git maintenance start` rely on.
1670 * For test purpose, GIT_TEST_MAINT_SCHEDULER can be set to a comma-separated
1671 * list of colon-separated key/value pairs where each pair contains a scheduler
1672 * and its corresponding mock.
1674 * * If $GIT_TEST_MAINT_SCHEDULER is not set, return false and leave the
1675 * arguments unmodified.
1677 * * If $GIT_TEST_MAINT_SCHEDULER is set, return true.
1678 * In this case, the *cmd value is read as input.
1680 * * if the input value *cmd is the key of one of the comma-separated list
1681 * item, then *is_available is set to true and *cmd is modified and becomes
1682 * the mock command.
1684 * * if the input value *cmd isn’t the key of any of the comma-separated list
1685 * item, then *is_available is set to false.
1687 * Ex.:
1688 * GIT_TEST_MAINT_SCHEDULER not set
1689 * +-------+-------------------------------------------------+
1690 * | Input | Output |
1691 * | *cmd | return code | *cmd | *is_available |
1692 * +-------+-------------+-------------------+---------------+
1693 * | "foo" | false | "foo" (unchanged) | (unchanged) |
1694 * +-------+-------------+-------------------+---------------+
1696 * GIT_TEST_MAINT_SCHEDULER set to “foo:./mock_foo.sh,bar:./mock_bar.sh”
1697 * +-------+-------------------------------------------------+
1698 * | Input | Output |
1699 * | *cmd | return code | *cmd | *is_available |
1700 * +-------+-------------+-------------------+---------------+
1701 * | "foo" | true | "./mock.foo.sh" | true |
1702 * | "qux" | true | "qux" (unchanged) | false |
1703 * +-------+-------------+-------------------+---------------+
1705 static int get_schedule_cmd(const char **cmd, int *is_available)
1707 char *testing = xstrdup_or_null(getenv("GIT_TEST_MAINT_SCHEDULER"));
1708 struct string_list_item *item;
1709 struct string_list list = STRING_LIST_INIT_NODUP;
1711 if (!testing)
1712 return 0;
1714 if (is_available)
1715 *is_available = 0;
1717 string_list_split_in_place(&list, testing, ",", -1);
1718 for_each_string_list_item(item, &list) {
1719 struct string_list pair = STRING_LIST_INIT_NODUP;
1721 if (string_list_split_in_place(&pair, item->string, ":", 2) != 2)
1722 continue;
1724 if (!strcmp(*cmd, pair.items[0].string)) {
1725 *cmd = pair.items[1].string;
1726 if (is_available)
1727 *is_available = 1;
1728 string_list_clear(&list, 0);
1729 UNLEAK(testing);
1730 return 1;
1734 string_list_clear(&list, 0);
1735 free(testing);
1736 return 1;
1739 static int get_random_minute(void)
1741 /* Use a static value when under tests. */
1742 if (getenv("GIT_TEST_MAINT_SCHEDULER"))
1743 return 13;
1745 return git_rand() % 60;
1748 static int is_launchctl_available(void)
1750 const char *cmd = "launchctl";
1751 int is_available;
1752 if (get_schedule_cmd(&cmd, &is_available))
1753 return is_available;
1755 #ifdef __APPLE__
1756 return 1;
1757 #else
1758 return 0;
1759 #endif
1762 static char *launchctl_service_name(const char *frequency)
1764 struct strbuf label = STRBUF_INIT;
1765 strbuf_addf(&label, "org.git-scm.git.%s", frequency);
1766 return strbuf_detach(&label, NULL);
1769 static char *launchctl_service_filename(const char *name)
1771 char *expanded;
1772 struct strbuf filename = STRBUF_INIT;
1773 strbuf_addf(&filename, "~/Library/LaunchAgents/%s.plist", name);
1775 expanded = interpolate_path(filename.buf, 1);
1776 if (!expanded)
1777 die(_("failed to expand path '%s'"), filename.buf);
1779 strbuf_release(&filename);
1780 return expanded;
1783 static char *launchctl_get_uid(void)
1785 return xstrfmt("gui/%d", getuid());
1788 static int launchctl_boot_plist(int enable, const char *filename)
1790 const char *cmd = "launchctl";
1791 int result;
1792 struct child_process child = CHILD_PROCESS_INIT;
1793 char *uid = launchctl_get_uid();
1795 get_schedule_cmd(&cmd, NULL);
1796 strvec_split(&child.args, cmd);
1797 strvec_pushl(&child.args, enable ? "bootstrap" : "bootout", uid,
1798 filename, NULL);
1800 child.no_stderr = 1;
1801 child.no_stdout = 1;
1803 if (start_command(&child))
1804 die(_("failed to start launchctl"));
1806 result = finish_command(&child);
1808 free(uid);
1809 return result;
1812 static int launchctl_remove_plist(enum schedule_priority schedule)
1814 const char *frequency = get_frequency(schedule);
1815 char *name = launchctl_service_name(frequency);
1816 char *filename = launchctl_service_filename(name);
1817 int result = launchctl_boot_plist(0, filename);
1818 unlink(filename);
1819 free(filename);
1820 free(name);
1821 return result;
1824 static int launchctl_remove_plists(void)
1826 return launchctl_remove_plist(SCHEDULE_HOURLY) ||
1827 launchctl_remove_plist(SCHEDULE_DAILY) ||
1828 launchctl_remove_plist(SCHEDULE_WEEKLY);
1831 static int launchctl_list_contains_plist(const char *name, const char *cmd)
1833 struct child_process child = CHILD_PROCESS_INIT;
1835 strvec_split(&child.args, cmd);
1836 strvec_pushl(&child.args, "list", name, NULL);
1838 child.no_stderr = 1;
1839 child.no_stdout = 1;
1841 if (start_command(&child))
1842 die(_("failed to start launchctl"));
1844 /* Returns failure if 'name' doesn't exist. */
1845 return !finish_command(&child);
1848 static int launchctl_schedule_plist(const char *exec_path, enum schedule_priority schedule)
1850 int i, fd;
1851 const char *preamble, *repeat;
1852 const char *frequency = get_frequency(schedule);
1853 char *name = launchctl_service_name(frequency);
1854 char *filename = launchctl_service_filename(name);
1855 struct lock_file lk = LOCK_INIT;
1856 static unsigned long lock_file_timeout_ms = ULONG_MAX;
1857 struct strbuf plist = STRBUF_INIT, plist2 = STRBUF_INIT;
1858 struct stat st;
1859 const char *cmd = "launchctl";
1860 int minute = get_random_minute();
1862 get_schedule_cmd(&cmd, NULL);
1863 preamble = "<?xml version=\"1.0\"?>\n"
1864 "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
1865 "<plist version=\"1.0\">"
1866 "<dict>\n"
1867 "<key>Label</key><string>%s</string>\n"
1868 "<key>ProgramArguments</key>\n"
1869 "<array>\n"
1870 "<string>%s/git</string>\n"
1871 "<string>--exec-path=%s</string>\n"
1872 "<string>for-each-repo</string>\n"
1873 "<string>--keep-going</string>\n"
1874 "<string>--config=maintenance.repo</string>\n"
1875 "<string>maintenance</string>\n"
1876 "<string>run</string>\n"
1877 "<string>--schedule=%s</string>\n"
1878 "</array>\n"
1879 "<key>StartCalendarInterval</key>\n"
1880 "<array>\n";
1881 strbuf_addf(&plist, preamble, name, exec_path, exec_path, frequency);
1883 switch (schedule) {
1884 case SCHEDULE_HOURLY:
1885 repeat = "<dict>\n"
1886 "<key>Hour</key><integer>%d</integer>\n"
1887 "<key>Minute</key><integer>%d</integer>\n"
1888 "</dict>\n";
1889 for (i = 1; i <= 23; i++)
1890 strbuf_addf(&plist, repeat, i, minute);
1891 break;
1893 case SCHEDULE_DAILY:
1894 repeat = "<dict>\n"
1895 "<key>Day</key><integer>%d</integer>\n"
1896 "<key>Hour</key><integer>0</integer>\n"
1897 "<key>Minute</key><integer>%d</integer>\n"
1898 "</dict>\n";
1899 for (i = 1; i <= 6; i++)
1900 strbuf_addf(&plist, repeat, i, minute);
1901 break;
1903 case SCHEDULE_WEEKLY:
1904 strbuf_addf(&plist,
1905 "<dict>\n"
1906 "<key>Day</key><integer>0</integer>\n"
1907 "<key>Hour</key><integer>0</integer>\n"
1908 "<key>Minute</key><integer>%d</integer>\n"
1909 "</dict>\n",
1910 minute);
1911 break;
1913 default:
1914 /* unreachable */
1915 break;
1917 strbuf_addstr(&plist, "</array>\n</dict>\n</plist>\n");
1919 if (safe_create_leading_directories(filename))
1920 die(_("failed to create directories for '%s'"), filename);
1922 if ((long)lock_file_timeout_ms < 0 &&
1923 git_config_get_ulong("gc.launchctlplistlocktimeoutms",
1924 &lock_file_timeout_ms))
1925 lock_file_timeout_ms = 150;
1927 fd = hold_lock_file_for_update_timeout(&lk, filename, LOCK_DIE_ON_ERROR,
1928 lock_file_timeout_ms);
1931 * Does this file already exist? With the intended contents? Is it
1932 * registered already? Then it does not need to be re-registered.
1934 if (!stat(filename, &st) && st.st_size == plist.len &&
1935 strbuf_read_file(&plist2, filename, plist.len) == plist.len &&
1936 !strbuf_cmp(&plist, &plist2) &&
1937 launchctl_list_contains_plist(name, cmd))
1938 rollback_lock_file(&lk);
1939 else {
1940 if (write_in_full(fd, plist.buf, plist.len) < 0 ||
1941 commit_lock_file(&lk))
1942 die_errno(_("could not write '%s'"), filename);
1944 /* bootout might fail if not already running, so ignore */
1945 launchctl_boot_plist(0, filename);
1946 if (launchctl_boot_plist(1, filename))
1947 die(_("failed to bootstrap service %s"), filename);
1950 free(filename);
1951 free(name);
1952 strbuf_release(&plist);
1953 strbuf_release(&plist2);
1954 return 0;
1957 static int launchctl_add_plists(void)
1959 const char *exec_path = git_exec_path();
1961 return launchctl_schedule_plist(exec_path, SCHEDULE_HOURLY) ||
1962 launchctl_schedule_plist(exec_path, SCHEDULE_DAILY) ||
1963 launchctl_schedule_plist(exec_path, SCHEDULE_WEEKLY);
1966 static int launchctl_update_schedule(int run_maintenance, int fd UNUSED)
1968 if (run_maintenance)
1969 return launchctl_add_plists();
1970 else
1971 return launchctl_remove_plists();
1974 static int is_schtasks_available(void)
1976 const char *cmd = "schtasks";
1977 int is_available;
1978 if (get_schedule_cmd(&cmd, &is_available))
1979 return is_available;
1981 #ifdef GIT_WINDOWS_NATIVE
1982 return 1;
1983 #else
1984 return 0;
1985 #endif
1988 static char *schtasks_task_name(const char *frequency)
1990 struct strbuf label = STRBUF_INIT;
1991 strbuf_addf(&label, "Git Maintenance (%s)", frequency);
1992 return strbuf_detach(&label, NULL);
1995 static int schtasks_remove_task(enum schedule_priority schedule)
1997 const char *cmd = "schtasks";
1998 struct child_process child = CHILD_PROCESS_INIT;
1999 const char *frequency = get_frequency(schedule);
2000 char *name = schtasks_task_name(frequency);
2002 get_schedule_cmd(&cmd, NULL);
2003 strvec_split(&child.args, cmd);
2004 strvec_pushl(&child.args, "/delete", "/tn", name, "/f", NULL);
2005 free(name);
2007 return run_command(&child);
2010 static int schtasks_remove_tasks(void)
2012 return schtasks_remove_task(SCHEDULE_HOURLY) ||
2013 schtasks_remove_task(SCHEDULE_DAILY) ||
2014 schtasks_remove_task(SCHEDULE_WEEKLY);
2017 static int schtasks_schedule_task(const char *exec_path, enum schedule_priority schedule)
2019 const char *cmd = "schtasks";
2020 int result;
2021 struct child_process child = CHILD_PROCESS_INIT;
2022 const char *xml;
2023 struct tempfile *tfile;
2024 const char *frequency = get_frequency(schedule);
2025 char *name = schtasks_task_name(frequency);
2026 struct strbuf tfilename = STRBUF_INIT;
2027 int minute = get_random_minute();
2029 get_schedule_cmd(&cmd, NULL);
2031 strbuf_addf(&tfilename, "%s/schedule_%s_XXXXXX",
2032 get_git_common_dir(), frequency);
2033 tfile = xmks_tempfile(tfilename.buf);
2034 strbuf_release(&tfilename);
2036 if (!fdopen_tempfile(tfile, "w"))
2037 die(_("failed to create temp xml file"));
2039 xml = "<?xml version=\"1.0\" ?>\n"
2040 "<Task version=\"1.4\" xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n"
2041 "<Triggers>\n"
2042 "<CalendarTrigger>\n";
2043 fputs(xml, tfile->fp);
2045 switch (schedule) {
2046 case SCHEDULE_HOURLY:
2047 fprintf(tfile->fp,
2048 "<StartBoundary>2020-01-01T01:%02d:00</StartBoundary>\n"
2049 "<Enabled>true</Enabled>\n"
2050 "<ScheduleByDay>\n"
2051 "<DaysInterval>1</DaysInterval>\n"
2052 "</ScheduleByDay>\n"
2053 "<Repetition>\n"
2054 "<Interval>PT1H</Interval>\n"
2055 "<Duration>PT23H</Duration>\n"
2056 "<StopAtDurationEnd>false</StopAtDurationEnd>\n"
2057 "</Repetition>\n",
2058 minute);
2059 break;
2061 case SCHEDULE_DAILY:
2062 fprintf(tfile->fp,
2063 "<StartBoundary>2020-01-01T00:%02d:00</StartBoundary>\n"
2064 "<Enabled>true</Enabled>\n"
2065 "<ScheduleByWeek>\n"
2066 "<DaysOfWeek>\n"
2067 "<Monday />\n"
2068 "<Tuesday />\n"
2069 "<Wednesday />\n"
2070 "<Thursday />\n"
2071 "<Friday />\n"
2072 "<Saturday />\n"
2073 "</DaysOfWeek>\n"
2074 "<WeeksInterval>1</WeeksInterval>\n"
2075 "</ScheduleByWeek>\n",
2076 minute);
2077 break;
2079 case SCHEDULE_WEEKLY:
2080 fprintf(tfile->fp,
2081 "<StartBoundary>2020-01-01T00:%02d:00</StartBoundary>\n"
2082 "<Enabled>true</Enabled>\n"
2083 "<ScheduleByWeek>\n"
2084 "<DaysOfWeek>\n"
2085 "<Sunday />\n"
2086 "</DaysOfWeek>\n"
2087 "<WeeksInterval>1</WeeksInterval>\n"
2088 "</ScheduleByWeek>\n",
2089 minute);
2090 break;
2092 default:
2093 break;
2096 xml = "</CalendarTrigger>\n"
2097 "</Triggers>\n"
2098 "<Principals>\n"
2099 "<Principal id=\"Author\">\n"
2100 "<LogonType>InteractiveToken</LogonType>\n"
2101 "<RunLevel>LeastPrivilege</RunLevel>\n"
2102 "</Principal>\n"
2103 "</Principals>\n"
2104 "<Settings>\n"
2105 "<MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>\n"
2106 "<Enabled>true</Enabled>\n"
2107 "<Hidden>true</Hidden>\n"
2108 "<UseUnifiedSchedulingEngine>true</UseUnifiedSchedulingEngine>\n"
2109 "<WakeToRun>false</WakeToRun>\n"
2110 "<ExecutionTimeLimit>PT72H</ExecutionTimeLimit>\n"
2111 "<Priority>7</Priority>\n"
2112 "</Settings>\n"
2113 "<Actions Context=\"Author\">\n"
2114 "<Exec>\n"
2115 "<Command>\"%s\\headless-git.exe\"</Command>\n"
2116 "<Arguments>--exec-path=\"%s\" for-each-repo --keep-going --config=maintenance.repo maintenance run --schedule=%s</Arguments>\n"
2117 "</Exec>\n"
2118 "</Actions>\n"
2119 "</Task>\n";
2120 fprintf(tfile->fp, xml, exec_path, exec_path, frequency);
2121 strvec_split(&child.args, cmd);
2122 strvec_pushl(&child.args, "/create", "/tn", name, "/f", "/xml",
2123 get_tempfile_path(tfile), NULL);
2124 close_tempfile_gently(tfile);
2126 child.no_stdout = 1;
2127 child.no_stderr = 1;
2129 if (start_command(&child))
2130 die(_("failed to start schtasks"));
2131 result = finish_command(&child);
2133 delete_tempfile(&tfile);
2134 free(name);
2135 return result;
2138 static int schtasks_schedule_tasks(void)
2140 const char *exec_path = git_exec_path();
2142 return schtasks_schedule_task(exec_path, SCHEDULE_HOURLY) ||
2143 schtasks_schedule_task(exec_path, SCHEDULE_DAILY) ||
2144 schtasks_schedule_task(exec_path, SCHEDULE_WEEKLY);
2147 static int schtasks_update_schedule(int run_maintenance, int fd UNUSED)
2149 if (run_maintenance)
2150 return schtasks_schedule_tasks();
2151 else
2152 return schtasks_remove_tasks();
2155 MAYBE_UNUSED
2156 static int check_crontab_process(const char *cmd)
2158 struct child_process child = CHILD_PROCESS_INIT;
2160 strvec_split(&child.args, cmd);
2161 strvec_push(&child.args, "-l");
2162 child.no_stdin = 1;
2163 child.no_stdout = 1;
2164 child.no_stderr = 1;
2165 child.silent_exec_failure = 1;
2167 if (start_command(&child))
2168 return 0;
2169 /* Ignore exit code, as an empty crontab will return error. */
2170 finish_command(&child);
2171 return 1;
2174 static int is_crontab_available(void)
2176 const char *cmd = "crontab";
2177 int is_available;
2179 if (get_schedule_cmd(&cmd, &is_available))
2180 return is_available;
2182 #ifdef __APPLE__
2184 * macOS has cron, but it requires special permissions and will
2185 * create a UI alert when attempting to run this command.
2187 return 0;
2188 #else
2189 return check_crontab_process(cmd);
2190 #endif
2193 #define BEGIN_LINE "# BEGIN GIT MAINTENANCE SCHEDULE"
2194 #define END_LINE "# END GIT MAINTENANCE SCHEDULE"
2196 static int crontab_update_schedule(int run_maintenance, int fd)
2198 const char *cmd = "crontab";
2199 int result = 0;
2200 int in_old_region = 0;
2201 struct child_process crontab_list = CHILD_PROCESS_INIT;
2202 struct child_process crontab_edit = CHILD_PROCESS_INIT;
2203 FILE *cron_list, *cron_in;
2204 struct strbuf line = STRBUF_INIT;
2205 struct tempfile *tmpedit = NULL;
2206 int minute = get_random_minute();
2208 get_schedule_cmd(&cmd, NULL);
2209 strvec_split(&crontab_list.args, cmd);
2210 strvec_push(&crontab_list.args, "-l");
2211 crontab_list.in = -1;
2212 crontab_list.out = dup(fd);
2213 crontab_list.git_cmd = 0;
2215 if (start_command(&crontab_list))
2216 return error(_("failed to run 'crontab -l'; your system might not support 'cron'"));
2218 /* Ignore exit code, as an empty crontab will return error. */
2219 finish_command(&crontab_list);
2221 tmpedit = mks_tempfile_t(".git_cron_edit_tmpXXXXXX");
2222 if (!tmpedit) {
2223 result = error(_("failed to create crontab temporary file"));
2224 goto out;
2226 cron_in = fdopen_tempfile(tmpedit, "w");
2227 if (!cron_in) {
2228 result = error(_("failed to open temporary file"));
2229 goto out;
2233 * Read from the .lock file, filtering out the old
2234 * schedule while appending the new schedule.
2236 cron_list = fdopen(fd, "r");
2237 rewind(cron_list);
2239 while (!strbuf_getline_lf(&line, cron_list)) {
2240 if (!in_old_region && !strcmp(line.buf, BEGIN_LINE))
2241 in_old_region = 1;
2242 else if (in_old_region && !strcmp(line.buf, END_LINE))
2243 in_old_region = 0;
2244 else if (!in_old_region)
2245 fprintf(cron_in, "%s\n", line.buf);
2247 strbuf_release(&line);
2249 if (run_maintenance) {
2250 struct strbuf line_format = STRBUF_INIT;
2251 const char *exec_path = git_exec_path();
2253 fprintf(cron_in, "%s\n", BEGIN_LINE);
2254 fprintf(cron_in,
2255 "# The following schedule was created by Git\n");
2256 fprintf(cron_in, "# Any edits made in this region might be\n");
2257 fprintf(cron_in,
2258 "# replaced in the future by a Git command.\n\n");
2260 strbuf_addf(&line_format,
2261 "%%d %%s * * %%s \"%s/git\" --exec-path=\"%s\" for-each-repo --keep-going --config=maintenance.repo maintenance run --schedule=%%s\n",
2262 exec_path, exec_path);
2263 fprintf(cron_in, line_format.buf, minute, "1-23", "*", "hourly");
2264 fprintf(cron_in, line_format.buf, minute, "0", "1-6", "daily");
2265 fprintf(cron_in, line_format.buf, minute, "0", "0", "weekly");
2266 strbuf_release(&line_format);
2268 fprintf(cron_in, "\n%s\n", END_LINE);
2271 fflush(cron_in);
2273 strvec_split(&crontab_edit.args, cmd);
2274 strvec_push(&crontab_edit.args, get_tempfile_path(tmpedit));
2275 crontab_edit.git_cmd = 0;
2277 if (start_command(&crontab_edit)) {
2278 result = error(_("failed to run 'crontab'; your system might not support 'cron'"));
2279 goto out;
2282 if (finish_command(&crontab_edit))
2283 result = error(_("'crontab' died"));
2284 else
2285 fclose(cron_list);
2286 out:
2287 delete_tempfile(&tmpedit);
2288 return result;
2291 static int real_is_systemd_timer_available(void)
2293 struct child_process child = CHILD_PROCESS_INIT;
2295 strvec_pushl(&child.args, "systemctl", "--user", "list-timers", NULL);
2296 child.no_stdin = 1;
2297 child.no_stdout = 1;
2298 child.no_stderr = 1;
2299 child.silent_exec_failure = 1;
2301 if (start_command(&child))
2302 return 0;
2303 if (finish_command(&child))
2304 return 0;
2305 return 1;
2308 static int is_systemd_timer_available(void)
2310 const char *cmd = "systemctl";
2311 int is_available;
2313 if (get_schedule_cmd(&cmd, &is_available))
2314 return is_available;
2316 return real_is_systemd_timer_available();
2319 static char *xdg_config_home_systemd(const char *filename)
2321 return xdg_config_home_for("systemd/user", filename);
2324 #define SYSTEMD_UNIT_FORMAT "git-maintenance@%s.%s"
2326 static int systemd_timer_delete_timer_file(enum schedule_priority priority)
2328 int ret = 0;
2329 const char *frequency = get_frequency(priority);
2330 char *local_timer_name = xstrfmt(SYSTEMD_UNIT_FORMAT, frequency, "timer");
2331 char *filename = xdg_config_home_systemd(local_timer_name);
2333 if (unlink(filename) && !is_missing_file_error(errno))
2334 ret = error_errno(_("failed to delete '%s'"), filename);
2336 free(filename);
2337 free(local_timer_name);
2338 return ret;
2341 static int systemd_timer_delete_service_template(void)
2343 int ret = 0;
2344 char *local_service_name = xstrfmt(SYSTEMD_UNIT_FORMAT, "", "service");
2345 char *filename = xdg_config_home_systemd(local_service_name);
2346 if (unlink(filename) && !is_missing_file_error(errno))
2347 ret = error_errno(_("failed to delete '%s'"), filename);
2349 free(filename);
2350 free(local_service_name);
2351 return ret;
2355 * Write the schedule information into a git-maintenance@<schedule>.timer
2356 * file using a custom minute. This timer file cannot use the templating
2357 * system, so we generate a specific file for each.
2359 static int systemd_timer_write_timer_file(enum schedule_priority schedule,
2360 int minute)
2362 int res = -1;
2363 char *filename;
2364 FILE *file;
2365 const char *unit;
2366 char *schedule_pattern = NULL;
2367 const char *frequency = get_frequency(schedule);
2368 char *local_timer_name = xstrfmt(SYSTEMD_UNIT_FORMAT, frequency, "timer");
2370 filename = xdg_config_home_systemd(local_timer_name);
2372 if (safe_create_leading_directories(filename)) {
2373 error(_("failed to create directories for '%s'"), filename);
2374 goto error;
2376 file = fopen_or_warn(filename, "w");
2377 if (!file)
2378 goto error;
2380 switch (schedule) {
2381 case SCHEDULE_HOURLY:
2382 schedule_pattern = xstrfmt("*-*-* 1..23:%02d:00", minute);
2383 break;
2385 case SCHEDULE_DAILY:
2386 schedule_pattern = xstrfmt("Tue..Sun *-*-* 0:%02d:00", minute);
2387 break;
2389 case SCHEDULE_WEEKLY:
2390 schedule_pattern = xstrfmt("Mon 0:%02d:00", minute);
2391 break;
2393 default:
2394 BUG("Unhandled schedule_priority");
2397 unit = "# This file was created and is maintained by Git.\n"
2398 "# Any edits made in this file might be replaced in the future\n"
2399 "# by a Git command.\n"
2400 "\n"
2401 "[Unit]\n"
2402 "Description=Optimize Git repositories data\n"
2403 "\n"
2404 "[Timer]\n"
2405 "OnCalendar=%s\n"
2406 "Persistent=true\n"
2407 "\n"
2408 "[Install]\n"
2409 "WantedBy=timers.target\n";
2410 if (fprintf(file, unit, schedule_pattern) < 0) {
2411 error(_("failed to write to '%s'"), filename);
2412 fclose(file);
2413 goto error;
2415 if (fclose(file) == EOF) {
2416 error_errno(_("failed to flush '%s'"), filename);
2417 goto error;
2420 res = 0;
2422 error:
2423 free(schedule_pattern);
2424 free(local_timer_name);
2425 free(filename);
2426 return res;
2430 * No matter the schedule, we use the same service and can make use of the
2431 * templating system. When installing git-maintenance@<schedule>.timer,
2432 * systemd will notice that git-maintenance@.service exists as a template
2433 * and will use this file and insert the <schedule> into the template at
2434 * the position of "%i".
2436 static int systemd_timer_write_service_template(const char *exec_path)
2438 int res = -1;
2439 char *filename;
2440 FILE *file;
2441 const char *unit;
2442 char *local_service_name = xstrfmt(SYSTEMD_UNIT_FORMAT, "", "service");
2444 filename = xdg_config_home_systemd(local_service_name);
2445 if (safe_create_leading_directories(filename)) {
2446 error(_("failed to create directories for '%s'"), filename);
2447 goto error;
2449 file = fopen_or_warn(filename, "w");
2450 if (!file)
2451 goto error;
2453 unit = "# This file was created and is maintained by Git.\n"
2454 "# Any edits made in this file might be replaced in the future\n"
2455 "# by a Git command.\n"
2456 "\n"
2457 "[Unit]\n"
2458 "Description=Optimize Git repositories data\n"
2459 "\n"
2460 "[Service]\n"
2461 "Type=oneshot\n"
2462 "ExecStart=\"%s/git\" --exec-path=\"%s\" for-each-repo --keep-going --config=maintenance.repo maintenance run --schedule=%%i\n"
2463 "LockPersonality=yes\n"
2464 "MemoryDenyWriteExecute=yes\n"
2465 "NoNewPrivileges=yes\n"
2466 "RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_VSOCK\n"
2467 "RestrictNamespaces=yes\n"
2468 "RestrictRealtime=yes\n"
2469 "RestrictSUIDSGID=yes\n"
2470 "SystemCallArchitectures=native\n"
2471 "SystemCallFilter=@system-service\n";
2472 if (fprintf(file, unit, exec_path, exec_path) < 0) {
2473 error(_("failed to write to '%s'"), filename);
2474 fclose(file);
2475 goto error;
2477 if (fclose(file) == EOF) {
2478 error_errno(_("failed to flush '%s'"), filename);
2479 goto error;
2482 res = 0;
2484 error:
2485 free(local_service_name);
2486 free(filename);
2487 return res;
2490 static int systemd_timer_enable_unit(int enable,
2491 enum schedule_priority schedule,
2492 int minute)
2494 const char *cmd = "systemctl";
2495 struct child_process child = CHILD_PROCESS_INIT;
2496 const char *frequency = get_frequency(schedule);
2499 * Disabling the systemd unit while it is already disabled makes
2500 * systemctl print an error.
2501 * Let's ignore it since it means we already are in the expected state:
2502 * the unit is disabled.
2504 * On the other hand, enabling a systemd unit which is already enabled
2505 * produces no error.
2507 if (!enable)
2508 child.no_stderr = 1;
2509 else if (systemd_timer_write_timer_file(schedule, minute))
2510 return -1;
2512 get_schedule_cmd(&cmd, NULL);
2513 strvec_split(&child.args, cmd);
2514 strvec_pushl(&child.args, "--user", enable ? "enable" : "disable",
2515 "--now", NULL);
2516 strvec_pushf(&child.args, SYSTEMD_UNIT_FORMAT, frequency, "timer");
2518 if (start_command(&child))
2519 return error(_("failed to start systemctl"));
2520 if (finish_command(&child))
2522 * Disabling an already disabled systemd unit makes
2523 * systemctl fail.
2524 * Let's ignore this failure.
2526 * Enabling an enabled systemd unit doesn't fail.
2528 if (enable)
2529 return error(_("failed to run systemctl"));
2530 return 0;
2534 * A previous version of Git wrote the timer units as template files.
2535 * Clean these up, if they exist.
2537 static void systemd_timer_delete_stale_timer_templates(void)
2539 char *timer_template_name = xstrfmt(SYSTEMD_UNIT_FORMAT, "", "timer");
2540 char *filename = xdg_config_home_systemd(timer_template_name);
2542 if (unlink(filename) && !is_missing_file_error(errno))
2543 warning(_("failed to delete '%s'"), filename);
2545 free(filename);
2546 free(timer_template_name);
2549 static int systemd_timer_delete_unit_files(void)
2551 systemd_timer_delete_stale_timer_templates();
2553 /* Purposefully not short-circuited to make sure all are called. */
2554 return systemd_timer_delete_timer_file(SCHEDULE_HOURLY) |
2555 systemd_timer_delete_timer_file(SCHEDULE_DAILY) |
2556 systemd_timer_delete_timer_file(SCHEDULE_WEEKLY) |
2557 systemd_timer_delete_service_template();
2560 static int systemd_timer_delete_units(void)
2562 int minute = get_random_minute();
2563 /* Purposefully not short-circuited to make sure all are called. */
2564 return systemd_timer_enable_unit(0, SCHEDULE_HOURLY, minute) |
2565 systemd_timer_enable_unit(0, SCHEDULE_DAILY, minute) |
2566 systemd_timer_enable_unit(0, SCHEDULE_WEEKLY, minute) |
2567 systemd_timer_delete_unit_files();
2570 static int systemd_timer_setup_units(void)
2572 int minute = get_random_minute();
2573 const char *exec_path = git_exec_path();
2575 int ret = systemd_timer_write_service_template(exec_path) ||
2576 systemd_timer_enable_unit(1, SCHEDULE_HOURLY, minute) ||
2577 systemd_timer_enable_unit(1, SCHEDULE_DAILY, minute) ||
2578 systemd_timer_enable_unit(1, SCHEDULE_WEEKLY, minute);
2580 if (ret)
2581 systemd_timer_delete_units();
2582 else
2583 systemd_timer_delete_stale_timer_templates();
2585 return ret;
2588 static int systemd_timer_update_schedule(int run_maintenance, int fd UNUSED)
2590 if (run_maintenance)
2591 return systemd_timer_setup_units();
2592 else
2593 return systemd_timer_delete_units();
2596 enum scheduler {
2597 SCHEDULER_INVALID = -1,
2598 SCHEDULER_AUTO,
2599 SCHEDULER_CRON,
2600 SCHEDULER_SYSTEMD,
2601 SCHEDULER_LAUNCHCTL,
2602 SCHEDULER_SCHTASKS,
2605 static const struct {
2606 const char *name;
2607 int (*is_available)(void);
2608 int (*update_schedule)(int run_maintenance, int fd);
2609 } scheduler_fn[] = {
2610 [SCHEDULER_CRON] = {
2611 .name = "crontab",
2612 .is_available = is_crontab_available,
2613 .update_schedule = crontab_update_schedule,
2615 [SCHEDULER_SYSTEMD] = {
2616 .name = "systemctl",
2617 .is_available = is_systemd_timer_available,
2618 .update_schedule = systemd_timer_update_schedule,
2620 [SCHEDULER_LAUNCHCTL] = {
2621 .name = "launchctl",
2622 .is_available = is_launchctl_available,
2623 .update_schedule = launchctl_update_schedule,
2625 [SCHEDULER_SCHTASKS] = {
2626 .name = "schtasks",
2627 .is_available = is_schtasks_available,
2628 .update_schedule = schtasks_update_schedule,
2632 static enum scheduler parse_scheduler(const char *value)
2634 if (!value)
2635 return SCHEDULER_INVALID;
2636 else if (!strcasecmp(value, "auto"))
2637 return SCHEDULER_AUTO;
2638 else if (!strcasecmp(value, "cron") || !strcasecmp(value, "crontab"))
2639 return SCHEDULER_CRON;
2640 else if (!strcasecmp(value, "systemd") ||
2641 !strcasecmp(value, "systemd-timer"))
2642 return SCHEDULER_SYSTEMD;
2643 else if (!strcasecmp(value, "launchctl"))
2644 return SCHEDULER_LAUNCHCTL;
2645 else if (!strcasecmp(value, "schtasks"))
2646 return SCHEDULER_SCHTASKS;
2647 else
2648 return SCHEDULER_INVALID;
2651 static int maintenance_opt_scheduler(const struct option *opt, const char *arg,
2652 int unset)
2654 enum scheduler *scheduler = opt->value;
2656 BUG_ON_OPT_NEG(unset);
2658 *scheduler = parse_scheduler(arg);
2659 if (*scheduler == SCHEDULER_INVALID)
2660 return error(_("unrecognized --scheduler argument '%s'"), arg);
2661 return 0;
2664 struct maintenance_start_opts {
2665 enum scheduler scheduler;
2668 static enum scheduler resolve_scheduler(enum scheduler scheduler)
2670 if (scheduler != SCHEDULER_AUTO)
2671 return scheduler;
2673 #if defined(__APPLE__)
2674 return SCHEDULER_LAUNCHCTL;
2676 #elif defined(GIT_WINDOWS_NATIVE)
2677 return SCHEDULER_SCHTASKS;
2679 #elif defined(__linux__)
2680 if (is_systemd_timer_available())
2681 return SCHEDULER_SYSTEMD;
2682 else if (is_crontab_available())
2683 return SCHEDULER_CRON;
2684 else
2685 die(_("neither systemd timers nor crontab are available"));
2687 #else
2688 return SCHEDULER_CRON;
2689 #endif
2692 static void validate_scheduler(enum scheduler scheduler)
2694 if (scheduler == SCHEDULER_INVALID)
2695 BUG("invalid scheduler");
2696 if (scheduler == SCHEDULER_AUTO)
2697 BUG("resolve_scheduler should have been called before");
2699 if (!scheduler_fn[scheduler].is_available())
2700 die(_("%s scheduler is not available"),
2701 scheduler_fn[scheduler].name);
2704 static int update_background_schedule(const struct maintenance_start_opts *opts,
2705 int enable)
2707 unsigned int i;
2708 int result = 0;
2709 struct lock_file lk;
2710 char *lock_path = xstrfmt("%s/schedule", the_repository->objects->odb->path);
2712 if (hold_lock_file_for_update(&lk, lock_path, LOCK_NO_DEREF) < 0) {
2713 free(lock_path);
2714 return error(_("another process is scheduling background maintenance"));
2717 for (i = 1; i < ARRAY_SIZE(scheduler_fn); i++) {
2718 if (enable && opts->scheduler == i)
2719 continue;
2720 if (!scheduler_fn[i].is_available())
2721 continue;
2722 scheduler_fn[i].update_schedule(0, get_lock_file_fd(&lk));
2725 if (enable)
2726 result = scheduler_fn[opts->scheduler].update_schedule(
2727 1, get_lock_file_fd(&lk));
2729 rollback_lock_file(&lk);
2731 free(lock_path);
2732 return result;
2735 static const char *const builtin_maintenance_start_usage[] = {
2736 N_("git maintenance start [--scheduler=<scheduler>]"),
2737 NULL
2740 static int maintenance_start(int argc, const char **argv, const char *prefix)
2742 struct maintenance_start_opts opts = { 0 };
2743 struct option options[] = {
2744 OPT_CALLBACK_F(
2745 0, "scheduler", &opts.scheduler, N_("scheduler"),
2746 N_("scheduler to trigger git maintenance run"),
2747 PARSE_OPT_NONEG, maintenance_opt_scheduler),
2748 OPT_END()
2750 const char *register_args[] = { "register", NULL };
2752 argc = parse_options(argc, argv, prefix, options,
2753 builtin_maintenance_start_usage, 0);
2754 if (argc)
2755 usage_with_options(builtin_maintenance_start_usage, options);
2757 opts.scheduler = resolve_scheduler(opts.scheduler);
2758 validate_scheduler(opts.scheduler);
2760 if (update_background_schedule(&opts, 1))
2761 die(_("failed to set up maintenance schedule"));
2763 if (maintenance_register(ARRAY_SIZE(register_args)-1, register_args, NULL))
2764 warning(_("failed to add repo to global config"));
2765 return 0;
2768 static const char *const builtin_maintenance_stop_usage[] = {
2769 "git maintenance stop",
2770 NULL
2773 static int maintenance_stop(int argc, const char **argv, const char *prefix)
2775 struct option options[] = {
2776 OPT_END()
2778 argc = parse_options(argc, argv, prefix, options,
2779 builtin_maintenance_stop_usage, 0);
2780 if (argc)
2781 usage_with_options(builtin_maintenance_stop_usage, options);
2782 return update_background_schedule(NULL, 0);
2785 static const char * const builtin_maintenance_usage[] = {
2786 N_("git maintenance <subcommand> [<options>]"),
2787 NULL,
2790 int cmd_maintenance(int argc, const char **argv, const char *prefix)
2792 parse_opt_subcommand_fn *fn = NULL;
2793 struct option builtin_maintenance_options[] = {
2794 OPT_SUBCOMMAND("run", &fn, maintenance_run),
2795 OPT_SUBCOMMAND("start", &fn, maintenance_start),
2796 OPT_SUBCOMMAND("stop", &fn, maintenance_stop),
2797 OPT_SUBCOMMAND("register", &fn, maintenance_register),
2798 OPT_SUBCOMMAND("unregister", &fn, maintenance_unregister),
2799 OPT_END(),
2802 argc = parse_options(argc, argv, prefix, builtin_maintenance_options,
2803 builtin_maintenance_usage, 0);
2804 return fn(argc, argv, prefix);