[thirdparty/git.git] / builtin / gc.c

/*
 * git gc builtin command
 *
 * Cleanup unreachable files and optimize the repository.
 *
 * Copyright (c) 2007 James Bowes
 *
 * Based on git-gc.sh, which is
 *
 * Copyright (c) 2006 Shawn O. Pearce
 */

#include "builtin.h"
#include "tempfile.h"
#include "lockfile.h"
#include "parse-options.h"
#include "run-command.h"
#include "sigchain.h"
#include "argv-array.h"
#include "commit.h"

#define FAILED_RUN "failed to run %s"

static const char * const builtin_gc_usage[] = {
	N_("git gc [<options>]"),
	NULL
};

static int pack_refs = 1;
static int prune_reflogs = 1;
static int aggressive_depth = 250;
static int aggressive_window = 250;
static int gc_auto_threshold = 6700;
static int gc_auto_pack_limit = 50;
static int detach_auto = 1;
static const char *prune_expire = "2.weeks.ago";
static const char *prune_worktrees_expire = "3.months.ago";

static struct argv_array pack_refs_cmd = ARGV_ARRAY_INIT;
static struct argv_array reflog = ARGV_ARRAY_INIT;
static struct argv_array repack = ARGV_ARRAY_INIT;
static struct argv_array prune = ARGV_ARRAY_INIT;
static struct argv_array prune_worktrees = ARGV_ARRAY_INIT;
static struct argv_array rerere = ARGV_ARRAY_INIT;

static struct tempfile pidfile;
static struct lock_file log_lock;

static void git_config_date_string(const char *key, const char **output)
{
	if (git_config_get_string_const(key, output))
		return;
	if (strcmp(*output, "now")) {
		unsigned long now = approxidate("now");
		if (approxidate(*output) >= now)
			git_die_config(key, _("Invalid %s: '%s'"), key, *output);
	}
}

static void process_log_file(void)
{
	struct stat st;
	if (!fstat(get_lock_file_fd(&log_lock), &st) && st.st_size)
		commit_lock_file(&log_lock);
	else
		rollback_lock_file(&log_lock);
}

static void process_log_file_at_exit(void)
{
	fflush(stderr);
	process_log_file();
}

static void process_log_file_on_signal(int signo)
{
	process_log_file();
	sigchain_pop(signo);
	raise(signo);
}

static void gc_config(void)
{
	const char *value;

	if (!git_config_get_value("gc.packrefs", &value)) {
		if (value && !strcmp(value, "notbare"))
			pack_refs = -1;
		else
			pack_refs = git_config_bool("gc.packrefs", value);
	}

	git_config_get_int("gc.aggressivewindow", &aggressive_window);
	git_config_get_int("gc.aggressivedepth", &aggressive_depth);
	git_config_get_int("gc.auto", &gc_auto_threshold);
	git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit);
	git_config_get_bool("gc.autodetach", &detach_auto);
	git_config_date_string("gc.pruneexpire", &prune_expire);
	git_config_date_string("gc.worktreepruneexpire", &prune_worktrees_expire);
	git_config(git_default_config, NULL);
}

static int too_many_loose_objects(void)
{
	/*
	 * Quickly check if a "gc" is needed, by estimating how
	 * many loose objects there are.  Because SHA-1 is evenly
	 * distributed, we can check only one and get a reasonable
	 * estimate.
	 */
	char path[PATH_MAX];
	const char *objdir = get_object_directory();
	DIR *dir;
	struct dirent *ent;
	int auto_threshold;
	int num_loose = 0;
	int needed = 0;

	if (gc_auto_threshold <= 0)
		return 0;

	if (sizeof(path) <= snprintf(path, sizeof(path), "%s/17", objdir)) {
		warning(_("insanely long object directory %.*s"), 50, objdir);
		return 0;
	}
	dir = opendir(path);
	if (!dir)
		return 0;

	auto_threshold = (gc_auto_threshold + 255) / 256;
	while ((ent = readdir(dir)) != NULL) {
		if (strspn(ent->d_name, "0123456789abcdef") != 38 ||
		    ent->d_name[38] != '\0')
			continue;
		if (++num_loose > auto_threshold) {
			needed = 1;
			break;
		}
	}
	closedir(dir);
	return needed;
}

