2 * git gc builtin command
4 * Cleanup unreachable files and optimize the repository.
6 * Copyright (c) 2007 James Bowes
8 * Based on git-gc.sh, which is
10 * Copyright (c) 2006 Shawn O. Pearce
15 #include "parse-options.h"
16 #include "run-command.h"
18 #define FAILED_RUN "failed to run %s"
20 static const char * const builtin_gc_usage
[] = {
25 static int pack_refs
= 1;
26 static int aggressive_window
= -1;
27 static int gc_auto_threshold
= 6700;
28 static int gc_auto_pack_limit
= 50;
29 static char *prune_expire
= "2.weeks.ago";
32 static const char *argv_pack_refs
[] = {"pack-refs", "--all", "--prune", NULL
};
33 static const char *argv_reflog
[] = {"reflog", "expire", "--all", NULL
};
34 static const char *argv_repack
[MAX_ADD
] = {"repack", "-d", "-l", NULL
};
35 static const char *argv_prune
[] = {"prune", "--expire", NULL
, NULL
};
36 static const char *argv_rerere
[] = {"rerere", "gc", NULL
};
38 static int gc_config(const char *var
, const char *value
)
40 if (!strcmp(var
, "gc.packrefs")) {
41 if (value
&& !strcmp(value
, "notbare"))
44 pack_refs
= git_config_bool(var
, value
);
47 if (!strcmp(var
, "gc.aggressivewindow")) {
48 aggressive_window
= git_config_int(var
, value
);
51 if (!strcmp(var
, "gc.auto")) {
52 gc_auto_threshold
= git_config_int(var
, value
);
55 if (!strcmp(var
, "gc.autopacklimit")) {
56 gc_auto_pack_limit
= git_config_int(var
, value
);
59 if (!strcmp(var
, "gc.pruneexpire")) {
61 return config_error_nonbool(var
);
62 if (strcmp(value
, "now")) {
63 unsigned long now
= approxidate("now");
64 if (approxidate(value
) >= now
)
65 return error("Invalid %s: '%s'", var
, value
);
67 prune_expire
= xstrdup(value
);
70 return git_default_config(var
, value
);
73 static void append_option(const char **cmd
, const char *opt
, int max_length
)
77 for (i
= 0; cmd
[i
]; i
++)
80 if (i
+ 2 >= max_length
)
81 die("Too many options specified");
86 static int too_many_loose_objects(void)
89 * Quickly check if a "gc" is needed, by estimating how
90 * many loose objects there are. Because SHA-1 is evenly
91 * distributed, we can check only one and get a reasonable
95 const char *objdir
= get_object_directory();
102 if (gc_auto_threshold
<= 0)
105 if (sizeof(path
) <= snprintf(path
, sizeof(path
), "%s/17", objdir
)) {
106 warning("insanely long object directory %.*s", 50, objdir
);
113 auto_threshold
= (gc_auto_threshold
+ 255) / 256;
114 while ((ent
= readdir(dir
)) != NULL
) {
115 if (strspn(ent
->d_name
, "0123456789abcdef") != 38 ||
116 ent
->d_name
[38] != '\0')
118 if (++num_loose
> auto_threshold
) {
127 static int too_many_packs(void)
129 struct packed_git
*p
;
132 if (gc_auto_pack_limit
<= 0)
135 prepare_packed_git();
136 for (cnt
= 0, p
= packed_git
; p
; p
= p
->next
) {
143 len
= strlen(p
->pack_name
);
144 if (PATH_MAX
<= len
+ 1)
145 continue; /* oops, give up */
146 memcpy(path
, p
->pack_name
, len
-5);
147 memcpy(path
+ len
- 5, ".keep", 6);
148 keep
= access(p
->pack_name
, F_OK
) && (errno
== ENOENT
);
152 * Perhaps check the size of the pack and count only
153 * very small ones here?
157 return gc_auto_pack_limit
<= cnt
;
160 static int run_hook(void)
163 struct child_process hook
;
166 argv
[0] = git_path("hooks/pre-auto-gc");
169 if (access(argv
[0], X_OK
) < 0)
172 memset(&hook
, 0, sizeof(hook
));
175 hook
.stdout_to_stderr
= 1;
177 ret
= start_command(&hook
);
179 warning("Could not spawn %s", argv
[0]);
182 ret
= finish_command(&hook
);
183 if (ret
== -ERR_RUN_COMMAND_WAITPID_SIGNAL
)
184 warning("%s exited due to uncaught signal", argv
[0]);
188 static int need_to_gc(void)
191 * Setting gc.auto to 0 or negative can disable the
194 if (gc_auto_threshold
<= 0)
198 * If there are too many loose objects, but not too many
199 * packs, we run "repack -d -l". If there are too many packs,
200 * we run "repack -A -d -l". Otherwise we tell the caller
203 if (too_many_packs())
204 append_option(argv_repack
, "-A", MAX_ADD
);
205 else if (!too_many_loose_objects())
213 int cmd_gc(int argc
, const char **argv
, const char *prefix
)
221 struct option builtin_gc_options
[] = {
222 OPT_BOOLEAN(0, "prune", &prune
, "prune unreferenced objects"),
223 OPT_BOOLEAN(0, "aggressive", &aggressive
, "be more thorough (increased runtime)"),
224 OPT_BOOLEAN(0, "auto", &auto_gc
, "enable auto-gc mode"),
225 OPT_BOOLEAN('q', "quiet", &quiet
, "suppress progress reports"),
229 git_config(gc_config
);
232 pack_refs
= !is_bare_repository();
234 argc
= parse_options(argc
, argv
, builtin_gc_options
, builtin_gc_usage
, 0);
236 usage_with_options(builtin_gc_usage
, builtin_gc_options
);
239 append_option(argv_repack
, "-f", MAX_ADD
);
240 if (aggressive_window
> 0) {
241 sprintf(buf
, "--window=%d", aggressive_window
);
242 append_option(argv_repack
, buf
, MAX_ADD
);
246 append_option(argv_repack
, "-q", MAX_ADD
);
250 * Auto-gc should be least intrusive as possible.
255 fprintf(stderr
, "Auto packing your repository for optimum "
256 "performance. You may also\n"
257 "run \"git gc\" manually. See "
258 "\"git help gc\" for more information.\n");
260 append_option(argv_repack
, "-A", MAX_ADD
);
262 if (pack_refs
&& run_command_v_opt(argv_pack_refs
, RUN_GIT_CMD
))
263 return error(FAILED_RUN
, argv_pack_refs
[0]);
265 if (run_command_v_opt(argv_reflog
, RUN_GIT_CMD
))
266 return error(FAILED_RUN
, argv_reflog
[0]);
268 if (run_command_v_opt(argv_repack
, RUN_GIT_CMD
))
269 return error(FAILED_RUN
, argv_repack
[0]);
271 argv_prune
[2] = prune_expire
;
272 if (run_command_v_opt(argv_prune
, RUN_GIT_CMD
))
273 return error(FAILED_RUN
, argv_prune
[0]);
275 if (run_command_v_opt(argv_rerere
, RUN_GIT_CMD
))
276 return error(FAILED_RUN
, argv_rerere
[0]);
278 if (auto_gc
&& too_many_loose_objects())
279 warning("There are too many unreachable loose objects; "
280 "run 'git prune' to remove them.");