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"
43 #define FAILED_RUN "failed to run %s"
45 static const char * const builtin_gc_usage
[] = {
46 N_("git gc [<options>]"),
50 static int pack_refs
= 1;
51 static int prune_reflogs
= 1;
52 static int cruft_packs
= -1;
53 static int aggressive_depth
= 50;
54 static int aggressive_window
= 250;
55 static int gc_auto_threshold
= 6700;
56 static int gc_auto_pack_limit
= 50;
57 static int detach_auto
= 1;
58 static timestamp_t gc_log_expire_time
;
59 static const char *gc_log_expire
= "1.day.ago";
60 static const char *prune_expire
= "2.weeks.ago";
61 static const char *prune_worktrees_expire
= "3.months.ago";
62 static unsigned long big_pack_threshold
;
63 static unsigned long max_delta_cache_size
= DEFAULT_DELTA_CACHE_SIZE
;
65 static struct strvec reflog
= STRVEC_INIT
;
66 static struct strvec repack
= STRVEC_INIT
;
67 static struct strvec prune
= STRVEC_INIT
;
68 static struct strvec prune_worktrees
= STRVEC_INIT
;
69 static struct strvec rerere
= STRVEC_INIT
;
71 static struct tempfile
*pidfile
;
72 static struct lock_file log_lock
;
74 static struct string_list pack_garbage
= STRING_LIST_INIT_DUP
;
76 static void clean_pack_garbage(void)
79 for (i
= 0; i
< pack_garbage
.nr
; i
++)
80 unlink_or_warn(pack_garbage
.items
[i
].string
);
81 string_list_clear(&pack_garbage
, 0);
84 static void report_pack_garbage(unsigned seen_bits
, const char *path
)
86 if (seen_bits
== PACKDIR_FILE_IDX
)
87 string_list_append(&pack_garbage
, path
);
90 static void process_log_file(void)
93 if (fstat(get_lock_file_fd(&log_lock
), &st
)) {
95 * Perhaps there was an i/o error or another
96 * unlikely situation. Try to make a note of
97 * this in gc.log along with any existing
100 int saved_errno
= errno
;
101 fprintf(stderr
, _("Failed to fstat %s: %s"),
102 get_lock_file_path(&log_lock
),
103 strerror(saved_errno
));
105 commit_lock_file(&log_lock
);
107 } else if (st
.st_size
) {
108 /* There was some error recorded in the lock file */
109 commit_lock_file(&log_lock
);
111 /* No error, clean up any old gc.log */
112 unlink(git_path("gc.log"));
113 rollback_lock_file(&log_lock
);
117 static void process_log_file_at_exit(void)
123 static void process_log_file_on_signal(int signo
)
130 static int gc_config_is_timestamp_never(const char *var
)
135 if (!git_config_get_value(var
, &value
) && value
) {
136 if (parse_expiry_date(value
, &expire
))
137 die(_("failed to parse '%s' value '%s'"), var
, value
);
143 static void gc_config(void)
147 if (!git_config_get_value("gc.packrefs", &value
)) {
148 if (value
&& !strcmp(value
, "notbare"))
151 pack_refs
= git_config_bool("gc.packrefs", value
);
154 if (gc_config_is_timestamp_never("gc.reflogexpire") &&
155 gc_config_is_timestamp_never("gc.reflogexpireunreachable"))
158 git_config_get_int("gc.aggressivewindow", &aggressive_window
);
159 git_config_get_int("gc.aggressivedepth", &aggressive_depth
);
160 git_config_get_int("gc.auto", &gc_auto_threshold
);
161 git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit
);
162 git_config_get_bool("gc.autodetach", &detach_auto
);
163 git_config_get_bool("gc.cruftpacks", &cruft_packs
);
164 git_config_get_expiry("gc.pruneexpire", &prune_expire
);
165 git_config_get_expiry("gc.worktreepruneexpire", &prune_worktrees_expire
);
166 git_config_get_expiry("gc.logexpiry", &gc_log_expire
);
168 git_config_get_ulong("gc.bigpackthreshold", &big_pack_threshold
);
169 git_config_get_ulong("pack.deltacachesize", &max_delta_cache_size
);
171 git_config(git_default_config
, NULL
);
174 struct maintenance_run_opts
;
175 static int maintenance_task_pack_refs(MAYBE_UNUSED
struct maintenance_run_opts
*opts
)
177 struct child_process cmd
= CHILD_PROCESS_INIT
;
180 strvec_pushl(&cmd
.args
, "pack-refs", "--all", "--prune", NULL
);
181 return run_command(&cmd
);
184 static int too_many_loose_objects(void)
187 * Quickly check if a "gc" is needed, by estimating how
188 * many loose objects there are. Because SHA-1 is evenly
189 * distributed, we can check only one and get a reasonable
197 const unsigned hexsz_loose
= the_hash_algo
->hexsz
- 2;
199 dir
= opendir(git_path("objects/17"));
203 auto_threshold
= DIV_ROUND_UP(gc_auto_threshold
, 256);
204 while ((ent
= readdir(dir
)) != NULL
) {
205 if (strspn(ent
->d_name
, "0123456789abcdef") != hexsz_loose
||
206 ent
->d_name
[hexsz_loose
] != '\0')
208 if (++num_loose
> auto_threshold
) {
217 static struct packed_git
*find_base_packs(struct string_list
*packs
,
220 struct packed_git
*p
, *base
= NULL
;
222 for (p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
226 if (p
->pack_size
>= limit
)
227 string_list_append(packs
, p
->pack_name
);
228 } else if (!base
|| base
->pack_size
< p
->pack_size
) {
234 string_list_append(packs
, base
->pack_name
);
239 static int too_many_packs(void)
241 struct packed_git
*p
;
244 if (gc_auto_pack_limit
<= 0)
247 for (cnt
= 0, p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
253 * Perhaps check the size of the pack and count only
254 * very small ones here?
258 return gc_auto_pack_limit
< cnt
;
261 static uint64_t total_ram(void)
263 #if defined(HAVE_SYSINFO)
268 #elif defined(HAVE_BSD_SYSCTL) && (defined(HW_MEMSIZE) || defined(HW_PHYSMEM))
269 int64_t physical_memory
;
274 # if defined(HW_MEMSIZE)
279 length
= sizeof(int64_t);
280 if (!sysctl(mib
, 2, &physical_memory
, &length
, NULL
, 0))
281 return physical_memory
;
282 #elif defined(GIT_WINDOWS_NATIVE)
283 MEMORYSTATUSEX memInfo
;
285 memInfo
.dwLength
= sizeof(MEMORYSTATUSEX
);
286 if (GlobalMemoryStatusEx(&memInfo
))
287 return memInfo
.ullTotalPhys
;
292 static uint64_t estimate_repack_memory(struct packed_git
*pack
)
294 unsigned long nr_objects
= repo_approximate_object_count(the_repository
);
295 size_t os_cache
, heap
;
297 if (!pack
|| !nr_objects
)
301 * First we have to scan through at least one pack.
302 * Assume enough room in OS file cache to keep the entire pack
303 * or we may accidentally evict data of other processes from
306 os_cache
= pack
->pack_size
+ pack
->index_size
;
307 /* then pack-objects needs lots more for book keeping */
308 heap
= sizeof(struct object_entry
) * nr_objects
;
310 * internal rev-list --all --objects takes up some memory too,
311 * let's say half of it is for blobs
313 heap
+= sizeof(struct blob
) * nr_objects
/ 2;
315 * and the other half is for trees (commits and tags are
316 * usually insignificant)
318 heap
+= sizeof(struct tree
) * nr_objects
/ 2;
319 /* and then obj_hash[], underestimated in fact */
320 heap
+= sizeof(struct object
*) * nr_objects
;
321 /* revindex is used also */
322 heap
+= (sizeof(off_t
) + sizeof(uint32_t)) * nr_objects
;
324 * read_sha1_file() (either at delta calculation phase, or
325 * writing phase) also fills up the delta base cache
327 heap
+= delta_base_cache_limit
;
328 /* and of course pack-objects has its own delta cache */
329 heap
+= max_delta_cache_size
;
331 return os_cache
+ heap
;
334 static int keep_one_pack(struct string_list_item
*item
, void *data UNUSED
)
336 strvec_pushf(&repack
, "--keep-pack=%s", basename(item
->string
));
340 static void add_repack_all_option(struct string_list
*keep_pack
)
342 if (prune_expire
&& !strcmp(prune_expire
, "now"))
343 strvec_push(&repack
, "-a");
344 else if (cruft_packs
) {
345 strvec_push(&repack
, "--cruft");
347 strvec_pushf(&repack
, "--cruft-expiration=%s", prune_expire
);
349 strvec_push(&repack
, "-A");
351 strvec_pushf(&repack
, "--unpack-unreachable=%s", prune_expire
);
355 for_each_string_list(keep_pack
, keep_one_pack
, NULL
);
358 static void add_repack_incremental_option(void)
360 strvec_push(&repack
, "--no-write-bitmap-index");
363 static int need_to_gc(void)
366 * Setting gc.auto to 0 or negative can disable the
369 if (gc_auto_threshold
<= 0)
373 * If there are too many loose objects, but not too many
374 * packs, we run "repack -d -l". If there are too many packs,
375 * we run "repack -A -d -l". Otherwise we tell the caller
378 if (too_many_packs()) {
379 struct string_list keep_pack
= STRING_LIST_INIT_NODUP
;
381 if (big_pack_threshold
) {
382 find_base_packs(&keep_pack
, big_pack_threshold
);
383 if (keep_pack
.nr
>= gc_auto_pack_limit
) {
384 big_pack_threshold
= 0;
385 string_list_clear(&keep_pack
, 0);
386 find_base_packs(&keep_pack
, 0);
389 struct packed_git
*p
= find_base_packs(&keep_pack
, 0);
390 uint64_t mem_have
, mem_want
;
392 mem_have
= total_ram();
393 mem_want
= estimate_repack_memory(p
);
396 * Only allow 1/2 of memory for pack-objects, leave
397 * the rest for the OS and other processes in the
400 if (!mem_have
|| mem_want
< mem_have
/ 2)
401 string_list_clear(&keep_pack
, 0);
404 add_repack_all_option(&keep_pack
);
405 string_list_clear(&keep_pack
, 0);
406 } else if (too_many_loose_objects())
407 add_repack_incremental_option();
411 if (run_hooks("pre-auto-gc"))
416 /* return NULL on success, else hostname running the gc */
417 static const char *lock_repo_for_gc(int force
, pid_t
* ret_pid
)
419 struct lock_file lock
= LOCK_INIT
;
420 char my_host
[HOST_NAME_MAX
+ 1];
421 struct strbuf sb
= STRBUF_INIT
;
428 if (is_tempfile_active(pidfile
))
432 if (xgethostname(my_host
, sizeof(my_host
)))
433 xsnprintf(my_host
, sizeof(my_host
), "unknown");
435 pidfile_path
= git_pathdup("gc.pid");
436 fd
= hold_lock_file_for_update(&lock
, pidfile_path
,
439 static char locking_host
[HOST_NAME_MAX
+ 1];
440 static char *scan_fmt
;
444 scan_fmt
= xstrfmt("%s %%%ds", "%"SCNuMAX
, HOST_NAME_MAX
);
445 fp
= fopen(pidfile_path
, "r");
446 memset(locking_host
, 0, sizeof(locking_host
));
449 !fstat(fileno(fp
), &st
) &&
451 * 12 hour limit is very generous as gc should
452 * never take that long. On the other hand we
453 * don't really need a strict limit here,
454 * running gc --auto one day late is not a big
455 * problem. --force can be used in manual gc
456 * after the user verifies that no gc is
459 time(NULL
) - st
.st_mtime
<= 12 * 3600 &&
460 fscanf(fp
, scan_fmt
, &pid
, locking_host
) == 2 &&
461 /* be gentle to concurrent "gc" on remote hosts */
462 (strcmp(locking_host
, my_host
) || !kill(pid
, 0) || errno
== EPERM
);
467 rollback_lock_file(&lock
);
474 strbuf_addf(&sb
, "%"PRIuMAX
" %s",
475 (uintmax_t) getpid(), my_host
);
476 write_in_full(fd
, sb
.buf
, sb
.len
);
478 commit_lock_file(&lock
);
479 pidfile
= register_tempfile(pidfile_path
);
485 * Returns 0 if there was no previous error and gc can proceed, 1 if
486 * gc should not proceed due to an error in the last run. Prints a
487 * message and returns with a non-[01] status code if an error occurred
488 * while reading gc.log
490 static int report_last_gc_error(void)
492 struct strbuf sb
= STRBUF_INIT
;
496 char *gc_log_path
= git_pathdup("gc.log");
498 if (stat(gc_log_path
, &st
)) {
502 ret
= die_message_errno(_("cannot stat '%s'"), gc_log_path
);
506 if (st
.st_mtime
< gc_log_expire_time
)
509 len
= strbuf_read_file(&sb
, gc_log_path
, 0);
511 ret
= die_message_errno(_("cannot read '%s'"), gc_log_path
);
514 * A previous gc failed. Report the error, and don't
515 * bother with an automatic gc run since it is likely
516 * to fail in the same way.
518 warning(_("The last gc run reported the following. "
519 "Please correct the root cause\n"
521 "Automatic cleanup will not be performed "
522 "until the file is removed.\n\n"
524 gc_log_path
, sb
.buf
);
533 static void gc_before_repack(void)
536 * We may be called twice, as both the pre- and
537 * post-daemonized phases will call us, but running these
538 * commands more than once is pointless and wasteful.
544 if (pack_refs
&& maintenance_task_pack_refs(NULL
))
545 die(FAILED_RUN
, "pack-refs");
548 struct child_process cmd
= CHILD_PROCESS_INIT
;
551 strvec_pushv(&cmd
.args
, reflog
.v
);
552 if (run_command(&cmd
))
553 die(FAILED_RUN
, reflog
.v
[0]);
557 int cmd_gc(int argc
, const char **argv
, const char *prefix
)
566 int keep_largest_pack
= -1;
568 struct child_process rerere_cmd
= CHILD_PROCESS_INIT
;
570 struct option builtin_gc_options
[] = {
571 OPT__QUIET(&quiet
, N_("suppress progress reporting")),
572 { OPTION_STRING
, 0, "prune", &prune_expire
, N_("date"),
573 N_("prune unreferenced objects"),
574 PARSE_OPT_OPTARG
, NULL
, (intptr_t)prune_expire
},
575 OPT_BOOL(0, "cruft", &cruft_packs
, N_("pack unreferenced objects separately")),
576 OPT_BOOL(0, "aggressive", &aggressive
, N_("be more thorough (increased runtime)")),
577 OPT_BOOL_F(0, "auto", &auto_gc
, N_("enable auto-gc mode"),
578 PARSE_OPT_NOCOMPLETE
),
579 OPT_BOOL_F(0, "force", &force
,
580 N_("force running gc even if there may be another gc running"),
581 PARSE_OPT_NOCOMPLETE
),
582 OPT_BOOL(0, "keep-largest-pack", &keep_largest_pack
,
583 N_("repack all other packs except the largest pack")),
587 if (argc
== 2 && !strcmp(argv
[1], "-h"))
588 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
590 strvec_pushl(&reflog
, "reflog", "expire", "--all", NULL
);
591 strvec_pushl(&repack
, "repack", "-d", "-l", NULL
);
592 strvec_pushl(&prune
, "prune", "--expire", NULL
);
593 strvec_pushl(&prune_worktrees
, "worktree", "prune", "--expire", NULL
);
594 strvec_pushl(&rerere
, "rerere", "gc", NULL
);
596 /* default expiry time, overwritten in gc_config */
598 if (parse_expiry_date(gc_log_expire
, &gc_log_expire_time
))
599 die(_("failed to parse gc.logExpiry value %s"), gc_log_expire
);
602 pack_refs
= !is_bare_repository();
604 argc
= parse_options(argc
, argv
, prefix
, builtin_gc_options
,
605 builtin_gc_usage
, 0);
607 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
609 if (prune_expire
&& parse_expiry_date(prune_expire
, &dummy
))
610 die(_("failed to parse prune expiry value %s"), prune_expire
);
612 prepare_repo_settings(the_repository
);
614 cruft_packs
= the_repository
->settings
.gc_cruft_packs
;
617 strvec_push(&repack
, "-f");
618 if (aggressive_depth
> 0)
619 strvec_pushf(&repack
, "--depth=%d", aggressive_depth
);
620 if (aggressive_window
> 0)
621 strvec_pushf(&repack
, "--window=%d", aggressive_window
);
624 strvec_push(&repack
, "-q");
628 * Auto-gc should be least intrusive as possible.
634 fprintf(stderr
, _("Auto packing the repository in background for optimum performance.\n"));
636 fprintf(stderr
, _("Auto packing the repository for optimum performance.\n"));
637 fprintf(stderr
, _("See \"git help gc\" for manual housekeeping.\n"));
640 int ret
= report_last_gc_error();
643 /* Last gc --auto failed. Skip this one. */
646 /* an I/O error occurred, already reported */
649 if (lock_repo_for_gc(force
, &pid
))
651 gc_before_repack(); /* dies on failure */
652 delete_tempfile(&pidfile
);
655 * failure to daemonize is ok, we'll continue
658 daemonized
= !daemonize();
661 struct string_list keep_pack
= STRING_LIST_INIT_NODUP
;
663 if (keep_largest_pack
!= -1) {
664 if (keep_largest_pack
)
665 find_base_packs(&keep_pack
, 0);
666 } else if (big_pack_threshold
) {
667 find_base_packs(&keep_pack
, big_pack_threshold
);
670 add_repack_all_option(&keep_pack
);
671 string_list_clear(&keep_pack
, 0);
674 name
= lock_repo_for_gc(force
, &pid
);
677 return 0; /* be quiet on --auto */
678 die(_("gc is already running on machine '%s' pid %"PRIuMAX
" (use --force if not)"),
679 name
, (uintmax_t)pid
);
683 hold_lock_file_for_update(&log_lock
,
686 dup2(get_lock_file_fd(&log_lock
), 2);
687 sigchain_push_common(process_log_file_on_signal
);
688 atexit(process_log_file_at_exit
);
693 if (!repository_format_precious_objects
) {
694 struct child_process repack_cmd
= CHILD_PROCESS_INIT
;
696 repack_cmd
.git_cmd
= 1;
697 repack_cmd
.close_object_store
= 1;
698 strvec_pushv(&repack_cmd
.args
, repack
.v
);
699 if (run_command(&repack_cmd
))
700 die(FAILED_RUN
, repack
.v
[0]);
703 struct child_process prune_cmd
= CHILD_PROCESS_INIT
;
705 /* run `git prune` even if using cruft packs */
706 strvec_push(&prune
, prune_expire
);
708 strvec_push(&prune
, "--no-progress");
709 if (repo_has_promisor_remote(the_repository
))
711 "--exclude-promisor-objects");
712 prune_cmd
.git_cmd
= 1;
713 strvec_pushv(&prune_cmd
.args
, prune
.v
);
714 if (run_command(&prune_cmd
))
715 die(FAILED_RUN
, prune
.v
[0]);
719 if (prune_worktrees_expire
) {
720 struct child_process prune_worktrees_cmd
= CHILD_PROCESS_INIT
;
722 strvec_push(&prune_worktrees
, prune_worktrees_expire
);
723 prune_worktrees_cmd
.git_cmd
= 1;
724 strvec_pushv(&prune_worktrees_cmd
.args
, prune_worktrees
.v
);
725 if (run_command(&prune_worktrees_cmd
))
726 die(FAILED_RUN
, prune_worktrees
.v
[0]);
729 rerere_cmd
.git_cmd
= 1;
730 strvec_pushv(&rerere_cmd
.args
, rerere
.v
);
731 if (run_command(&rerere_cmd
))
732 die(FAILED_RUN
, rerere
.v
[0]);
734 report_garbage
= report_pack_garbage
;
735 reprepare_packed_git(the_repository
);
736 if (pack_garbage
.nr
> 0) {
737 close_object_store(the_repository
->objects
);
738 clean_pack_garbage();
741 if (the_repository
->settings
.gc_write_commit_graph
== 1)
742 write_commit_graph_reachable(the_repository
->objects
->odb
,
743 !quiet
&& !daemonized
? COMMIT_GRAPH_WRITE_PROGRESS
: 0,
746 if (auto_gc
&& too_many_loose_objects())
747 warning(_("There are too many unreachable loose objects; "
748 "run 'git prune' to remove them."));
751 unlink(git_path("gc.log"));
756 static const char *const builtin_maintenance_run_usage
[] = {
757 N_("git maintenance run [--auto] [--[no-]quiet] [--task=<task>] [--schedule]"),
761 enum schedule_priority
{
768 static enum schedule_priority
parse_schedule(const char *value
)
771 return SCHEDULE_NONE
;
772 if (!strcasecmp(value
, "hourly"))
773 return SCHEDULE_HOURLY
;
774 if (!strcasecmp(value
, "daily"))
775 return SCHEDULE_DAILY
;
776 if (!strcasecmp(value
, "weekly"))
777 return SCHEDULE_WEEKLY
;
778 return SCHEDULE_NONE
;
781 static int maintenance_opt_schedule(const struct option
*opt
, const char *arg
,
784 enum schedule_priority
*priority
= opt
->value
;
787 die(_("--no-schedule is not allowed"));
789 *priority
= parse_schedule(arg
);
792 die(_("unrecognized --schedule argument '%s'"), arg
);
797 struct maintenance_run_opts
{
800 enum schedule_priority schedule
;
803 /* Remember to update object flag allocation in object.h */
806 struct cg_auto_data
{
807 int num_not_in_graph
;
811 static int dfs_on_ref(const char *refname UNUSED
,
812 const struct object_id
*oid
,
816 struct cg_auto_data
*data
= (struct cg_auto_data
*)cb_data
;
818 struct object_id peeled
;
819 struct commit_list
*stack
= NULL
;
820 struct commit
*commit
;
822 if (!peel_iterated_oid(oid
, &peeled
))
824 if (oid_object_info(the_repository
, oid
, NULL
) != OBJ_COMMIT
)
827 commit
= lookup_commit(the_repository
, oid
);
830 if (repo_parse_commit(the_repository
, commit
) ||
831 commit_graph_position(commit
) != COMMIT_NOT_FROM_GRAPH
)
834 data
->num_not_in_graph
++;
836 if (data
->num_not_in_graph
>= data
->limit
)
839 commit_list_append(commit
, &stack
);
841 while (!result
&& stack
) {
842 struct commit_list
*parent
;
844 commit
= pop_commit(&stack
);
846 for (parent
= commit
->parents
; parent
; parent
= parent
->next
) {
847 if (repo_parse_commit(the_repository
, parent
->item
) ||
848 commit_graph_position(parent
->item
) != COMMIT_NOT_FROM_GRAPH
||
849 parent
->item
->object
.flags
& SEEN
)
852 parent
->item
->object
.flags
|= SEEN
;
853 data
->num_not_in_graph
++;
855 if (data
->num_not_in_graph
>= data
->limit
) {
860 commit_list_append(parent
->item
, &stack
);
864 free_commit_list(stack
);
868 static int should_write_commit_graph(void)
871 struct cg_auto_data data
;
873 data
.num_not_in_graph
= 0;
875 git_config_get_int("maintenance.commit-graph.auto",
883 result
= for_each_ref(dfs_on_ref
, &data
);
885 repo_clear_commit_marks(the_repository
, SEEN
);
890 static int run_write_commit_graph(struct maintenance_run_opts
*opts
)
892 struct child_process child
= CHILD_PROCESS_INIT
;
894 child
.git_cmd
= child
.close_object_store
= 1;
895 strvec_pushl(&child
.args
, "commit-graph", "write",
896 "--split", "--reachable", NULL
);
899 strvec_push(&child
.args
, "--no-progress");
901 return !!run_command(&child
);
904 static int maintenance_task_commit_graph(struct maintenance_run_opts
*opts
)
906 prepare_repo_settings(the_repository
);
907 if (!the_repository
->settings
.core_commit_graph
)
910 if (run_write_commit_graph(opts
)) {
911 error(_("failed to write commit-graph"));
918 static int fetch_remote(struct remote
*remote
, void *cbdata
)
920 struct maintenance_run_opts
*opts
= cbdata
;
921 struct child_process child
= CHILD_PROCESS_INIT
;
923 if (remote
->skip_default_update
)
927 strvec_pushl(&child
.args
, "fetch", remote
->name
,
928 "--prefetch", "--prune", "--no-tags",
929 "--no-write-fetch-head", "--recurse-submodules=no",
933 strvec_push(&child
.args
, "--quiet");
935 return !!run_command(&child
);
938 static int maintenance_task_prefetch(struct maintenance_run_opts
*opts
)
940 if (for_each_remote(fetch_remote
, opts
)) {
941 error(_("failed to prefetch remotes"));
948 static int maintenance_task_gc(struct maintenance_run_opts
*opts
)
950 struct child_process child
= CHILD_PROCESS_INIT
;
952 child
.git_cmd
= child
.close_object_store
= 1;
953 strvec_push(&child
.args
, "gc");
956 strvec_push(&child
.args
, "--auto");
958 strvec_push(&child
.args
, "--quiet");
960 strvec_push(&child
.args
, "--no-quiet");
962 return run_command(&child
);
965 static int prune_packed(struct maintenance_run_opts
*opts
)
967 struct child_process child
= CHILD_PROCESS_INIT
;
970 strvec_push(&child
.args
, "prune-packed");
973 strvec_push(&child
.args
, "--quiet");
975 return !!run_command(&child
);
978 struct write_loose_object_data
{
984 static int loose_object_auto_limit
= 100;
986 static int loose_object_count(const struct object_id
*oid UNUSED
,
987 const char *path UNUSED
,
990 int *count
= (int*)data
;
991 if (++(*count
) >= loose_object_auto_limit
)
996 static int loose_object_auto_condition(void)
1000 git_config_get_int("maintenance.loose-objects.auto",
1001 &loose_object_auto_limit
);
1003 if (!loose_object_auto_limit
)
1005 if (loose_object_auto_limit
< 0)
1008 return for_each_loose_file_in_objdir(the_repository
->objects
->odb
->path
,
1010 NULL
, NULL
, &count
);
1013 static int bail_on_loose(const struct object_id
*oid UNUSED
,
1014 const char *path UNUSED
,
1020 static int write_loose_object_to_stdin(const struct object_id
*oid
,
1021 const char *path UNUSED
,
1024 struct write_loose_object_data
*d
= (struct write_loose_object_data
*)data
;
1026 fprintf(d
->in
, "%s\n", oid_to_hex(oid
));
1028 return ++(d
->count
) > d
->batch_size
;
1031 static int pack_loose(struct maintenance_run_opts
*opts
)
1033 struct repository
*r
= the_repository
;
1035 struct write_loose_object_data data
;
1036 struct child_process pack_proc
= CHILD_PROCESS_INIT
;
1039 * Do not start pack-objects process
1040 * if there are no loose objects.
1042 if (!for_each_loose_file_in_objdir(r
->objects
->odb
->path
,
1047 pack_proc
.git_cmd
= 1;
1049 strvec_push(&pack_proc
.args
, "pack-objects");
1051 strvec_push(&pack_proc
.args
, "--quiet");
1052 strvec_pushf(&pack_proc
.args
, "%s/pack/loose", r
->objects
->odb
->path
);
1056 if (start_command(&pack_proc
)) {
1057 error(_("failed to start 'git pack-objects' process"));
1061 data
.in
= xfdopen(pack_proc
.in
, "w");
1063 data
.batch_size
= 50000;
1065 for_each_loose_file_in_objdir(r
->objects
->odb
->path
,
1066 write_loose_object_to_stdin
,
1073 if (finish_command(&pack_proc
)) {
1074 error(_("failed to finish 'git pack-objects' process"));
1081 static int maintenance_task_loose_objects(struct maintenance_run_opts
*opts
)
1083 return prune_packed(opts
) || pack_loose(opts
);
1086 static int incremental_repack_auto_condition(void)
1088 struct packed_git
*p
;
1089 int incremental_repack_auto_limit
= 10;
1092 prepare_repo_settings(the_repository
);
1093 if (!the_repository
->settings
.core_multi_pack_index
)
1096 git_config_get_int("maintenance.incremental-repack.auto",
1097 &incremental_repack_auto_limit
);
1099 if (!incremental_repack_auto_limit
)
1101 if (incremental_repack_auto_limit
< 0)
1104 for (p
= get_packed_git(the_repository
);
1105 count
< incremental_repack_auto_limit
&& p
;
1107 if (!p
->multi_pack_index
)
1111 return count
>= incremental_repack_auto_limit
;
1114 static int multi_pack_index_write(struct maintenance_run_opts
*opts
)
1116 struct child_process child
= CHILD_PROCESS_INIT
;
1119 strvec_pushl(&child
.args
, "multi-pack-index", "write", NULL
);
1122 strvec_push(&child
.args
, "--no-progress");
1124 if (run_command(&child
))
1125 return error(_("failed to write multi-pack-index"));
1130 static int multi_pack_index_expire(struct maintenance_run_opts
*opts
)
1132 struct child_process child
= CHILD_PROCESS_INIT
;
1134 child
.git_cmd
= child
.close_object_store
= 1;
1135 strvec_pushl(&child
.args
, "multi-pack-index", "expire", NULL
);
1138 strvec_push(&child
.args
, "--no-progress");
1140 if (run_command(&child
))
1141 return error(_("'git multi-pack-index expire' failed"));
1146 #define TWO_GIGABYTES (INT32_MAX)
1148 static off_t
get_auto_pack_size(void)
1151 * The "auto" value is special: we optimize for
1152 * one large pack-file (i.e. from a clone) and
1153 * expect the rest to be small and they can be
1156 * The strategy we select here is to select a
1157 * size that is one more than the second largest
1158 * pack-file. This ensures that we will repack
1159 * at least two packs if there are three or more
1163 off_t second_largest_size
= 0;
1165 struct packed_git
*p
;
1166 struct repository
*r
= the_repository
;
1168 reprepare_packed_git(r
);
1169 for (p
= get_all_packs(r
); p
; p
= p
->next
) {
1170 if (p
->pack_size
> max_size
) {
1171 second_largest_size
= max_size
;
1172 max_size
= p
->pack_size
;
1173 } else if (p
->pack_size
> second_largest_size
)
1174 second_largest_size
= p
->pack_size
;
1177 result_size
= second_largest_size
+ 1;
1179 /* But limit ourselves to a batch size of 2g */
1180 if (result_size
> TWO_GIGABYTES
)
1181 result_size
= TWO_GIGABYTES
;
1186 static int multi_pack_index_repack(struct maintenance_run_opts
*opts
)
1188 struct child_process child
= CHILD_PROCESS_INIT
;
1190 child
.git_cmd
= child
.close_object_store
= 1;
1191 strvec_pushl(&child
.args
, "multi-pack-index", "repack", NULL
);
1194 strvec_push(&child
.args
, "--no-progress");
1196 strvec_pushf(&child
.args
, "--batch-size=%"PRIuMAX
,
1197 (uintmax_t)get_auto_pack_size());
1199 if (run_command(&child
))
1200 return error(_("'git multi-pack-index repack' failed"));
1205 static int maintenance_task_incremental_repack(struct maintenance_run_opts
*opts
)
1207 prepare_repo_settings(the_repository
);
1208 if (!the_repository
->settings
.core_multi_pack_index
) {
1209 warning(_("skipping incremental-repack task because core.multiPackIndex is disabled"));
1213 if (multi_pack_index_write(opts
))
1215 if (multi_pack_index_expire(opts
))
1217 if (multi_pack_index_repack(opts
))
1222 typedef int maintenance_task_fn(struct maintenance_run_opts
*opts
);
1225 * An auto condition function returns 1 if the task should run
1226 * and 0 if the task should NOT run. See needs_to_gc() for an
1229 typedef int maintenance_auto_fn(void);
1231 struct maintenance_task
{
1233 maintenance_task_fn
*fn
;
1234 maintenance_auto_fn
*auto_condition
;
1237 enum schedule_priority schedule
;
1239 /* -1 if not selected. */
1243 enum maintenance_task_label
{
1246 TASK_INCREMENTAL_REPACK
,
1251 /* Leave as final value */
1255 static struct maintenance_task tasks
[] = {
1258 maintenance_task_prefetch
,
1260 [TASK_LOOSE_OBJECTS
] = {
1262 maintenance_task_loose_objects
,
1263 loose_object_auto_condition
,
1265 [TASK_INCREMENTAL_REPACK
] = {
1266 "incremental-repack",
1267 maintenance_task_incremental_repack
,
1268 incremental_repack_auto_condition
,
1272 maintenance_task_gc
,
1276 [TASK_COMMIT_GRAPH
] = {
1278 maintenance_task_commit_graph
,
1279 should_write_commit_graph
,
1281 [TASK_PACK_REFS
] = {
1283 maintenance_task_pack_refs
,
1288 static int compare_tasks_by_selection(const void *a_
, const void *b_
)
1290 const struct maintenance_task
*a
= a_
;
1291 const struct maintenance_task
*b
= b_
;
1293 return b
->selected_order
- a
->selected_order
;
1296 static int maintenance_run_tasks(struct maintenance_run_opts
*opts
)
1298 int i
, found_selected
= 0;
1300 struct lock_file lk
;
1301 struct repository
*r
= the_repository
;
1302 char *lock_path
= xstrfmt("%s/maintenance", r
->objects
->odb
->path
);
1304 if (hold_lock_file_for_update(&lk
, lock_path
, LOCK_NO_DEREF
) < 0) {
1306 * Another maintenance command is running.
1308 * If --auto was provided, then it is likely due to a
1309 * recursive process stack. Do not report an error in
1312 if (!opts
->auto_flag
&& !opts
->quiet
)
1313 warning(_("lock file '%s' exists, skipping maintenance"),
1320 for (i
= 0; !found_selected
&& i
< TASK__COUNT
; i
++)
1321 found_selected
= tasks
[i
].selected_order
>= 0;
1324 QSORT(tasks
, TASK__COUNT
, compare_tasks_by_selection
);
1326 for (i
= 0; i
< TASK__COUNT
; i
++) {
1327 if (found_selected
&& tasks
[i
].selected_order
< 0)
1330 if (!found_selected
&& !tasks
[i
].enabled
)
1333 if (opts
->auto_flag
&&
1334 (!tasks
[i
].auto_condition
||
1335 !tasks
[i
].auto_condition()))
1338 if (opts
->schedule
&& tasks
[i
].schedule
< opts
->schedule
)
1341 trace2_region_enter("maintenance", tasks
[i
].name
, r
);
1342 if (tasks
[i
].fn(opts
)) {
1343 error(_("task '%s' failed"), tasks
[i
].name
);
1346 trace2_region_leave("maintenance", tasks
[i
].name
, r
);
1349 rollback_lock_file(&lk
);
1353 static void initialize_maintenance_strategy(void)
1357 if (git_config_get_string("maintenance.strategy", &config_str
))
1360 if (!strcasecmp(config_str
, "incremental")) {
1361 tasks
[TASK_GC
].schedule
= SCHEDULE_NONE
;
1362 tasks
[TASK_COMMIT_GRAPH
].enabled
= 1;
1363 tasks
[TASK_COMMIT_GRAPH
].schedule
= SCHEDULE_HOURLY
;
1364 tasks
[TASK_PREFETCH
].enabled
= 1;
1365 tasks
[TASK_PREFETCH
].schedule
= SCHEDULE_HOURLY
;
1366 tasks
[TASK_INCREMENTAL_REPACK
].enabled
= 1;
1367 tasks
[TASK_INCREMENTAL_REPACK
].schedule
= SCHEDULE_DAILY
;
1368 tasks
[TASK_LOOSE_OBJECTS
].enabled
= 1;
1369 tasks
[TASK_LOOSE_OBJECTS
].schedule
= SCHEDULE_DAILY
;
1370 tasks
[TASK_PACK_REFS
].enabled
= 1;
1371 tasks
[TASK_PACK_REFS
].schedule
= SCHEDULE_WEEKLY
;
1375 static void initialize_task_config(int schedule
)
1378 struct strbuf config_name
= STRBUF_INIT
;
1382 initialize_maintenance_strategy();
1384 for (i
= 0; i
< TASK__COUNT
; i
++) {
1388 strbuf_reset(&config_name
);
1389 strbuf_addf(&config_name
, "maintenance.%s.enabled",
1392 if (!git_config_get_bool(config_name
.buf
, &config_value
))
1393 tasks
[i
].enabled
= config_value
;
1395 strbuf_reset(&config_name
);
1396 strbuf_addf(&config_name
, "maintenance.%s.schedule",
1399 if (!git_config_get_string(config_name
.buf
, &config_str
)) {
1400 tasks
[i
].schedule
= parse_schedule(config_str
);
1405 strbuf_release(&config_name
);
1408 static int task_option_parse(const struct option
*opt
,
1409 const char *arg
, int unset
)
1411 int i
, num_selected
= 0;
1412 struct maintenance_task
*task
= NULL
;
1414 BUG_ON_OPT_NEG(unset
);
1416 for (i
= 0; i
< TASK__COUNT
; i
++) {
1417 if (tasks
[i
].selected_order
>= 0)
1419 if (!strcasecmp(tasks
[i
].name
, arg
)) {
1425 error(_("'%s' is not a valid task"), arg
);
1429 if (task
->selected_order
>= 0) {
1430 error(_("task '%s' cannot be selected multiple times"), arg
);
1434 task
->selected_order
= num_selected
+ 1;
1439 static int maintenance_run(int argc
, const char **argv
, const char *prefix
)
1442 struct maintenance_run_opts opts
;
1443 struct option builtin_maintenance_run_options
[] = {
1444 OPT_BOOL(0, "auto", &opts
.auto_flag
,
1445 N_("run tasks based on the state of the repository")),
1446 OPT_CALLBACK(0, "schedule", &opts
.schedule
, N_("frequency"),
1447 N_("run tasks based on frequency"),
1448 maintenance_opt_schedule
),
1449 OPT_BOOL(0, "quiet", &opts
.quiet
,
1450 N_("do not report progress or other information over stderr")),
1451 OPT_CALLBACK_F(0, "task", NULL
, N_("task"),
1452 N_("run a specific task"),
1453 PARSE_OPT_NONEG
, task_option_parse
),
1456 memset(&opts
, 0, sizeof(opts
));
1458 opts
.quiet
= !isatty(2);
1460 for (i
= 0; i
< TASK__COUNT
; i
++)
1461 tasks
[i
].selected_order
= -1;
1463 argc
= parse_options(argc
, argv
, prefix
,
1464 builtin_maintenance_run_options
,
1465 builtin_maintenance_run_usage
,
1466 PARSE_OPT_STOP_AT_NON_OPTION
);
1468 if (opts
.auto_flag
&& opts
.schedule
)
1469 die(_("use at most one of --auto and --schedule=<frequency>"));
1471 initialize_task_config(opts
.schedule
);
1474 usage_with_options(builtin_maintenance_run_usage
,
1475 builtin_maintenance_run_options
);
1476 return maintenance_run_tasks(&opts
);
1479 static char *get_maintpath(void)
1481 struct strbuf sb
= STRBUF_INIT
;
1482 const char *p
= the_repository
->worktree
?
1483 the_repository
->worktree
: the_repository
->gitdir
;
1485 strbuf_realpath(&sb
, p
, 1);
1486 return strbuf_detach(&sb
, NULL
);
1489 static char const * const builtin_maintenance_register_usage
[] = {
1490 "git maintenance register [--config-file <path>]",
1494 static int maintenance_register(int argc
, const char **argv
, const char *prefix
)
1496 char *config_file
= NULL
;
1497 struct option options
[] = {
1498 OPT_STRING(0, "config-file", &config_file
, N_("file"), N_("use given config file")),
1502 const char *key
= "maintenance.repo";
1504 char *maintpath
= get_maintpath();
1505 struct string_list_item
*item
;
1506 const struct string_list
*list
;
1508 argc
= parse_options(argc
, argv
, prefix
, options
,
1509 builtin_maintenance_register_usage
, 0);
1511 usage_with_options(builtin_maintenance_register_usage
,
1514 /* Disable foreground maintenance */
1515 git_config_set("maintenance.auto", "false");
1517 /* Set maintenance strategy, if unset */
1518 if (!git_config_get_string("maintenance.strategy", &config_value
))
1521 git_config_set("maintenance.strategy", "incremental");
1523 list
= git_config_get_value_multi(key
);
1525 for_each_string_list_item(item
, list
) {
1526 if (!strcmp(maintpath
, item
->string
)) {
1535 char *user_config
= NULL
, *xdg_config
= NULL
;
1538 git_global_config(&user_config
, &xdg_config
);
1539 config_file
= user_config
;
1541 die(_("$HOME not set"));
1543 rc
= git_config_set_multivar_in_file_gently(
1544 config_file
, "maintenance.repo", maintpath
,
1545 CONFIG_REGEX_NONE
, 0);
1550 die(_("unable to add '%s' value of '%s'"),
1558 static char const * const builtin_maintenance_unregister_usage
[] = {
1559 "git maintenance unregister [--config-file <path>] [--force]",
1563 static int maintenance_unregister(int argc
, const char **argv
, const char *prefix
)
1566 char *config_file
= NULL
;
1567 struct option options
[] = {
1568 OPT_STRING(0, "config-file", &config_file
, N_("file"), N_("use given config file")),
1570 N_("return success even if repository was not registered"),
1571 PARSE_OPT_NOCOMPLETE
),
1574 const char *key
= "maintenance.repo";
1575 char *maintpath
= get_maintpath();
1577 struct string_list_item
*item
;
1578 const struct string_list
*list
;
1579 struct config_set cs
= { { 0 } };
1581 argc
= parse_options(argc
, argv
, prefix
, options
,
1582 builtin_maintenance_unregister_usage
, 0);
1584 usage_with_options(builtin_maintenance_unregister_usage
,
1588 git_configset_init(&cs
);
1589 git_configset_add_file(&cs
, config_file
);
1590 list
= git_configset_get_value_multi(&cs
, key
);
1592 list
= git_config_get_value_multi(key
);
1595 for_each_string_list_item(item
, list
) {
1596 if (!strcmp(maintpath
, item
->string
)) {
1605 char *user_config
= NULL
, *xdg_config
= NULL
;
1607 git_global_config(&user_config
, &xdg_config
);
1608 config_file
= user_config
;
1610 die(_("$HOME not set"));
1612 rc
= git_config_set_multivar_in_file_gently(
1613 config_file
, key
, NULL
, maintpath
,
1614 CONFIG_FLAGS_MULTI_REPLACE
| CONFIG_FLAGS_FIXED_VALUE
);
1619 (!force
|| rc
== CONFIG_NOTHING_SET
))
1620 die(_("unable to unset '%s' value of '%s'"),
1622 } else if (!force
) {
1623 die(_("repository '%s' is not registered"), maintpath
);
1626 git_configset_clear(&cs
);
1631 static const char *get_frequency(enum schedule_priority schedule
)
1634 case SCHEDULE_HOURLY
:
1636 case SCHEDULE_DAILY
:
1638 case SCHEDULE_WEEKLY
:
1641 BUG("invalid schedule %d", schedule
);
1646 * get_schedule_cmd` reads the GIT_TEST_MAINT_SCHEDULER environment variable
1647 * to mock the schedulers that `git maintenance start` rely on.
1649 * For test purpose, GIT_TEST_MAINT_SCHEDULER can be set to a comma-separated
1650 * list of colon-separated key/value pairs where each pair contains a scheduler
1651 * and its corresponding mock.
1653 * * If $GIT_TEST_MAINT_SCHEDULER is not set, return false and leave the
1654 * arguments unmodified.
1656 * * If $GIT_TEST_MAINT_SCHEDULER is set, return true.
1657 * In this case, the *cmd value is read as input.
1659 * * if the input value *cmd is the key of one of the comma-separated list
1660 * item, then *is_available is set to true and *cmd is modified and becomes
1663 * * if the input value *cmd isn’t the key of any of the comma-separated list
1664 * item, then *is_available is set to false.
1667 * GIT_TEST_MAINT_SCHEDULER not set
1668 * +-------+-------------------------------------------------+
1669 * | Input | Output |
1670 * | *cmd | return code | *cmd | *is_available |
1671 * +-------+-------------+-------------------+---------------+
1672 * | "foo" | false | "foo" (unchanged) | (unchanged) |
1673 * +-------+-------------+-------------------+---------------+
1675 * GIT_TEST_MAINT_SCHEDULER set to “foo:./mock_foo.sh,bar:./mock_bar.sh”
1676 * +-------+-------------------------------------------------+
1677 * | Input | Output |
1678 * | *cmd | return code | *cmd | *is_available |
1679 * +-------+-------------+-------------------+---------------+
1680 * | "foo" | true | "./mock.foo.sh" | true |
1681 * | "qux" | true | "qux" (unchanged) | false |
1682 * +-------+-------------+-------------------+---------------+
1684 static int get_schedule_cmd(const char **cmd
, int *is_available
)
1686 char *testing
= xstrdup_or_null(getenv("GIT_TEST_MAINT_SCHEDULER"));
1687 struct string_list_item
*item
;
1688 struct string_list list
= STRING_LIST_INIT_NODUP
;
1696 string_list_split_in_place(&list
, testing
, ',', -1);
1697 for_each_string_list_item(item
, &list
) {
1698 struct string_list pair
= STRING_LIST_INIT_NODUP
;
1700 if (string_list_split_in_place(&pair
, item
->string
, ':', 2) != 2)
1703 if (!strcmp(*cmd
, pair
.items
[0].string
)) {
1704 *cmd
= pair
.items
[1].string
;
1707 string_list_clear(&list
, 0);
1713 string_list_clear(&list
, 0);
1718 static int is_launchctl_available(void)
1720 const char *cmd
= "launchctl";
1722 if (get_schedule_cmd(&cmd
, &is_available
))
1723 return is_available
;
1732 static char *launchctl_service_name(const char *frequency
)
1734 struct strbuf label
= STRBUF_INIT
;
1735 strbuf_addf(&label
, "org.git-scm.git.%s", frequency
);
1736 return strbuf_detach(&label
, NULL
);
1739 static char *launchctl_service_filename(const char *name
)
1742 struct strbuf filename
= STRBUF_INIT
;
1743 strbuf_addf(&filename
, "~/Library/LaunchAgents/%s.plist", name
);
1745 expanded
= interpolate_path(filename
.buf
, 1);
1747 die(_("failed to expand path '%s'"), filename
.buf
);
1749 strbuf_release(&filename
);
1753 static char *launchctl_get_uid(void)
1755 return xstrfmt("gui/%d", getuid());
1758 static int launchctl_boot_plist(int enable
, const char *filename
)
1760 const char *cmd
= "launchctl";
1762 struct child_process child
= CHILD_PROCESS_INIT
;
1763 char *uid
= launchctl_get_uid();
1765 get_schedule_cmd(&cmd
, NULL
);
1766 strvec_split(&child
.args
, cmd
);
1767 strvec_pushl(&child
.args
, enable
? "bootstrap" : "bootout", uid
,
1770 child
.no_stderr
= 1;
1771 child
.no_stdout
= 1;
1773 if (start_command(&child
))
1774 die(_("failed to start launchctl"));
1776 result
= finish_command(&child
);
1782 static int launchctl_remove_plist(enum schedule_priority schedule
)
1784 const char *frequency
= get_frequency(schedule
);
1785 char *name
= launchctl_service_name(frequency
);
1786 char *filename
= launchctl_service_filename(name
);
1787 int result
= launchctl_boot_plist(0, filename
);
1794 static int launchctl_remove_plists(void)
1796 return launchctl_remove_plist(SCHEDULE_HOURLY
) ||
1797 launchctl_remove_plist(SCHEDULE_DAILY
) ||
1798 launchctl_remove_plist(SCHEDULE_WEEKLY
);
1801 static int launchctl_list_contains_plist(const char *name
, const char *cmd
)
1803 struct child_process child
= CHILD_PROCESS_INIT
;
1805 strvec_split(&child
.args
, cmd
);
1806 strvec_pushl(&child
.args
, "list", name
, NULL
);
1808 child
.no_stderr
= 1;
1809 child
.no_stdout
= 1;
1811 if (start_command(&child
))
1812 die(_("failed to start launchctl"));
1814 /* Returns failure if 'name' doesn't exist. */
1815 return !finish_command(&child
);
1818 static int launchctl_schedule_plist(const char *exec_path
, enum schedule_priority schedule
)
1821 const char *preamble
, *repeat
;
1822 const char *frequency
= get_frequency(schedule
);
1823 char *name
= launchctl_service_name(frequency
);
1824 char *filename
= launchctl_service_filename(name
);
1825 struct lock_file lk
= LOCK_INIT
;
1826 static unsigned long lock_file_timeout_ms
= ULONG_MAX
;
1827 struct strbuf plist
= STRBUF_INIT
, plist2
= STRBUF_INIT
;
1829 const char *cmd
= "launchctl";
1831 get_schedule_cmd(&cmd
, NULL
);
1832 preamble
= "<?xml version=\"1.0\"?>\n"
1833 "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
1834 "<plist version=\"1.0\">"
1836 "<key>Label</key><string>%s</string>\n"
1837 "<key>ProgramArguments</key>\n"
1839 "<string>%s/git</string>\n"
1840 "<string>--exec-path=%s</string>\n"
1841 "<string>for-each-repo</string>\n"
1842 "<string>--config=maintenance.repo</string>\n"
1843 "<string>maintenance</string>\n"
1844 "<string>run</string>\n"
1845 "<string>--schedule=%s</string>\n"
1847 "<key>StartCalendarInterval</key>\n"
1849 strbuf_addf(&plist
, preamble
, name
, exec_path
, exec_path
, frequency
);
1852 case SCHEDULE_HOURLY
:
1854 "<key>Hour</key><integer>%d</integer>\n"
1855 "<key>Minute</key><integer>0</integer>\n"
1857 for (i
= 1; i
<= 23; i
++)
1858 strbuf_addf(&plist
, repeat
, i
);
1861 case SCHEDULE_DAILY
:
1863 "<key>Day</key><integer>%d</integer>\n"
1864 "<key>Hour</key><integer>0</integer>\n"
1865 "<key>Minute</key><integer>0</integer>\n"
1867 for (i
= 1; i
<= 6; i
++)
1868 strbuf_addf(&plist
, repeat
, i
);
1871 case SCHEDULE_WEEKLY
:
1872 strbuf_addstr(&plist
,
1874 "<key>Day</key><integer>0</integer>\n"
1875 "<key>Hour</key><integer>0</integer>\n"
1876 "<key>Minute</key><integer>0</integer>\n"
1884 strbuf_addstr(&plist
, "</array>\n</dict>\n</plist>\n");
1886 if (safe_create_leading_directories(filename
))
1887 die(_("failed to create directories for '%s'"), filename
);
1889 if ((long)lock_file_timeout_ms
< 0 &&
1890 git_config_get_ulong("gc.launchctlplistlocktimeoutms",
1891 &lock_file_timeout_ms
))
1892 lock_file_timeout_ms
= 150;
1894 fd
= hold_lock_file_for_update_timeout(&lk
, filename
, LOCK_DIE_ON_ERROR
,
1895 lock_file_timeout_ms
);
1898 * Does this file already exist? With the intended contents? Is it
1899 * registered already? Then it does not need to be re-registered.
1901 if (!stat(filename
, &st
) && st
.st_size
== plist
.len
&&
1902 strbuf_read_file(&plist2
, filename
, plist
.len
) == plist
.len
&&
1903 !strbuf_cmp(&plist
, &plist2
) &&
1904 launchctl_list_contains_plist(name
, cmd
))
1905 rollback_lock_file(&lk
);
1907 if (write_in_full(fd
, plist
.buf
, plist
.len
) < 0 ||
1908 commit_lock_file(&lk
))
1909 die_errno(_("could not write '%s'"), filename
);
1911 /* bootout might fail if not already running, so ignore */
1912 launchctl_boot_plist(0, filename
);
1913 if (launchctl_boot_plist(1, filename
))
1914 die(_("failed to bootstrap service %s"), filename
);
1919 strbuf_release(&plist
);
1920 strbuf_release(&plist2
);
1924 static int launchctl_add_plists(void)
1926 const char *exec_path
= git_exec_path();
1928 return launchctl_schedule_plist(exec_path
, SCHEDULE_HOURLY
) ||
1929 launchctl_schedule_plist(exec_path
, SCHEDULE_DAILY
) ||
1930 launchctl_schedule_plist(exec_path
, SCHEDULE_WEEKLY
);
1933 static int launchctl_update_schedule(int run_maintenance
, int fd
)
1935 if (run_maintenance
)
1936 return launchctl_add_plists();
1938 return launchctl_remove_plists();
1941 static int is_schtasks_available(void)
1943 const char *cmd
= "schtasks";
1945 if (get_schedule_cmd(&cmd
, &is_available
))
1946 return is_available
;
1948 #ifdef GIT_WINDOWS_NATIVE
1955 static char *schtasks_task_name(const char *frequency
)
1957 struct strbuf label
= STRBUF_INIT
;
1958 strbuf_addf(&label
, "Git Maintenance (%s)", frequency
);
1959 return strbuf_detach(&label
, NULL
);
1962 static int schtasks_remove_task(enum schedule_priority schedule
)
1964 const char *cmd
= "schtasks";
1965 struct child_process child
= CHILD_PROCESS_INIT
;
1966 const char *frequency
= get_frequency(schedule
);
1967 char *name
= schtasks_task_name(frequency
);
1969 get_schedule_cmd(&cmd
, NULL
);
1970 strvec_split(&child
.args
, cmd
);
1971 strvec_pushl(&child
.args
, "/delete", "/tn", name
, "/f", NULL
);
1974 return run_command(&child
);
1977 static int schtasks_remove_tasks(void)
1979 return schtasks_remove_task(SCHEDULE_HOURLY
) ||
1980 schtasks_remove_task(SCHEDULE_DAILY
) ||
1981 schtasks_remove_task(SCHEDULE_WEEKLY
);
1984 static int schtasks_schedule_task(const char *exec_path
, enum schedule_priority schedule
)
1986 const char *cmd
= "schtasks";
1988 struct child_process child
= CHILD_PROCESS_INIT
;
1990 struct tempfile
*tfile
;
1991 const char *frequency
= get_frequency(schedule
);
1992 char *name
= schtasks_task_name(frequency
);
1993 struct strbuf tfilename
= STRBUF_INIT
;
1995 get_schedule_cmd(&cmd
, NULL
);
1997 strbuf_addf(&tfilename
, "%s/schedule_%s_XXXXXX",
1998 get_git_common_dir(), frequency
);
1999 tfile
= xmks_tempfile(tfilename
.buf
);
2000 strbuf_release(&tfilename
);
2002 if (!fdopen_tempfile(tfile
, "w"))
2003 die(_("failed to create temp xml file"));
2005 xml
= "<?xml version=\"1.0\" ?>\n"
2006 "<Task version=\"1.4\" xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n"
2008 "<CalendarTrigger>\n";
2009 fputs(xml
, tfile
->fp
);
2012 case SCHEDULE_HOURLY
:
2014 "<StartBoundary>2020-01-01T01:00:00</StartBoundary>\n"
2015 "<Enabled>true</Enabled>\n"
2017 "<DaysInterval>1</DaysInterval>\n"
2018 "</ScheduleByDay>\n"
2020 "<Interval>PT1H</Interval>\n"
2021 "<Duration>PT23H</Duration>\n"
2022 "<StopAtDurationEnd>false</StopAtDurationEnd>\n"
2026 case SCHEDULE_DAILY
:
2028 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2029 "<Enabled>true</Enabled>\n"
2030 "<ScheduleByWeek>\n"
2039 "<WeeksInterval>1</WeeksInterval>\n"
2040 "</ScheduleByWeek>\n");
2043 case SCHEDULE_WEEKLY
:
2045 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2046 "<Enabled>true</Enabled>\n"
2047 "<ScheduleByWeek>\n"
2051 "<WeeksInterval>1</WeeksInterval>\n"
2052 "</ScheduleByWeek>\n");
2059 xml
= "</CalendarTrigger>\n"
2062 "<Principal id=\"Author\">\n"
2063 "<LogonType>InteractiveToken</LogonType>\n"
2064 "<RunLevel>LeastPrivilege</RunLevel>\n"
2068 "<MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>\n"
2069 "<Enabled>true</Enabled>\n"
2070 "<Hidden>true</Hidden>\n"
2071 "<UseUnifiedSchedulingEngine>true</UseUnifiedSchedulingEngine>\n"
2072 "<WakeToRun>false</WakeToRun>\n"
2073 "<ExecutionTimeLimit>PT72H</ExecutionTimeLimit>\n"
2074 "<Priority>7</Priority>\n"
2076 "<Actions Context=\"Author\">\n"
2078 "<Command>\"%s\\git.exe\"</Command>\n"
2079 "<Arguments>--exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%s</Arguments>\n"
2083 fprintf(tfile
->fp
, xml
, exec_path
, exec_path
, frequency
);
2084 strvec_split(&child
.args
, cmd
);
2085 strvec_pushl(&child
.args
, "/create", "/tn", name
, "/f", "/xml",
2086 get_tempfile_path(tfile
), NULL
);
2087 close_tempfile_gently(tfile
);
2089 child
.no_stdout
= 1;
2090 child
.no_stderr
= 1;
2092 if (start_command(&child
))
2093 die(_("failed to start schtasks"));
2094 result
= finish_command(&child
);
2096 delete_tempfile(&tfile
);
2101 static int schtasks_schedule_tasks(void)
2103 const char *exec_path
= git_exec_path();
2105 return schtasks_schedule_task(exec_path
, SCHEDULE_HOURLY
) ||
2106 schtasks_schedule_task(exec_path
, SCHEDULE_DAILY
) ||
2107 schtasks_schedule_task(exec_path
, SCHEDULE_WEEKLY
);
2110 static int schtasks_update_schedule(int run_maintenance
, int fd
)
2112 if (run_maintenance
)
2113 return schtasks_schedule_tasks();
2115 return schtasks_remove_tasks();
2119 static int check_crontab_process(const char *cmd
)
2121 struct child_process child
= CHILD_PROCESS_INIT
;
2123 strvec_split(&child
.args
, cmd
);
2124 strvec_push(&child
.args
, "-l");
2126 child
.no_stdout
= 1;
2127 child
.no_stderr
= 1;
2128 child
.silent_exec_failure
= 1;
2130 if (start_command(&child
))
2132 /* Ignore exit code, as an empty crontab will return error. */
2133 finish_command(&child
);
2137 static int is_crontab_available(void)
2139 const char *cmd
= "crontab";
2142 if (get_schedule_cmd(&cmd
, &is_available
))
2143 return is_available
;
2147 * macOS has cron, but it requires special permissions and will
2148 * create a UI alert when attempting to run this command.
2152 return check_crontab_process(cmd
);
2156 #define BEGIN_LINE "# BEGIN GIT MAINTENANCE SCHEDULE"
2157 #define END_LINE "# END GIT MAINTENANCE SCHEDULE"
2159 static int crontab_update_schedule(int run_maintenance
, int fd
)
2161 const char *cmd
= "crontab";
2163 int in_old_region
= 0;
2164 struct child_process crontab_list
= CHILD_PROCESS_INIT
;
2165 struct child_process crontab_edit
= CHILD_PROCESS_INIT
;
2166 FILE *cron_list
, *cron_in
;
2167 struct strbuf line
= STRBUF_INIT
;
2168 struct tempfile
*tmpedit
= NULL
;
2170 get_schedule_cmd(&cmd
, NULL
);
2171 strvec_split(&crontab_list
.args
, cmd
);
2172 strvec_push(&crontab_list
.args
, "-l");
2173 crontab_list
.in
= -1;
2174 crontab_list
.out
= dup(fd
);
2175 crontab_list
.git_cmd
= 0;
2177 if (start_command(&crontab_list
))
2178 return error(_("failed to run 'crontab -l'; your system might not support 'cron'"));
2180 /* Ignore exit code, as an empty crontab will return error. */
2181 finish_command(&crontab_list
);
2183 tmpedit
= mks_tempfile_t(".git_cron_edit_tmpXXXXXX");
2185 result
= error(_("failed to create crontab temporary file"));
2188 cron_in
= fdopen_tempfile(tmpedit
, "w");
2190 result
= error(_("failed to open temporary file"));
2195 * Read from the .lock file, filtering out the old
2196 * schedule while appending the new schedule.
2198 cron_list
= fdopen(fd
, "r");
2201 while (!strbuf_getline_lf(&line
, cron_list
)) {
2202 if (!in_old_region
&& !strcmp(line
.buf
, BEGIN_LINE
))
2204 else if (in_old_region
&& !strcmp(line
.buf
, END_LINE
))
2206 else if (!in_old_region
)
2207 fprintf(cron_in
, "%s\n", line
.buf
);
2209 strbuf_release(&line
);
2211 if (run_maintenance
) {
2212 struct strbuf line_format
= STRBUF_INIT
;
2213 const char *exec_path
= git_exec_path();
2215 fprintf(cron_in
, "%s\n", BEGIN_LINE
);
2217 "# The following schedule was created by Git\n");
2218 fprintf(cron_in
, "# Any edits made in this region might be\n");
2220 "# replaced in the future by a Git command.\n\n");
2222 strbuf_addf(&line_format
,
2223 "%%s %%s * * %%s \"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%s\n",
2224 exec_path
, exec_path
);
2225 fprintf(cron_in
, line_format
.buf
, "0", "1-23", "*", "hourly");
2226 fprintf(cron_in
, line_format
.buf
, "0", "0", "1-6", "daily");
2227 fprintf(cron_in
, line_format
.buf
, "0", "0", "0", "weekly");
2228 strbuf_release(&line_format
);
2230 fprintf(cron_in
, "\n%s\n", END_LINE
);
2235 strvec_split(&crontab_edit
.args
, cmd
);
2236 strvec_push(&crontab_edit
.args
, get_tempfile_path(tmpedit
));
2237 crontab_edit
.git_cmd
= 0;
2239 if (start_command(&crontab_edit
)) {
2240 result
= error(_("failed to run 'crontab'; your system might not support 'cron'"));
2244 if (finish_command(&crontab_edit
))
2245 result
= error(_("'crontab' died"));
2249 delete_tempfile(&tmpedit
);
2253 static int real_is_systemd_timer_available(void)
2255 struct child_process child
= CHILD_PROCESS_INIT
;
2257 strvec_pushl(&child
.args
, "systemctl", "--user", "list-timers", NULL
);
2259 child
.no_stdout
= 1;
2260 child
.no_stderr
= 1;
2261 child
.silent_exec_failure
= 1;
2263 if (start_command(&child
))
2265 if (finish_command(&child
))
2270 static int is_systemd_timer_available(void)
2272 const char *cmd
= "systemctl";
2275 if (get_schedule_cmd(&cmd
, &is_available
))
2276 return is_available
;
2278 return real_is_systemd_timer_available();
2281 static char *xdg_config_home_systemd(const char *filename
)
2283 return xdg_config_home_for("systemd/user", filename
);
2286 static int systemd_timer_enable_unit(int enable
,
2287 enum schedule_priority schedule
)
2289 const char *cmd
= "systemctl";
2290 struct child_process child
= CHILD_PROCESS_INIT
;
2291 const char *frequency
= get_frequency(schedule
);
2294 * Disabling the systemd unit while it is already disabled makes
2295 * systemctl print an error.
2296 * Let's ignore it since it means we already are in the expected state:
2297 * the unit is disabled.
2299 * On the other hand, enabling a systemd unit which is already enabled
2300 * produces no error.
2303 child
.no_stderr
= 1;
2305 get_schedule_cmd(&cmd
, NULL
);
2306 strvec_split(&child
.args
, cmd
);
2307 strvec_pushl(&child
.args
, "--user", enable
? "enable" : "disable",
2309 strvec_pushf(&child
.args
, "git-maintenance@%s.timer", frequency
);
2311 if (start_command(&child
))
2312 return error(_("failed to start systemctl"));
2313 if (finish_command(&child
))
2315 * Disabling an already disabled systemd unit makes
2317 * Let's ignore this failure.
2319 * Enabling an enabled systemd unit doesn't fail.
2322 return error(_("failed to run systemctl"));
2326 static int systemd_timer_delete_unit_templates(void)
2329 char *filename
= xdg_config_home_systemd("git-maintenance@.timer");
2330 if (unlink(filename
) && !is_missing_file_error(errno
))
2331 ret
= error_errno(_("failed to delete '%s'"), filename
);
2332 FREE_AND_NULL(filename
);
2334 filename
= xdg_config_home_systemd("git-maintenance@.service");
2335 if (unlink(filename
) && !is_missing_file_error(errno
))
2336 ret
= error_errno(_("failed to delete '%s'"), filename
);
2342 static int systemd_timer_delete_units(void)
2344 return systemd_timer_enable_unit(0, SCHEDULE_HOURLY
) ||
2345 systemd_timer_enable_unit(0, SCHEDULE_DAILY
) ||
2346 systemd_timer_enable_unit(0, SCHEDULE_WEEKLY
) ||
2347 systemd_timer_delete_unit_templates();
2350 static int systemd_timer_write_unit_templates(const char *exec_path
)
2356 filename
= xdg_config_home_systemd("git-maintenance@.timer");
2357 if (safe_create_leading_directories(filename
)) {
2358 error(_("failed to create directories for '%s'"), filename
);
2361 file
= fopen_or_warn(filename
, "w");
2365 unit
= "# This file was created and is maintained by Git.\n"
2366 "# Any edits made in this file might be replaced in the future\n"
2367 "# by a Git command.\n"
2370 "Description=Optimize Git repositories data\n"
2377 "WantedBy=timers.target\n";
2378 if (fputs(unit
, file
) == EOF
) {
2379 error(_("failed to write to '%s'"), filename
);
2383 if (fclose(file
) == EOF
) {
2384 error_errno(_("failed to flush '%s'"), filename
);
2389 filename
= xdg_config_home_systemd("git-maintenance@.service");
2390 file
= fopen_or_warn(filename
, "w");
2394 unit
= "# This file was created and is maintained by Git.\n"
2395 "# Any edits made in this file might be replaced in the future\n"
2396 "# by a Git command.\n"
2399 "Description=Optimize Git repositories data\n"
2403 "ExecStart=\"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%i\n"
2404 "LockPersonality=yes\n"
2405 "MemoryDenyWriteExecute=yes\n"
2406 "NoNewPrivileges=yes\n"
2407 "RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6\n"
2408 "RestrictNamespaces=yes\n"
2409 "RestrictRealtime=yes\n"
2410 "RestrictSUIDSGID=yes\n"
2411 "SystemCallArchitectures=native\n"
2412 "SystemCallFilter=@system-service\n";
2413 if (fprintf(file
, unit
, exec_path
, exec_path
) < 0) {
2414 error(_("failed to write to '%s'"), filename
);
2418 if (fclose(file
) == EOF
) {
2419 error_errno(_("failed to flush '%s'"), filename
);
2427 systemd_timer_delete_unit_templates();
2431 static int systemd_timer_setup_units(void)
2433 const char *exec_path
= git_exec_path();
2435 int ret
= systemd_timer_write_unit_templates(exec_path
) ||
2436 systemd_timer_enable_unit(1, SCHEDULE_HOURLY
) ||
2437 systemd_timer_enable_unit(1, SCHEDULE_DAILY
) ||
2438 systemd_timer_enable_unit(1, SCHEDULE_WEEKLY
);
2440 systemd_timer_delete_units();
2444 static int systemd_timer_update_schedule(int run_maintenance
, int fd
)
2446 if (run_maintenance
)
2447 return systemd_timer_setup_units();
2449 return systemd_timer_delete_units();
2453 SCHEDULER_INVALID
= -1,
2457 SCHEDULER_LAUNCHCTL
,
2461 static const struct {
2463 int (*is_available
)(void);
2464 int (*update_schedule
)(int run_maintenance
, int fd
);
2465 } scheduler_fn
[] = {
2466 [SCHEDULER_CRON
] = {
2468 .is_available
= is_crontab_available
,
2469 .update_schedule
= crontab_update_schedule
,
2471 [SCHEDULER_SYSTEMD
] = {
2472 .name
= "systemctl",
2473 .is_available
= is_systemd_timer_available
,
2474 .update_schedule
= systemd_timer_update_schedule
,
2476 [SCHEDULER_LAUNCHCTL
] = {
2477 .name
= "launchctl",
2478 .is_available
= is_launchctl_available
,
2479 .update_schedule
= launchctl_update_schedule
,
2481 [SCHEDULER_SCHTASKS
] = {
2483 .is_available
= is_schtasks_available
,
2484 .update_schedule
= schtasks_update_schedule
,
2488 static enum scheduler
parse_scheduler(const char *value
)
2491 return SCHEDULER_INVALID
;
2492 else if (!strcasecmp(value
, "auto"))
2493 return SCHEDULER_AUTO
;
2494 else if (!strcasecmp(value
, "cron") || !strcasecmp(value
, "crontab"))
2495 return SCHEDULER_CRON
;
2496 else if (!strcasecmp(value
, "systemd") ||
2497 !strcasecmp(value
, "systemd-timer"))
2498 return SCHEDULER_SYSTEMD
;
2499 else if (!strcasecmp(value
, "launchctl"))
2500 return SCHEDULER_LAUNCHCTL
;
2501 else if (!strcasecmp(value
, "schtasks"))
2502 return SCHEDULER_SCHTASKS
;
2504 return SCHEDULER_INVALID
;
2507 static int maintenance_opt_scheduler(const struct option
*opt
, const char *arg
,
2510 enum scheduler
*scheduler
= opt
->value
;
2512 BUG_ON_OPT_NEG(unset
);
2514 *scheduler
= parse_scheduler(arg
);
2515 if (*scheduler
== SCHEDULER_INVALID
)
2516 return error(_("unrecognized --scheduler argument '%s'"), arg
);
2520 struct maintenance_start_opts
{
2521 enum scheduler scheduler
;
2524 static enum scheduler
resolve_scheduler(enum scheduler scheduler
)
2526 if (scheduler
!= SCHEDULER_AUTO
)
2529 #if defined(__APPLE__)
2530 return SCHEDULER_LAUNCHCTL
;
2532 #elif defined(GIT_WINDOWS_NATIVE)
2533 return SCHEDULER_SCHTASKS
;
2535 #elif defined(__linux__)
2536 if (is_systemd_timer_available())
2537 return SCHEDULER_SYSTEMD
;
2538 else if (is_crontab_available())
2539 return SCHEDULER_CRON
;
2541 die(_("neither systemd timers nor crontab are available"));
2544 return SCHEDULER_CRON
;
2548 static void validate_scheduler(enum scheduler scheduler
)
2550 if (scheduler
== SCHEDULER_INVALID
)
2551 BUG("invalid scheduler");
2552 if (scheduler
== SCHEDULER_AUTO
)
2553 BUG("resolve_scheduler should have been called before");
2555 if (!scheduler_fn
[scheduler
].is_available())
2556 die(_("%s scheduler is not available"),
2557 scheduler_fn
[scheduler
].name
);
2560 static int update_background_schedule(const struct maintenance_start_opts
*opts
,
2565 struct lock_file lk
;
2566 char *lock_path
= xstrfmt("%s/schedule", the_repository
->objects
->odb
->path
);
2568 if (hold_lock_file_for_update(&lk
, lock_path
, LOCK_NO_DEREF
) < 0) {
2570 return error(_("another process is scheduling background maintenance"));
2573 for (i
= 1; i
< ARRAY_SIZE(scheduler_fn
); i
++) {
2574 if (enable
&& opts
->scheduler
== i
)
2576 if (!scheduler_fn
[i
].is_available())
2578 scheduler_fn
[i
].update_schedule(0, get_lock_file_fd(&lk
));
2582 result
= scheduler_fn
[opts
->scheduler
].update_schedule(
2583 1, get_lock_file_fd(&lk
));
2585 rollback_lock_file(&lk
);
2591 static const char *const builtin_maintenance_start_usage
[] = {
2592 N_("git maintenance start [--scheduler=<scheduler>]"),
2596 static int maintenance_start(int argc
, const char **argv
, const char *prefix
)
2598 struct maintenance_start_opts opts
= { 0 };
2599 struct option options
[] = {
2601 0, "scheduler", &opts
.scheduler
, N_("scheduler"),
2602 N_("scheduler to trigger git maintenance run"),
2603 PARSE_OPT_NONEG
, maintenance_opt_scheduler
),
2606 const char *register_args
[] = { "register", NULL
};
2608 argc
= parse_options(argc
, argv
, prefix
, options
,
2609 builtin_maintenance_start_usage
, 0);
2611 usage_with_options(builtin_maintenance_start_usage
, options
);
2613 opts
.scheduler
= resolve_scheduler(opts
.scheduler
);
2614 validate_scheduler(opts
.scheduler
);
2616 if (maintenance_register(ARRAY_SIZE(register_args
)-1, register_args
, NULL
))
2617 warning(_("failed to add repo to global config"));
2618 return update_background_schedule(&opts
, 1);
2621 static const char *const builtin_maintenance_stop_usage
[] = {
2622 "git maintenance stop",
2626 static int maintenance_stop(int argc
, const char **argv
, const char *prefix
)
2628 struct option options
[] = {
2631 argc
= parse_options(argc
, argv
, prefix
, options
,
2632 builtin_maintenance_stop_usage
, 0);
2634 usage_with_options(builtin_maintenance_stop_usage
, options
);
2635 return update_background_schedule(NULL
, 0);
2638 static const char * const builtin_maintenance_usage
[] = {
2639 N_("git maintenance <subcommand> [<options>]"),
2643 int cmd_maintenance(int argc
, const char **argv
, const char *prefix
)
2645 parse_opt_subcommand_fn
*fn
= NULL
;
2646 struct option builtin_maintenance_options
[] = {
2647 OPT_SUBCOMMAND("run", &fn
, maintenance_run
),
2648 OPT_SUBCOMMAND("start", &fn
, maintenance_start
),
2649 OPT_SUBCOMMAND("stop", &fn
, maintenance_stop
),
2650 OPT_SUBCOMMAND("register", &fn
, maintenance_register
),
2651 OPT_SUBCOMMAND("unregister", &fn
, maintenance_unregister
),
2655 argc
= parse_options(argc
, argv
, prefix
, builtin_maintenance_options
,
2656 builtin_maintenance_usage
, 0);
2657 return fn(argc
, argv
, prefix
);