static int too_many_packs(void)
{
	struct packed_git *p;
	int cnt;

	if (gc_auto_pack_limit <= 0)
		return 0;

	prepare_packed_git();
	for (cnt = 0, p = packed_git; p; p = p->next) {
		if (!p->pack_local)
			continue;
		if (p->pack_keep)
			continue;
		/*
		 * Perhaps check the size of the pack and count only
		 * very small ones here?
		 */
		cnt++;
	}
	return gc_auto_pack_limit <= cnt;
}

static void add_repack_all_option(void)
{
	if (prune_expire && !strcmp(prune_expire, "now"))
		argv_array_push(&repack, "-a");
	else {
		argv_array_push(&repack, "-A");
		if (prune_expire)
			argv_array_pushf(&repack, "--unpack-unreachable=%s", prune_expire);
	}
}

static int need_to_gc(void)
{
	/*
	 * Setting gc.auto to 0 or negative can disable the
	 * automatic gc.
	 */
	if (gc_auto_threshold <= 0)
		return 0;

	/*
	 * If there are too many loose objects, but not too many
	 * packs, we run "repack -d -l".  If there are too many packs,
	 * we run "repack -A -d -l".  Otherwise we tell the caller
	 * there is no need.
	 */
	if (too_many_packs())
		add_repack_all_option();
	else if (!too_many_loose_objects())
		return 0;

	if (run_hook_le(NULL, "pre-auto-gc", NULL))
		return 0;
	return 1;
}

/* return NULL on success, else hostname running the gc */
static const char *lock_repo_for_gc(int force, pid_t* ret_pid)
{
	static struct lock_file lock;
	char my_host[128];
	struct strbuf sb = STRBUF_INIT;
	struct stat st;
	uintmax_t pid;
	FILE *fp;
	int fd;
	char *pidfile_path;

	if (is_tempfile_active(&pidfile))
		/* already locked */
		return NULL;

	if (gethostname(my_host, sizeof(my_host)))
		xsnprintf(my_host, sizeof(my_host), "unknown");

	pidfile_path = git_pathdup("gc.pid");
	fd = hold_lock_file_for_update(&lock, pidfile_path,
				       LOCK_DIE_ON_ERROR);
	if (!force) {
		static char locking_host[128];
		int should_exit;
		fp = fopen(pidfile_path, "r");
		memset(locking_host, 0, sizeof(locking_host));
		should_exit =
			fp != NULL &&
			!fstat(fileno(fp), &st) &&
			/*
			 * 12 hour limit is very generous as gc should
			 * never take that long. On the other hand we
			 * don't really need a strict limit here,
			 * running gc --auto one day late is not a big
			 * problem. --force can be used in manual gc
			 * after the user verifies that no gc is
			 * running.
			 */
			time(NULL) - st.st_mtime <= 12 * 3600 &&
			fscanf(fp, "%"PRIuMAX" %127c", &pid, locking_host) == 2 &&
			/* be gentle to concurrent "gc" on remote hosts */
			(strcmp(locking_host, my_host) || !kill(pid, 0) || errno == EPERM);
		if (fp != NULL)
			fclose(fp);
		if (should_exit) {
			if (fd >= 0)
				rollback_lock_file(&lock);
			*ret_pid = pid;
			free(pidfile_path);
			return locking_host;
		}
	}

	strbuf_addf(&sb, "%"PRIuMAX" %s",
		    (uintmax_t) getpid(), my_host);
	write_in_full(fd, sb.buf, sb.len);
	strbuf_release(&sb);
	commit_lock_file(&lock);
	register_tempfile(&pidfile, pidfile_path);
	free(pidfile_path);
	return NULL;
}

