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