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