static int report_last_gc_error(void)
{
	struct strbuf sb = STRBUF_INIT;
	int ret;

	ret = strbuf_read_file(&sb, git_path("gc.log"), 0);
	if (ret > 0)
		return error(_("The last gc run reported the following. "
			       "Please correct the root cause\n"
			       "and remove %s.\n"
			       "Automatic cleanup will not be performed "
			       "until the file is removed.\n\n"
			       "%s"),
			     git_path("gc.log"), sb.buf);
	strbuf_release(&sb);
	return 0;
}

static int gc_before_repack(void)
{
	if (pack_refs && run_command_v_opt(pack_refs_cmd.argv, RUN_GIT_CMD))
		return error(FAILED_RUN, pack_refs_cmd.argv[0]);

	if (prune_reflogs && run_command_v_opt(reflog.argv, RUN_GIT_CMD))
		return error(FAILED_RUN, reflog.argv[0]);

	pack_refs = 0;
	prune_reflogs = 0;
	return 0;
}

int cmd_gc(int argc, const char **argv, const char *prefix)
{
	int aggressive = 0;
	int auto_gc = 0;
	int quiet = 0;
	int force = 0;
	const char *name;
	pid_t pid;
	int daemonized = 0;

	struct option builtin_gc_options[] = {
		OPT__QUIET(&quiet, N_("suppress progress reporting")),
		{ OPTION_STRING, 0, "prune", &prune_expire, N_("date"),
			N_("prune unreferenced objects"),
			PARSE_OPT_OPTARG, NULL, (intptr_t)prune_expire },
		OPT_BOOL(0, "aggressive", &aggressive, N_("be more thorough (increased runtime)")),
		OPT_BOOL(0, "auto", &auto_gc, N_("enable auto-gc mode")),
		OPT_BOOL(0, "force", &force, N_("force running gc even if there may be another gc running")),
		OPT_END()
	};

	if (argc == 2 && !strcmp(argv[1], "-h"))
		usage_with_options(builtin_gc_usage, builtin_gc_options);

	argv_array_pushl(&pack_refs_cmd, "pack-refs", "--all", "--prune", NULL);
	argv_array_pushl(&reflog, "reflog", "expire", "--all", NULL);
	argv_array_pushl(&repack, "repack", "-d", "-l", NULL);
	argv_array_pushl(&prune, "prune", "--expire", NULL);
	argv_array_pushl(&prune_worktrees, "worktree", "prune", "--expire", NULL);
	argv_array_pushl(&rerere, "rerere", "gc", NULL);

	gc_config();

	if (pack_refs < 0)
		pack_refs = !is_bare_repository();

	argc = parse_options(argc, argv, prefix, builtin_gc_options,
			     builtin_gc_usage, 0);
	if (argc > 0)
		usage_with_options(builtin_gc_usage, builtin_gc_options);

	if (aggressive) {
		argv_array_push(&repack, "-f");
		if (aggressive_depth > 0)
			argv_array_pushf(&repack, "--depth=%d", aggressive_depth);
		if (aggressive_window > 0)
			argv_array_pushf(&repack, "--window=%d", aggressive_window);
	}
	if (quiet)
		argv_array_push(&repack, "-q");

	if (auto_gc) {
		/*
		 * Auto-gc should be least intrusive as possible.
		 */
		if (!need_to_gc())
			return 0;
		if (!quiet) {
			if (detach_auto)
				fprintf(stderr, _("Auto packing the repository in background for optimum performance.\n"));
			else
				fprintf(stderr, _("Auto packing the repository for optimum performance.\n"));
			fprintf(stderr, _("See \"git help gc\" for manual housekeeping.\n"));
		}
		if (detach_auto) {
			if (report_last_gc_error())
				return -1;

			if (gc_before_repack())
				return -1;
			/*
			 * failure to daemonize is ok, we'll continue
			 * in foreground
			 */
			daemonized = !daemonize();
		}
	} else
		add_repack_all_option();

	name = lock_repo_for_gc(force, &pid);
	if (name) {
		if (auto_gc)
			return 0; /* be quiet on --auto */
		die(_("gc is already running on machine '%s' pid %"PRIuMAX" (use --force if not)"),
		    name, (uintmax_t)pid);
	}

	if (daemonized) {
		hold_lock_file_for_update(&log_lock,
					  git_path("gc.log"),
					  LOCK_DIE_ON_ERROR);
		dup2(get_lock_file_fd(&log_lock), 2);
		sigchain_push_common(process_log_file_on_signal);
		atexit(process_log_file_at_exit);
	}

	if (gc_before_repack())
		return -1;

	if (run_command_v_opt(repack.argv, RUN_GIT_CMD))
		return error(FAILED_RUN, repack.argv[0]);

	if (prune_expire) {
		argv_array_push(&prune, prune_expire);
		if (quiet)
			argv_array_push(&prune, "--no-progress");
		if (run_command_v_opt(prune.argv, RUN_GIT_CMD))
			return error(FAILED_RUN, prune.argv[0]);
	}

	if (prune_worktrees_expire) {
		argv_array_push(&prune_worktrees, prune_worktrees_expire);
		if (run_command_v_opt(prune_worktrees.argv, RUN_GIT_CMD))
			return error(FAILED_RUN, prune_worktrees.argv[0]);
	}

	if (run_command_v_opt(rerere.argv, RUN_GIT_CMD))
		return error(FAILED_RUN, rerere.argv[0]);

	if (auto_gc && too_many_loose_objects())
		warning(_("There are too many unreachable loose objects; "
			"run 'git prune' to remove them."));

	return 0;
}
Commit	Line	Data
6757ada4 JB	1	/*
	2	* git gc builtin command
	3	*
	4	* Cleanup unreachable files and optimize the repository.
	5	*
	6	* Copyright (c) 2007 James Bowes
	7	*
	8	* Based on git-gc.sh, which is
	9	*
	10	* Copyright (c) 2006 Shawn O. Pearce
	11	*/
	12
