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