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
16 #include "environment.h"
18 #include "repository.h"
22 #include "parse-options.h"
23 #include "run-command.h"
27 #include "commit-graph.h"
29 #include "object-file.h"
30 #include "object-store-ll.h"
32 #include "pack-objects.h"
36 #include "promisor-remote.h"
45 #define FAILED_RUN "failed to run %s"
47 static const char * const builtin_gc_usage
[] = {
48 N_("git gc [<options>]"),
52 static int pack_refs
= 1;
53 static int prune_reflogs
= 1;
54 static int cruft_packs
= 1;
55 static int aggressive_depth
= 50;
56 static int aggressive_window
= 250;
57 static int gc_auto_threshold
= 6700;
58 static int gc_auto_pack_limit
= 50;
59 static int detach_auto
= 1;
60 static timestamp_t gc_log_expire_time
;
61 static const char *gc_log_expire
= "1.day.ago";
62 static const char *prune_expire
= "2.weeks.ago";
63 static const char *prune_worktrees_expire
= "3.months.ago";
64 static unsigned long big_pack_threshold
;
65 static unsigned long max_delta_cache_size
= DEFAULT_DELTA_CACHE_SIZE
;
67 static struct strvec reflog
= STRVEC_INIT
;
68 static struct strvec repack
= STRVEC_INIT
;
69 static struct strvec prune
= STRVEC_INIT
;
70 static struct strvec prune_worktrees
= STRVEC_INIT
;
71 static struct strvec rerere
= STRVEC_INIT
;
73 static struct tempfile
*pidfile
;
74 static struct lock_file log_lock
;
76 static struct string_list pack_garbage
= STRING_LIST_INIT_DUP
;
78 static void clean_pack_garbage(void)
81 for (i
= 0; i
< pack_garbage
.nr
; i
++)
82 unlink_or_warn(pack_garbage
.items
[i
].string
);
83 string_list_clear(&pack_garbage
, 0);
86 static void report_pack_garbage(unsigned seen_bits
, const char *path
)
88 if (seen_bits
== PACKDIR_FILE_IDX
)
89 string_list_append(&pack_garbage
, path
);
92 static void process_log_file(void)
95 if (fstat(get_lock_file_fd(&log_lock
), &st
)) {
97 * Perhaps there was an i/o error or another
98 * unlikely situation. Try to make a note of
99 * this in gc.log along with any existing
102 int saved_errno
= errno
;
103 fprintf(stderr
, _("Failed to fstat %s: %s"),
104 get_lock_file_path(&log_lock
),
105 strerror(saved_errno
));
107 commit_lock_file(&log_lock
);
109 } else if (st
.st_size
) {
110 /* There was some error recorded in the lock file */
111 commit_lock_file(&log_lock
);
113 /* No error, clean up any old gc.log */
114 unlink(git_path("gc.log"));
115 rollback_lock_file(&log_lock
);
119 static void process_log_file_at_exit(void)
125 static void process_log_file_on_signal(int signo
)
132 static int gc_config_is_timestamp_never(const char *var
)
137 if (!git_config_get_value(var
, &value
) && value
) {
138 if (parse_expiry_date(value
, &expire
))
139 die(_("failed to parse '%s' value '%s'"), var
, value
);
145 static void gc_config(void)
149 if (!git_config_get_value("gc.packrefs", &value
)) {
150 if (value
&& !strcmp(value
, "notbare"))
153 pack_refs
= git_config_bool("gc.packrefs", value
);
156 if (gc_config_is_timestamp_never("gc.reflogexpire") &&
157 gc_config_is_timestamp_never("gc.reflogexpireunreachable"))
160 git_config_get_int("gc.aggressivewindow", &aggressive_window
);
161 git_config_get_int("gc.aggressivedepth", &aggressive_depth
);
162 git_config_get_int("gc.auto", &gc_auto_threshold
);
163 git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit
);
164 git_config_get_bool("gc.autodetach", &detach_auto
);
165 git_config_get_bool("gc.cruftpacks", &cruft_packs
);
166 git_config_get_expiry("gc.pruneexpire", &prune_expire
);
167 git_config_get_expiry("gc.worktreepruneexpire", &prune_worktrees_expire
);
168 git_config_get_expiry("gc.logexpiry", &gc_log_expire
);
170 git_config_get_ulong("gc.bigpackthreshold", &big_pack_threshold
);
171 git_config_get_ulong("pack.deltacachesize", &max_delta_cache_size
);
173 git_config(git_default_config
, NULL
);
176 struct maintenance_run_opts
;
177 static int maintenance_task_pack_refs(MAYBE_UNUSED
struct maintenance_run_opts
*opts
)
179 struct child_process cmd
= CHILD_PROCESS_INIT
;
182 strvec_pushl(&cmd
.args
, "pack-refs", "--all", "--prune", NULL
);
183 return run_command(&cmd
);
186 static int too_many_loose_objects(void)
189 * Quickly check if a "gc" is needed, by estimating how
190 * many loose objects there are. Because SHA-1 is evenly
191 * distributed, we can check only one and get a reasonable
199 const unsigned hexsz_loose
= the_hash_algo
->hexsz
- 2;
201 dir
= opendir(git_path("objects/17"));
205 auto_threshold
= DIV_ROUND_UP(gc_auto_threshold
, 256);
206 while ((ent
= readdir(dir
)) != NULL
) {
207 if (strspn(ent
->d_name
, "0123456789abcdef") != hexsz_loose
||
208 ent
->d_name
[hexsz_loose
] != '\0')
210 if (++num_loose
> auto_threshold
) {
219 static struct packed_git
*find_base_packs(struct string_list
*packs
,
222 struct packed_git
*p
, *base
= NULL
;
224 for (p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
225 if (!p
->pack_local
|| p
->is_cruft
)
228 if (p
->pack_size
>= limit
)
229 string_list_append(packs
, p
->pack_name
);
230 } else if (!base
|| base
->pack_size
< p
->pack_size
) {
236 string_list_append(packs
, base
->pack_name
);
241 static int too_many_packs(void)
243 struct packed_git
*p
;
246 if (gc_auto_pack_limit
<= 0)
249 for (cnt
= 0, p
= get_all_packs(the_repository
); p
; p
= p
->next
) {
255 * Perhaps check the size of the pack and count only
256 * very small ones here?
260 return gc_auto_pack_limit
< cnt
;
263 static uint64_t total_ram(void)
265 #if defined(HAVE_SYSINFO)
270 #elif defined(HAVE_BSD_SYSCTL) && (defined(HW_MEMSIZE) || defined(HW_PHYSMEM))
271 int64_t physical_memory
;
276 # if defined(HW_MEMSIZE)
281 length
= sizeof(int64_t);
282 if (!sysctl(mib
, 2, &physical_memory
, &length
, NULL
, 0))
283 return physical_memory
;
284 #elif defined(GIT_WINDOWS_NATIVE)
285 MEMORYSTATUSEX memInfo
;
287 memInfo
.dwLength
= sizeof(MEMORYSTATUSEX
);
288 if (GlobalMemoryStatusEx(&memInfo
))
289 return memInfo
.ullTotalPhys
;
294 static uint64_t estimate_repack_memory(struct packed_git
*pack
)
296 unsigned long nr_objects
= repo_approximate_object_count(the_repository
);
297 size_t os_cache
, heap
;
299 if (!pack
|| !nr_objects
)
303 * First we have to scan through at least one pack.
304 * Assume enough room in OS file cache to keep the entire pack
305 * or we may accidentally evict data of other processes from
308 os_cache
= pack
->pack_size
+ pack
->index_size
;
309 /* then pack-objects needs lots more for book keeping */
310 heap
= sizeof(struct object_entry
) * nr_objects
;
312 * internal rev-list --all --objects takes up some memory too,
313 * let's say half of it is for blobs
315 heap
+= sizeof(struct blob
) * nr_objects
/ 2;
317 * and the other half is for trees (commits and tags are
318 * usually insignificant)
320 heap
+= sizeof(struct tree
) * nr_objects
/ 2;
321 /* and then obj_hash[], underestimated in fact */
322 heap
+= sizeof(struct object
*) * nr_objects
;
323 /* revindex is used also */
324 heap
+= (sizeof(off_t
) + sizeof(uint32_t)) * nr_objects
;
326 * read_sha1_file() (either at delta calculation phase, or
327 * writing phase) also fills up the delta base cache
329 heap
+= delta_base_cache_limit
;
330 /* and of course pack-objects has its own delta cache */
331 heap
+= max_delta_cache_size
;
333 return os_cache
+ heap
;
336 static int keep_one_pack(struct string_list_item
*item
, void *data UNUSED
)
338 strvec_pushf(&repack
, "--keep-pack=%s", basename(item
->string
));
342 static void add_repack_all_option(struct string_list
*keep_pack
)
344 if (prune_expire
&& !strcmp(prune_expire
, "now"))
345 strvec_push(&repack
, "-a");
346 else if (cruft_packs
) {
347 strvec_push(&repack
, "--cruft");
349 strvec_pushf(&repack
, "--cruft-expiration=%s", prune_expire
);
351 strvec_push(&repack
, "-A");
353 strvec_pushf(&repack
, "--unpack-unreachable=%s", prune_expire
);
357 for_each_string_list(keep_pack
, keep_one_pack
, NULL
);
360 static void add_repack_incremental_option(void)
362 strvec_push(&repack
, "--no-write-bitmap-index");
365 static int need_to_gc(void)
368 * Setting gc.auto to 0 or negative can disable the
371 if (gc_auto_threshold
<= 0)
375 * If there are too many loose objects, but not too many
376 * packs, we run "repack -d -l". If there are too many packs,
377 * we run "repack -A -d -l". Otherwise we tell the caller
380 if (too_many_packs()) {
381 struct string_list keep_pack
= STRING_LIST_INIT_NODUP
;
383 if (big_pack_threshold
) {
384 find_base_packs(&keep_pack
, big_pack_threshold
);
385 if (keep_pack
.nr
>= gc_auto_pack_limit
) {
386 big_pack_threshold
= 0;
387 string_list_clear(&keep_pack
, 0);
388 find_base_packs(&keep_pack
, 0);
391 struct packed_git
*p
= find_base_packs(&keep_pack
, 0);
392 uint64_t mem_have
, mem_want
;
394 mem_have
= total_ram();
395 mem_want
= estimate_repack_memory(p
);
398 * Only allow 1/2 of memory for pack-objects, leave
399 * the rest for the OS and other processes in the
402 if (!mem_have
|| mem_want
< mem_have
/ 2)
403 string_list_clear(&keep_pack
, 0);
406 add_repack_all_option(&keep_pack
);
407 string_list_clear(&keep_pack
, 0);
408 } else if (too_many_loose_objects())
409 add_repack_incremental_option();
413 if (run_hooks("pre-auto-gc"))
418 /* return NULL on success, else hostname running the gc */
419 static const char *lock_repo_for_gc(int force
, pid_t
* ret_pid
)
421 struct lock_file lock
= LOCK_INIT
;
422 char my_host
[HOST_NAME_MAX
+ 1];
423 struct strbuf sb
= STRBUF_INIT
;
430 if (is_tempfile_active(pidfile
))
434 if (xgethostname(my_host
, sizeof(my_host
)))
435 xsnprintf(my_host
, sizeof(my_host
), "unknown");
437 pidfile_path
= git_pathdup("gc.pid");
438 fd
= hold_lock_file_for_update(&lock
, pidfile_path
,
441 static char locking_host
[HOST_NAME_MAX
+ 1];
442 static char *scan_fmt
;
446 scan_fmt
= xstrfmt("%s %%%ds", "%"SCNuMAX
, HOST_NAME_MAX
);
447 fp
= fopen(pidfile_path
, "r");
448 memset(locking_host
, 0, sizeof(locking_host
));
451 !fstat(fileno(fp
), &st
) &&
453 * 12 hour limit is very generous as gc should
454 * never take that long. On the other hand we
455 * don't really need a strict limit here,
456 * running gc --auto one day late is not a big
457 * problem. --force can be used in manual gc
458 * after the user verifies that no gc is
461 time(NULL
) - st
.st_mtime
<= 12 * 3600 &&
462 fscanf(fp
, scan_fmt
, &pid
, locking_host
) == 2 &&
463 /* be gentle to concurrent "gc" on remote hosts */
464 (strcmp(locking_host
, my_host
) || !kill(pid
, 0) || errno
== EPERM
);
469 rollback_lock_file(&lock
);
476 strbuf_addf(&sb
, "%"PRIuMAX
" %s",
477 (uintmax_t) getpid(), my_host
);
478 write_in_full(fd
, sb
.buf
, sb
.len
);
480 commit_lock_file(&lock
);
481 pidfile
= register_tempfile(pidfile_path
);
487 * Returns 0 if there was no previous error and gc can proceed, 1 if
488 * gc should not proceed due to an error in the last run. Prints a
489 * message and returns with a non-[01] status code if an error occurred
490 * while reading gc.log
492 static int report_last_gc_error(void)
494 struct strbuf sb
= STRBUF_INIT
;
498 char *gc_log_path
= git_pathdup("gc.log");
500 if (stat(gc_log_path
, &st
)) {
504 ret
= die_message_errno(_("cannot stat '%s'"), gc_log_path
);
508 if (st
.st_mtime
< gc_log_expire_time
)
511 len
= strbuf_read_file(&sb
, gc_log_path
, 0);
513 ret
= die_message_errno(_("cannot read '%s'"), gc_log_path
);
516 * A previous gc failed. Report the error, and don't
517 * bother with an automatic gc run since it is likely
518 * to fail in the same way.
520 warning(_("The last gc run reported the following. "
521 "Please correct the root cause\n"
523 "Automatic cleanup will not be performed "
524 "until the file is removed.\n\n"
526 gc_log_path
, sb
.buf
);
535 static void gc_before_repack(void)
538 * We may be called twice, as both the pre- and
539 * post-daemonized phases will call us, but running these
540 * commands more than once is pointless and wasteful.
546 if (pack_refs
&& maintenance_task_pack_refs(NULL
))
547 die(FAILED_RUN
, "pack-refs");
550 struct child_process cmd
= CHILD_PROCESS_INIT
;
553 strvec_pushv(&cmd
.args
, reflog
.v
);
554 if (run_command(&cmd
))
555 die(FAILED_RUN
, reflog
.v
[0]);
559 int cmd_gc(int argc
, const char **argv
, const char *prefix
)
568 int keep_largest_pack
= -1;
570 struct child_process rerere_cmd
= CHILD_PROCESS_INIT
;
572 struct option builtin_gc_options
[] = {
573 OPT__QUIET(&quiet
, N_("suppress progress reporting")),
574 { OPTION_STRING
, 0, "prune", &prune_expire
, N_("date"),
575 N_("prune unreferenced objects"),
576 PARSE_OPT_OPTARG
, NULL
, (intptr_t)prune_expire
},
577 OPT_BOOL(0, "cruft", &cruft_packs
, N_("pack unreferenced objects separately")),
578 OPT_BOOL(0, "aggressive", &aggressive
, N_("be more thorough (increased runtime)")),
579 OPT_BOOL_F(0, "auto", &auto_gc
, N_("enable auto-gc mode"),
580 PARSE_OPT_NOCOMPLETE
),
581 OPT_BOOL_F(0, "force", &force
,
582 N_("force running gc even if there may be another gc running"),
583 PARSE_OPT_NOCOMPLETE
),
584 OPT_BOOL(0, "keep-largest-pack", &keep_largest_pack
,
585 N_("repack all other packs except the largest pack")),
589 if (argc
== 2 && !strcmp(argv
[1], "-h"))
590 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
592 strvec_pushl(&reflog
, "reflog", "expire", "--all", NULL
);
593 strvec_pushl(&repack
, "repack", "-d", "-l", NULL
);
594 strvec_pushl(&prune
, "prune", "--expire", NULL
);
595 strvec_pushl(&prune_worktrees
, "worktree", "prune", "--expire", NULL
);
596 strvec_pushl(&rerere
, "rerere", "gc", NULL
);
598 /* default expiry time, overwritten in gc_config */
600 if (parse_expiry_date(gc_log_expire
, &gc_log_expire_time
))
601 die(_("failed to parse gc.logExpiry value %s"), gc_log_expire
);
604 pack_refs
= !is_bare_repository();
606 argc
= parse_options(argc
, argv
, prefix
, builtin_gc_options
,
607 builtin_gc_usage
, 0);
609 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
611 if (prune_expire
&& parse_expiry_date(prune_expire
, &dummy
))
612 die(_("failed to parse prune expiry value %s"), prune_expire
);
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 (repo_has_promisor_remote(the_repository
))
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 (repo_parse_commit(the_repository
, 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 (repo_parse_commit(the_repository
, 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";
1501 char *maintpath
= get_maintpath();
1502 struct string_list_item
*item
;
1503 const struct string_list
*list
;
1505 argc
= parse_options(argc
, argv
, prefix
, options
,
1506 builtin_maintenance_register_usage
, 0);
1508 usage_with_options(builtin_maintenance_register_usage
,
1511 /* Disable foreground maintenance */
1512 git_config_set("maintenance.auto", "false");
1514 /* Set maintenance strategy, if unset */
1515 if (git_config_get("maintenance.strategy"))
1516 git_config_set("maintenance.strategy", "incremental");
1518 if (!git_config_get_string_multi(key
, &list
)) {
1519 for_each_string_list_item(item
, list
) {
1520 if (!strcmp(maintpath
, item
->string
)) {
1529 char *user_config
= NULL
, *xdg_config
= NULL
;
1532 git_global_config(&user_config
, &xdg_config
);
1533 config_file
= user_config
;
1535 die(_("$HOME not set"));
1537 rc
= git_config_set_multivar_in_file_gently(
1538 config_file
, "maintenance.repo", maintpath
,
1539 CONFIG_REGEX_NONE
, 0);
1544 die(_("unable to add '%s' value of '%s'"),
1552 static char const * const builtin_maintenance_unregister_usage
[] = {
1553 "git maintenance unregister [--config-file <path>] [--force]",
1557 static int maintenance_unregister(int argc
, const char **argv
, const char *prefix
)
1560 char *config_file
= NULL
;
1561 struct option options
[] = {
1562 OPT_STRING(0, "config-file", &config_file
, N_("file"), N_("use given config file")),
1564 N_("return success even if repository was not registered"),
1565 PARSE_OPT_NOCOMPLETE
),
1568 const char *key
= "maintenance.repo";
1569 char *maintpath
= get_maintpath();
1571 struct string_list_item
*item
;
1572 const struct string_list
*list
;
1573 struct config_set cs
= { { 0 } };
1575 argc
= parse_options(argc
, argv
, prefix
, options
,
1576 builtin_maintenance_unregister_usage
, 0);
1578 usage_with_options(builtin_maintenance_unregister_usage
,
1582 git_configset_init(&cs
);
1583 git_configset_add_file(&cs
, config_file
);
1586 ? git_configset_get_string_multi(&cs
, key
, &list
)
1587 : git_config_get_string_multi(key
, &list
))) {
1588 for_each_string_list_item(item
, list
) {
1589 if (!strcmp(maintpath
, item
->string
)) {
1598 char *user_config
= NULL
, *xdg_config
= NULL
;
1600 git_global_config(&user_config
, &xdg_config
);
1601 config_file
= user_config
;
1603 die(_("$HOME not set"));
1605 rc
= git_config_set_multivar_in_file_gently(
1606 config_file
, key
, NULL
, maintpath
,
1607 CONFIG_FLAGS_MULTI_REPLACE
| CONFIG_FLAGS_FIXED_VALUE
);
1612 (!force
|| rc
== CONFIG_NOTHING_SET
))
1613 die(_("unable to unset '%s' value of '%s'"),
1615 } else if (!force
) {
1616 die(_("repository '%s' is not registered"), maintpath
);
1619 git_configset_clear(&cs
);
1624 static const char *get_frequency(enum schedule_priority schedule
)
1627 case SCHEDULE_HOURLY
:
1629 case SCHEDULE_DAILY
:
1631 case SCHEDULE_WEEKLY
:
1634 BUG("invalid schedule %d", schedule
);
1639 * get_schedule_cmd` reads the GIT_TEST_MAINT_SCHEDULER environment variable
1640 * to mock the schedulers that `git maintenance start` rely on.
1642 * For test purpose, GIT_TEST_MAINT_SCHEDULER can be set to a comma-separated
1643 * list of colon-separated key/value pairs where each pair contains a scheduler
1644 * and its corresponding mock.
1646 * * If $GIT_TEST_MAINT_SCHEDULER is not set, return false and leave the
1647 * arguments unmodified.
1649 * * If $GIT_TEST_MAINT_SCHEDULER is set, return true.
1650 * In this case, the *cmd value is read as input.
1652 * * if the input value *cmd is the key of one of the comma-separated list
1653 * item, then *is_available is set to true and *cmd is modified and becomes
1656 * * if the input value *cmd isn’t the key of any of the comma-separated list
1657 * item, then *is_available is set to false.
1660 * GIT_TEST_MAINT_SCHEDULER not set
1661 * +-------+-------------------------------------------------+
1662 * | Input | Output |
1663 * | *cmd | return code | *cmd | *is_available |
1664 * +-------+-------------+-------------------+---------------+
1665 * | "foo" | false | "foo" (unchanged) | (unchanged) |
1666 * +-------+-------------+-------------------+---------------+
1668 * GIT_TEST_MAINT_SCHEDULER set to “foo:./mock_foo.sh,bar:./mock_bar.sh”
1669 * +-------+-------------------------------------------------+
1670 * | Input | Output |
1671 * | *cmd | return code | *cmd | *is_available |
1672 * +-------+-------------+-------------------+---------------+
1673 * | "foo" | true | "./mock.foo.sh" | true |
1674 * | "qux" | true | "qux" (unchanged) | false |
1675 * +-------+-------------+-------------------+---------------+
1677 static int get_schedule_cmd(const char **cmd
, int *is_available
)
1679 char *testing
= xstrdup_or_null(getenv("GIT_TEST_MAINT_SCHEDULER"));
1680 struct string_list_item
*item
;
1681 struct string_list list
= STRING_LIST_INIT_NODUP
;
1689 string_list_split_in_place(&list
, testing
, ",", -1);
1690 for_each_string_list_item(item
, &list
) {
1691 struct string_list pair
= STRING_LIST_INIT_NODUP
;
1693 if (string_list_split_in_place(&pair
, item
->string
, ":", 2) != 2)
1696 if (!strcmp(*cmd
, pair
.items
[0].string
)) {
1697 *cmd
= pair
.items
[1].string
;
1700 string_list_clear(&list
, 0);
1706 string_list_clear(&list
, 0);
1711 static int is_launchctl_available(void)
1713 const char *cmd
= "launchctl";
1715 if (get_schedule_cmd(&cmd
, &is_available
))
1716 return is_available
;
1725 static char *launchctl_service_name(const char *frequency
)
1727 struct strbuf label
= STRBUF_INIT
;
1728 strbuf_addf(&label
, "org.git-scm.git.%s", frequency
);
1729 return strbuf_detach(&label
, NULL
);
1732 static char *launchctl_service_filename(const char *name
)
1735 struct strbuf filename
= STRBUF_INIT
;
1736 strbuf_addf(&filename
, "~/Library/LaunchAgents/%s.plist", name
);
1738 expanded
= interpolate_path(filename
.buf
, 1);
1740 die(_("failed to expand path '%s'"), filename
.buf
);
1742 strbuf_release(&filename
);
1746 static char *launchctl_get_uid(void)
1748 return xstrfmt("gui/%d", getuid());
1751 static int launchctl_boot_plist(int enable
, const char *filename
)
1753 const char *cmd
= "launchctl";
1755 struct child_process child
= CHILD_PROCESS_INIT
;
1756 char *uid
= launchctl_get_uid();
1758 get_schedule_cmd(&cmd
, NULL
);
1759 strvec_split(&child
.args
, cmd
);
1760 strvec_pushl(&child
.args
, enable
? "bootstrap" : "bootout", uid
,
1763 child
.no_stderr
= 1;
1764 child
.no_stdout
= 1;
1766 if (start_command(&child
))
1767 die(_("failed to start launchctl"));
1769 result
= finish_command(&child
);
1775 static int launchctl_remove_plist(enum schedule_priority schedule
)
1777 const char *frequency
= get_frequency(schedule
);
1778 char *name
= launchctl_service_name(frequency
);
1779 char *filename
= launchctl_service_filename(name
);
1780 int result
= launchctl_boot_plist(0, filename
);
1787 static int launchctl_remove_plists(void)
1789 return launchctl_remove_plist(SCHEDULE_HOURLY
) ||
1790 launchctl_remove_plist(SCHEDULE_DAILY
) ||
1791 launchctl_remove_plist(SCHEDULE_WEEKLY
);
1794 static int launchctl_list_contains_plist(const char *name
, const char *cmd
)
1796 struct child_process child
= CHILD_PROCESS_INIT
;
1798 strvec_split(&child
.args
, cmd
);
1799 strvec_pushl(&child
.args
, "list", name
, NULL
);
1801 child
.no_stderr
= 1;
1802 child
.no_stdout
= 1;
1804 if (start_command(&child
))
1805 die(_("failed to start launchctl"));
1807 /* Returns failure if 'name' doesn't exist. */
1808 return !finish_command(&child
);
1811 static int launchctl_schedule_plist(const char *exec_path
, enum schedule_priority schedule
)
1814 const char *preamble
, *repeat
;
1815 const char *frequency
= get_frequency(schedule
);
1816 char *name
= launchctl_service_name(frequency
);
1817 char *filename
= launchctl_service_filename(name
);
1818 struct lock_file lk
= LOCK_INIT
;
1819 static unsigned long lock_file_timeout_ms
= ULONG_MAX
;
1820 struct strbuf plist
= STRBUF_INIT
, plist2
= STRBUF_INIT
;
1822 const char *cmd
= "launchctl";
1824 get_schedule_cmd(&cmd
, NULL
);
1825 preamble
= "<?xml version=\"1.0\"?>\n"
1826 "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
1827 "<plist version=\"1.0\">"
1829 "<key>Label</key><string>%s</string>\n"
1830 "<key>ProgramArguments</key>\n"
1832 "<string>%s/git</string>\n"
1833 "<string>--exec-path=%s</string>\n"
1834 "<string>for-each-repo</string>\n"
1835 "<string>--config=maintenance.repo</string>\n"
1836 "<string>maintenance</string>\n"
1837 "<string>run</string>\n"
1838 "<string>--schedule=%s</string>\n"
1840 "<key>StartCalendarInterval</key>\n"
1842 strbuf_addf(&plist
, preamble
, name
, exec_path
, exec_path
, frequency
);
1845 case SCHEDULE_HOURLY
:
1847 "<key>Hour</key><integer>%d</integer>\n"
1848 "<key>Minute</key><integer>0</integer>\n"
1850 for (i
= 1; i
<= 23; i
++)
1851 strbuf_addf(&plist
, repeat
, i
);
1854 case SCHEDULE_DAILY
:
1856 "<key>Day</key><integer>%d</integer>\n"
1857 "<key>Hour</key><integer>0</integer>\n"
1858 "<key>Minute</key><integer>0</integer>\n"
1860 for (i
= 1; i
<= 6; i
++)
1861 strbuf_addf(&plist
, repeat
, i
);
1864 case SCHEDULE_WEEKLY
:
1865 strbuf_addstr(&plist
,
1867 "<key>Day</key><integer>0</integer>\n"
1868 "<key>Hour</key><integer>0</integer>\n"
1869 "<key>Minute</key><integer>0</integer>\n"
1877 strbuf_addstr(&plist
, "</array>\n</dict>\n</plist>\n");
1879 if (safe_create_leading_directories(filename
))
1880 die(_("failed to create directories for '%s'"), filename
);
1882 if ((long)lock_file_timeout_ms
< 0 &&
1883 git_config_get_ulong("gc.launchctlplistlocktimeoutms",
1884 &lock_file_timeout_ms
))
1885 lock_file_timeout_ms
= 150;
1887 fd
= hold_lock_file_for_update_timeout(&lk
, filename
, LOCK_DIE_ON_ERROR
,
1888 lock_file_timeout_ms
);
1891 * Does this file already exist? With the intended contents? Is it
1892 * registered already? Then it does not need to be re-registered.
1894 if (!stat(filename
, &st
) && st
.st_size
== plist
.len
&&
1895 strbuf_read_file(&plist2
, filename
, plist
.len
) == plist
.len
&&
1896 !strbuf_cmp(&plist
, &plist2
) &&
1897 launchctl_list_contains_plist(name
, cmd
))
1898 rollback_lock_file(&lk
);
1900 if (write_in_full(fd
, plist
.buf
, plist
.len
) < 0 ||
1901 commit_lock_file(&lk
))
1902 die_errno(_("could not write '%s'"), filename
);
1904 /* bootout might fail if not already running, so ignore */
1905 launchctl_boot_plist(0, filename
);
1906 if (launchctl_boot_plist(1, filename
))
1907 die(_("failed to bootstrap service %s"), filename
);
1912 strbuf_release(&plist
);
1913 strbuf_release(&plist2
);
1917 static int launchctl_add_plists(void)
1919 const char *exec_path
= git_exec_path();
1921 return launchctl_schedule_plist(exec_path
, SCHEDULE_HOURLY
) ||
1922 launchctl_schedule_plist(exec_path
, SCHEDULE_DAILY
) ||
1923 launchctl_schedule_plist(exec_path
, SCHEDULE_WEEKLY
);
1926 static int launchctl_update_schedule(int run_maintenance
, int fd
)
1928 if (run_maintenance
)
1929 return launchctl_add_plists();
1931 return launchctl_remove_plists();
1934 static int is_schtasks_available(void)
1936 const char *cmd
= "schtasks";
1938 if (get_schedule_cmd(&cmd
, &is_available
))
1939 return is_available
;
1941 #ifdef GIT_WINDOWS_NATIVE
1948 static char *schtasks_task_name(const char *frequency
)
1950 struct strbuf label
= STRBUF_INIT
;
1951 strbuf_addf(&label
, "Git Maintenance (%s)", frequency
);
1952 return strbuf_detach(&label
, NULL
);
1955 static int schtasks_remove_task(enum schedule_priority schedule
)
1957 const char *cmd
= "schtasks";
1958 struct child_process child
= CHILD_PROCESS_INIT
;
1959 const char *frequency
= get_frequency(schedule
);
1960 char *name
= schtasks_task_name(frequency
);
1962 get_schedule_cmd(&cmd
, NULL
);
1963 strvec_split(&child
.args
, cmd
);
1964 strvec_pushl(&child
.args
, "/delete", "/tn", name
, "/f", NULL
);
1967 return run_command(&child
);
1970 static int schtasks_remove_tasks(void)
1972 return schtasks_remove_task(SCHEDULE_HOURLY
) ||
1973 schtasks_remove_task(SCHEDULE_DAILY
) ||
1974 schtasks_remove_task(SCHEDULE_WEEKLY
);
1977 static int schtasks_schedule_task(const char *exec_path
, enum schedule_priority schedule
)
1979 const char *cmd
= "schtasks";
1981 struct child_process child
= CHILD_PROCESS_INIT
;
1983 struct tempfile
*tfile
;
1984 const char *frequency
= get_frequency(schedule
);
1985 char *name
= schtasks_task_name(frequency
);
1986 struct strbuf tfilename
= STRBUF_INIT
;
1988 get_schedule_cmd(&cmd
, NULL
);
1990 strbuf_addf(&tfilename
, "%s/schedule_%s_XXXXXX",
1991 get_git_common_dir(), frequency
);
1992 tfile
= xmks_tempfile(tfilename
.buf
);
1993 strbuf_release(&tfilename
);
1995 if (!fdopen_tempfile(tfile
, "w"))
1996 die(_("failed to create temp xml file"));
1998 xml
= "<?xml version=\"1.0\" ?>\n"
1999 "<Task version=\"1.4\" xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n"
2001 "<CalendarTrigger>\n";
2002 fputs(xml
, tfile
->fp
);
2005 case SCHEDULE_HOURLY
:
2007 "<StartBoundary>2020-01-01T01:00:00</StartBoundary>\n"
2008 "<Enabled>true</Enabled>\n"
2010 "<DaysInterval>1</DaysInterval>\n"
2011 "</ScheduleByDay>\n"
2013 "<Interval>PT1H</Interval>\n"
2014 "<Duration>PT23H</Duration>\n"
2015 "<StopAtDurationEnd>false</StopAtDurationEnd>\n"
2019 case SCHEDULE_DAILY
:
2021 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2022 "<Enabled>true</Enabled>\n"
2023 "<ScheduleByWeek>\n"
2032 "<WeeksInterval>1</WeeksInterval>\n"
2033 "</ScheduleByWeek>\n");
2036 case SCHEDULE_WEEKLY
:
2038 "<StartBoundary>2020-01-01T00:00:00</StartBoundary>\n"
2039 "<Enabled>true</Enabled>\n"
2040 "<ScheduleByWeek>\n"
2044 "<WeeksInterval>1</WeeksInterval>\n"
2045 "</ScheduleByWeek>\n");
2052 xml
= "</CalendarTrigger>\n"
2055 "<Principal id=\"Author\">\n"
2056 "<LogonType>InteractiveToken</LogonType>\n"
2057 "<RunLevel>LeastPrivilege</RunLevel>\n"
2061 "<MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>\n"
2062 "<Enabled>true</Enabled>\n"
2063 "<Hidden>true</Hidden>\n"
2064 "<UseUnifiedSchedulingEngine>true</UseUnifiedSchedulingEngine>\n"
2065 "<WakeToRun>false</WakeToRun>\n"
2066 "<ExecutionTimeLimit>PT72H</ExecutionTimeLimit>\n"
2067 "<Priority>7</Priority>\n"
2069 "<Actions Context=\"Author\">\n"
2071 "<Command>\"%s\\git.exe\"</Command>\n"
2072 "<Arguments>--exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%s</Arguments>\n"
2076 fprintf(tfile
->fp
, xml
, exec_path
, exec_path
, frequency
);
2077 strvec_split(&child
.args
, cmd
);
2078 strvec_pushl(&child
.args
, "/create", "/tn", name
, "/f", "/xml",
2079 get_tempfile_path(tfile
), NULL
);
2080 close_tempfile_gently(tfile
);
2082 child
.no_stdout
= 1;
2083 child
.no_stderr
= 1;
2085 if (start_command(&child
))
2086 die(_("failed to start schtasks"));
2087 result
= finish_command(&child
);
2089 delete_tempfile(&tfile
);
2094 static int schtasks_schedule_tasks(void)
2096 const char *exec_path
= git_exec_path();
2098 return schtasks_schedule_task(exec_path
, SCHEDULE_HOURLY
) ||
2099 schtasks_schedule_task(exec_path
, SCHEDULE_DAILY
) ||
2100 schtasks_schedule_task(exec_path
, SCHEDULE_WEEKLY
);
2103 static int schtasks_update_schedule(int run_maintenance
, int fd
)
2105 if (run_maintenance
)
2106 return schtasks_schedule_tasks();
2108 return schtasks_remove_tasks();
2112 static int check_crontab_process(const char *cmd
)
2114 struct child_process child
= CHILD_PROCESS_INIT
;
2116 strvec_split(&child
.args
, cmd
);
2117 strvec_push(&child
.args
, "-l");
2119 child
.no_stdout
= 1;
2120 child
.no_stderr
= 1;
2121 child
.silent_exec_failure
= 1;
2123 if (start_command(&child
))
2125 /* Ignore exit code, as an empty crontab will return error. */
2126 finish_command(&child
);
2130 static int is_crontab_available(void)
2132 const char *cmd
= "crontab";
2135 if (get_schedule_cmd(&cmd
, &is_available
))
2136 return is_available
;
2140 * macOS has cron, but it requires special permissions and will
2141 * create a UI alert when attempting to run this command.
2145 return check_crontab_process(cmd
);
2149 #define BEGIN_LINE "# BEGIN GIT MAINTENANCE SCHEDULE"
2150 #define END_LINE "# END GIT MAINTENANCE SCHEDULE"
2152 static int crontab_update_schedule(int run_maintenance
, int fd
)
2154 const char *cmd
= "crontab";
2156 int in_old_region
= 0;
2157 struct child_process crontab_list
= CHILD_PROCESS_INIT
;
2158 struct child_process crontab_edit
= CHILD_PROCESS_INIT
;
2159 FILE *cron_list
, *cron_in
;
2160 struct strbuf line
= STRBUF_INIT
;
2161 struct tempfile
*tmpedit
= NULL
;
2163 get_schedule_cmd(&cmd
, NULL
);
2164 strvec_split(&crontab_list
.args
, cmd
);
2165 strvec_push(&crontab_list
.args
, "-l");
2166 crontab_list
.in
= -1;
2167 crontab_list
.out
= dup(fd
);
2168 crontab_list
.git_cmd
= 0;
2170 if (start_command(&crontab_list
))
2171 return error(_("failed to run 'crontab -l'; your system might not support 'cron'"));
2173 /* Ignore exit code, as an empty crontab will return error. */
2174 finish_command(&crontab_list
);
2176 tmpedit
= mks_tempfile_t(".git_cron_edit_tmpXXXXXX");
2178 result
= error(_("failed to create crontab temporary file"));
2181 cron_in
= fdopen_tempfile(tmpedit
, "w");
2183 result
= error(_("failed to open temporary file"));
2188 * Read from the .lock file, filtering out the old
2189 * schedule while appending the new schedule.
2191 cron_list
= fdopen(fd
, "r");
2194 while (!strbuf_getline_lf(&line
, cron_list
)) {
2195 if (!in_old_region
&& !strcmp(line
.buf
, BEGIN_LINE
))
2197 else if (in_old_region
&& !strcmp(line
.buf
, END_LINE
))
2199 else if (!in_old_region
)
2200 fprintf(cron_in
, "%s\n", line
.buf
);
2202 strbuf_release(&line
);
2204 if (run_maintenance
) {
2205 struct strbuf line_format
= STRBUF_INIT
;
2206 const char *exec_path
= git_exec_path();
2208 fprintf(cron_in
, "%s\n", BEGIN_LINE
);
2210 "# The following schedule was created by Git\n");
2211 fprintf(cron_in
, "# Any edits made in this region might be\n");
2213 "# replaced in the future by a Git command.\n\n");
2215 strbuf_addf(&line_format
,
2216 "%%s %%s * * %%s \"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%s\n",
2217 exec_path
, exec_path
);
2218 fprintf(cron_in
, line_format
.buf
, "0", "1-23", "*", "hourly");
2219 fprintf(cron_in
, line_format
.buf
, "0", "0", "1-6", "daily");
2220 fprintf(cron_in
, line_format
.buf
, "0", "0", "0", "weekly");
2221 strbuf_release(&line_format
);
2223 fprintf(cron_in
, "\n%s\n", END_LINE
);
2228 strvec_split(&crontab_edit
.args
, cmd
);
2229 strvec_push(&crontab_edit
.args
, get_tempfile_path(tmpedit
));
2230 crontab_edit
.git_cmd
= 0;
2232 if (start_command(&crontab_edit
)) {
2233 result
= error(_("failed to run 'crontab'; your system might not support 'cron'"));
2237 if (finish_command(&crontab_edit
))
2238 result
= error(_("'crontab' died"));
2242 delete_tempfile(&tmpedit
);
2246 static int real_is_systemd_timer_available(void)
2248 struct child_process child
= CHILD_PROCESS_INIT
;
2250 strvec_pushl(&child
.args
, "systemctl", "--user", "list-timers", NULL
);
2252 child
.no_stdout
= 1;
2253 child
.no_stderr
= 1;
2254 child
.silent_exec_failure
= 1;
2256 if (start_command(&child
))
2258 if (finish_command(&child
))
2263 static int is_systemd_timer_available(void)
2265 const char *cmd
= "systemctl";
2268 if (get_schedule_cmd(&cmd
, &is_available
))
2269 return is_available
;
2271 return real_is_systemd_timer_available();
2274 static char *xdg_config_home_systemd(const char *filename
)
2276 return xdg_config_home_for("systemd/user", filename
);
2279 static int systemd_timer_enable_unit(int enable
,
2280 enum schedule_priority schedule
)
2282 const char *cmd
= "systemctl";
2283 struct child_process child
= CHILD_PROCESS_INIT
;
2284 const char *frequency
= get_frequency(schedule
);
2287 * Disabling the systemd unit while it is already disabled makes
2288 * systemctl print an error.
2289 * Let's ignore it since it means we already are in the expected state:
2290 * the unit is disabled.
2292 * On the other hand, enabling a systemd unit which is already enabled
2293 * produces no error.
2296 child
.no_stderr
= 1;
2298 get_schedule_cmd(&cmd
, NULL
);
2299 strvec_split(&child
.args
, cmd
);
2300 strvec_pushl(&child
.args
, "--user", enable
? "enable" : "disable",
2302 strvec_pushf(&child
.args
, "git-maintenance@%s.timer", frequency
);
2304 if (start_command(&child
))
2305 return error(_("failed to start systemctl"));
2306 if (finish_command(&child
))
2308 * Disabling an already disabled systemd unit makes
2310 * Let's ignore this failure.
2312 * Enabling an enabled systemd unit doesn't fail.
2315 return error(_("failed to run systemctl"));
2319 static int systemd_timer_delete_unit_templates(void)
2322 char *filename
= xdg_config_home_systemd("git-maintenance@.timer");
2323 if (unlink(filename
) && !is_missing_file_error(errno
))
2324 ret
= error_errno(_("failed to delete '%s'"), filename
);
2325 FREE_AND_NULL(filename
);
2327 filename
= xdg_config_home_systemd("git-maintenance@.service");
2328 if (unlink(filename
) && !is_missing_file_error(errno
))
2329 ret
= error_errno(_("failed to delete '%s'"), filename
);
2335 static int systemd_timer_delete_units(void)
2337 return systemd_timer_enable_unit(0, SCHEDULE_HOURLY
) ||
2338 systemd_timer_enable_unit(0, SCHEDULE_DAILY
) ||
2339 systemd_timer_enable_unit(0, SCHEDULE_WEEKLY
) ||
2340 systemd_timer_delete_unit_templates();
2343 static int systemd_timer_write_unit_templates(const char *exec_path
)
2349 filename
= xdg_config_home_systemd("git-maintenance@.timer");
2350 if (safe_create_leading_directories(filename
)) {
2351 error(_("failed to create directories for '%s'"), filename
);
2354 file
= fopen_or_warn(filename
, "w");
2358 unit
= "# This file was created and is maintained by Git.\n"
2359 "# Any edits made in this file might be replaced in the future\n"
2360 "# by a Git command.\n"
2363 "Description=Optimize Git repositories data\n"
2370 "WantedBy=timers.target\n";
2371 if (fputs(unit
, file
) == EOF
) {
2372 error(_("failed to write to '%s'"), filename
);
2376 if (fclose(file
) == EOF
) {
2377 error_errno(_("failed to flush '%s'"), filename
);
2382 filename
= xdg_config_home_systemd("git-maintenance@.service");
2383 file
= fopen_or_warn(filename
, "w");
2387 unit
= "# This file was created and is maintained by Git.\n"
2388 "# Any edits made in this file might be replaced in the future\n"
2389 "# by a Git command.\n"
2392 "Description=Optimize Git repositories data\n"
2396 "ExecStart=\"%s/git\" --exec-path=\"%s\" for-each-repo --config=maintenance.repo maintenance run --schedule=%%i\n"
2397 "LockPersonality=yes\n"
2398 "MemoryDenyWriteExecute=yes\n"
2399 "NoNewPrivileges=yes\n"
2400 "RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6\n"
2401 "RestrictNamespaces=yes\n"
2402 "RestrictRealtime=yes\n"
2403 "RestrictSUIDSGID=yes\n"
2404 "SystemCallArchitectures=native\n"
2405 "SystemCallFilter=@system-service\n";
2406 if (fprintf(file
, unit
, exec_path
, exec_path
) < 0) {
2407 error(_("failed to write to '%s'"), filename
);
2411 if (fclose(file
) == EOF
) {
2412 error_errno(_("failed to flush '%s'"), filename
);
2420 systemd_timer_delete_unit_templates();
2424 static int systemd_timer_setup_units(void)
2426 const char *exec_path
= git_exec_path();
2428 int ret
= systemd_timer_write_unit_templates(exec_path
) ||
2429 systemd_timer_enable_unit(1, SCHEDULE_HOURLY
) ||
2430 systemd_timer_enable_unit(1, SCHEDULE_DAILY
) ||
2431 systemd_timer_enable_unit(1, SCHEDULE_WEEKLY
);
2433 systemd_timer_delete_units();
2437 static int systemd_timer_update_schedule(int run_maintenance
, int fd
)
2439 if (run_maintenance
)
2440 return systemd_timer_setup_units();
2442 return systemd_timer_delete_units();
2446 SCHEDULER_INVALID
= -1,
2450 SCHEDULER_LAUNCHCTL
,
2454 static const struct {
2456 int (*is_available
)(void);
2457 int (*update_schedule
)(int run_maintenance
, int fd
);
2458 } scheduler_fn
[] = {
2459 [SCHEDULER_CRON
] = {
2461 .is_available
= is_crontab_available
,
2462 .update_schedule
= crontab_update_schedule
,
2464 [SCHEDULER_SYSTEMD
] = {
2465 .name
= "systemctl",
2466 .is_available
= is_systemd_timer_available
,
2467 .update_schedule
= systemd_timer_update_schedule
,
2469 [SCHEDULER_LAUNCHCTL
] = {
2470 .name
= "launchctl",
2471 .is_available
= is_launchctl_available
,
2472 .update_schedule
= launchctl_update_schedule
,
2474 [SCHEDULER_SCHTASKS
] = {
2476 .is_available
= is_schtasks_available
,
2477 .update_schedule
= schtasks_update_schedule
,
2481 static enum scheduler
parse_scheduler(const char *value
)
2484 return SCHEDULER_INVALID
;
2485 else if (!strcasecmp(value
, "auto"))
2486 return SCHEDULER_AUTO
;
2487 else if (!strcasecmp(value
, "cron") || !strcasecmp(value
, "crontab"))
2488 return SCHEDULER_CRON
;
2489 else if (!strcasecmp(value
, "systemd") ||
2490 !strcasecmp(value
, "systemd-timer"))
2491 return SCHEDULER_SYSTEMD
;
2492 else if (!strcasecmp(value
, "launchctl"))
2493 return SCHEDULER_LAUNCHCTL
;
2494 else if (!strcasecmp(value
, "schtasks"))
2495 return SCHEDULER_SCHTASKS
;
2497 return SCHEDULER_INVALID
;
2500 static int maintenance_opt_scheduler(const struct option
*opt
, const char *arg
,
2503 enum scheduler
*scheduler
= opt
->value
;
2505 BUG_ON_OPT_NEG(unset
);
2507 *scheduler
= parse_scheduler(arg
);
2508 if (*scheduler
== SCHEDULER_INVALID
)
2509 return error(_("unrecognized --scheduler argument '%s'"), arg
);
2513 struct maintenance_start_opts
{
2514 enum scheduler scheduler
;
2517 static enum scheduler
resolve_scheduler(enum scheduler scheduler
)
2519 if (scheduler
!= SCHEDULER_AUTO
)
2522 #if defined(__APPLE__)
2523 return SCHEDULER_LAUNCHCTL
;
2525 #elif defined(GIT_WINDOWS_NATIVE)
2526 return SCHEDULER_SCHTASKS
;
2528 #elif defined(__linux__)
2529 if (is_systemd_timer_available())
2530 return SCHEDULER_SYSTEMD
;
2531 else if (is_crontab_available())
2532 return SCHEDULER_CRON
;
2534 die(_("neither systemd timers nor crontab are available"));
2537 return SCHEDULER_CRON
;
2541 static void validate_scheduler(enum scheduler scheduler
)
2543 if (scheduler
== SCHEDULER_INVALID
)
2544 BUG("invalid scheduler");
2545 if (scheduler
== SCHEDULER_AUTO
)
2546 BUG("resolve_scheduler should have been called before");
2548 if (!scheduler_fn
[scheduler
].is_available())
2549 die(_("%s scheduler is not available"),
2550 scheduler_fn
[scheduler
].name
);
2553 static int update_background_schedule(const struct maintenance_start_opts
*opts
,
2558 struct lock_file lk
;
2559 char *lock_path
= xstrfmt("%s/schedule", the_repository
->objects
->odb
->path
);
2561 if (hold_lock_file_for_update(&lk
, lock_path
, LOCK_NO_DEREF
) < 0) {
2563 return error(_("another process is scheduling background maintenance"));
2566 for (i
= 1; i
< ARRAY_SIZE(scheduler_fn
); i
++) {
2567 if (enable
&& opts
->scheduler
== i
)
2569 if (!scheduler_fn
[i
].is_available())
2571 scheduler_fn
[i
].update_schedule(0, get_lock_file_fd(&lk
));
2575 result
= scheduler_fn
[opts
->scheduler
].update_schedule(
2576 1, get_lock_file_fd(&lk
));
2578 rollback_lock_file(&lk
);
2584 static const char *const builtin_maintenance_start_usage
[] = {
2585 N_("git maintenance start [--scheduler=<scheduler>]"),
2589 static int maintenance_start(int argc
, const char **argv
, const char *prefix
)
2591 struct maintenance_start_opts opts
= { 0 };
2592 struct option options
[] = {
2594 0, "scheduler", &opts
.scheduler
, N_("scheduler"),
2595 N_("scheduler to trigger git maintenance run"),
2596 PARSE_OPT_NONEG
, maintenance_opt_scheduler
),
2599 const char *register_args
[] = { "register", NULL
};
2601 argc
= parse_options(argc
, argv
, prefix
, options
,
2602 builtin_maintenance_start_usage
, 0);
2604 usage_with_options(builtin_maintenance_start_usage
, options
);
2606 opts
.scheduler
= resolve_scheduler(opts
.scheduler
);
2607 validate_scheduler(opts
.scheduler
);
2609 if (maintenance_register(ARRAY_SIZE(register_args
)-1, register_args
, NULL
))
2610 warning(_("failed to add repo to global config"));
2611 return update_background_schedule(&opts
, 1);
2614 static const char *const builtin_maintenance_stop_usage
[] = {
2615 "git maintenance stop",
2619 static int maintenance_stop(int argc
, const char **argv
, const char *prefix
)
2621 struct option options
[] = {
2624 argc
= parse_options(argc
, argv
, prefix
, options
,
2625 builtin_maintenance_stop_usage
, 0);
2627 usage_with_options(builtin_maintenance_stop_usage
, options
);
2628 return update_background_schedule(NULL
, 0);
2631 static const char * const builtin_maintenance_usage
[] = {
2632 N_("git maintenance <subcommand> [<options>]"),
2636 int cmd_maintenance(int argc
, const char **argv
, const char *prefix
)
2638 parse_opt_subcommand_fn
*fn
= NULL
;
2639 struct option builtin_maintenance_options
[] = {
2640 OPT_SUBCOMMAND("run", &fn
, maintenance_run
),
2641 OPT_SUBCOMMAND("start", &fn
, maintenance_start
),
2642 OPT_SUBCOMMAND("stop", &fn
, maintenance_stop
),
2643 OPT_SUBCOMMAND("register", &fn
, maintenance_register
),
2644 OPT_SUBCOMMAND("unregister", &fn
, maintenance_unregister
),
2648 argc
= parse_options(argc
, argv
, prefix
, builtin_maintenance_options
,
2649 builtin_maintenance_usage
, 0);
2650 return fn(argc
, argv
, prefix
);