baffc0e7	13	#include "builtin.h"
ebebeaea	14	#include "tempfile.h"
697cc8ef	15	#include "lockfile.h"
44c637c8	16	#include "parse-options.h"
6757ada4	17	#include "run-command.h"
4c5baf02	18	#include "sigchain.h"
234587fc	19	#include "argv-array.h"
eab3296c	20	#include "commit.h"
6757ada4 JB	21
	22	#define FAILED_RUN "failed to run %s"
	23
44c637c8	24	static const char * const builtin_gc_usage[] = {
9c9b4f2f	25	N_("git gc [<options>]"),
44c637c8 JB	26	NULL
44c637c8 JB	27	};
6757ada4	28
56752391	29	static int pack_refs = 1;
62aad184	30	static int prune_reflogs = 1;
125f8146	31	static int aggressive_depth = 250;
1c192f34	32	static int aggressive_window = 250;
2c3c4399	33	static int gc_auto_threshold = 6700;
97063974	34	static int gc_auto_pack_limit = 50;
9f673f94	35	static int detach_auto = 1;
d3154b44	36	static const char *prune_expire = "2.weeks.ago";
e3df33bb	37	static const char *prune_worktrees_expire = "3.months.ago";
6757ada4	38
234587fc JK	39	static struct argv_array pack_refs_cmd = ARGV_ARRAY_INIT;
	40	static struct argv_array reflog = ARGV_ARRAY_INIT;
	41	static struct argv_array repack = ARGV_ARRAY_INIT;
	42	static struct argv_array prune = ARGV_ARRAY_INIT;
e3df33bb	43	static struct argv_array prune_worktrees = ARGV_ARRAY_INIT;
234587fc	44	static struct argv_array rerere = ARGV_ARRAY_INIT;
6757ada4	45
ebebeaea	46	static struct tempfile pidfile;
329e6e87	47	static struct lock_file log_lock;
4c5baf02	48
09dbb90b NTND	49	static void git_config_date_string(const char key, const char *output)
	50	{
	51	if (git_config_get_string_const(key, output))
	52	return;
	53	if (strcmp(*output, "now")) {
	54	unsigned long now = approxidate("now");
	55	if (approxidate(*output) >= now)
	56	git_die_config(key, _("Invalid %s: '%s'"), key, *output);
	57	}
	58	}
	59
