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
15 #include "environment.h"
17 #include "repository.h"
21 #include "parse-options.h"
22 #include "run-command.h"
26 #include "commit-graph.h"
28 #include "object-store.h"
30 #include "pack-objects.h"
33 #include "promisor-remote.h"
41 #define FAILED_RUN "failed to run %s"
43 static const char * const builtin_gc_usage
[] = {
44 N_("git gc [<options>]"),
48 static int pack_refs
= 1;
49 static int prune_reflogs
= 1;
50 static int cruft_packs
= -1;
51 static int aggressive_depth
= 50;
52 static int aggressive_window
= 250;
53 static int gc_auto_threshold
= 6700;
54 static int gc_auto_pack_limit
= 50;
55 static int detach_auto
= 1;
56 static timestamp_t gc_log_expire_time
;
57 static const char *gc_log_expire
= "1.day.ago";
58 static const char *prune_expire
= "2.weeks.ago";
59 static const char *prune_worktrees_expire
= "3.months.ago";
60 static unsigned long big_pack_threshold
;
61 static unsigned long max_delta_cache_size
= DEFAULT_DELTA_CACHE_SIZE
;
63 static struct strvec reflog
= STRVEC_INIT
;
64 static struct strvec repack
= STRVEC_INIT
;
65 static struct strvec prune
= STRVEC_INIT
;
66 static struct strvec prune_worktrees
= STRVEC_INIT
;
67 static struct strvec rerere
= STRVEC_INIT
;
69 static struct tempfile
*pidfile
;
70 static struct lock_file log_lock
;
72 static struct string_list pack_garbage
= STRING_LIST_INIT_DUP
;
74 static void clean_pack_garbage(void)
77 for (i
= 0; i
< pack_garbage
.nr
; i
++)
78 unlink_or_warn(pack_garbage
.items
[i
].string
);
79 string_list_clear(&pack_garbage
, 0);
82 static void report_pack_garbage(unsigned seen_bits
, const char *path
)
84 if (seen_bits
== PACKDIR_FILE_IDX
)
85 string_list_append(&pack_garbage
, path
);
88 static void process_log_file(void)
91 if (fstat(get_lock_file_fd(&log_lock
), &st
)) {
93 * Perhaps there was an i/o error or another
94 * unlikely situation. Try to make a note of
95 * this in gc.log along with any existing
98 int saved_errno
= errno
;
99 fprintf(stderr
, _("Failed to fstat %s: %s"),
100 get_lock_file_path(&log_lock
),
101 strerror(saved_errno
));
103 commit_lock_file(&log_lock
);
105 } else if (st
.st_size
) {
106 /* There was some error recorded in the lock file */
107 commit_lock_file(&log_lock
);
109 /* No error, clean up any old gc.log */
110 unlink(git_path("gc.log"));
111 rollback_lock_file(&log_lock
);
115 static void process_log_file_at_exit(void)
121 static void process_log_file_on_signal(int signo
)
128 static int gc_config_is_timestamp_never(const char *var
)
133 if (!git_config_get_value(var
, &value
) && value
) {
134 if (parse_expiry_date(value
, &expire
))
135 die(_("failed to parse '%s' value '%s'"), var
, value
);
141 static void gc_config(void)
145 if (!git_config_get_value("gc.packrefs", &value
)) {
146 if (value
&& !strcmp(value
, "notbare"))
149 pack_refs
= git_config_bool("gc.packrefs", value
);
152 if (gc_config_is_timestamp_never("gc.reflogexpire") &&
153 gc_config_is_timestamp_never("gc.reflogexpireunreachable"))
156 git_config_get_int("gc.aggressivewindow", &aggressive_window
);
157 git_config_get_int("gc.aggressivedepth", &aggressive_depth
);
158 git_config_get_int("gc.auto", &gc_auto_threshold
);
159 git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit
);
160 git_config_get_bool("gc.autodetach", &detach_auto
);
161 git_config_get_bool("gc.cruftpacks", &cruft_packs
);
162 git_config_get_expiry("gc.pruneexpire", &prune_expire
);
163 git_config_get_expiry("gc.worktreepruneexpire", &prune_worktrees_expire
);
164 git_config_get_expiry("gc.logexpiry", &gc_log_expire
);
166 git_config_get_ulong("gc.bigpackthreshold", &big_pack_threshold
);
167 git_config_get_ulong("pack.deltacachesize", &max_delta_cache_size
);
169 git_config(git_default_config
, NULL
);
172 struct maintenance_run_opts
;
173 static int maintenance_task_pack_refs(MAYBE_UNUSED
struct maintenance_run_opts
*opts
)
175 struct child_process cmd
= CHILD_PROCESS_INIT
;
178 strvec_pushl(&cmd
.args
, "pack-refs", "--all", "--prune", NULL
);
179 return run_command(&cmd
);
182 static int too_many_loose_objects(void)
185 * Quickly check if a "gc" is needed, by estimating how
186 * many loose objects there are. Because SHA-1 is evenly
187 * distributed, we can check only one and get a reasonable
195 const unsigned hexsz_loose
= the_hash_algo
->hexsz
- 2;
197 dir
= opendir(git_path("objects/17"));
201 auto_threshold
= DIV_ROUND_UP(gc_auto_threshold
, 256);
202 while ((ent
= readdir(dir
)) != NULL
) {
203 if (strspn(ent
->d_name
, "0123456789abcdef") != hexsz_loose
||
204 ent
->d_name
[hexsz_loose
] != '\0')
206 if (++num_loose
> auto_threshold
) {
215 static struct packed_git
*find_base_packs(struct string_list
*packs
,
218 struct packed_git
*p
, *base
= NULL
;
220 for (p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
224 if (p
->pack_size
>= limit
)
225 string_list_append(packs
, p
->pack_name
);
226 } else if (!base
|| base
->pack_size
< p
->pack_size
) {
232 string_list_append(packs
, base
->pack_name
);
237 static int too_many_packs(void)
239 struct packed_git
*p
;
242 if (gc_auto_pack_limit
<= 0)
245 for (cnt
= 0, p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
251 * Perhaps check the size of the pack and count only
252 * very small ones here?
256 return gc_auto_pack_limit
< cnt
;
259 static uint64_t total_ram(void)
261 #if defined(HAVE_SYSINFO)
266 #elif defined(HAVE_BSD_SYSCTL) && (defined(HW_MEMSIZE) || defined(HW_PHYSMEM))
267 int64_t physical_memory
;
272 # if defined(HW_MEMSIZE)
277 length
= sizeof(int64_t);
278 if (!sysctl(mib
, 2, &physical_memory
, &length
, NULL
, 0))
279 return physical_memory
;
280 #elif defined(GIT_WINDOWS_NATIVE)
281 MEMORYSTATUSEX memInfo
;
283 memInfo
.dwLength
= sizeof(MEMORYSTATUSEX
);
284 if (GlobalMemoryStatusEx(&memInfo
))
285 return memInfo
.ullTotalPhys
;
290 static uint64_t estimate_repack_memory(struct packed_git
*pack
)
292 unsigned long nr_objects
= approximate_object_count();
293 size_t os_cache
, heap
;
295 if (!pack
|| !nr_objects
)
299 * First we have to scan through at least one pack.
300 * Assume enough room in OS file cache to keep the entire pack
301 * or we may accidentally evict data of other processes from
304 os_cache
= pack
->pack_size
+ pack
->index_size
;
305 /* then pack-objects needs lots more for book keeping */
306 heap
= sizeof(struct object_entry
) * nr_objects
;
308 * internal rev-list --all --objects takes up some memory too,
309 * let's say half of it is for blobs
311 heap
+= sizeof(struct blob
) * nr_objects
/ 2;
313 * and the other half is for trees (commits and tags are
314 * usually insignificant)
316 heap
+= sizeof(struct tree
) * nr_objects
/ 2;
317 /* and then obj_hash[], underestimated in fact */
318 heap
+= sizeof(struct object
*) * nr_objects
;
319 /* revindex is used also */
320 heap
+= (sizeof(off_t
) + sizeof(uint32_t)) * nr_objects
;
322 * read_sha1_file() (either at delta calculation phase, or
323 * writing phase) also fills up the delta base cache
325 heap
+= delta_base_cache_limit
;
326 /* and of course pack-objects has its own delta cache */
327 heap
+= max_delta_cache_size
;
329 return os_cache
+ heap
;
332 static int keep_one_pack(struct string_list_item
*item
, void *data UNUSED
)
334 strvec_pushf(&repack
, "--keep-pack=%s", basename(item
->string
));
338 static void add_repack_all_option(struct string_list
*keep_pack
)
340 if (prune_expire
&& !strcmp(prune_expire
, "now"))
341 strvec_push(&repack
, "-a");
342 else if (cruft_packs
) {
343 strvec_push(&repack
, "--cruft");
345 strvec_pushf(&repack
, "--cruft-expiration=%s", prune_expire
);
347 strvec_push(&repack
, "-A");
349 strvec_pushf(&repack
, "--unpack-unreachable=%s", prune_expire
);
353 for_each_string_list(keep_pack
, keep_one_pack
, NULL
);
356 static void add_repack_incremental_option(void)
358 strvec_push(&repack
, "--no-write-bitmap-index");
361 static int need_to_gc(void)
364 * Setting gc.auto to 0 or negative can disable the
367 if (gc_auto_threshold
<= 0)
371 * If there are too many loose objects, but not too many
372 * packs, we run "repack -d -l". If there are too many packs,
373 * we run "repack -A -d -l". Otherwise we tell the caller
376 if (too_many_packs()) {
377 struct string_list keep_pack
= STRING_LIST_INIT_NODUP
;
379 if (big_pack_threshold
) {
380 find_base_packs(&keep_pack
, big_pack_threshold
);
381 if (keep_pack
.nr
>= gc_auto_pack_limit
) {
382 big_pack_threshold
= 0;
383 string_list_clear(&keep_pack
, 0);
384 find_base_packs(&keep_pack
, 0);
387 struct packed_git
*p
= find_base_packs(&keep_pack
, 0);
388 uint64_t mem_have
, mem_want
;
390 mem_have
= total_ram();
391 mem_want
= estimate_repack_memory(p
);
394 * Only allow 1/2 of memory for pack-objects, leave
395 * the rest for the OS and other processes in the
398 if (!mem_have
|| mem_want
< mem_have
/ 2)
399 string_list_clear(&keep_pack
, 0);
402 add_repack_all_option(&keep_pack
);
403 string_list_clear(&keep_pack
, 0);
404 } else if (too_many_loose_objects())
405 add_repack_incremental_option();
409 if (run_hooks("pre-auto-gc"))
414 /* return NULL on success, else hostname running the gc */
415 static const char *lock_repo_for_gc(int force
, pid_t
* ret_pid
)
417 struct lock_file lock
= LOCK_INIT
;
418 char my_host
[HOST_NAME_MAX
+ 1];
419 struct strbuf sb
= STRBUF_INIT
;
426 if (is_tempfile_active(pidfile
))
430 if (xgethostname(my_host
, sizeof(my_host
)))
431 xsnprintf(my_host
, sizeof(my_host
), "unknown");
433 pidfile_path
= git_pathdup("gc.pid");
434 fd
= hold_lock_file_for_update(&lock
, pidfile_path
,
437 static char locking_host
[HOST_NAME_MAX
+ 1];
438 static char *scan_fmt
;
442 scan_fmt
= xstrfmt("%s %%%ds", "%"SCNuMAX
, HOST_NAME_MAX
);
443 fp
= fopen(pidfile_path
, "r");
444 memset(locking_host
, 0, sizeof(locking_host
));
447 !fstat(fileno(fp
), &st
) &&
449 * 12 hour limit is very generous as gc should
450 * never take that long. On the other hand we
451 * don't really need a strict limit here,
452 * running gc --auto one day late is not a big
453 * problem. --force can be used in manual gc
454 * after the user verifies that no gc is
457 time(NULL
) - st
.st_mtime
<= 12 * 3600 &&
458 fscanf(fp
, scan_fmt
, &pid
, locking_host
) == 2 &&
459 /* be gentle to concurrent "gc" on remote hosts */
460 (strcmp(locking_host
, my_host
) || !kill(pid
, 0) || errno
== EPERM
);
465 rollback_lock_file(&lock
);
472 strbuf_addf(&sb
, "%"PRIuMAX
" %s",
473 (uintmax_t) getpid(), my_host
);
474 write_in_full(fd
, sb
.buf
, sb
.len
);
476 commit_lock_file(&lock
);
477 pidfile
= register_tempfile(pidfile_path
);
483 * Returns 0 if there was no previous error and gc can proceed, 1 if
484 * gc should not proceed due to an error in the last run. Prints a
485 * message and returns with a non-[01] status code if an error occurred
486 * while reading gc.log
488 static int report_last_gc_error(void)
490 struct strbuf sb
= STRBUF_INIT
;
494 char *gc_log_path
= git_pathdup("gc.log");
496 if (stat(gc_log_path
, &st
)) {
500 ret
= die_message_errno(_("cannot stat '%s'"), gc_log_path
);
504 if (st
.st_mtime
< gc_log_expire_time
)
507 len
= strbuf_read_file(&sb
, gc_log_path
, 0);
509 ret
= die_message_errno(_("cannot read '%s'"), gc_log_path
);
512 * A previous gc failed. Report the error, and don't
513 * bother with an automatic gc run since it is likely
514 * to fail in the same way.
516 warning(_("The last gc run reported the following. "
517 "Please correct the root cause\n"
519 "Automatic cleanup will not be performed "
520 "until the file is removed.\n\n"
522 gc_log_path
, sb
.buf
);
531 static void gc_before_repack(void)
534 * We may be called twice, as both the pre- and
535 * post-daemonized phases will call us, but running these
536 * commands more than once is pointless and wasteful.
542 if (pack_refs
&& maintenance_task_pack_refs(NULL
))
543 die(FAILED_RUN
, "pack-refs");
546 struct child_process cmd
= CHILD_PROCESS_INIT
;
549 strvec_pushv(&cmd
.args
, reflog
.v
);
550 if (run_command(&cmd
))
551 die(FAILED_RUN
, reflog
.v
[0]);
555 int cmd_gc(int argc
, const char **argv
, const char *prefix
)
564 int keep_largest_pack
= -1;
566 struct child_process rerere_cmd
= CHILD_PROCESS_INIT
;
568 struct option builtin_gc_options
[] = {
569 OPT__QUIET(&quiet
, N_("suppress progress reporting")),
570 { OPTION_STRING
, 0, "prune", &prune_expire
, N_("date"),
571 N_("prune unreferenced objects"),
572 PARSE_OPT_OPTARG
, NULL
, (intptr_t)prune_expire
},
573 OPT_BOOL(0, "cruft", &cruft_packs
, N_("pack unreferenced objects separately")),
574 OPT_BOOL(0, "aggressive", &aggressive
, N_("be more thorough (increased runtime)")),
575 OPT_BOOL_F(0, "auto", &auto_gc
, N_("enable auto-gc mode"),
576 PARSE_OPT_NOCOMPLETE
),
577 OPT_BOOL_F(0, "force", &force
,
578 N_("force running gc even if there may be another gc running"),
579 PARSE_OPT_NOCOMPLETE
),
580 OPT_BOOL(0, "keep-largest-pack", &keep_largest_pack
,
581 N_("repack all other packs except the largest pack")),
585 if (argc
== 2 && !strcmp(argv
[1], "-h"))
586 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
588 strvec_pushl(&reflog
, "reflog", "expire", "--all", NULL
);
589 strvec_pushl(&repack
, "repack", "-d", "-l", NULL
);
590 strvec_pushl(&prune
, "prune", "--expire", NULL
);
591 strvec_pushl(&prune_worktrees
, "worktree", "prune", "--expire", NULL
);
592 strvec_pushl(&rerere
, "rerere", "gc", NULL
);
594 /* default expiry time, overwritten in gc_config */
596 if (parse_expiry_date(gc_log_expire
, &gc_log_expire_time
))
597 die(_("failed to parse gc.logExpiry value %s"), gc_log_expire
);
600 pack_refs
= !is_bare_repository();
602 argc
= parse_options(argc
, argv
, prefix
, builtin_gc_options
,
603 builtin_gc_usage
, 0);
605 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
607 if (prune_expire
&& parse_expiry_date(prune_expire
, &dummy
))
608 die(_("failed to parse prune expiry value %s"), prune_expire
);
610 prepare_repo_settings(the_repository
);
612 cruft_packs
= the_repository
->settings
.gc_cruft_packs
;
615 strvec_push(&repack
, "-f");
616 if (aggressive_depth
> 0)
617 strvec_pushf(&repack
, "--depth=%d", aggressive_depth
);
618 if (aggressive_window
> 0)
619 strvec_pushf(&repack
, "--window=%d", aggressive_window
);
622 strvec_push(&repack
, "-q");
626 * Auto-gc should be least intrusive as possible.
632 fprintf(stderr
, _("Auto packing the repository in background for optimum performance.\n"));
634 fprintf(stderr
, _("Auto packing the repository for optimum performance.\n"));
635 fprintf(stderr
, _("See \"git help gc\" for manual housekeeping.\n"));
638 int ret
= report_last_gc_error();
641 /* Last gc --auto failed. Skip this one. */
644 /* an I/O error occurred, already reported */
647 if (lock_repo_for_gc(force
, &pid
))
649 gc_before_repack(); /* dies on failure */
650 delete_tempfile(&pidfile
);
653 * failure to daemonize is ok, we'll continue
656 daemonized
= !daemonize();
659 struct string_list keep_pack
= STRING_LIST_INIT_NODUP
;
661 if (keep_largest_pack
!= -1) {
662 if (keep_largest_pack
)
663 find_base_packs(&keep_pack
, 0);
664 } else if (big_pack_threshold
) {
665 find_base_packs(&keep_pack
, big_pack_threshold
);
668 add_repack_all_option(&keep_pack
);
669 string_list_clear(&keep_pack
, 0);
672 name
= lock_repo_for_gc(force
, &pid
);
675 return 0; /* be quiet on --auto */
676 die(_("gc is already running on machine '%s' pid %"PRIuMAX
" (use --force if not)"),
677 name
, (uintmax_t)pid
);
681 hold_lock_file_for_update(&log_lock
,
684 dup2(get_lock_file_fd(&log_lock
), 2);
685 sigchain_push_common(process_log_file_on_signal
);
686 atexit(process_log_file_at_exit
);
691 if (!repository_format_precious_objects
) {
692 struct child_process repack_cmd
= CHILD_PROCESS_INIT
;
694 repack_cmd
.git_cmd
= 1;
695 repack_cmd
.close_object_store
= 1;
696 strvec_pushv(&repack_cmd
.args
, repack
.v
);
697 if (run_command(&repack_cmd
))
698 die(FAILED_RUN
, repack
.v
[0]);
701 struct child_process prune_cmd
= CHILD_PROCESS_INIT
;
703 /* run `git prune` even if using cruft packs */
704 strvec_push(&prune
, prune_expire
);
706 strvec_push(&prune
, "--no-progress");
707 if (has_promisor_remote())
709 "--exclude-promisor-objects");
710 prune_cmd
.git_cmd
= 1;
711 strvec_pushv(&prune_cmd
.args
, prune
.v
);
712 if (run_command(&prune_cmd
))
713 die(FAILED_RUN
, prune
.v
[0]);
717 if (prune_worktrees_expire
) {
718 struct child_process prune_worktrees_cmd
= CHILD_PROCESS_INIT
;
720 strvec_push(&prune_worktrees
, prune_worktrees_expire
);
721 prune_worktrees_cmd
.git_cmd
= 1;
722 strvec_pushv(&prune_worktrees_cmd
.args
, prune_worktrees
.v
);
723 if (run_command(&prune_worktrees_cmd
))
724 die(FAILED_RUN
, prune_worktrees
.v
[0]);
727 rerere_cmd
.git_cmd
= 1;
728 strvec_pushv(&rerere_cmd
.args
, rerere
.v
);
729 if (run_command(&rerere_cmd
))
730 die(FAILED_RUN
, rerere
.v
[0]);
732 report_garbage
= report_pack_garbage
;
733 reprepare_packed_git(the_repository
);
734 if (pack_garbage
.nr
> 0) {
735 close_object_store(the_repository
->objects
);
736 clean_pack_garbage();
739 if (the_repository
->settings
.gc_write_commit_graph
== 1)
740 write_commit_graph_reachable(the_repository
->objects
->odb
,
741 !quiet
&& !daemonized
? COMMIT_GRAPH_WRITE_PROGRESS
: 0,
744 if (auto_gc
&& too_many_loose_objects())
745 warning(_("There are too many unreachable loose objects; "
746 "run 'git prune' to remove them."));
749 unlink(git_path("gc.log"));
754 static const char *const builtin_maintenance_run_usage
[] = {
755 N_("git maintenance run [--auto] [--[no-]quiet] [--task=<task>] [--schedule]"),
759 enum schedule_priority
{
766 static enum schedule_priority
parse_schedule(const char *value
)
769 return SCHEDULE_NONE
;
770 if (!strcasecmp(value
, "hourly"))
771 return SCHEDULE_HOURLY
;
772 if (!strcasecmp(value
, "daily"))
773 return SCHEDULE_DAILY
;
774 if (!strcasecmp(value
, "weekly"))
775 return SCHEDULE_WEEKLY
;
776 return SCHEDULE_NONE
;
779 static int maintenance_opt_schedule(const struct option
*opt
, const char *arg
,
782 enum schedule_priority
*priority
= opt
->value
;
785 die(_("--no-schedule is not allowed"));
787 *priority
= parse_schedule(arg
);
790 die(_("unrecognized --schedule argument '%s'"), arg
);
795 struct maintenance_run_opts
{
798 enum schedule_priority schedule
;
801 /* Remember to update object flag allocation in object.h */
804 struct cg_auto_data
{
805 int num_not_in_graph
;
809 static int dfs_on_ref(const char *refname UNUSED
,
810 const struct object_id
*oid
,
814 struct cg_auto_data
*data
= (struct cg_auto_data
*)cb_data
;
816 struct object_id peeled
;
817 struct commit_list
*stack
= NULL
;
818 struct commit
*commit
;
820 if (!peel_iterated_oid(oid
, &peeled
))
822 if (oid_object_info(the_repository
, oid
, NULL
) != OBJ_COMMIT
)
825 commit
= lookup_commit(the_repository
, oid
);
828 if (parse_commit(commit
) ||
829 commit_graph_position(commit
) != COMMIT_NOT_FROM_GRAPH
)
832 data
->num_not_in_graph
++;
834 if (data
->num_not_in_graph
>= data
->limit
)
837 commit_list_append(commit
, &stack
);
839 while (!result
&& stack
) {
840 struct commit_list
*parent
;
842 commit
= pop_commit(&stack
);
844 for (parent
= commit
->parents
; parent
; parent
= parent
->next
) {
845 if (parse_commit(parent
->item
) ||
846 commit_graph_position(parent
->item
) != COMMIT_NOT_FROM_GRAPH
||
847 parent
->item
->object
.flags
& SEEN
)
850 parent
->item
->object
.flags
|= SEEN
;
851 data
->num_not_in_graph
++;
853 if (data
->num_not_in_graph
>= data
->limit
) {
858 commit_list_append(parent
->item
, &stack
);
862 free_commit_list(stack
);
866 static int should_write_commit_graph(void)
869 struct cg_auto_data data
;
871 data
.num_not_in_graph
= 0;
873 git_config_get_int("maintenance.commit-graph.auto",
881 result
= for_each_ref(dfs_on_ref
, &data
);
883 repo_clear_commit_marks(the_repository
, SEEN
);
888 static int run_write_commit_graph(struct maintenance_run_opts
*opts
)
890 struct child_process child
= CHILD_PROCESS_INIT
;
892 child
.git_cmd
= child
.close_object_store
= 1;
893 strvec_pushl(&child
.args
, "commit-graph", "write",
894 "--split", "--reachable", NULL
);
897 strvec_push(&child
.args
, "--no-progress");
899 return !!run_command(&child
);
902 static int maintenance_task_commit_graph(struct maintenance_run_opts
*opts
)
904 prepare_repo_settings(the_repository
);
905 if (!the_repository
->settings
.core_commit_graph
)
908 if (run_write_commit_graph(opts
)) {
909 error(_("failed to write commit-graph"));
916 static int fetch_remote(struct remote
*remote
, void *cbdata
)
918 struct maintenance_run_opts
*opts
= cbdata
;
919 struct child_process child
= CHILD_PROCESS_INIT
;
921 if (remote
->skip_default_update
)
925 strvec_pushl(&child
.args
, "fetch", remote
->name
,
926 "--prefetch", "--prune", "--no-tags",
927 "--no-write-fetch-head", "--recurse-submodules=no",
931 strvec_push(&child
.args
, "--quiet");
933 return !!run_command(&child
);
936 static int maintenance_task_prefetch(struct maintenance_run_opts
*opts
)
938 if (for_each_remote(fetch_remote
, opts
)) {
939 error(_("failed to prefetch remotes"));
946 static int maintenance_task_gc(struct maintenance_run_opts
*opts
)
948 struct child_process child
= CHILD_PROCESS_INIT
;
950 child
.git_cmd
= child
.close_object_store
= 1;
951 strvec_push(&child
.args
, "gc");
954 strvec_push(&child
.args
, "--auto");
956 strvec_push(&child
.args
, "--quiet");
958 strvec_push(&child
.args
, "--no-quiet");
960 return run_command(&child
);
963 static int prune_packed(struct maintenance_run_opts
*opts
)
965 struct child_process child
= CHILD_PROCESS_INIT
;
968 strvec_push(&child
.args
, "prune-packed");
971 strvec_push(&child
.args
, "--quiet");
973 return !!run_command(&child
);
976 struct write_loose_object_data
{
982 static int loose_object_auto_limit
= 100;
984 static int loose_object_count(const struct object_id
*oid UNUSED
,
985 const char *path UNUSED
,
988 int *count
= (int*)data
;
989 if (++(*count
) >= loose_object_auto_limit
)
994 static int loose_object_auto_condition(void)
998 git_config_get_int("maintenance.loose-objects.auto",
999 &loose_object_auto_limit
);
1001 if (!loose_object_auto_limit
)
1003 if (loose_object_auto_limit
< 0)
1006 return for_each_loose_file_in_objdir(the_repository
->objects
->odb
->path
,
1008 NULL
, NULL
, &count
);
1011 static int bail_on_loose(const struct object_id
*oid UNUSED
,
1012 const char *path UNUSED
,
1018 static int write_loose_object_to_stdin(const struct object_id
*oid
,
1019 const char *path UNUSED
,
1022 struct write_loose_object_data
*d
= (struct write_loose_object_data
*)data
;
1024 fprintf(d
->in
, "%s\n", oid_to_hex(oid
));
1026 return ++(d
->count
) > d
->batch_size
;
1029 static int pack_loose(struct maintenance_run_opts
*opts
)
1031 struct repository
*r
= the_repository
;
1033 struct write_loose_object_data data
;
1034 struct child_process pack_proc
= CHILD_PROCESS_INIT
;
1037 * Do not start pack-objects process
1038 * if there are no loose objects.
1040 if (!for_each_loose_file_in_objdir(r
->objects
->odb
->path
,
1045 pack_proc
.git_cmd
= 1;
1047 strvec_push(&pack_proc
.args
, "pack-objects");
1049 strvec_push(&pack_proc
.args
, "--quiet");
1050 strvec_pushf(&pack_proc
.args
, "%s/pack/loose", r
->objects
->odb
->path
);
1054 if (start_command(&pack_proc
)) {
1055 error(_("failed to start 'git pack-objects' process"));
1059 data
.in
= xfdopen(pack_proc
.in
, "w");
1061 data
.batch_size
= 50000;
1063 for_each_loose_file_in_objdir(r
->objects
->odb
->path
,
1064 write_loose_object_to_stdin
,
1071 if (finish_command(&pack_proc
)) {
1072 error(_("failed to finish 'git pack-objects' process"));
1079 static int maintenance_task_loose_objects(struct maintenance_run_opts
*opts
)
1081 return prune_packed(opts
) || pack_loose(opts
);
1084 static int incremental_repack_auto_condition(void)
1086 struct packed_git
*p
;
1087 int incremental_repack_auto_limit
= 10;
1090 prepare_repo_settings(the_repository
);
1091 if (!the_repository
->settings
.core_multi_pack_index
)
1094 git_config_get_int("maintenance.incremental-repack.auto",
1095 &incremental_repack_auto_limit
);
1097 if (!incremental_repack_auto_limit
)
1099 if (incremental_repack_auto_limit
< 0)
1102 for (p
= get_packed_git(the_repository
);
1103 count
< incremental_repack_auto_limit
&& p
;
1105 if (!p
->multi_pack_index
)
1109 return count
>= incremental_repack_auto_limit
;
1112 static int multi_pack_index_write(struct maintenance_run_opts
*opts
)
1114 struct child_process child
= CHILD_PROCESS_INIT
;
1117 strvec_pushl(&child
.args
, "multi-pack-index", "write", NULL
);
1120 strvec_push(&child
.args
, "--no-progress");
1122 if (run_command(&child
))
1123 return error(_("failed to write multi-pack-index"));
1128 static int multi_pack_index_expire(struct maintenance_run_opts
*opts
)
1130 struct child_process child
= CHILD_PROCESS_INIT
;
1132 child
.git_cmd
= child
.close_object_store
= 1;
1133 strvec_pushl(&child
.args
, "multi-pack-index", "expire", NULL
);
1136 strvec_push(&child
.args
, "--no-progress");
1138 if (run_command(&child
))
1139 return error(_("'git multi-pack-index expire' failed"));
1144 #define TWO_GIGABYTES (INT32_MAX)
1146 static off_t
get_auto_pack_size(void)
1149 * The "auto" value is special: we optimize for
1150 * one large pack-file (i.e. from a clone) and
1151 * expect the rest to be small and they can be
1154 * The strategy we select here is to select a
1155 * size that is one more than the second largest
1156 * pack-file. This ensures that we will repack
1157 * at least two packs if there are three or more
1161 off_t second_largest_size
= 0;
1163 struct packed_git
*p
;
1164 struct repository
*r
= the_repository
;
1166 reprepare_packed_git(r
);
1167 for (p
= get_all_packs(r
); p
; p
= p
->next
) {
1168 if (p
->pack_size
> max_size
) {
1169 second_largest_size
= max_size
;
1170 max_size
= p
->pack_size
;
1171 } else if (p
->pack_size
> second_largest_size
)
1172 second_largest_size
= p
->pack_size
;
1175 result_size
= second_largest_size
+ 1;
1177 /* But limit ourselves to a batch size of 2g */
1178 if (result_size
> TWO_GIGABYTES
)
1179 result_size
= TWO_GIGABYTES
;
1184 static int multi_pack_index_repack(struct maintenance_run_opts
*opts
)
1186 struct child_process child
= CHILD_PROCESS_INIT
;
1188 child
.git_cmd
= child
.close_object_store
= 1;
1189 strvec_pushl(&child
.args
, "multi-pack-index", "repack", NULL
);
1192 strvec_push(&child
.args
, "--no-progress");
1194 strvec_pushf(&child
.args
, "--batch-size=%"PRIuMAX
,
1195 (uintmax_t)get_auto_pack_size());
1197 if (run_command(&child
))
1198 return error(_("'git multi-pack-index repack' failed"));
1203 static int maintenance_task_incremental_repack(struct maintenance_run_opts
*opts
)
1205 prepare_repo_settings(the_repository
);
1206 if (!the_repository
->settings
.core_multi_pack_index
) {
1207 warning(_("skipping incremental-repack task because core.multiPackIndex is disabled"));
1211 if (multi_pack_index_write(opts
))
1213 if (multi_pack_index_expire(opts
))
1215 if (multi_pack_index_repack(opts
))
1220 typedef int maintenance_task_fn(struct maintenance_run_opts
*opts
);
1223 * An auto condition function returns 1 if the task should run
1224 * and 0 if the task should NOT run. See needs_to_gc() for an
1227 typedef int maintenance_auto_fn(void);
1229 struct maintenance_task
{
1231 maintenance_task_fn
*fn
;
1232 maintenance_auto_fn
*auto_condition
;
1235 enum schedule_priority schedule
;
1237 /* -1 if not selected. */
1241 enum maintenance_task_label
{
1244 TASK_INCREMENTAL_REPACK
,
1249 /* Leave as final value */
1253 static struct maintenance_task tasks
[] = {
1256 maintenance_task_prefetch
,
1258 [TASK_LOOSE_OBJECTS
] = {
1260 maintenance_task_loose_objects
,
1261 loose_object_auto_condition
,
1263 [TASK_INCREMENTAL_REPACK
] = {
1264 "incremental-repack",
1265 maintenance_task_incremental_repack
,
1266 incremental_repack_auto_condition
,
1270 maintenance_task_gc
,
1274 [TASK_COMMIT_GRAPH
] = {
1276 maintenance_task_commit_graph
,
1277 should_write_commit_graph
,
1279 [TASK_PACK_REFS
] = {
1281 maintenance_task_pack_refs
,
1286 static int compare_tasks_by_selection(const void *a_
, const void *b_
)
1288 const struct maintenance_task
*a
= a_
;
1289 const struct maintenance_task
*b
= b_
;
1291 return b
->selected_order
- a
->selected_order
;
1294 static int maintenance_run_tasks(struct maintenance_run_opts
*opts
)
1296 int i
, found_selected
= 0;
1298 struct lock_file lk
;
1299 struct repository
*r
= the_repository
;
1300 char *lock_path
= xstrfmt("%s/maintenance", r
->objects
->odb
->path
);
1302 if (hold_lock_file_for_update(&lk
, lock_path
, LOCK_NO_DEREF
) < 0) {
1304 * Another maintenance command is running.
1306 * If --auto was provided, then it is likely due to a
1307 * recursive process stack. Do not report an error in
1310 if (!opts
->auto_flag
&& !opts
->quiet
)
1311 warning(_("lock file '%s' exists, skipping maintenance"),
1318 for (i
= 0; !found_selected
&& i
< TASK__COUNT
; i
++)
1319 found_selected
= tasks
[i
].selected_order
>= 0;
1322 QSORT(tasks
, TASK__COUNT
, compare_tasks_by_selection
);
1324 for (i
= 0; i
< TASK__COUNT
; i
++) {
1325 if (found_selected
&& tasks
[i
].selected_order
< 0)
1328 if (!found_selected
&& !tasks
[i
].enabled
)
1331 if (opts
->auto_flag
&&
1332 (!tasks
[i
].auto_condition
||
1333 !tasks
[i
].auto_condition()))
1336 if (opts
->schedule
&& tasks
[i
].schedule
< opts
->schedule
)
1339 trace2_region_enter("maintenance", tasks
[i
].name
, r
);
1340 if (tasks
[i
].fn(opts
)) {
1341 error(_("task '%s' failed"), tasks
[i
].name
);
1344 trace2_region_leave("maintenance", tasks
[i
].name
, r
);
1347 rollback_lock_file(&lk
);
1351 static void initialize_maintenance_strategy(void)
1355 if (git_config_get_string("maintenance.strategy", &config_str
))
1358 if (!strcasecmp(config_str
, "incremental")) {
1359 tasks
[TASK_GC
].schedule
= SCHEDULE_NONE
;
1360 tasks
[TASK_COMMIT_GRAPH
].enabled
= 1;
1361 tasks
[TASK_COMMIT_GRAPH
].schedule
= SCHEDULE_HOURLY
;
1362 tasks
[TASK_PREFETCH
].enabled
= 1;
1363 tasks
[TASK_PREFETCH
].schedule
= SCHEDULE_HOURLY
;
1364 tasks
[TASK_INCREMENTAL_REPACK
].enabled
= 1;
1365 tasks
[TASK_INCREMENTAL_REPACK
].schedule
= SCHEDULE_DAILY
;
1366 tasks
[TASK_LOOSE_OBJECTS
].enabled
= 1;
1367 tasks
[TASK_LOOSE_OBJECTS
].schedule
= SCHEDULE_DAILY
;
1368 tasks
[TASK_PACK_REFS
].enabled
= 1;
1369 tasks
[TASK_PACK_REFS
].schedule
= SCHEDULE_WEEKLY
;
1373 static void initialize_task_config(int schedule
)
1376 struct strbuf config_name
= STRBUF_INIT
;
1380 initialize_maintenance_strategy();
1382 for (i
= 0; i
< TASK__COUNT
; i
++) {
1386 strbuf_reset(&config_name
);
1387 strbuf_addf(&config_name
, "maintenance.%s.enabled",
1390 if (!git_config_get_bool(config_name
.buf
, &config_value
))
1391 tasks
[i
].enabled
= config_value
;
1393 strbuf_reset(&config_name
);
1394 strbuf_addf(&config_name
, "maintenance.%s.schedule",
1397 if (!git_config_get_string(config_name
.buf
, &config_str
)) {
1398 tasks
[i
].schedule
= parse_schedule(config_str
);
1403 strbuf_release(&config_name
);
1406 static int task_option_parse(const struct option
*opt
,
1407 const char *arg
, int unset
)
1409 int i
, num_selected
= 0;
1410 struct maintenance_task
*task
= NULL
;
1412 BUG_ON_OPT_NEG(unset
);
1414 for (i
= 0; i
< TASK__COUNT
; i
++) {
1415 if (tasks
[i
].selected_order
>= 0)
1417 if (!strcasecmp(tasks
[i
].name
, arg
)) {
1423 error(_("'%s' is not a valid task"), arg
);
1427 if (task
->selected_order
>= 0) {
1428 error(_("task '%s' cannot be selected multiple times"), arg
);
1432 task
->selected_order
= num_selected
+ 1;
1437 static int maintenance_run(int argc
, const char **argv
, const char *prefix
)
1440 struct maintenance_run_opts opts
;
1441 struct option builtin_maintenance_run_options
[] = {
1442 OPT_BOOL(0, "auto", &opts
.auto_flag
,
1443 N_("run tasks based on the state of the repository")),
1444 OPT_CALLBACK(0, "schedule", &opts
.schedule
, N_("frequency"),
1445 N_("run tasks based on frequency"),
1446 maintenance_opt_schedule
),
1447 OPT_BOOL(0, "quiet", &opts
.quiet
,
1448 N_("do not report progress or other information over stderr")),
1449 OPT_CALLBACK_F(0, "task", NULL
, N_("task"),
1450 N_("run a specific task"),
1451 PARSE_OPT_NONEG
, task_option_parse
),
1454 memset(&opts
, 0, sizeof(opts
));
1456 opts
.quiet
= !isatty(2);
1458 for (i
= 0; i
< TASK__COUNT
; i
++)
1459 tasks
[i
].selected_order
= -1;
1461 argc
= parse_options(argc
, argv
, prefix
,
1462 builtin_maintenance_run_options
,
1463 builtin_maintenance_run_usage
,
1464 PARSE_OPT_STOP_AT_NON_OPTION
);
1466 if (opts
.auto_flag
&& opts
.schedule
)
1467 die(_("use at most one of --auto and --schedule=<frequency>"));
1469 initialize_task_config(opts
.schedule
);
1472 usage_with_options(builtin_maintenance_run_usage
,
1473 builtin_maintenance_run_options
);
1474 return maintenance_run_tasks(&opts
);
1477 static char *get_maintpath(void)
1479 struct strbuf sb
= STRBUF_INIT
;
1480 const char *p
= the_repository
->worktree
?
1481 the_repository
->worktree
: the_repository
->gitdir
;
1483 strbuf_realpath(&sb
, p
, 1);
1484 return strbuf_detach(&sb
, NULL
);
1487 static char const * const builtin_maintenance_register_usage
[] = {
1488 "git maintenance register [--config-file <path>]",
1492 static int maintenance_register(int argc
, const char **argv
, const char *prefix
)
1494 char *config_file
= NULL
;
1495 struct option options
[] = {
1496 OPT_STRING(0, "config-file", &config_file
, N_("file"), N_("use given config file")),
1500 const char *key
= "maintenance.repo";
1502 char *maintpath
= get_maintpath();
1503 struct string_list_item
*item
;
1504 const struct string_list
*list
;
1506 argc
= parse_options(argc
, argv
, prefix
, options
,
1507 builtin_maintenance_register_usage
, 0);
1509 usage_with_options(builtin_maintenance_register_usage
,
1512 /* Disable foreground maintenance */
1513 git_config_set("maintenance.auto", "false");
1515 /* Set maintenance strategy, if unset */
1516 if (!git_config_get_string("maintenance.strategy", &config_value
))
1519 git_config_set("maintenance.strategy", "incremental");
1521 list
= git_config_get_value_multi(key
);
1523 for_each_string_list_item(item
, list
) {
1524 if (!strcmp(maintpath
, item
->string
)) {
1533 char *user_config
= NULL
, *xdg_config
= NULL
;
1536 git_global_config(&user_config
, &xdg_config
);
1537 config_file
= user_config
;
1539 die(_("$HOME not set"));
1541 rc
= git_config_set_multivar_in_file_gently(
1542 config_file
, "maintenance.repo", maintpath
,
1543 CONFIG_REGEX_NONE
, 0);
1548 die(_("unable to add '%s' value of '%s'"),
1556 static char const * const builtin_maintenance_unregister_usage
[] = {
1557 "git maintenance unregister [--config-file <path>] [--force]",
1561 static int maintenance_unregister(int argc
, const char **argv
, const char *prefix
)
1564 char *config_file
= NULL
;
1565 struct option options
[] = {
1566 OPT_STRING(0, "config-file", &config_file
, N_("file"), N_("use given config file")),
1568 N_("return success even if repository was not registered"),
1569 PARSE_OPT_NOCOMPLETE
),
1572 const char *key
= "maintenance.repo";
1573 char *maintpath
= get_maintpath();
1575 struct string_list_item
*item
;
1576 const struct string_list
*list
;
1577 struct config_set cs
= { { 0 } };
1579 argc
= parse_options(argc
, argv
, prefix
, options
,
1580 builtin_maintenance_unregister_usage
, 0);
1582 usage_with_options(builtin_maintenance_unregister_usage
,
1586 git_configset_init(&cs
);
1587 git_configset_add_file(&cs
, config_file
);
1588 list
= git_configset_get_value_multi(&cs
, key
);
1590 list
= git_config_get_value_multi(key
);
1593 for_each_string_list_item(item
, list
) {
1594 if (!strcmp(maintpath
, item
->string
)) {
1603 char *user_config
= NULL
, *xdg_config
= NULL
;
1605 git_global_config(&user_config
, &xdg_config
);
1606 config_file
= user_config
;
1608 die(_("$HOME not set"));
1610 rc
= git_config_set_multivar_in_file_gently(
1611 config_file
, key
, NULL
, maintpath
,
1612 CONFIG_FLAGS_MULTI_REPLACE
| CONFIG_FLAGS_FIXED_VALUE
);
1617 (!force
|| rc
== CONFIG_NOTHING_SET
))
1618 die(_("unable to unset '%s' value of '%s'"),
1620 } else if (!force
) {
1621 die(_("repository '%s' is not registered"), maintpath
);
1624 git_configset_clear(&cs
);
1629 static const char *get_frequency(enum schedule_priority schedule
)
1632 case SCHEDULE_HOURLY
:
1634 case SCHEDULE_DAILY
:
1636 case SCHEDULE_WEEKLY
:
1639 BUG("invalid schedule %d", schedule
);
1644 * get_schedule_cmd` reads the GIT_TEST_MAINT_SCHEDULER environment variable
1645 * to mock the schedulers that `git maintenance start` rely on.
1647 * For test purpose, GIT_TEST_MAINT_SCHEDULER can be set to a comma-separated
1648 * list of colon-separated key/value pairs where each pair contains a scheduler
1649 * and its corresponding mock.
1651 * * If $GIT_TEST_MAINT_SCHEDULER is not set, return false and leave the
1652 * arguments unmodified.
1654 * * If $GIT_TEST_MAINT_SCHEDULER is set, return true.
1655 * In this case, the *cmd value is read as input.
1657 * * if the input value *cmd is the key of one of the comma-separated list
1658 * item, then *is_available is set to true and *cmd is modified and becomes
1661 * * if the input value *cmd isn’t the key of any of the comma-separated list
1662 * item, then *is_available is set to false.
1665 * GIT_TEST_MAINT_SCHEDULER not set
1666 * +-------+-------------------------------------------------+
1667 * | Input | Output |
1668 * | *cmd | return code | *cmd | *is_available |
1669 * +-------+-------------+-------------------+---------------+
1670 * | "foo" | false | "foo" (unchanged) | (unchanged) |
1671 * +-------+-------------+-------------------+---------------+
1673 * GIT_TEST_MAINT_SCHEDULER set to “foo:./mock_foo.sh,bar:./mock_bar.sh”
1674 * +-------+-------------------------------------------------+
1675 * | Input | Output |
1676 * | *cmd | return code | *cmd | *is_available |
1677 * +-------+-------------+-------------------+---------------+
1678 * | "foo" | true | "./mock.foo.sh" | true |
1679 * | "qux" | true | "qux" (unchanged) | false |
1680 * +-------+-------------+-------------------+---------------+
1682 static int get_schedule_cmd(const char **cmd
, int *is_available
)
1684 char *testing
= xstrdup_or_null(getenv("GIT_TEST_MAINT_SCHEDULER"));
1685 struct string_list_item
*item
;
1686 struct string_list list
= STRING_LIST_INIT_NODUP
;
1694 string_list_split_in_place(&list
, testing
, ',', -1);
1695 for_each_string_list_item(item
, &list
) {
1696 struct string_list pair
= STRING_LIST_INIT_NODUP
;
1698 if (string_list_split_in_place(&pair
, item
->string
, ':', 2) != 2)
1701 if (!strcmp(*cmd
, pair
.items
[0].string
)) {
1702 *cmd
= pair
.items
[1].string
;
1705 string_list_clear(&list
, 0);
1711 string_list_clear(&list
, 0);
1716 static int is_launchctl_available(void)
1718 const char *cmd
= "launchctl";
1720 if (get_schedule_cmd(&cmd
, &is_available
))
1721 return is_available
;
1730 static char *launchctl_service_name(const char *frequency
)
1732 struct strbuf label
= STRBUF_INIT
;
1733 strbuf_addf(&label
, "org.git-scm.git.%s", frequency
);
1734 return strbuf_detach(&label
, NULL
);
1737 static char *launchctl_service_filename(const char *name
)
1740 struct strbuf filename
= STRBUF_INIT
;
1741 strbuf_addf(&filename
, "~/Library/LaunchAgents/%s.plist", name
);
1743 expanded
= interpolate_path(filename
.buf
, 1);
1745 die(_("failed to expand path '%s'"), filename
.buf
);
1747 strbuf_release(&filename
);
1751 static char *launchctl_get_uid(void)
1753 return xstrfmt("gui/%d", getuid());
1756 static int launchctl_boot_plist(int enable
, const char *filename
)
1758 const char *cmd
= "launchctl";
1760 struct child_process child
= CHILD_PROCESS_INIT
;
1761 char *uid
= launchctl_get_uid();
1763 get_schedule_cmd(&cmd
, NULL
);
1764 strvec_split(&child
.args
, cmd
);
1765 strvec_pushl(&child
.args
, enable
? "bootstrap" : "bootout", uid
,
1768 child
.no_stderr
= 1;
1769 child
.no_stdout
= 1;
1771 if (start_command(&child
))
1772 die(_("failed to start launchctl"));
1774 result
= finish_command(&child
);
1780 static int launchctl_remove_plist(enum schedule_priority schedule
)
1782 const char *frequency
= get_frequency(schedule
);
1783 char *name
= launchctl_service_name(frequency
);
1784 char *filename
= launchctl_service_filename(name
);
1785 int result
= launchctl_boot_plist(0, filename
);
1792 static int launchctl_remove_plists(void)
1794 return launchctl_remove_plist(SCHEDULE_HOURLY
) ||
1795 launchctl_remove_plist(SCHEDULE_DAILY
) ||
1796 launchctl_remove_plist(SCHEDULE_WEEKLY
);
1799 static int launchctl_list_contains_plist(const char *name
, const char *cmd
)
1801 struct child_process child
= CHILD_PROCESS_INIT
;
1803 strvec_split(&child
.args
, cmd
);
1804 strvec_pushl(&child
.args
, "list", name
, NULL
);
1806 child
.no_stderr
= 1;
1807 child
.no_stdout
= 1;
1809 if (start_command(&child
))
1810 die(_("failed to start launchctl"));
1812 /* Returns failure if 'name' doesn't exist. */
1813 return !finish_command(&child
);
1816 static int launchctl_schedule_plist(const char *exec_path
, enum schedule_priority schedule
)
1819 const char *preamble
, *repeat
;
1820 const char *frequency
= get_frequency(schedule
);
1821 char *name
= launchctl_service_name(frequency
);
1822 char *filename
= launchctl_service_filename(name
);
1823 struct lock_file lk
= LOCK_INIT
;
1824 static unsigned long lock_file_timeout_ms
= ULONG_MAX
;
1825 struct strbuf plist
= STRBUF_INIT
, plist2
= STRBUF_INIT
;
1827 const char *cmd
= "launchctl";
1829 get_schedule_cmd(&cmd
, NULL
);
1830 preamble
= "<?xml version=\"1.0\"?>\n"
1831 "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
1832 "<plist version=\"1.0\">"
1834 "<key>Label</key><string>%s</string>\n"
1835 "<key>ProgramArguments</key>\n"
1837 "<string>%s/git</string>\n"
1838 "<string>--exec-path=%s</string>\n"
1839 "<string>for-each-repo</string>\n"
1840 "<string>--config=maintenance.repo</string>\n"
1841 "<string>maintenance</string>\n"
1842 "<string>run</string>\n"
1843 "<string>--schedule=%s</string>\n"
1845 "<key>StartCalendarInterval</key>\n"
1847 strbuf_addf(&plist
, preamble
, name
, exec_path
, exec_path
, frequency
);
1850 case SCHEDULE_HOURLY
:
1852 "<key>Hour</key><integer>%d</integer>\n"
1853 "<key>Minute</key><integer>0</integer>\n"
1855 for (i
= 1; i
<= 23; i
++)
1856 strbuf_addf(&plist
, repeat
, i
);
1859 case SCHEDULE_DAILY
:
1861 "<key>Day</key><integer>%d</integer>\n"
1862 "<key>Hour</key><integer>0</integer>\n"
1863 "<key>Minute</key><integer>0</integer>\n"
1865 for (i
= 1; i
<= 6; i
++)
1866 strbuf_addf(&plist
, repeat
, i
);
1869 case SCHEDULE_WEEKLY
:
1870 strbuf_addstr(&plist
,
1872 "<key>Day</key><integer>0</integer>\n"
1873 "<key>Hour</key><integer>0</integer>\n"
1874 "<key>Minute</key><integer>0</integer>\n"
1882 strbuf_addstr(&plist
, "</array>\n</dict>\n</plist>\n");
1884 if (safe_create_leading_directories(filename
))
1885 die(_("failed to create directories for '%s'"), filename
);
1887 if ((long)lock_file_timeout_ms
< 0 &&
1888 git_config_get_ulong("gc.launchctlplistlocktimeoutms",
1889 &lock_file_timeout_ms
))
1890 lock_file_timeout_ms
= 150;
1892 fd
= hold_lock_file_for_update_timeout(&lk
, filename
, LOCK_DIE_ON_ERROR
,
1893 lock_file_timeout_ms
);
1896 * Does this file already exist? With the intended contents? Is it
1897 * registered already? Then it does not need to be re-registered.
1899 if (!stat(filename
, &st
) && st
.st_size
== plist
.len
&&
1900 strbuf_read_file(&plist2
, filename
, plist
.len
) == plist
.len
&&
1901 !strbuf_cmp(&plist
, &plist2
) &&
1902 launchctl_list_contains_plist(name
, cmd
))
1903 rollback_lock_file(&lk
);
1905 if (write_in_full(fd
, plist
.buf
, plist
.len
) < 0 ||
1906 commit_lock_file(&lk
))
1907 die_errno(_("could not write '%s'"), filename
);
1909 /* bootout might fail if not already running, so ignore */
1910 launchctl_boot_plist(0, filename
);
1911 if (launchctl_boot_plist(1, filename
))
1912 die(_("failed to bootstrap service %s"), filename
);
1917 strbuf_release(&plist
);
1918 strbuf_release(&plist2
);
1922 static int launchctl_add_plists(void)
1924 const char *exec_path
= git_exec_path();
1926 return launchctl_schedule_plist(exec_path
, SCHEDULE_HOURLY
) ||
1927 launchctl_schedule_plist(exec_path
, SCHEDULE_DAILY
) ||
1928 launchctl_schedule_plist(exec_path
, SCHEDULE_WEEKLY
);
1931 static int launchctl_update_schedule(int run_maintenance
, int fd
)
1933 if (run_maintenance
)
1934 return launchctl_add_plists();
1936 return launchctl_remove_plists();
1939 static int is_schtasks_available(void)
1941 const char *cmd
= "schtasks";
1943 if (get_schedule_cmd(&cmd
, &is_available
))
1944 return is_available
;
1946 #ifdef GIT_WINDOWS_NATIVE
1953 static char *schtasks_task_name(const char *frequency
)
1955 struct strbuf label
= STRBUF_INIT
;
1956 strbuf_addf(&label
, "Git Maintenance (%s)", frequency
);
1957 return strbuf_detach(&label
, NULL
);
1960 static int schtasks_remove_task(enum schedule_priority schedule
)
1962 const char *cmd
= "schtasks";
1963 struct child_process child
= CHILD_PROCESS_INIT
;
1964 const char *frequency
= get_frequency(schedule
);
1965 char *name
= schtasks_task_name(frequency
);
1967 get_schedule_cmd(&cmd
, NULL
);
1968 strvec_split(&child
.args
, cmd
);
1969 strvec_pushl(&child
.args
, "/delete", "/tn", name
, "/f", NULL
);
1972 return run_command(&child
);
1975 static int schtasks_remove_tasks(void)
1977 return schtasks_remove_task(SCHEDULE_HOURLY
) ||
1978 schtasks_remove_task(SCHEDULE_DAILY
) ||
1979 schtasks_remove_task(SCHEDULE_WEEKLY
);
1982 static int schtasks_schedule_task(const char *exec_path
, enum schedule_priority schedule
)
1984 const char *cmd
= "schtasks";
1986 struct child_process child
= CHILD_PROCESS_INIT
;
1988 struct tempfile
*tfile
;
1989 const char *frequency
= get_frequency(schedule
);
1990 char *name
= schtasks_task_name(frequency
);
1991 struct strbuf tfilename
= STRBUF_INIT
;
1993 get_schedule_cmd(&cmd
, NULL
);
1995 strbuf_addf(&tfilename
, "%s/schedule_%s_XXXXXX",
1996 get_git_common_dir(), frequency
);
1997 tfile
= xmks_tempfile(tfilename
.buf
);
1998 strbuf_release(&tfilename
);
2000 if (!fdopen_tempfile(tfile
, "w"))
2001 die(_("failed to create temp xml file"));
2003 xml
= "<?xml version=\"1.0\" ?>\n"
2004 "<Task version=\"1.4\" xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n"
2006 "<CalendarTrigger>\n";
2007 fputs(xml
, tfile
->fp
);
2010 case SCHEDULE_HOURLY
:
2012 "<StartBoundary>2020-01-01T01:00:00</StartBoundary>\n"
2013 "<Enabled>true</Enabled>\n"
2015 "<DaysInterval>1</DaysInterval>\n"
2016 "</ScheduleByDay>\n"
2018 "<Interval>PT1H</Interval>\n"
2019 "<Duration>PT23H</Duration>\n"
2020 "<StopAtDurationEnd>false</StopAtDurationEnd>\n"
2024 case SCHEDULE_DAILY
:
2026 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2027 "<Enabled>true</Enabled>\n"
2028 "<ScheduleByWeek>\n"
2037 "<WeeksInterval>1</WeeksInterval>\n"
2038 "</ScheduleByWeek>\n");
2041 case SCHEDULE_WEEKLY
:
2043 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2044 "<Enabled>true</Enabled>\n"
2045 "<ScheduleByWeek>\n"
2049 "<WeeksInterval>1</WeeksInterval>\n"
2050 "</ScheduleByWeek>\n");
2057 xml
= "</CalendarTrigger>\n"
2060 "<Principal id=\"Author\">\n"
2061 "<LogonType>InteractiveToken</LogonType>\n"
2062 "<RunLevel>LeastPrivilege</RunLevel>\n"
2066 "<MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>\n"
2067 "<Enabled>true</Enabled>\n"
2068 "<Hidden>true</Hidden>\n"
2069 "<UseUnifiedSchedulingEngine>true</UseUnifiedSchedulingEngine>\n"
2070 "<WakeToRun>false</WakeToRun>\n"
2071 "<ExecutionTimeLimit>PT72H</ExecutionTimeLimit>\n"
2072 "<Priority>7</Priority>\n"
2074 "<Actions Context=\"Author\">\n"
2076 "<Command>\"%s\\git.exe\"</Command>\n"
2077 "<Arguments>--exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%s</Arguments>\n"
2081 fprintf(tfile
->fp
, xml
, exec_path
, exec_path
, frequency
);
2082 strvec_split(&child
.args
, cmd
);
2083 strvec_pushl(&child
.args
, "/create", "/tn", name
, "/f", "/xml",
2084 get_tempfile_path(tfile
), NULL
);
2085 close_tempfile_gently(tfile
);
2087 child
.no_stdout
= 1;
2088 child
.no_stderr
= 1;
2090 if (start_command(&child
))
2091 die(_("failed to start schtasks"));
2092 result
= finish_command(&child
);
2094 delete_tempfile(&tfile
);
2099 static int schtasks_schedule_tasks(void)
2101 const char *exec_path
= git_exec_path();
2103 return schtasks_schedule_task(exec_path
, SCHEDULE_HOURLY
) ||
2104 schtasks_schedule_task(exec_path
, SCHEDULE_DAILY
) ||
2105 schtasks_schedule_task(exec_path
, SCHEDULE_WEEKLY
);
2108 static int schtasks_update_schedule(int run_maintenance
, int fd
)
2110 if (run_maintenance
)
2111 return schtasks_schedule_tasks();
2113 return schtasks_remove_tasks();
2117 static int check_crontab_process(const char *cmd
)
2119 struct child_process child
= CHILD_PROCESS_INIT
;
2121 strvec_split(&child
.args
, cmd
);
2122 strvec_push(&child
.args
, "-l");
2124 child
.no_stdout
= 1;
2125 child
.no_stderr
= 1;
2126 child
.silent_exec_failure
= 1;
2128 if (start_command(&child
))
2130 /* Ignore exit code, as an empty crontab will return error. */
2131 finish_command(&child
);
2135 static int is_crontab_available(void)
2137 const char *cmd
= "crontab";
2140 if (get_schedule_cmd(&cmd
, &is_available
))
2141 return is_available
;
2145 * macOS has cron, but it requires special permissions and will
2146 * create a UI alert when attempting to run this command.
2150 return check_crontab_process(cmd
);
2154 #define BEGIN_LINE "# BEGIN GIT MAINTENANCE SCHEDULE"
2155 #define END_LINE "# END GIT MAINTENANCE SCHEDULE"
2157 static int crontab_update_schedule(int run_maintenance
, int fd
)
2159 const char *cmd
= "crontab";
2161 int in_old_region
= 0;
2162 struct child_process crontab_list
= CHILD_PROCESS_INIT
;
2163 struct child_process crontab_edit
= CHILD_PROCESS_INIT
;
2164 FILE *cron_list
, *cron_in
;
2165 struct strbuf line
= STRBUF_INIT
;
2166 struct tempfile
*tmpedit
= NULL
;
2168 get_schedule_cmd(&cmd
, NULL
);
2169 strvec_split(&crontab_list
.args
, cmd
);
2170 strvec_push(&crontab_list
.args
, "-l");
2171 crontab_list
.in
= -1;
2172 crontab_list
.out
= dup(fd
);
2173 crontab_list
.git_cmd
= 0;
2175 if (start_command(&crontab_list
))
2176 return error(_("failed to run 'crontab -l'; your system might not support 'cron'"));
2178 /* Ignore exit code, as an empty crontab will return error. */
2179 finish_command(&crontab_list
);
2181 tmpedit
= mks_tempfile_t(".git_cron_edit_tmpXXXXXX");
2183 result
= error(_("failed to create crontab temporary file"));
2186 cron_in
= fdopen_tempfile(tmpedit
, "w");
2188 result
= error(_("failed to open temporary file"));
2193 * Read from the .lock file, filtering out the old
2194 * schedule while appending the new schedule.
2196 cron_list
= fdopen(fd
, "r");
2199 while (!strbuf_getline_lf(&line
, cron_list
)) {
2200 if (!in_old_region
&& !strcmp(line
.buf
, BEGIN_LINE
))
2202 else if (in_old_region
&& !strcmp(line
.buf
, END_LINE
))
2204 else if (!in_old_region
)
2205 fprintf(cron_in
, "%s\n", line
.buf
);
2207 strbuf_release(&line
);
2209 if (run_maintenance
) {
2210 struct strbuf line_format
= STRBUF_INIT
;
2211 const char *exec_path
= git_exec_path();
2213 fprintf(cron_in
, "%s\n", BEGIN_LINE
);
2215 "# The following schedule was created by Git\n");
2216 fprintf(cron_in
, "# Any edits made in this region might be\n");
2218 "# replaced in the future by a Git command.\n\n");
2220 strbuf_addf(&line_format
,
2221 "%%s %%s * * %%s \"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%s\n",
2222 exec_path
, exec_path
);
2223 fprintf(cron_in
, line_format
.buf
, "0", "1-23", "*", "hourly");
2224 fprintf(cron_in
, line_format
.buf
, "0", "0", "1-6", "daily");
2225 fprintf(cron_in
, line_format
.buf
, "0", "0", "0", "weekly");
2226 strbuf_release(&line_format
);
2228 fprintf(cron_in
, "\n%s\n", END_LINE
);
2233 strvec_split(&crontab_edit
.args
, cmd
);
2234 strvec_push(&crontab_edit
.args
, get_tempfile_path(tmpedit
));
2235 crontab_edit
.git_cmd
= 0;
2237 if (start_command(&crontab_edit
)) {
2238 result
= error(_("failed to run 'crontab'; your system might not support 'cron'"));
2242 if (finish_command(&crontab_edit
))
2243 result
= error(_("'crontab' died"));
2247 delete_tempfile(&tmpedit
);
2251 static int real_is_systemd_timer_available(void)
2253 struct child_process child
= CHILD_PROCESS_INIT
;
2255 strvec_pushl(&child
.args
, "systemctl", "--user", "list-timers", NULL
);
2257 child
.no_stdout
= 1;
2258 child
.no_stderr
= 1;
2259 child
.silent_exec_failure
= 1;
2261 if (start_command(&child
))
2263 if (finish_command(&child
))
2268 static int is_systemd_timer_available(void)
2270 const char *cmd
= "systemctl";
2273 if (get_schedule_cmd(&cmd
, &is_available
))
2274 return is_available
;
2276 return real_is_systemd_timer_available();
2279 static char *xdg_config_home_systemd(const char *filename
)
2281 return xdg_config_home_for("systemd/user", filename
);
2284 static int systemd_timer_enable_unit(int enable
,
2285 enum schedule_priority schedule
)
2287 const char *cmd
= "systemctl";
2288 struct child_process child
= CHILD_PROCESS_INIT
;
2289 const char *frequency
= get_frequency(schedule
);
2292 * Disabling the systemd unit while it is already disabled makes
2293 * systemctl print an error.
2294 * Let's ignore it since it means we already are in the expected state:
2295 * the unit is disabled.
2297 * On the other hand, enabling a systemd unit which is already enabled
2298 * produces no error.
2301 child
.no_stderr
= 1;
2303 get_schedule_cmd(&cmd
, NULL
);
2304 strvec_split(&child
.args
, cmd
);
2305 strvec_pushl(&child
.args
, "--user", enable
? "enable" : "disable",
2307 strvec_pushf(&child
.args
, "git-maintenance@%s.timer", frequency
);
2309 if (start_command(&child
))
2310 return error(_("failed to start systemctl"));
2311 if (finish_command(&child
))
2313 * Disabling an already disabled systemd unit makes
2315 * Let's ignore this failure.
2317 * Enabling an enabled systemd unit doesn't fail.
2320 return error(_("failed to run systemctl"));
2324 static int systemd_timer_delete_unit_templates(void)
2327 char *filename
= xdg_config_home_systemd("git-maintenance@.timer");
2328 if (unlink(filename
) && !is_missing_file_error(errno
))
2329 ret
= error_errno(_("failed to delete '%s'"), filename
);
2330 FREE_AND_NULL(filename
);
2332 filename
= xdg_config_home_systemd("git-maintenance@.service");
2333 if (unlink(filename
) && !is_missing_file_error(errno
))
2334 ret
= error_errno(_("failed to delete '%s'"), filename
);
2340 static int systemd_timer_delete_units(void)
2342 return systemd_timer_enable_unit(0, SCHEDULE_HOURLY
) ||
2343 systemd_timer_enable_unit(0, SCHEDULE_DAILY
) ||
2344 systemd_timer_enable_unit(0, SCHEDULE_WEEKLY
) ||
2345 systemd_timer_delete_unit_templates();
2348 static int systemd_timer_write_unit_templates(const char *exec_path
)
2354 filename
= xdg_config_home_systemd("git-maintenance@.timer");
2355 if (safe_create_leading_directories(filename
)) {
2356 error(_("failed to create directories for '%s'"), filename
);
2359 file
= fopen_or_warn(filename
, "w");
2363 unit
= "# This file was created and is maintained by Git.\n"
2364 "# Any edits made in this file might be replaced in the future\n"
2365 "# by a Git command.\n"
2368 "Description=Optimize Git repositories data\n"
2375 "WantedBy=timers.target\n";
2376 if (fputs(unit
, file
) == EOF
) {
2377 error(_("failed to write to '%s'"), filename
);
2381 if (fclose(file
) == EOF
) {
2382 error_errno(_("failed to flush '%s'"), filename
);
2387 filename
= xdg_config_home_systemd("git-maintenance@.service");
2388 file
= fopen_or_warn(filename
, "w");
2392 unit
= "# This file was created and is maintained by Git.\n"
2393 "# Any edits made in this file might be replaced in the future\n"
2394 "# by a Git command.\n"
2397 "Description=Optimize Git repositories data\n"
2401 "ExecStart=\"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%i\n"
2402 "LockPersonality=yes\n"
2403 "MemoryDenyWriteExecute=yes\n"
2404 "NoNewPrivileges=yes\n"
2405 "RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6\n"
2406 "RestrictNamespaces=yes\n"
2407 "RestrictRealtime=yes\n"
2408 "RestrictSUIDSGID=yes\n"
2409 "SystemCallArchitectures=native\n"
2410 "SystemCallFilter=@system-service\n";
2411 if (fprintf(file
, unit
, exec_path
, exec_path
) < 0) {
2412 error(_("failed to write to '%s'"), filename
);
2416 if (fclose(file
) == EOF
) {
2417 error_errno(_("failed to flush '%s'"), filename
);
2425 systemd_timer_delete_unit_templates();
2429 static int systemd_timer_setup_units(void)
2431 const char *exec_path
= git_exec_path();
2433 int ret
= systemd_timer_write_unit_templates(exec_path
) ||
2434 systemd_timer_enable_unit(1, SCHEDULE_HOURLY
) ||
2435 systemd_timer_enable_unit(1, SCHEDULE_DAILY
) ||
2436 systemd_timer_enable_unit(1, SCHEDULE_WEEKLY
);
2438 systemd_timer_delete_units();
2442 static int systemd_timer_update_schedule(int run_maintenance
, int fd
)
2444 if (run_maintenance
)
2445 return systemd_timer_setup_units();
2447 return systemd_timer_delete_units();
2451 SCHEDULER_INVALID
= -1,
2455 SCHEDULER_LAUNCHCTL
,
2459 static const struct {
2461 int (*is_available
)(void);
2462 int (*update_schedule
)(int run_maintenance
, int fd
);
2463 } scheduler_fn
[] = {
2464 [SCHEDULER_CRON
] = {
2466 .is_available
= is_crontab_available
,
2467 .update_schedule
= crontab_update_schedule
,
2469 [SCHEDULER_SYSTEMD
] = {
2470 .name
= "systemctl",
2471 .is_available
= is_systemd_timer_available
,
2472 .update_schedule
= systemd_timer_update_schedule
,
2474 [SCHEDULER_LAUNCHCTL
] = {
2475 .name
= "launchctl",
2476 .is_available
= is_launchctl_available
,
2477 .update_schedule
= launchctl_update_schedule
,
2479 [SCHEDULER_SCHTASKS
] = {
2481 .is_available
= is_schtasks_available
,
2482 .update_schedule
= schtasks_update_schedule
,
2486 static enum scheduler
parse_scheduler(const char *value
)
2489 return SCHEDULER_INVALID
;
2490 else if (!strcasecmp(value
, "auto"))
2491 return SCHEDULER_AUTO
;
2492 else if (!strcasecmp(value
, "cron") || !strcasecmp(value
, "crontab"))
2493 return SCHEDULER_CRON
;
2494 else if (!strcasecmp(value
, "systemd") ||
2495 !strcasecmp(value
, "systemd-timer"))
2496 return SCHEDULER_SYSTEMD
;
2497 else if (!strcasecmp(value
, "launchctl"))
2498 return SCHEDULER_LAUNCHCTL
;
2499 else if (!strcasecmp(value
, "schtasks"))
2500 return SCHEDULER_SCHTASKS
;
2502 return SCHEDULER_INVALID
;
2505 static int maintenance_opt_scheduler(const struct option
*opt
, const char *arg
,
2508 enum scheduler
*scheduler
= opt
->value
;
2510 BUG_ON_OPT_NEG(unset
);
2512 *scheduler
= parse_scheduler(arg
);
2513 if (*scheduler
== SCHEDULER_INVALID
)
2514 return error(_("unrecognized --scheduler argument '%s'"), arg
);
2518 struct maintenance_start_opts
{
2519 enum scheduler scheduler
;
2522 static enum scheduler
resolve_scheduler(enum scheduler scheduler
)
2524 if (scheduler
!= SCHEDULER_AUTO
)
2527 #if defined(__APPLE__)
2528 return SCHEDULER_LAUNCHCTL
;
2530 #elif defined(GIT_WINDOWS_NATIVE)
2531 return SCHEDULER_SCHTASKS
;
2533 #elif defined(__linux__)
2534 if (is_systemd_timer_available())
2535 return SCHEDULER_SYSTEMD
;
2536 else if (is_crontab_available())
2537 return SCHEDULER_CRON
;
2539 die(_("neither systemd timers nor crontab are available"));
2542 return SCHEDULER_CRON
;
2546 static void validate_scheduler(enum scheduler scheduler
)
2548 if (scheduler
== SCHEDULER_INVALID
)
2549 BUG("invalid scheduler");
2550 if (scheduler
== SCHEDULER_AUTO
)
2551 BUG("resolve_scheduler should have been called before");
2553 if (!scheduler_fn
[scheduler
].is_available())
2554 die(_("%s scheduler is not available"),
2555 scheduler_fn
[scheduler
].name
);
2558 static int update_background_schedule(const struct maintenance_start_opts
*opts
,
2563 struct lock_file lk
;
2564 char *lock_path
= xstrfmt("%s/schedule", the_repository
->objects
->odb
->path
);
2566 if (hold_lock_file_for_update(&lk
, lock_path
, LOCK_NO_DEREF
) < 0) {
2568 return error(_("another process is scheduling background maintenance"));
2571 for (i
= 1; i
< ARRAY_SIZE(scheduler_fn
); i
++) {
2572 if (enable
&& opts
->scheduler
== i
)
2574 if (!scheduler_fn
[i
].is_available())
2576 scheduler_fn
[i
].update_schedule(0, get_lock_file_fd(&lk
));
2580 result
= scheduler_fn
[opts
->scheduler
].update_schedule(
2581 1, get_lock_file_fd(&lk
));
2583 rollback_lock_file(&lk
);
2589 static const char *const builtin_maintenance_start_usage
[] = {
2590 N_("git maintenance start [--scheduler=<scheduler>]"),
2594 static int maintenance_start(int argc
, const char **argv
, const char *prefix
)
2596 struct maintenance_start_opts opts
= { 0 };
2597 struct option options
[] = {
2599 0, "scheduler", &opts
.scheduler
, N_("scheduler"),
2600 N_("scheduler to trigger git maintenance run"),
2601 PARSE_OPT_NONEG
, maintenance_opt_scheduler
),
2604 const char *register_args
[] = { "register", NULL
};
2606 argc
= parse_options(argc
, argv
, prefix
, options
,
2607 builtin_maintenance_start_usage
, 0);
2609 usage_with_options(builtin_maintenance_start_usage
, options
);
2611 opts
.scheduler
= resolve_scheduler(opts
.scheduler
);
2612 validate_scheduler(opts
.scheduler
);
2614 if (maintenance_register(ARRAY_SIZE(register_args
)-1, register_args
, NULL
))
2615 warning(_("failed to add repo to global config"));
2616 return update_background_schedule(&opts
, 1);
2619 static const char *const builtin_maintenance_stop_usage
[] = {
2620 "git maintenance stop",
2624 static int maintenance_stop(int argc
, const char **argv
, const char *prefix
)
2626 struct option options
[] = {
2629 argc
= parse_options(argc
, argv
, prefix
, options
,
2630 builtin_maintenance_stop_usage
, 0);
2632 usage_with_options(builtin_maintenance_stop_usage
, options
);
2633 return update_background_schedule(NULL
, 0);
2636 static const char * const builtin_maintenance_usage
[] = {
2637 N_("git maintenance <subcommand> [<options>]"),
2641 int cmd_maintenance(int argc
, const char **argv
, const char *prefix
)
2643 parse_opt_subcommand_fn
*fn
= NULL
;
2644 struct option builtin_maintenance_options
[] = {
2645 OPT_SUBCOMMAND("run", &fn
, maintenance_run
),
2646 OPT_SUBCOMMAND("start", &fn
, maintenance_start
),
2647 OPT_SUBCOMMAND("stop", &fn
, maintenance_stop
),
2648 OPT_SUBCOMMAND("register", &fn
, maintenance_register
),
2649 OPT_SUBCOMMAND("unregister", &fn
, maintenance_unregister
),
2653 argc
= parse_options(argc
, argv
, prefix
, builtin_maintenance_options
,
2654 builtin_maintenance_usage
, 0);
2655 return fn(argc
, argv
, prefix
);