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