329e6e87 NTND	60	static void process_log_file(void)
	61	{
	62	struct stat st;
076c8278	63	if (!fstat(get_lock_file_fd(&log_lock), &st) && st.st_size)
329e6e87 NTND	64	commit_lock_file(&log_lock);
	65	else
	66	rollback_lock_file(&log_lock);
	67	}
	68
	69	static void process_log_file_at_exit(void)
	70	{
	71	fflush(stderr);
	72	process_log_file();
	73	}
	74
	75	static void process_log_file_on_signal(int signo)
	76	{
	77	process_log_file();
	78	sigchain_pop(signo);
	79	raise(signo);
	80	}
	81
5801d3b4	82	static void gc_config(void)
6757ada4	83	{
5801d3b4 TA	84	const char *value;
	85
	86	if (!git_config_get_value("gc.packrefs", &value)) {
c5e5a2c0	87	if (value && !strcmp(value, "notbare"))
6757ada4 JB	88	pack_refs = -1;
6757ada4 JB	89	else
5801d3b4	90	pack_refs = git_config_bool("gc.packrefs", value);
17815501	91	}
5801d3b4 TA	92
	93	git_config_get_int("gc.aggressivewindow", &aggressive_window);
	94	git_config_get_int("gc.aggressivedepth", &aggressive_depth);
	95	git_config_get_int("gc.auto", &gc_auto_threshold);
	96	git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit);
	97	git_config_get_bool("gc.autodetach", &detach_auto);
09dbb90b	98	git_config_date_string("gc.pruneexpire", &prune_expire);
114ff888	99	git_config_date_string("gc.worktreepruneexpire", &prune_worktrees_expire);
5801d3b4	100	git_config(git_default_config, NULL);
6757ada4 JB	101	}
6757ada4 JB	102
a087cc98	103	static int too_many_loose_objects(void)
2c3c4399 JH	104	{
	105	/*
	106	* Quickly check if a "gc" is needed, by estimating how
	107	* many loose objects there are. Because SHA-1 is evenly
	108	* distributed, we can check only one and get a reasonable
	109	* estimate.
	110	*/
	111	char path[PATH_MAX];
	112	const char *objdir = get_object_directory();
	113	DIR *dir;
	114	struct dirent *ent;
	115	int auto_threshold;
	116	int num_loose = 0;
	117	int needed = 0;
	118
17815501 JH	119	if (gc_auto_threshold <= 0)
	120	return 0;
	121
2c3c4399	122	if (sizeof(path) <= snprintf(path, sizeof(path), "%s/17", objdir)) {
fea6128b	123	warning(_("insanely long object directory %.*s"), 50, objdir);
2c3c4399 JH	124	return 0;
	125	}
	126	dir = opendir(path);
	127	if (!dir)
	128	return 0;
	129
	130	auto_threshold = (gc_auto_threshold + 255) / 256;
	131	while ((ent = readdir(dir)) != NULL) {
	132	if (strspn(ent->d_name, "0123456789abcdef") != 38 \|\|
	133	ent->d_name[38] != '\0')
	134	continue;
	135	if (++num_loose > auto_threshold) {
	136	needed = 1;
	137	break;
	138	}
	139	}
	140	closedir(dir);
	141	return needed;
	142	}
	143
17815501 JH	144	static int too_many_packs(void)
	145	{
	146	struct packed_git *p;
	147	int cnt;
	148
	149	if (gc_auto_pack_limit <= 0)
	150	return 0;
	151
	152	prepare_packed_git();
	153	for (cnt = 0, p = packed_git; p; p = p->next) {
17815501 JH	154	if (!p->pack_local)
17815501 JH	155	continue;
01af249f	156	if (p->pack_keep)
17815501 JH	157	continue;
	158	/*
	159	* Perhaps check the size of the pack and count only
	160	* very small ones here?
	161	*/
	162	cnt++;
	163	}
	164	return gc_auto_pack_limit <= cnt;
	165	}
	166
