Merge branch 'mh/mingw-case-sensitive-build'
[alt-git.git] / builtin / repack.c
blobaea5ca9d44165721953d7031764ae67878cf491b
1 #include "builtin.h"
2 #include "config.h"
3 #include "dir.h"
4 #include "environment.h"
5 #include "gettext.h"
6 #include "hex.h"
7 #include "parse-options.h"
8 #include "path.h"
9 #include "run-command.h"
10 #include "server-info.h"
11 #include "sigchain.h"
12 #include "strbuf.h"
13 #include "string-list.h"
14 #include "strvec.h"
15 #include "midx.h"
16 #include "packfile.h"
17 #include "prune-packed.h"
18 #include "object-store-ll.h"
19 #include "promisor-remote.h"
20 #include "shallow.h"
21 #include "pack.h"
22 #include "pack-bitmap.h"
23 #include "refs.h"
25 #define ALL_INTO_ONE 1
26 #define LOOSEN_UNREACHABLE 2
27 #define PACK_CRUFT 4
29 #define DELETE_PACK 1
30 #define CRUFT_PACK 2
32 static int pack_everything;
33 static int delta_base_offset = 1;
34 static int pack_kept_objects = -1;
35 static int write_bitmaps = -1;
36 static int use_delta_islands;
37 static int run_update_server_info = 1;
38 static char *packdir, *packtmp_name, *packtmp;
40 static const char *const git_repack_usage[] = {
41 N_("git repack [<options>]"),
42 NULL
45 static const char incremental_bitmap_conflict_error[] = N_(
46 "Incremental repacks are incompatible with bitmap indexes. Use\n"
47 "--no-write-bitmap-index or disable the pack.writeBitmaps configuration."
50 struct pack_objects_args {
51 const char *window;
52 const char *window_memory;
53 const char *depth;
54 const char *threads;
55 const char *max_pack_size;
56 int no_reuse_delta;
57 int no_reuse_object;
58 int quiet;
59 int local;
62 static int repack_config(const char *var, const char *value,
63 const struct config_context *ctx, void *cb)
65 struct pack_objects_args *cruft_po_args = cb;
66 if (!strcmp(var, "repack.usedeltabaseoffset")) {
67 delta_base_offset = git_config_bool(var, value);
68 return 0;
70 if (!strcmp(var, "repack.packkeptobjects")) {
71 pack_kept_objects = git_config_bool(var, value);
72 return 0;
74 if (!strcmp(var, "repack.writebitmaps") ||
75 !strcmp(var, "pack.writebitmaps")) {
76 write_bitmaps = git_config_bool(var, value);
77 return 0;
79 if (!strcmp(var, "repack.usedeltaislands")) {
80 use_delta_islands = git_config_bool(var, value);
81 return 0;
83 if (strcmp(var, "repack.updateserverinfo") == 0) {
84 run_update_server_info = git_config_bool(var, value);
85 return 0;
87 if (!strcmp(var, "repack.cruftwindow"))
88 return git_config_string(&cruft_po_args->window, var, value);
89 if (!strcmp(var, "repack.cruftwindowmemory"))
90 return git_config_string(&cruft_po_args->window_memory, var, value);
91 if (!strcmp(var, "repack.cruftdepth"))
92 return git_config_string(&cruft_po_args->depth, var, value);
93 if (!strcmp(var, "repack.cruftthreads"))
94 return git_config_string(&cruft_po_args->threads, var, value);
95 return git_default_config(var, value, ctx, cb);
99 * Adds all packs hex strings (pack-$HASH) to either fname_nonkept_list
100 * or fname_kept_list based on whether each pack has a corresponding
101 * .keep file or not. Packs without a .keep file are not to be kept
102 * if we are going to pack everything into one file.
104 static void collect_pack_filenames(struct string_list *fname_nonkept_list,
105 struct string_list *fname_kept_list,
106 const struct string_list *extra_keep)
108 struct packed_git *p;
109 struct strbuf buf = STRBUF_INIT;
111 for (p = get_all_packs(the_repository); p; p = p->next) {
112 int i;
113 const char *base;
115 if (!p->pack_local)
116 continue;
118 base = pack_basename(p);
120 for (i = 0; i < extra_keep->nr; i++)
121 if (!fspathcmp(base, extra_keep->items[i].string))
122 break;
124 strbuf_reset(&buf);
125 strbuf_addstr(&buf, base);
126 strbuf_strip_suffix(&buf, ".pack");
128 if ((extra_keep->nr > 0 && i < extra_keep->nr) || p->pack_keep)
129 string_list_append(fname_kept_list, buf.buf);
130 else {
131 struct string_list_item *item;
132 item = string_list_append(fname_nonkept_list, buf.buf);
133 if (p->is_cruft)
134 item->util = (void*)(uintptr_t)CRUFT_PACK;
138 string_list_sort(fname_kept_list);
139 strbuf_release(&buf);
142 static void remove_redundant_pack(const char *dir_name, const char *base_name)
144 struct strbuf buf = STRBUF_INIT;
145 struct multi_pack_index *m = get_local_multi_pack_index(the_repository);
146 strbuf_addf(&buf, "%s.pack", base_name);
147 if (m && midx_contains_pack(m, buf.buf))
148 clear_midx_file(the_repository);
149 strbuf_insertf(&buf, 0, "%s/", dir_name);
150 unlink_pack_path(buf.buf, 1);
151 strbuf_release(&buf);
154 static void prepare_pack_objects(struct child_process *cmd,
155 const struct pack_objects_args *args,
156 const char *out)
158 strvec_push(&cmd->args, "pack-objects");
159 if (args->window)
160 strvec_pushf(&cmd->args, "--window=%s", args->window);
161 if (args->window_memory)
162 strvec_pushf(&cmd->args, "--window-memory=%s", args->window_memory);
163 if (args->depth)
164 strvec_pushf(&cmd->args, "--depth=%s", args->depth);
165 if (args->threads)
166 strvec_pushf(&cmd->args, "--threads=%s", args->threads);
167 if (args->max_pack_size)
168 strvec_pushf(&cmd->args, "--max-pack-size=%s", args->max_pack_size);
169 if (args->no_reuse_delta)
170 strvec_pushf(&cmd->args, "--no-reuse-delta");
171 if (args->no_reuse_object)
172 strvec_pushf(&cmd->args, "--no-reuse-object");
173 if (args->local)
174 strvec_push(&cmd->args, "--local");
175 if (args->quiet)
176 strvec_push(&cmd->args, "--quiet");
177 if (delta_base_offset)
178 strvec_push(&cmd->args, "--delta-base-offset");
179 strvec_push(&cmd->args, out);
180 cmd->git_cmd = 1;
181 cmd->out = -1;
185 * Write oid to the given struct child_process's stdin, starting it first if
186 * necessary.
188 static int write_oid(const struct object_id *oid,
189 struct packed_git *pack UNUSED,
190 uint32_t pos UNUSED, void *data)
192 struct child_process *cmd = data;
194 if (cmd->in == -1) {
195 if (start_command(cmd))
196 die(_("could not start pack-objects to repack promisor objects"));
199 xwrite(cmd->in, oid_to_hex(oid), the_hash_algo->hexsz);
200 xwrite(cmd->in, "\n", 1);
201 return 0;
204 static struct {
205 const char *name;
206 unsigned optional:1;
207 } exts[] = {
208 {".pack"},
209 {".rev", 1},
210 {".mtimes", 1},
211 {".bitmap", 1},
212 {".promisor", 1},
213 {".idx"},
216 struct generated_pack_data {
217 struct tempfile *tempfiles[ARRAY_SIZE(exts)];
220 static struct generated_pack_data *populate_pack_exts(const char *name)
222 struct stat statbuf;
223 struct strbuf path = STRBUF_INIT;
224 struct generated_pack_data *data = xcalloc(1, sizeof(*data));
225 int i;
227 for (i = 0; i < ARRAY_SIZE(exts); i++) {
228 strbuf_reset(&path);
229 strbuf_addf(&path, "%s-%s%s", packtmp, name, exts[i].name);
231 if (stat(path.buf, &statbuf))
232 continue;
234 data->tempfiles[i] = register_tempfile(path.buf);
237 strbuf_release(&path);
238 return data;
241 static void repack_promisor_objects(const struct pack_objects_args *args,
242 struct string_list *names)
244 struct child_process cmd = CHILD_PROCESS_INIT;
245 FILE *out;
246 struct strbuf line = STRBUF_INIT;
248 prepare_pack_objects(&cmd, args, packtmp);
249 cmd.in = -1;
252 * NEEDSWORK: Giving pack-objects only the OIDs without any ordering
253 * hints may result in suboptimal deltas in the resulting pack. See if
254 * the OIDs can be sent with fake paths such that pack-objects can use a
255 * {type -> existing pack order} ordering when computing deltas instead
256 * of a {type -> size} ordering, which may produce better deltas.
258 for_each_packed_object(write_oid, &cmd,
259 FOR_EACH_OBJECT_PROMISOR_ONLY);
261 if (cmd.in == -1) {
262 /* No packed objects; cmd was never started */
263 child_process_clear(&cmd);
264 return;
267 close(cmd.in);
269 out = xfdopen(cmd.out, "r");
270 while (strbuf_getline_lf(&line, out) != EOF) {
271 struct string_list_item *item;
272 char *promisor_name;
274 if (line.len != the_hash_algo->hexsz)
275 die(_("repack: Expecting full hex object ID lines only from pack-objects."));
276 item = string_list_append(names, line.buf);
279 * pack-objects creates the .pack and .idx files, but not the
280 * .promisor file. Create the .promisor file, which is empty.
282 * NEEDSWORK: fetch-pack sometimes generates non-empty
283 * .promisor files containing the ref names and associated
284 * hashes at the point of generation of the corresponding
285 * packfile, but this would not preserve their contents. Maybe
286 * concatenate the contents of all .promisor files instead of
287 * just creating a new empty file.
289 promisor_name = mkpathdup("%s-%s.promisor", packtmp,
290 line.buf);
291 write_promisor_file(promisor_name, NULL, 0);
293 item->util = populate_pack_exts(item->string);
295 free(promisor_name);
297 fclose(out);
298 if (finish_command(&cmd))
299 die(_("could not finish pack-objects to repack promisor objects"));
302 struct pack_geometry {
303 struct packed_git **pack;
304 uint32_t pack_nr, pack_alloc;
305 uint32_t split;
308 static uint32_t geometry_pack_weight(struct packed_git *p)
310 if (open_pack_index(p))
311 die(_("cannot open index for %s"), p->pack_name);
312 return p->num_objects;
315 static int geometry_cmp(const void *va, const void *vb)
317 uint32_t aw = geometry_pack_weight(*(struct packed_git **)va),
318 bw = geometry_pack_weight(*(struct packed_git **)vb);
320 if (aw < bw)
321 return -1;
322 if (aw > bw)
323 return 1;
324 return 0;
327 static void init_pack_geometry(struct pack_geometry **geometry_p,
328 struct string_list *existing_kept_packs,
329 const struct pack_objects_args *args)
331 struct packed_git *p;
332 struct pack_geometry *geometry;
333 struct strbuf buf = STRBUF_INIT;
335 *geometry_p = xcalloc(1, sizeof(struct pack_geometry));
336 geometry = *geometry_p;
338 for (p = get_all_packs(the_repository); p; p = p->next) {
339 if (args->local && !p->pack_local)
341 * When asked to only repack local packfiles we skip
342 * over any packfiles that are borrowed from alternate
343 * object directories.
345 continue;
347 if (!pack_kept_objects) {
349 * Any pack that has its pack_keep bit set will appear
350 * in existing_kept_packs below, but this saves us from
351 * doing a more expensive check.
353 if (p->pack_keep)
354 continue;
357 * The pack may be kept via the --keep-pack option;
358 * check 'existing_kept_packs' to determine whether to
359 * ignore it.
361 strbuf_reset(&buf);
362 strbuf_addstr(&buf, pack_basename(p));
363 strbuf_strip_suffix(&buf, ".pack");
365 if (string_list_has_string(existing_kept_packs, buf.buf))
366 continue;
368 if (p->is_cruft)
369 continue;
371 ALLOC_GROW(geometry->pack,
372 geometry->pack_nr + 1,
373 geometry->pack_alloc);
375 geometry->pack[geometry->pack_nr] = p;
376 geometry->pack_nr++;
379 QSORT(geometry->pack, geometry->pack_nr, geometry_cmp);
380 strbuf_release(&buf);
383 static void split_pack_geometry(struct pack_geometry *geometry, int factor)
385 uint32_t i;
386 uint32_t split;
387 off_t total_size = 0;
389 if (!geometry->pack_nr) {
390 geometry->split = geometry->pack_nr;
391 return;
395 * First, count the number of packs (in descending order of size) which
396 * already form a geometric progression.
398 for (i = geometry->pack_nr - 1; i > 0; i--) {
399 struct packed_git *ours = geometry->pack[i];
400 struct packed_git *prev = geometry->pack[i - 1];
402 if (unsigned_mult_overflows(factor, geometry_pack_weight(prev)))
403 die(_("pack %s too large to consider in geometric "
404 "progression"),
405 prev->pack_name);
407 if (geometry_pack_weight(ours) < factor * geometry_pack_weight(prev))
408 break;
411 split = i;
413 if (split) {
415 * Move the split one to the right, since the top element in the
416 * last-compared pair can't be in the progression. Only do this
417 * when we split in the middle of the array (otherwise if we got
418 * to the end, then the split is in the right place).
420 split++;
424 * Then, anything to the left of 'split' must be in a new pack. But,
425 * creating that new pack may cause packs in the heavy half to no longer
426 * form a geometric progression.
428 * Compute an expected size of the new pack, and then determine how many
429 * packs in the heavy half need to be joined into it (if any) to restore
430 * the geometric progression.
432 for (i = 0; i < split; i++) {
433 struct packed_git *p = geometry->pack[i];
435 if (unsigned_add_overflows(total_size, geometry_pack_weight(p)))
436 die(_("pack %s too large to roll up"), p->pack_name);
437 total_size += geometry_pack_weight(p);
439 for (i = split; i < geometry->pack_nr; i++) {
440 struct packed_git *ours = geometry->pack[i];
442 if (unsigned_mult_overflows(factor, total_size))
443 die(_("pack %s too large to roll up"), ours->pack_name);
445 if (geometry_pack_weight(ours) < factor * total_size) {
446 if (unsigned_add_overflows(total_size,
447 geometry_pack_weight(ours)))
448 die(_("pack %s too large to roll up"),
449 ours->pack_name);
451 split++;
452 total_size += geometry_pack_weight(ours);
453 } else
454 break;
457 geometry->split = split;
460 static struct packed_git *get_preferred_pack(struct pack_geometry *geometry)
462 uint32_t i;
464 if (!geometry) {
466 * No geometry means either an all-into-one repack (in which
467 * case there is only one pack left and it is the largest) or an
468 * incremental one.
470 * If repacking incrementally, then we could check the size of
471 * all packs to determine which should be preferred, but leave
472 * this for later.
474 return NULL;
476 if (geometry->split == geometry->pack_nr)
477 return NULL;
480 * The preferred pack is the largest pack above the split line. In
481 * other words, it is the largest pack that does not get rolled up in
482 * the geometric repack.
484 for (i = geometry->pack_nr; i > geometry->split; i--)
486 * A pack that is not local would never be included in a
487 * multi-pack index. We thus skip over any non-local packs.
489 if (geometry->pack[i - 1]->pack_local)
490 return geometry->pack[i - 1];
492 return NULL;
495 static void clear_pack_geometry(struct pack_geometry *geometry)
497 if (!geometry)
498 return;
500 free(geometry->pack);
501 geometry->pack_nr = 0;
502 geometry->pack_alloc = 0;
503 geometry->split = 0;
506 struct midx_snapshot_ref_data {
507 struct tempfile *f;
508 struct oidset seen;
509 int preferred;
512 static int midx_snapshot_ref_one(const char *refname UNUSED,
513 const struct object_id *oid,
514 int flag UNUSED, void *_data)
516 struct midx_snapshot_ref_data *data = _data;
517 struct object_id peeled;
519 if (!peel_iterated_oid(oid, &peeled))
520 oid = &peeled;
522 if (oidset_insert(&data->seen, oid))
523 return 0; /* already seen */
525 if (oid_object_info(the_repository, oid, NULL) != OBJ_COMMIT)
526 return 0;
528 fprintf(data->f->fp, "%s%s\n", data->preferred ? "+" : "",
529 oid_to_hex(oid));
531 return 0;
534 static void midx_snapshot_refs(struct tempfile *f)
536 struct midx_snapshot_ref_data data;
537 const struct string_list *preferred = bitmap_preferred_tips(the_repository);
539 data.f = f;
540 data.preferred = 0;
541 oidset_init(&data.seen, 0);
543 if (!fdopen_tempfile(f, "w"))
544 die(_("could not open tempfile %s for writing"),
545 get_tempfile_path(f));
547 if (preferred) {
548 struct string_list_item *item;
550 data.preferred = 1;
551 for_each_string_list_item(item, preferred)
552 for_each_ref_in(item->string, midx_snapshot_ref_one, &data);
553 data.preferred = 0;
556 for_each_ref(midx_snapshot_ref_one, &data);
558 if (close_tempfile_gently(f)) {
559 int save_errno = errno;
560 delete_tempfile(&f);
561 errno = save_errno;
562 die_errno(_("could not close refs snapshot tempfile"));
565 oidset_clear(&data.seen);
568 static void midx_included_packs(struct string_list *include,
569 struct string_list *existing_nonkept_packs,
570 struct string_list *existing_kept_packs,
571 struct string_list *names,
572 struct pack_geometry *geometry)
574 struct string_list_item *item;
576 for_each_string_list_item(item, existing_kept_packs)
577 string_list_insert(include, xstrfmt("%s.idx", item->string));
578 for_each_string_list_item(item, names)
579 string_list_insert(include, xstrfmt("pack-%s.idx", item->string));
580 if (geometry) {
581 struct strbuf buf = STRBUF_INIT;
582 uint32_t i;
583 for (i = geometry->split; i < geometry->pack_nr; i++) {
584 struct packed_git *p = geometry->pack[i];
587 * The multi-pack index never refers to packfiles part
588 * of an alternate object database, so we skip these.
589 * While git-multi-pack-index(1) would silently ignore
590 * them anyway, this allows us to skip executing the
591 * command completely when we have only non-local
592 * packfiles.
594 if (!p->pack_local)
595 continue;
597 strbuf_addstr(&buf, pack_basename(p));
598 strbuf_strip_suffix(&buf, ".pack");
599 strbuf_addstr(&buf, ".idx");
601 string_list_insert(include, strbuf_detach(&buf, NULL));
604 for_each_string_list_item(item, existing_nonkept_packs) {
605 if (!((uintptr_t)item->util & CRUFT_PACK)) {
607 * no need to check DELETE_PACK, since we're not
608 * doing an ALL_INTO_ONE repack
610 continue;
612 string_list_insert(include, xstrfmt("%s.idx", item->string));
614 } else {
615 for_each_string_list_item(item, existing_nonkept_packs) {
616 if ((uintptr_t)item->util & DELETE_PACK)
617 continue;
618 string_list_insert(include, xstrfmt("%s.idx", item->string));
623 static int write_midx_included_packs(struct string_list *include,
624 struct pack_geometry *geometry,
625 const char *refs_snapshot,
626 int show_progress, int write_bitmaps)
628 struct child_process cmd = CHILD_PROCESS_INIT;
629 struct string_list_item *item;
630 struct packed_git *preferred = get_preferred_pack(geometry);
631 FILE *in;
632 int ret;
634 if (!include->nr)
635 return 0;
637 cmd.in = -1;
638 cmd.git_cmd = 1;
640 strvec_push(&cmd.args, "multi-pack-index");
641 strvec_pushl(&cmd.args, "write", "--stdin-packs", NULL);
643 if (show_progress)
644 strvec_push(&cmd.args, "--progress");
645 else
646 strvec_push(&cmd.args, "--no-progress");
648 if (write_bitmaps)
649 strvec_push(&cmd.args, "--bitmap");
651 if (preferred)
652 strvec_pushf(&cmd.args, "--preferred-pack=%s",
653 pack_basename(preferred));
655 if (refs_snapshot)
656 strvec_pushf(&cmd.args, "--refs-snapshot=%s", refs_snapshot);
658 ret = start_command(&cmd);
659 if (ret)
660 return ret;
662 in = xfdopen(cmd.in, "w");
663 for_each_string_list_item(item, include)
664 fprintf(in, "%s\n", item->string);
665 fclose(in);
667 return finish_command(&cmd);
670 static void remove_redundant_bitmaps(struct string_list *include,
671 const char *packdir)
673 struct strbuf path = STRBUF_INIT;
674 struct string_list_item *item;
675 size_t packdir_len;
677 strbuf_addstr(&path, packdir);
678 strbuf_addch(&path, '/');
679 packdir_len = path.len;
682 * Remove any pack bitmaps corresponding to packs which are now
683 * included in the MIDX.
685 for_each_string_list_item(item, include) {
686 strbuf_addstr(&path, item->string);
687 strbuf_strip_suffix(&path, ".idx");
688 strbuf_addstr(&path, ".bitmap");
690 if (unlink(path.buf) && errno != ENOENT)
691 warning_errno(_("could not remove stale bitmap: %s"),
692 path.buf);
694 strbuf_setlen(&path, packdir_len);
696 strbuf_release(&path);
699 static int write_cruft_pack(const struct pack_objects_args *args,
700 const char *destination,
701 const char *pack_prefix,
702 const char *cruft_expiration,
703 struct string_list *names,
704 struct string_list *existing_packs,
705 struct string_list *existing_kept_packs)
707 struct child_process cmd = CHILD_PROCESS_INIT;
708 struct strbuf line = STRBUF_INIT;
709 struct string_list_item *item;
710 FILE *in, *out;
711 int ret;
712 const char *scratch;
713 int local = skip_prefix(destination, packdir, &scratch);
715 prepare_pack_objects(&cmd, args, destination);
717 strvec_push(&cmd.args, "--cruft");
718 if (cruft_expiration)
719 strvec_pushf(&cmd.args, "--cruft-expiration=%s",
720 cruft_expiration);
722 strvec_push(&cmd.args, "--honor-pack-keep");
723 strvec_push(&cmd.args, "--non-empty");
724 strvec_push(&cmd.args, "--max-pack-size=0");
726 cmd.in = -1;
728 ret = start_command(&cmd);
729 if (ret)
730 return ret;
733 * names has a confusing double use: it both provides the list
734 * of just-written new packs, and accepts the name of the cruft
735 * pack we are writing.
737 * By the time it is read here, it contains only the pack(s)
738 * that were just written, which is exactly the set of packs we
739 * want to consider kept.
741 * If `--expire-to` is given, the double-use served by `names`
742 * ensures that the pack written to `--expire-to` excludes any
743 * objects contained in the cruft pack.
745 in = xfdopen(cmd.in, "w");
746 for_each_string_list_item(item, names)
747 fprintf(in, "%s-%s.pack\n", pack_prefix, item->string);
748 for_each_string_list_item(item, existing_packs)
749 fprintf(in, "-%s.pack\n", item->string);
750 for_each_string_list_item(item, existing_kept_packs)
751 fprintf(in, "%s.pack\n", item->string);
752 fclose(in);
754 out = xfdopen(cmd.out, "r");
755 while (strbuf_getline_lf(&line, out) != EOF) {
756 struct string_list_item *item;
758 if (line.len != the_hash_algo->hexsz)
759 die(_("repack: Expecting full hex object ID lines only "
760 "from pack-objects."));
762 * avoid putting packs written outside of the repository in the
763 * list of names
765 if (local) {
766 item = string_list_append(names, line.buf);
767 item->util = populate_pack_exts(line.buf);
770 fclose(out);
772 strbuf_release(&line);
774 return finish_command(&cmd);
777 int cmd_repack(int argc, const char **argv, const char *prefix)
779 struct child_process cmd = CHILD_PROCESS_INIT;
780 struct string_list_item *item;
781 struct string_list names = STRING_LIST_INIT_DUP;
782 struct string_list existing_nonkept_packs = STRING_LIST_INIT_DUP;
783 struct string_list existing_kept_packs = STRING_LIST_INIT_DUP;
784 struct pack_geometry *geometry = NULL;
785 struct strbuf line = STRBUF_INIT;
786 struct tempfile *refs_snapshot = NULL;
787 int i, ext, ret;
788 FILE *out;
789 int show_progress;
791 /* variables to be filled by option parsing */
792 int delete_redundant = 0;
793 const char *unpack_unreachable = NULL;
794 int keep_unreachable = 0;
795 struct string_list keep_pack_list = STRING_LIST_INIT_NODUP;
796 struct pack_objects_args po_args = {NULL};
797 struct pack_objects_args cruft_po_args = {NULL};
798 int geometric_factor = 0;
799 int write_midx = 0;
800 const char *cruft_expiration = NULL;
801 const char *expire_to = NULL;
803 struct option builtin_repack_options[] = {
804 OPT_BIT('a', NULL, &pack_everything,
805 N_("pack everything in a single pack"), ALL_INTO_ONE),
806 OPT_BIT('A', NULL, &pack_everything,
807 N_("same as -a, and turn unreachable objects loose"),
808 LOOSEN_UNREACHABLE | ALL_INTO_ONE),
809 OPT_BIT(0, "cruft", &pack_everything,
810 N_("same as -a, pack unreachable cruft objects separately"),
811 PACK_CRUFT),
812 OPT_STRING(0, "cruft-expiration", &cruft_expiration, N_("approxidate"),
813 N_("with --cruft, expire objects older than this")),
814 OPT_BOOL('d', NULL, &delete_redundant,
815 N_("remove redundant packs, and run git-prune-packed")),
816 OPT_BOOL('f', NULL, &po_args.no_reuse_delta,
817 N_("pass --no-reuse-delta to git-pack-objects")),
818 OPT_BOOL('F', NULL, &po_args.no_reuse_object,
819 N_("pass --no-reuse-object to git-pack-objects")),
820 OPT_NEGBIT('n', NULL, &run_update_server_info,
821 N_("do not run git-update-server-info"), 1),
822 OPT__QUIET(&po_args.quiet, N_("be quiet")),
823 OPT_BOOL('l', "local", &po_args.local,
824 N_("pass --local to git-pack-objects")),
825 OPT_BOOL('b', "write-bitmap-index", &write_bitmaps,
826 N_("write bitmap index")),
827 OPT_BOOL('i', "delta-islands", &use_delta_islands,
828 N_("pass --delta-islands to git-pack-objects")),
829 OPT_STRING(0, "unpack-unreachable", &unpack_unreachable, N_("approxidate"),
830 N_("with -A, do not loosen objects older than this")),
831 OPT_BOOL('k', "keep-unreachable", &keep_unreachable,
832 N_("with -a, repack unreachable objects")),
833 OPT_STRING(0, "window", &po_args.window, N_("n"),
834 N_("size of the window used for delta compression")),
835 OPT_STRING(0, "window-memory", &po_args.window_memory, N_("bytes"),
836 N_("same as the above, but limit memory size instead of entries count")),
837 OPT_STRING(0, "depth", &po_args.depth, N_("n"),
838 N_("limits the maximum delta depth")),
839 OPT_STRING(0, "threads", &po_args.threads, N_("n"),
840 N_("limits the maximum number of threads")),
841 OPT_STRING(0, "max-pack-size", &po_args.max_pack_size, N_("bytes"),
842 N_("maximum size of each packfile")),
843 OPT_BOOL(0, "pack-kept-objects", &pack_kept_objects,
844 N_("repack objects in packs marked with .keep")),
845 OPT_STRING_LIST(0, "keep-pack", &keep_pack_list, N_("name"),
846 N_("do not repack this pack")),
847 OPT_INTEGER('g', "geometric", &geometric_factor,
848 N_("find a geometric progression with factor <N>")),
849 OPT_BOOL('m', "write-midx", &write_midx,
850 N_("write a multi-pack index of the resulting packs")),
851 OPT_STRING(0, "expire-to", &expire_to, N_("dir"),
852 N_("pack prefix to store a pack containing pruned objects")),
853 OPT_END()
856 git_config(repack_config, &cruft_po_args);
858 argc = parse_options(argc, argv, prefix, builtin_repack_options,
859 git_repack_usage, 0);
861 if (delete_redundant && repository_format_precious_objects)
862 die(_("cannot delete packs in a precious-objects repo"));
864 if (keep_unreachable &&
865 (unpack_unreachable || (pack_everything & LOOSEN_UNREACHABLE)))
866 die(_("options '%s' and '%s' cannot be used together"), "--keep-unreachable", "-A");
868 if (pack_everything & PACK_CRUFT) {
869 pack_everything |= ALL_INTO_ONE;
871 if (unpack_unreachable || (pack_everything & LOOSEN_UNREACHABLE))
872 die(_("options '%s' and '%s' cannot be used together"), "--cruft", "-A");
873 if (keep_unreachable)
874 die(_("options '%s' and '%s' cannot be used together"), "--cruft", "-k");
877 if (write_bitmaps < 0) {
878 if (!write_midx &&
879 (!(pack_everything & ALL_INTO_ONE) || !is_bare_repository()))
880 write_bitmaps = 0;
881 } else if (write_bitmaps &&
882 git_env_bool(GIT_TEST_MULTI_PACK_INDEX, 0) &&
883 git_env_bool(GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP, 0)) {
884 write_bitmaps = 0;
886 if (pack_kept_objects < 0)
887 pack_kept_objects = write_bitmaps > 0 && !write_midx;
889 if (write_bitmaps && !(pack_everything & ALL_INTO_ONE) && !write_midx)
890 die(_(incremental_bitmap_conflict_error));
892 if (write_bitmaps && po_args.local && has_alt_odb(the_repository)) {
894 * When asked to do a local repack, but we have
895 * packfiles that are inherited from an alternate, then
896 * we cannot guarantee that the multi-pack-index would
897 * have full coverage of all objects. We thus disable
898 * writing bitmaps in that case.
900 warning(_("disabling bitmap writing, as some objects are not being packed"));
901 write_bitmaps = 0;
904 if (write_midx && write_bitmaps) {
905 struct strbuf path = STRBUF_INIT;
907 strbuf_addf(&path, "%s/%s_XXXXXX", get_object_directory(),
908 "bitmap-ref-tips");
910 refs_snapshot = xmks_tempfile(path.buf);
911 midx_snapshot_refs(refs_snapshot);
913 strbuf_release(&path);
916 packdir = mkpathdup("%s/pack", get_object_directory());
917 packtmp_name = xstrfmt(".tmp-%d-pack", (int)getpid());
918 packtmp = mkpathdup("%s/%s", packdir, packtmp_name);
920 collect_pack_filenames(&existing_nonkept_packs, &existing_kept_packs,
921 &keep_pack_list);
923 if (geometric_factor) {
924 if (pack_everything)
925 die(_("options '%s' and '%s' cannot be used together"), "--geometric", "-A/-a");
926 init_pack_geometry(&geometry, &existing_kept_packs, &po_args);
927 split_pack_geometry(geometry, geometric_factor);
930 prepare_pack_objects(&cmd, &po_args, packtmp);
932 show_progress = !po_args.quiet && isatty(2);
934 strvec_push(&cmd.args, "--keep-true-parents");
935 if (!pack_kept_objects)
936 strvec_push(&cmd.args, "--honor-pack-keep");
937 for (i = 0; i < keep_pack_list.nr; i++)
938 strvec_pushf(&cmd.args, "--keep-pack=%s",
939 keep_pack_list.items[i].string);
940 strvec_push(&cmd.args, "--non-empty");
941 if (!geometry) {
943 * We need to grab all reachable objects, including those that
944 * are reachable from reflogs and the index.
946 * When repacking into a geometric progression of packs,
947 * however, we ask 'git pack-objects --stdin-packs', and it is
948 * not about packing objects based on reachability but about
949 * repacking all the objects in specified packs and loose ones
950 * (indeed, --stdin-packs is incompatible with these options).
952 strvec_push(&cmd.args, "--all");
953 strvec_push(&cmd.args, "--reflog");
954 strvec_push(&cmd.args, "--indexed-objects");
956 if (repo_has_promisor_remote(the_repository))
957 strvec_push(&cmd.args, "--exclude-promisor-objects");
958 if (!write_midx) {
959 if (write_bitmaps > 0)
960 strvec_push(&cmd.args, "--write-bitmap-index");
961 else if (write_bitmaps < 0)
962 strvec_push(&cmd.args, "--write-bitmap-index-quiet");
964 if (use_delta_islands)
965 strvec_push(&cmd.args, "--delta-islands");
967 if (pack_everything & ALL_INTO_ONE) {
968 repack_promisor_objects(&po_args, &names);
970 if (existing_nonkept_packs.nr && delete_redundant &&
971 !(pack_everything & PACK_CRUFT)) {
972 for_each_string_list_item(item, &names) {
973 strvec_pushf(&cmd.args, "--keep-pack=%s-%s.pack",
974 packtmp_name, item->string);
976 if (unpack_unreachable) {
977 strvec_pushf(&cmd.args,
978 "--unpack-unreachable=%s",
979 unpack_unreachable);
980 } else if (pack_everything & LOOSEN_UNREACHABLE) {
981 strvec_push(&cmd.args,
982 "--unpack-unreachable");
983 } else if (keep_unreachable) {
984 strvec_push(&cmd.args, "--keep-unreachable");
985 strvec_push(&cmd.args, "--pack-loose-unreachable");
988 } else if (geometry) {
989 strvec_push(&cmd.args, "--stdin-packs");
990 strvec_push(&cmd.args, "--unpacked");
991 } else {
992 strvec_push(&cmd.args, "--unpacked");
993 strvec_push(&cmd.args, "--incremental");
996 if (geometry)
997 cmd.in = -1;
998 else
999 cmd.no_stdin = 1;
1001 ret = start_command(&cmd);
1002 if (ret)
1003 goto cleanup;
1005 if (geometry) {
1006 FILE *in = xfdopen(cmd.in, "w");
1008 * The resulting pack should contain all objects in packs that
1009 * are going to be rolled up, but exclude objects in packs which
1010 * are being left alone.
1012 for (i = 0; i < geometry->split; i++)
1013 fprintf(in, "%s\n", pack_basename(geometry->pack[i]));
1014 for (i = geometry->split; i < geometry->pack_nr; i++)
1015 fprintf(in, "^%s\n", pack_basename(geometry->pack[i]));
1016 fclose(in);
1019 out = xfdopen(cmd.out, "r");
1020 while (strbuf_getline_lf(&line, out) != EOF) {
1021 struct string_list_item *item;
1023 if (line.len != the_hash_algo->hexsz)
1024 die(_("repack: Expecting full hex object ID lines only from pack-objects."));
1025 item = string_list_append(&names, line.buf);
1026 item->util = populate_pack_exts(item->string);
1028 strbuf_release(&line);
1029 fclose(out);
1030 ret = finish_command(&cmd);
1031 if (ret)
1032 goto cleanup;
1034 if (!names.nr && !po_args.quiet)
1035 printf_ln(_("Nothing new to pack."));
1037 if (pack_everything & PACK_CRUFT) {
1038 const char *pack_prefix;
1039 if (!skip_prefix(packtmp, packdir, &pack_prefix))
1040 die(_("pack prefix %s does not begin with objdir %s"),
1041 packtmp, packdir);
1042 if (*pack_prefix == '/')
1043 pack_prefix++;
1045 if (!cruft_po_args.window)
1046 cruft_po_args.window = po_args.window;
1047 if (!cruft_po_args.window_memory)
1048 cruft_po_args.window_memory = po_args.window_memory;
1049 if (!cruft_po_args.depth)
1050 cruft_po_args.depth = po_args.depth;
1051 if (!cruft_po_args.threads)
1052 cruft_po_args.threads = po_args.threads;
1054 cruft_po_args.local = po_args.local;
1055 cruft_po_args.quiet = po_args.quiet;
1057 ret = write_cruft_pack(&cruft_po_args, packtmp, pack_prefix,
1058 cruft_expiration, &names,
1059 &existing_nonkept_packs,
1060 &existing_kept_packs);
1061 if (ret)
1062 goto cleanup;
1064 if (delete_redundant && expire_to) {
1066 * If `--expire-to` is given with `-d`, it's possible
1067 * that we're about to prune some objects. With cruft
1068 * packs, pruning is implicit: any objects from existing
1069 * packs that weren't picked up by new packs are removed
1070 * when their packs are deleted.
1072 * Generate an additional cruft pack, with one twist:
1073 * `names` now includes the name of the cruft pack
1074 * written in the previous step. So the contents of
1075 * _this_ cruft pack exclude everything contained in the
1076 * existing cruft pack (that is, all of the unreachable
1077 * objects which are no older than
1078 * `--cruft-expiration`).
1080 * To make this work, cruft_expiration must become NULL
1081 * so that this cruft pack doesn't actually prune any
1082 * objects. If it were non-NULL, this call would always
1083 * generate an empty pack (since every object not in the
1084 * cruft pack generated above will have an mtime older
1085 * than the expiration).
1087 ret = write_cruft_pack(&cruft_po_args, expire_to,
1088 pack_prefix,
1089 NULL,
1090 &names,
1091 &existing_nonkept_packs,
1092 &existing_kept_packs);
1093 if (ret)
1094 goto cleanup;
1098 string_list_sort(&names);
1100 close_object_store(the_repository->objects);
1103 * Ok we have prepared all new packfiles.
1105 for_each_string_list_item(item, &names) {
1106 struct generated_pack_data *data = item->util;
1108 for (ext = 0; ext < ARRAY_SIZE(exts); ext++) {
1109 char *fname;
1111 fname = mkpathdup("%s/pack-%s%s",
1112 packdir, item->string, exts[ext].name);
1114 if (data->tempfiles[ext]) {
1115 const char *fname_old = get_tempfile_path(data->tempfiles[ext]);
1116 struct stat statbuffer;
1118 if (!stat(fname_old, &statbuffer)) {
1119 statbuffer.st_mode &= ~(S_IWUSR | S_IWGRP | S_IWOTH);
1120 chmod(fname_old, statbuffer.st_mode);
1123 if (rename_tempfile(&data->tempfiles[ext], fname))
1124 die_errno(_("renaming pack to '%s' failed"), fname);
1125 } else if (!exts[ext].optional)
1126 die(_("pack-objects did not write a '%s' file for pack %s-%s"),
1127 exts[ext].name, packtmp, item->string);
1128 else if (unlink(fname) < 0 && errno != ENOENT)
1129 die_errno(_("could not unlink: %s"), fname);
1131 free(fname);
1134 /* End of pack replacement. */
1136 if (delete_redundant && pack_everything & ALL_INTO_ONE) {
1137 const int hexsz = the_hash_algo->hexsz;
1138 for_each_string_list_item(item, &existing_nonkept_packs) {
1139 char *sha1;
1140 size_t len = strlen(item->string);
1141 if (len < hexsz)
1142 continue;
1143 sha1 = item->string + len - hexsz;
1145 * Mark this pack for deletion, which ensures that this
1146 * pack won't be included in a MIDX (if `--write-midx`
1147 * was given) and that we will actually delete this pack
1148 * (if `-d` was given).
1150 if (!string_list_has_string(&names, sha1))
1151 item->util = (void*)(uintptr_t)((size_t)item->util | DELETE_PACK);
1155 if (write_midx) {
1156 struct string_list include = STRING_LIST_INIT_NODUP;
1157 midx_included_packs(&include, &existing_nonkept_packs,
1158 &existing_kept_packs, &names, geometry);
1160 ret = write_midx_included_packs(&include, geometry,
1161 refs_snapshot ? get_tempfile_path(refs_snapshot) : NULL,
1162 show_progress, write_bitmaps > 0);
1164 if (!ret && write_bitmaps)
1165 remove_redundant_bitmaps(&include, packdir);
1167 string_list_clear(&include, 0);
1169 if (ret)
1170 goto cleanup;
1173 reprepare_packed_git(the_repository);
1175 if (delete_redundant) {
1176 int opts = 0;
1177 for_each_string_list_item(item, &existing_nonkept_packs) {
1178 if (!((uintptr_t)item->util & DELETE_PACK))
1179 continue;
1180 remove_redundant_pack(packdir, item->string);
1183 if (geometry) {
1184 struct strbuf buf = STRBUF_INIT;
1186 uint32_t i;
1187 for (i = 0; i < geometry->split; i++) {
1188 struct packed_git *p = geometry->pack[i];
1189 if (string_list_has_string(&names,
1190 hash_to_hex(p->hash)))
1191 continue;
1193 strbuf_reset(&buf);
1194 strbuf_addstr(&buf, pack_basename(p));
1195 strbuf_strip_suffix(&buf, ".pack");
1197 if ((p->pack_keep) ||
1198 (string_list_has_string(&existing_kept_packs,
1199 buf.buf)))
1200 continue;
1202 remove_redundant_pack(packdir, buf.buf);
1204 strbuf_release(&buf);
1206 if (show_progress)
1207 opts |= PRUNE_PACKED_VERBOSE;
1208 prune_packed_objects(opts);
1210 if (!keep_unreachable &&
1211 (!(pack_everything & LOOSEN_UNREACHABLE) ||
1212 unpack_unreachable) &&
1213 is_repository_shallow(the_repository))
1214 prune_shallow(PRUNE_QUICK);
1217 if (run_update_server_info)
1218 update_server_info(0);
1220 if (git_env_bool(GIT_TEST_MULTI_PACK_INDEX, 0)) {
1221 unsigned flags = 0;
1222 if (git_env_bool(GIT_TEST_MULTI_PACK_INDEX_WRITE_BITMAP, 0))
1223 flags |= MIDX_WRITE_BITMAP | MIDX_WRITE_REV_INDEX;
1224 write_midx_file(get_object_directory(), NULL, NULL, flags);
1227 cleanup:
1228 string_list_clear(&names, 1);
1229 string_list_clear(&existing_nonkept_packs, 0);
1230 string_list_clear(&existing_kept_packs, 0);
1231 clear_pack_geometry(geometry);
1233 return ret;