repack: consider bitmaps when performing repacks
[git] / builtin / repack.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "dir.h"
4 #include "parse-options.h"
5 #include "run-command.h"
6 #include "sigchain.h"
7 #include "strbuf.h"
8 #include "string-list.h"
9 #include "argv-array.h"
10
11 static int delta_base_offset = 1;
12 static char *packdir, *packtmp;
13
14 static const char *const git_repack_usage[] = {
15         N_("git repack [options]"),
16         NULL
17 };
18
19 static int repack_config(const char *var, const char *value, void *cb)
20 {
21         if (!strcmp(var, "repack.usedeltabaseoffset")) {
22                 delta_base_offset = git_config_bool(var, value);
23                 return 0;
24         }
25         return git_default_config(var, value, cb);
26 }
27
28 /*
29  * Remove temporary $GIT_OBJECT_DIRECTORY/pack/.tmp-$$-pack-* files.
30  */
31 static void remove_temporary_files(void)
32 {
33         struct strbuf buf = STRBUF_INIT;
34         size_t dirlen, prefixlen;
35         DIR *dir;
36         struct dirent *e;
37
38         dir = opendir(packdir);
39         if (!dir)
40                 return;
41
42         /* Point at the slash at the end of ".../objects/pack/" */
43         dirlen = strlen(packdir) + 1;
44         strbuf_addstr(&buf, packtmp);
45         /* Hold the length of  ".tmp-%d-pack-" */
46         prefixlen = buf.len - dirlen;
47
48         while ((e = readdir(dir))) {
49                 if (strncmp(e->d_name, buf.buf + dirlen, prefixlen))
50                         continue;
51                 strbuf_setlen(&buf, dirlen);
52                 strbuf_addstr(&buf, e->d_name);
53                 unlink(buf.buf);
54         }
55         closedir(dir);
56         strbuf_release(&buf);
57 }
58
59 static void remove_pack_on_signal(int signo)
60 {
61         remove_temporary_files();
62         sigchain_pop(signo);
63         raise(signo);
64 }
65
66 /*
67  * Adds all packs hex strings to the fname list, which do not
68  * have a corresponding .keep file.
69  */
70 static void get_non_kept_pack_filenames(struct string_list *fname_list)
71 {
72         DIR *dir;
73         struct dirent *e;
74         char *fname;
75         size_t len;
76
77         if (!(dir = opendir(packdir)))
78                 return;
79
80         while ((e = readdir(dir)) != NULL) {
81                 if (suffixcmp(e->d_name, ".pack"))
82                         continue;
83
84                 len = strlen(e->d_name) - strlen(".pack");
85                 fname = xmemdupz(e->d_name, len);
86
87                 if (!file_exists(mkpath("%s/%s.keep", packdir, fname)))
88                         string_list_append_nodup(fname_list, fname);
89                 else
90                         free(fname);
91         }
92         closedir(dir);
93 }
94
95 static void remove_redundant_pack(const char *dir_name, const char *base_name)
96 {
97         const char *exts[] = {".pack", ".idx", ".keep", ".bitmap"};
98         int i;
99         struct strbuf buf = STRBUF_INIT;
100         size_t plen;
101
102         strbuf_addf(&buf, "%s/%s", dir_name, base_name);
103         plen = buf.len;
104
105         for (i = 0; i < ARRAY_SIZE(exts); i++) {
106                 strbuf_setlen(&buf, plen);
107                 strbuf_addstr(&buf, exts[i]);
108                 unlink(buf.buf);
109         }
110         strbuf_release(&buf);
111 }
112
113 #define ALL_INTO_ONE 1
114 #define LOOSEN_UNREACHABLE 2
115
116 int cmd_repack(int argc, const char **argv, const char *prefix)
117 {
118         struct {
119                 const char *name;
120                 unsigned optional:1;
121         } exts[] = {
122                 {".pack"},
123                 {".idx"},
124                 {".bitmap", 1},
125         };
126         struct child_process cmd;
127         struct string_list_item *item;
128         struct argv_array cmd_args = ARGV_ARRAY_INIT;
129         struct string_list names = STRING_LIST_INIT_DUP;
130         struct string_list rollback = STRING_LIST_INIT_NODUP;
131         struct string_list existing_packs = STRING_LIST_INIT_DUP;
132         struct strbuf line = STRBUF_INIT;
133         int nr_packs, ext, ret, failed;
134         FILE *out;
135
136         /* variables to be filled by option parsing */
137         int pack_everything = 0;
138         int delete_redundant = 0;
139         char *unpack_unreachable = NULL;
140         int window = 0, window_memory = 0;
141         int depth = 0;
142         int max_pack_size = 0;
143         int no_reuse_delta = 0, no_reuse_object = 0;
144         int no_update_server_info = 0;
145         int quiet = 0;
146         int local = 0;
147         int write_bitmap = -1;
148
149         struct option builtin_repack_options[] = {
150                 OPT_BIT('a', NULL, &pack_everything,
151                                 N_("pack everything in a single pack"), ALL_INTO_ONE),
152                 OPT_BIT('A', NULL, &pack_everything,
153                                 N_("same as -a, and turn unreachable objects loose"),
154                                    LOOSEN_UNREACHABLE | ALL_INTO_ONE),
155                 OPT_BOOL('d', NULL, &delete_redundant,
156                                 N_("remove redundant packs, and run git-prune-packed")),
157                 OPT_BOOL('f', NULL, &no_reuse_delta,
158                                 N_("pass --no-reuse-delta to git-pack-objects")),
159                 OPT_BOOL('F', NULL, &no_reuse_object,
160                                 N_("pass --no-reuse-object to git-pack-objects")),
161                 OPT_BOOL('n', NULL, &no_update_server_info,
162                                 N_("do not run git-update-server-info")),
163                 OPT__QUIET(&quiet, N_("be quiet")),
164                 OPT_BOOL('l', "local", &local,
165                                 N_("pass --local to git-pack-objects")),
166                 OPT_BOOL('b', "write-bitmap-index", &write_bitmap,
167                                 N_("write bitmap index")),
168                 OPT_STRING(0, "unpack-unreachable", &unpack_unreachable, N_("approxidate"),
169                                 N_("with -A, do not loosen objects older than this")),
170                 OPT_INTEGER(0, "window", &window,
171                                 N_("size of the window used for delta compression")),
172                 OPT_INTEGER(0, "window-memory", &window_memory,
173                                 N_("same as the above, but limit memory size instead of entries count")),
174                 OPT_INTEGER(0, "depth", &depth,
175                                 N_("limits the maximum delta depth")),
176                 OPT_INTEGER(0, "max-pack-size", &max_pack_size,
177                                 N_("maximum size of each packfile")),
178                 OPT_END()
179         };
180
181         git_config(repack_config, NULL);
182
183         argc = parse_options(argc, argv, prefix, builtin_repack_options,
184                                 git_repack_usage, 0);
185
186         packdir = mkpathdup("%s/pack", get_object_directory());
187         packtmp = mkpathdup("%s/.tmp-%d-pack", packdir, (int)getpid());
188
189         sigchain_push_common(remove_pack_on_signal);
190
191         argv_array_push(&cmd_args, "pack-objects");
192         argv_array_push(&cmd_args, "--keep-true-parents");
193         argv_array_push(&cmd_args, "--honor-pack-keep");
194         argv_array_push(&cmd_args, "--non-empty");
195         argv_array_push(&cmd_args, "--all");
196         argv_array_push(&cmd_args, "--reflog");
197         if (window)
198                 argv_array_pushf(&cmd_args, "--window=%u", window);
199         if (window_memory)
200                 argv_array_pushf(&cmd_args, "--window-memory=%u", window_memory);
201         if (depth)
202                 argv_array_pushf(&cmd_args, "--depth=%u", depth);
203         if (max_pack_size)
204                 argv_array_pushf(&cmd_args, "--max_pack_size=%u", max_pack_size);
205         if (no_reuse_delta)
206                 argv_array_pushf(&cmd_args, "--no-reuse-delta");
207         if (no_reuse_object)
208                 argv_array_pushf(&cmd_args, "--no-reuse-object");
209         if (write_bitmap >= 0)
210                 argv_array_pushf(&cmd_args, "--%swrite-bitmap-index",
211                                  write_bitmap ? "" : "no-");
212
213         if (pack_everything & ALL_INTO_ONE) {
214                 get_non_kept_pack_filenames(&existing_packs);
215
216                 if (existing_packs.nr && delete_redundant) {
217                         if (unpack_unreachable)
218                                 argv_array_pushf(&cmd_args,
219                                                 "--unpack-unreachable=%s",
220                                                 unpack_unreachable);
221                         else if (pack_everything & LOOSEN_UNREACHABLE)
222                                 argv_array_push(&cmd_args,
223                                                 "--unpack-unreachable");
224                 }
225         } else {
226                 argv_array_push(&cmd_args, "--unpacked");
227                 argv_array_push(&cmd_args, "--incremental");
228         }
229
230         if (local)
231                 argv_array_push(&cmd_args,  "--local");
232         if (quiet)
233                 argv_array_push(&cmd_args,  "--quiet");
234         if (delta_base_offset)
235                 argv_array_push(&cmd_args,  "--delta-base-offset");
236
237         argv_array_push(&cmd_args, packtmp);
238
239         memset(&cmd, 0, sizeof(cmd));
240         cmd.argv = cmd_args.argv;
241         cmd.git_cmd = 1;
242         cmd.out = -1;
243         cmd.no_stdin = 1;
244
245         ret = start_command(&cmd);
246         if (ret)
247                 return ret;
248
249         nr_packs = 0;
250         out = xfdopen(cmd.out, "r");
251         while (strbuf_getline(&line, out, '\n') != EOF) {
252                 if (line.len != 40)
253                         die("repack: Expecting 40 character sha1 lines only from pack-objects.");
254                 string_list_append(&names, line.buf);
255                 nr_packs++;
256         }
257         fclose(out);
258         ret = finish_command(&cmd);
259         if (ret)
260                 return ret;
261         argv_array_clear(&cmd_args);
262
263         if (!nr_packs && !quiet)
264                 printf("Nothing new to pack.\n");
265
266         /*
267          * Ok we have prepared all new packfiles.
268          * First see if there are packs of the same name and if so
269          * if we can move them out of the way (this can happen if we
270          * repacked immediately after packing fully.
271          */
272         failed = 0;
273         for_each_string_list_item(item, &names) {
274                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
275                         char *fname, *fname_old;
276                         fname = mkpathdup("%s/%s%s", packdir,
277                                                 item->string, exts[ext].name);
278                         if (!file_exists(fname)) {
279                                 free(fname);
280                                 continue;
281                         }
282
283                         fname_old = mkpath("%s/old-%s%s", packdir,
284                                                 item->string, exts[ext].name);
285                         if (file_exists(fname_old))
286                                 if (unlink(fname_old))
287                                         failed = 1;
288
289                         if (!failed && rename(fname, fname_old)) {
290                                 free(fname);
291                                 failed = 1;
292                                 break;
293                         } else {
294                                 string_list_append(&rollback, fname);
295                         }
296                 }
297                 if (failed)
298                         break;
299         }
300         if (failed) {
301                 struct string_list rollback_failure = STRING_LIST_INIT_DUP;
302                 for_each_string_list_item(item, &rollback) {
303                         char *fname, *fname_old;
304                         fname = mkpathdup("%s/%s", packdir, item->string);
305                         fname_old = mkpath("%s/old-%s", packdir, item->string);
306                         if (rename(fname_old, fname))
307                                 string_list_append(&rollback_failure, fname);
308                         free(fname);
309                 }
310
311                 if (rollback_failure.nr) {
312                         int i;
313                         fprintf(stderr,
314                                 "WARNING: Some packs in use have been renamed by\n"
315                                 "WARNING: prefixing old- to their name, in order to\n"
316                                 "WARNING: replace them with the new version of the\n"
317                                 "WARNING: file.  But the operation failed, and the\n"
318                                 "WARNING: attempt to rename them back to their\n"
319                                 "WARNING: original names also failed.\n"
320                                 "WARNING: Please rename them in %s manually:\n", packdir);
321                         for (i = 0; i < rollback_failure.nr; i++)
322                                 fprintf(stderr, "WARNING:   old-%s -> %s\n",
323                                         rollback_failure.items[i].string,
324                                         rollback_failure.items[i].string);
325                 }
326                 exit(1);
327         }
328
329         /* Now the ones with the same name are out of the way... */
330         for_each_string_list_item(item, &names) {
331                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
332                         char *fname, *fname_old;
333                         struct stat statbuffer;
334                         int exists = 0;
335                         fname = mkpathdup("%s/pack-%s%s",
336                                         packdir, item->string, exts[ext].name);
337                         fname_old = mkpathdup("%s-%s%s",
338                                         packtmp, item->string, exts[ext].name);
339                         if (!stat(fname_old, &statbuffer)) {
340                                 statbuffer.st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
341                                 chmod(fname_old, statbuffer.st_mode);
342                                 exists = 1;
343                         }
344                         if (exists || !exts[ext].optional) {
345                                 if (rename(fname_old, fname))
346                                         die_errno(_("renaming '%s' failed"), fname_old);
347                         }
348                         free(fname);
349                         free(fname_old);
350                 }
351         }
352
353         /* Remove the "old-" files */
354         for_each_string_list_item(item, &names) {
355                 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
356                         char *fname;
357                         fname = mkpath("%s/old-pack-%s%s",
358                                         packdir,
359                                         item->string,
360                                         exts[ext].name);
361                         if (remove_path(fname))
362                                 warning(_("removing '%s' failed"), fname);
363                 }
364         }
365
366         /* End of pack replacement. */
367
368         if (delete_redundant) {
369                 sort_string_list(&names);
370                 for_each_string_list_item(item, &existing_packs) {
371                         char *sha1;
372                         size_t len = strlen(item->string);
373                         if (len < 40)
374                                 continue;
375                         sha1 = item->string + len - 40;
376                         if (!string_list_has_string(&names, sha1))
377                                 remove_redundant_pack(packdir, item->string);
378                 }
379                 argv_array_push(&cmd_args, "prune-packed");
380                 if (quiet)
381                         argv_array_push(&cmd_args, "--quiet");
382
383                 memset(&cmd, 0, sizeof(cmd));
384                 cmd.argv = cmd_args.argv;
385                 cmd.git_cmd = 1;
386                 run_command(&cmd);
387                 argv_array_clear(&cmd_args);
388         }
389
390         if (!no_update_server_info) {
391                 argv_array_push(&cmd_args, "update-server-info");
392                 memset(&cmd, 0, sizeof(cmd));
393                 cmd.argv = cmd_args.argv;
394                 cmd.git_cmd = 1;
395                 run_command(&cmd);
396                 argv_array_clear(&cmd_args);
397         }
398         remove_temporary_files();
399         string_list_clear(&names, 0);
400         string_list_clear(&rollback, 0);
401         string_list_clear(&existing_packs, 0);
402         strbuf_release(&line);
403
404         return 0;
405 }