7e52f566 JK	167	static void add_repack_all_option(void)
	168	{
	169	if (prune_expire && !strcmp(prune_expire, "now"))
234587fc	170	argv_array_push(&repack, "-a");
7e52f566	171	else {
234587fc JK	172	argv_array_push(&repack, "-A");
	173	if (prune_expire)
	174	argv_array_pushf(&repack, "--unpack-unreachable=%s", prune_expire);
7e52f566 JK	175	}
	176	}
	177
a087cc98 JH	178	static int need_to_gc(void)
	179	{
	180	/*
b14d255b BC	181	* Setting gc.auto to 0 or negative can disable the
b14d255b BC	182	* automatic gc.
a087cc98	183	*/
b14d255b	184	if (gc_auto_threshold <= 0)
95143f9e JH	185	return 0;
95143f9e JH	186
17815501 JH	187	/*
	188	* If there are too many loose objects, but not too many
	189	* packs, we run "repack -d -l". If there are too many packs,
	190	* we run "repack -A -d -l". Otherwise we tell the caller
	191	* there is no need.
	192	*/
17815501	193	if (too_many_packs())
7e52f566	194	add_repack_all_option();
17815501 JH	195	else if (!too_many_loose_objects())
17815501 JH	196	return 0;
bde30540	197
15048f8a	198	if (run_hook_le(NULL, "pre-auto-gc", NULL))
bde30540	199	return 0;
95143f9e	200	return 1;
a087cc98 JH	201	}
a087cc98 JH	202
64a99eb4 NTND	203	/* return NULL on success, else hostname running the gc */
	204	static const char lock_repo_for_gc(int force, pid_t ret_pid)
	205	{
	206	static struct lock_file lock;
64a99eb4 NTND	207	char my_host[128];
	208	struct strbuf sb = STRBUF_INIT;
	209	struct stat st;
	210	uintmax_t pid;
	211	FILE *fp;
4f1c0b21	212	int fd;
00539cef	213	char *pidfile_path;
64a99eb4	214
ebebeaea	215	if (is_tempfile_active(&pidfile))
4c5baf02 JN	216	/* already locked */
	217	return NULL;
	218
64a99eb4	219	if (gethostname(my_host, sizeof(my_host)))
5096d490	220	xsnprintf(my_host, sizeof(my_host), "unknown");
64a99eb4	221
00539cef MH	222	pidfile_path = git_pathdup("gc.pid");
00539cef MH	223	fd = hold_lock_file_for_update(&lock, pidfile_path,
64a99eb4 NTND	224	LOCK_DIE_ON_ERROR);
64a99eb4 NTND	225	if (!force) {
4f1c0b21 EP	226	static char locking_host[128];
4f1c0b21 EP	227	int should_exit;
00539cef	228	fp = fopen(pidfile_path, "r");
64a99eb4 NTND	229	memset(locking_host, 0, sizeof(locking_host));
	230	should_exit =
	231	fp != NULL &&
	232	!fstat(fileno(fp), &st) &&
	233	/*
	234	* 12 hour limit is very generous as gc should
	235	* never take that long. On the other hand we
	236	* don't really need a strict limit here,
	237	* running gc --auto one day late is not a big
	238	* problem. --force can be used in manual gc
	239	* after the user verifies that no gc is
	240	* running.
	241	*/
	242	time(NULL) - st.st_mtime <= 12 * 3600 &&
	243	fscanf(fp, "%"PRIuMAX" %127c", &pid, locking_host) == 2 &&
	244	/* be gentle to concurrent "gc" on remote hosts */
ed7eda8b	245	(strcmp(locking_host, my_host) \|\| !kill(pid, 0) \|\| errno == EPERM);
64a99eb4 NTND	246	if (fp != NULL)
	247	fclose(fp);
	248	if (should_exit) {
	249	if (fd >= 0)
	250	rollback_lock_file(&lock);
	251	*ret_pid = pid;
00539cef	252	free(pidfile_path);
64a99eb4 NTND	253	return locking_host;
	254	}
	255	}
	256
	257	strbuf_addf(&sb, "%"PRIuMAX" %s",
	258	(uintmax_t) getpid(), my_host);
	259	write_in_full(fd, sb.buf, sb.len);
	260	strbuf_release(&sb);
	261	commit_lock_file(&lock);
ebebeaea MH	262	register_tempfile(&pidfile, pidfile_path);
ebebeaea MH	263	free(pidfile_path);
64a99eb4 NTND	264	return NULL;
	265	}
	266
329e6e87 NTND	267	static int report_last_gc_error(void)
	268	{
	269	struct strbuf sb = STRBUF_INIT;
	270	int ret;
	271
	272	ret = strbuf_read_file(&sb, git_path("gc.log"), 0);
	273	if (ret > 0)
	274	return error(_("The last gc run reported the following. "
	275	"Please correct the root cause\n"
	276	"and remove %s.\n"
	277	"Automatic cleanup will not be performed "
	278	"until the file is removed.\n\n"
	279	"%s"),
	280	git_path("gc.log"), sb.buf);
	281	strbuf_release(&sb);
	282	return 0;
	283	}
	284
62aad184 NTND	285	static int gc_before_repack(void)
	286	{
	287	if (pack_refs && run_command_v_opt(pack_refs_cmd.argv, RUN_GIT_CMD))
	288	return error(FAILED_RUN, pack_refs_cmd.argv[0]);
	289
	290	if (prune_reflogs && run_command_v_opt(reflog.argv, RUN_GIT_CMD))
	291	return error(FAILED_RUN, reflog.argv[0]);
	292
	293	pack_refs = 0;
	294	prune_reflogs = 0;
	295	return 0;
	296	}
	297
6757ada4 JB	298	int cmd_gc(int argc, const char *argv, const char prefix)
6757ada4 JB	299	{
44c637c8	300	int aggressive = 0;
2c3c4399	301	int auto_gc = 0;
a0c14cbb	302	int quiet = 0;
64a99eb4 NTND	303	int force = 0;
	304	const char *name;
	305	pid_t pid;
329e6e87	306	int daemonized = 0;
6757ada4	307
44c637c8	308	struct option builtin_gc_options[] = {
6705c162 NTND	309	OPT__QUIET(&quiet, N_("suppress progress reporting")),
	310	{ OPTION_STRING, 0, "prune", &prune_expire, N_("date"),
	311	N_("prune unreferenced objects"),
58e9d9d4	312	PARSE_OPT_OPTARG, NULL, (intptr_t)prune_expire },
d5d09d47 SB	313	OPT_BOOL(0, "aggressive", &aggressive, N_("be more thorough (increased runtime)")),
d5d09d47 SB	314	OPT_BOOL(0, "auto", &auto_gc, N_("enable auto-gc mode")),
64a99eb4	315	OPT_BOOL(0, "force", &force, N_("force running gc even if there may be another gc running")),
44c637c8 JB	316	OPT_END()
	317	};
	318
0c8151b6 NTND	319	if (argc == 2 && !strcmp(argv[1], "-h"))
	320	usage_with_options(builtin_gc_usage, builtin_gc_options);
	321
234587fc JK	322	argv_array_pushl(&pack_refs_cmd, "pack-refs", "--all", "--prune", NULL);
	323	argv_array_pushl(&reflog, "reflog", "expire", "--all", NULL);
	324	argv_array_pushl(&repack, "repack", "-d", "-l", NULL);
2cfe2a78	325	argv_array_pushl(&prune, "prune", "--expire", NULL);
df0b6cfb	326	argv_array_pushl(&prune_worktrees, "worktree", "prune", "--expire", NULL);
234587fc JK	327	argv_array_pushl(&rerere, "rerere", "gc", NULL);
234587fc JK	328
5801d3b4	329	gc_config();
6757ada4 JB	330
	331	if (pack_refs < 0)
	332	pack_refs = !is_bare_repository();
	333
37782920 SB	334	argc = parse_options(argc, argv, prefix, builtin_gc_options,
37782920 SB	335	builtin_gc_usage, 0);
44c637c8 JB	336	if (argc > 0)
	337	usage_with_options(builtin_gc_usage, builtin_gc_options);
	338
	339	if (aggressive) {
234587fc	340	argv_array_push(&repack, "-f");
125f8146 NTND	341	if (aggressive_depth > 0)
125f8146 NTND	342	argv_array_pushf(&repack, "--depth=%d", aggressive_depth);
234587fc JK	343	if (aggressive_window > 0)
234587fc JK	344	argv_array_pushf(&repack, "--window=%d", aggressive_window);
6757ada4	345	}
a0c14cbb	346	if (quiet)
234587fc	347	argv_array_push(&repack, "-q");
6757ada4	348
2c3c4399 JH	349	if (auto_gc) {
	350	/*
	351	* Auto-gc should be least intrusive as possible.
	352	*/
2c3c4399 JH	353	if (!need_to_gc())
2c3c4399 JH	354	return 0;
9f673f94 NTND	355	if (!quiet) {
	356	if (detach_auto)
	357	fprintf(stderr, _("Auto packing the repository in background for optimum performance.\n"));
	358	else
	359	fprintf(stderr, _("Auto packing the repository for optimum performance.\n"));
	360	fprintf(stderr, _("See \"git help gc\" for manual housekeeping.\n"));
	361	}
62aad184	362	if (detach_auto) {
329e6e87 NTND	363	if (report_last_gc_error())
	364	return -1;
	365
62aad184 NTND	366	if (gc_before_repack())
62aad184 NTND	367	return -1;
9f673f94 NTND	368	/*
	369	* failure to daemonize is ok, we'll continue
	370	* in foreground
	371	*/
329e6e87	372	daemonized = !daemonize();
62aad184	373	}
a37cce3b	374	} else
7e52f566	375	add_repack_all_option();
2c3c4399	376
64a99eb4 NTND	377	name = lock_repo_for_gc(force, &pid);
	378	if (name) {
	379	if (auto_gc)
	380	return 0; /* be quiet on --auto */
	381	die(_("gc is already running on machine '%s' pid %"PRIuMAX" (use --force if not)"),
	382	name, (uintmax_t)pid);
	383	}
	384
329e6e87 NTND	385	if (daemonized) {
	386	hold_lock_file_for_update(&log_lock,
	387	git_path("gc.log"),
	388	LOCK_DIE_ON_ERROR);
076c8278	389	dup2(get_lock_file_fd(&log_lock), 2);
329e6e87 NTND	390	sigchain_push_common(process_log_file_on_signal);
	391	atexit(process_log_file_at_exit);
	392	}
	393
62aad184 NTND	394	if (gc_before_repack())
62aad184 NTND	395	return -1;
6757ada4	396
234587fc JK	397	if (run_command_v_opt(repack.argv, RUN_GIT_CMD))
234587fc JK	398	return error(FAILED_RUN, repack.argv[0]);
6757ada4	399
58e9d9d4	400	if (prune_expire) {
234587fc	401	argv_array_push(&prune, prune_expire);
bf0a59b3	402	if (quiet)
234587fc JK	403	argv_array_push(&prune, "--no-progress");
	404	if (run_command_v_opt(prune.argv, RUN_GIT_CMD))
	405	return error(FAILED_RUN, prune.argv[0]);
58e9d9d4	406	}
6757ada4	407
e3df33bb NTND	408	if (prune_worktrees_expire) {
	409	argv_array_push(&prune_worktrees, prune_worktrees_expire);
	410	if (run_command_v_opt(prune_worktrees.argv, RUN_GIT_CMD))
	411	return error(FAILED_RUN, prune_worktrees.argv[0]);
	412	}
	413
234587fc JK	414	if (run_command_v_opt(rerere.argv, RUN_GIT_CMD))
234587fc JK	415	return error(FAILED_RUN, rerere.argv[0]);
6757ada4	416
a087cc98	417	if (auto_gc && too_many_loose_objects())
fea6128b ÆAB	418	warning(_("There are too many unreachable loose objects; "
fea6128b ÆAB	419	"run 'git prune' to remove them."));
a087cc98	420
6757ada4 JB	421	return 0;
6757ada4 JB	422	}