Merge branch 'jc/gettext-test-fix'
[alt-git.git] / commit-graph.c
blob66865acbd7489df4f85ee2454fe05a9b346e7aa7
1 #include "cache.h"
2 #include "config.h"
3 #include "dir.h"
4 #include "git-compat-util.h"
5 #include "lockfile.h"
6 #include "pack.h"
7 #include "packfile.h"
8 #include "commit.h"
9 #include "object.h"
10 #include "refs.h"
11 #include "revision.h"
12 #include "sha1-lookup.h"
13 #include "commit-graph.h"
14 #include "object-store.h"
15 #include "alloc.h"
16 #include "hashmap.h"
17 #include "replace-object.h"
18 #include "progress.h"
20 #define GRAPH_SIGNATURE 0x43475048 /* "CGPH" */
21 #define GRAPH_CHUNKID_OIDFANOUT 0x4f494446 /* "OIDF" */
22 #define GRAPH_CHUNKID_OIDLOOKUP 0x4f49444c /* "OIDL" */
23 #define GRAPH_CHUNKID_DATA 0x43444154 /* "CDAT" */
24 #define GRAPH_CHUNKID_EXTRAEDGES 0x45444745 /* "EDGE" */
26 #define GRAPH_DATA_WIDTH (the_hash_algo->rawsz + 16)
28 #define GRAPH_VERSION_1 0x1
29 #define GRAPH_VERSION GRAPH_VERSION_1
31 #define GRAPH_EXTRA_EDGES_NEEDED 0x80000000
32 #define GRAPH_EDGE_LAST_MASK 0x7fffffff
33 #define GRAPH_PARENT_NONE 0x70000000
35 #define GRAPH_LAST_EDGE 0x80000000
37 #define GRAPH_HEADER_SIZE 8
38 #define GRAPH_FANOUT_SIZE (4 * 256)
39 #define GRAPH_CHUNKLOOKUP_WIDTH 12
40 #define GRAPH_MIN_SIZE (GRAPH_HEADER_SIZE + 4 * GRAPH_CHUNKLOOKUP_WIDTH \
41 + GRAPH_FANOUT_SIZE + the_hash_algo->rawsz)
43 char *get_commit_graph_filename(const char *obj_dir)
45 return xstrfmt("%s/info/commit-graph", obj_dir);
48 static uint8_t oid_version(void)
50 return 1;
53 static struct commit_graph *alloc_commit_graph(void)
55 struct commit_graph *g = xcalloc(1, sizeof(*g));
56 g->graph_fd = -1;
58 return g;
61 extern int read_replace_refs;
63 static int commit_graph_compatible(struct repository *r)
65 if (!r->gitdir)
66 return 0;
68 if (read_replace_refs) {
69 prepare_replace_object(r);
70 if (hashmap_get_size(&r->objects->replace_map->map))
71 return 0;
74 prepare_commit_graft(r);
75 if (r->parsed_objects && r->parsed_objects->grafts_nr)
76 return 0;
77 if (is_repository_shallow(r))
78 return 0;
80 return 1;
83 int open_commit_graph(const char *graph_file, int *fd, struct stat *st)
85 *fd = git_open(graph_file);
86 if (*fd < 0)
87 return 0;
88 if (fstat(*fd, st)) {
89 close(*fd);
90 return 0;
92 return 1;
95 struct commit_graph *load_commit_graph_one_fd_st(int fd, struct stat *st)
97 void *graph_map;
98 size_t graph_size;
99 struct commit_graph *ret;
101 graph_size = xsize_t(st->st_size);
103 if (graph_size < GRAPH_MIN_SIZE) {
104 close(fd);
105 error(_("commit-graph file is too small"));
106 return NULL;
108 graph_map = xmmap(NULL, graph_size, PROT_READ, MAP_PRIVATE, fd, 0);
109 ret = parse_commit_graph(graph_map, fd, graph_size);
111 if (!ret) {
112 munmap(graph_map, graph_size);
113 close(fd);
116 return ret;
119 static int verify_commit_graph_lite(struct commit_graph *g)
122 * Basic validation shared between parse_commit_graph()
123 * which'll be called every time the graph is used, and the
124 * much more expensive verify_commit_graph() used by
125 * "commit-graph verify".
127 * There should only be very basic checks here to ensure that
128 * we don't e.g. segfault in fill_commit_in_graph(), but
129 * because this is a very hot codepath nothing that e.g. loops
130 * over g->num_commits, or runs a checksum on the commit-graph
131 * itself.
133 if (!g->chunk_oid_fanout) {
134 error("commit-graph is missing the OID Fanout chunk");
135 return 1;
137 if (!g->chunk_oid_lookup) {
138 error("commit-graph is missing the OID Lookup chunk");
139 return 1;
141 if (!g->chunk_commit_data) {
142 error("commit-graph is missing the Commit Data chunk");
143 return 1;
146 return 0;
149 struct commit_graph *parse_commit_graph(void *graph_map, int fd,
150 size_t graph_size)
152 const unsigned char *data, *chunk_lookup;
153 uint32_t i;
154 struct commit_graph *graph;
155 uint64_t last_chunk_offset;
156 uint32_t last_chunk_id;
157 uint32_t graph_signature;
158 unsigned char graph_version, hash_version;
160 if (!graph_map)
161 return NULL;
163 if (graph_size < GRAPH_MIN_SIZE)
164 return NULL;
166 data = (const unsigned char *)graph_map;
168 graph_signature = get_be32(data);
169 if (graph_signature != GRAPH_SIGNATURE) {
170 error(_("commit-graph signature %X does not match signature %X"),
171 graph_signature, GRAPH_SIGNATURE);
172 return NULL;
175 graph_version = *(unsigned char*)(data + 4);
176 if (graph_version != GRAPH_VERSION) {
177 error(_("commit-graph version %X does not match version %X"),
178 graph_version, GRAPH_VERSION);
179 return NULL;
182 hash_version = *(unsigned char*)(data + 5);
183 if (hash_version != oid_version()) {
184 error(_("commit-graph hash version %X does not match version %X"),
185 hash_version, oid_version());
186 return NULL;
189 graph = alloc_commit_graph();
191 graph->hash_len = the_hash_algo->rawsz;
192 graph->num_chunks = *(unsigned char*)(data + 6);
193 graph->graph_fd = fd;
194 graph->data = graph_map;
195 graph->data_len = graph_size;
197 last_chunk_id = 0;
198 last_chunk_offset = 8;
199 chunk_lookup = data + 8;
200 for (i = 0; i < graph->num_chunks; i++) {
201 uint32_t chunk_id;
202 uint64_t chunk_offset;
203 int chunk_repeated = 0;
205 if (data + graph_size - chunk_lookup <
206 GRAPH_CHUNKLOOKUP_WIDTH) {
207 error(_("commit-graph chunk lookup table entry missing; file may be incomplete"));
208 free(graph);
209 return NULL;
212 chunk_id = get_be32(chunk_lookup + 0);
213 chunk_offset = get_be64(chunk_lookup + 4);
215 chunk_lookup += GRAPH_CHUNKLOOKUP_WIDTH;
217 if (chunk_offset > graph_size - the_hash_algo->rawsz) {
218 error(_("commit-graph improper chunk offset %08x%08x"), (uint32_t)(chunk_offset >> 32),
219 (uint32_t)chunk_offset);
220 free(graph);
221 return NULL;
224 switch (chunk_id) {
225 case GRAPH_CHUNKID_OIDFANOUT:
226 if (graph->chunk_oid_fanout)
227 chunk_repeated = 1;
228 else
229 graph->chunk_oid_fanout = (uint32_t*)(data + chunk_offset);
230 break;
232 case GRAPH_CHUNKID_OIDLOOKUP:
233 if (graph->chunk_oid_lookup)
234 chunk_repeated = 1;
235 else
236 graph->chunk_oid_lookup = data + chunk_offset;
237 break;
239 case GRAPH_CHUNKID_DATA:
240 if (graph->chunk_commit_data)
241 chunk_repeated = 1;
242 else
243 graph->chunk_commit_data = data + chunk_offset;
244 break;
246 case GRAPH_CHUNKID_EXTRAEDGES:
247 if (graph->chunk_extra_edges)
248 chunk_repeated = 1;
249 else
250 graph->chunk_extra_edges = data + chunk_offset;
251 break;
254 if (chunk_repeated) {
255 error(_("commit-graph chunk id %08x appears multiple times"), chunk_id);
256 free(graph);
257 return NULL;
260 if (last_chunk_id == GRAPH_CHUNKID_OIDLOOKUP)
262 graph->num_commits = (chunk_offset - last_chunk_offset)
263 / graph->hash_len;
266 last_chunk_id = chunk_id;
267 last_chunk_offset = chunk_offset;
270 if (verify_commit_graph_lite(graph))
271 return NULL;
273 return graph;
276 static struct commit_graph *load_commit_graph_one(const char *graph_file)
279 struct stat st;
280 int fd;
281 int open_ok = open_commit_graph(graph_file, &fd, &st);
283 if (!open_ok)
284 return NULL;
286 return load_commit_graph_one_fd_st(fd, &st);
289 static void prepare_commit_graph_one(struct repository *r, const char *obj_dir)
291 char *graph_name;
293 if (r->objects->commit_graph)
294 return;
296 graph_name = get_commit_graph_filename(obj_dir);
297 r->objects->commit_graph =
298 load_commit_graph_one(graph_name);
300 FREE_AND_NULL(graph_name);
304 * Return 1 if commit_graph is non-NULL, and 0 otherwise.
306 * On the first invocation, this function attemps to load the commit
307 * graph if the_repository is configured to have one.
309 static int prepare_commit_graph(struct repository *r)
311 struct object_directory *odb;
312 int config_value;
314 if (git_env_bool(GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD, 0))
315 die("dying as requested by the '%s' variable on commit-graph load!",
316 GIT_TEST_COMMIT_GRAPH_DIE_ON_LOAD);
318 if (r->objects->commit_graph_attempted)
319 return !!r->objects->commit_graph;
320 r->objects->commit_graph_attempted = 1;
322 if (!git_env_bool(GIT_TEST_COMMIT_GRAPH, 0) &&
323 (repo_config_get_bool(r, "core.commitgraph", &config_value) ||
324 !config_value))
326 * This repository is not configured to use commit graphs, so
327 * do not load one. (But report commit_graph_attempted anyway
328 * so that commit graph loading is not attempted again for this
329 * repository.)
331 return 0;
333 if (!commit_graph_compatible(r))
334 return 0;
336 prepare_alt_odb(r);
337 for (odb = r->objects->odb;
338 !r->objects->commit_graph && odb;
339 odb = odb->next)
340 prepare_commit_graph_one(r, odb->path);
341 return !!r->objects->commit_graph;
344 int generation_numbers_enabled(struct repository *r)
346 uint32_t first_generation;
347 struct commit_graph *g;
348 if (!prepare_commit_graph(r))
349 return 0;
351 g = r->objects->commit_graph;
353 if (!g->num_commits)
354 return 0;
356 first_generation = get_be32(g->chunk_commit_data +
357 g->hash_len + 8) >> 2;
359 return !!first_generation;
362 void close_commit_graph(struct repository *r)
364 free_commit_graph(r->objects->commit_graph);
365 r->objects->commit_graph = NULL;
368 static int bsearch_graph(struct commit_graph *g, struct object_id *oid, uint32_t *pos)
370 return bsearch_hash(oid->hash, g->chunk_oid_fanout,
371 g->chunk_oid_lookup, g->hash_len, pos);
374 static struct commit_list **insert_parent_or_die(struct repository *r,
375 struct commit_graph *g,
376 uint64_t pos,
377 struct commit_list **pptr)
379 struct commit *c;
380 struct object_id oid;
382 if (pos >= g->num_commits)
383 die("invalid parent position %"PRIu64, pos);
385 hashcpy(oid.hash, g->chunk_oid_lookup + g->hash_len * pos);
386 c = lookup_commit(r, &oid);
387 if (!c)
388 die(_("could not find commit %s"), oid_to_hex(&oid));
389 c->graph_pos = pos;
390 return &commit_list_insert(c, pptr)->next;
393 static void fill_commit_graph_info(struct commit *item, struct commit_graph *g, uint32_t pos)
395 const unsigned char *commit_data = g->chunk_commit_data + GRAPH_DATA_WIDTH * pos;
396 item->graph_pos = pos;
397 item->generation = get_be32(commit_data + g->hash_len + 8) >> 2;
400 static int fill_commit_in_graph(struct repository *r,
401 struct commit *item,
402 struct commit_graph *g, uint32_t pos)
404 uint32_t edge_value;
405 uint32_t *parent_data_ptr;
406 uint64_t date_low, date_high;
407 struct commit_list **pptr;
408 const unsigned char *commit_data = g->chunk_commit_data + (g->hash_len + 16) * pos;
410 item->object.parsed = 1;
411 item->graph_pos = pos;
413 item->maybe_tree = NULL;
415 date_high = get_be32(commit_data + g->hash_len + 8) & 0x3;
416 date_low = get_be32(commit_data + g->hash_len + 12);
417 item->date = (timestamp_t)((date_high << 32) | date_low);
419 item->generation = get_be32(commit_data + g->hash_len + 8) >> 2;
421 pptr = &item->parents;
423 edge_value = get_be32(commit_data + g->hash_len);
424 if (edge_value == GRAPH_PARENT_NONE)
425 return 1;
426 pptr = insert_parent_or_die(r, g, edge_value, pptr);
428 edge_value = get_be32(commit_data + g->hash_len + 4);
429 if (edge_value == GRAPH_PARENT_NONE)
430 return 1;
431 if (!(edge_value & GRAPH_EXTRA_EDGES_NEEDED)) {
432 pptr = insert_parent_or_die(r, g, edge_value, pptr);
433 return 1;
436 parent_data_ptr = (uint32_t*)(g->chunk_extra_edges +
437 4 * (uint64_t)(edge_value & GRAPH_EDGE_LAST_MASK));
438 do {
439 edge_value = get_be32(parent_data_ptr);
440 pptr = insert_parent_or_die(r, g,
441 edge_value & GRAPH_EDGE_LAST_MASK,
442 pptr);
443 parent_data_ptr++;
444 } while (!(edge_value & GRAPH_LAST_EDGE));
446 return 1;
449 static int find_commit_in_graph(struct commit *item, struct commit_graph *g, uint32_t *pos)
451 if (item->graph_pos != COMMIT_NOT_FROM_GRAPH) {
452 *pos = item->graph_pos;
453 return 1;
454 } else {
455 return bsearch_graph(g, &(item->object.oid), pos);
459 static int parse_commit_in_graph_one(struct repository *r,
460 struct commit_graph *g,
461 struct commit *item)
463 uint32_t pos;
465 if (item->object.parsed)
466 return 1;
468 if (find_commit_in_graph(item, g, &pos))
469 return fill_commit_in_graph(r, item, g, pos);
471 return 0;
474 int parse_commit_in_graph(struct repository *r, struct commit *item)
476 if (!prepare_commit_graph(r))
477 return 0;
478 return parse_commit_in_graph_one(r, r->objects->commit_graph, item);
481 void load_commit_graph_info(struct repository *r, struct commit *item)
483 uint32_t pos;
484 if (!prepare_commit_graph(r))
485 return;
486 if (find_commit_in_graph(item, r->objects->commit_graph, &pos))
487 fill_commit_graph_info(item, r->objects->commit_graph, pos);
490 static struct tree *load_tree_for_commit(struct repository *r,
491 struct commit_graph *g,
492 struct commit *c)
494 struct object_id oid;
495 const unsigned char *commit_data = g->chunk_commit_data +
496 GRAPH_DATA_WIDTH * (c->graph_pos);
498 hashcpy(oid.hash, commit_data);
499 c->maybe_tree = lookup_tree(r, &oid);
501 return c->maybe_tree;
504 static struct tree *get_commit_tree_in_graph_one(struct repository *r,
505 struct commit_graph *g,
506 const struct commit *c)
508 if (c->maybe_tree)
509 return c->maybe_tree;
510 if (c->graph_pos == COMMIT_NOT_FROM_GRAPH)
511 BUG("get_commit_tree_in_graph_one called from non-commit-graph commit");
513 return load_tree_for_commit(r, g, (struct commit *)c);
516 struct tree *get_commit_tree_in_graph(struct repository *r, const struct commit *c)
518 return get_commit_tree_in_graph_one(r, r->objects->commit_graph, c);
521 static void write_graph_chunk_fanout(struct hashfile *f,
522 struct commit **commits,
523 int nr_commits,
524 struct progress *progress,
525 uint64_t *progress_cnt)
527 int i, count = 0;
528 struct commit **list = commits;
531 * Write the first-level table (the list is sorted,
532 * but we use a 256-entry lookup to be able to avoid
533 * having to do eight extra binary search iterations).
535 for (i = 0; i < 256; i++) {
536 while (count < nr_commits) {
537 if ((*list)->object.oid.hash[0] != i)
538 break;
539 display_progress(progress, ++*progress_cnt);
540 count++;
541 list++;
544 hashwrite_be32(f, count);
548 static void write_graph_chunk_oids(struct hashfile *f, int hash_len,
549 struct commit **commits, int nr_commits,
550 struct progress *progress,
551 uint64_t *progress_cnt)
553 struct commit **list = commits;
554 int count;
555 for (count = 0; count < nr_commits; count++, list++) {
556 display_progress(progress, ++*progress_cnt);
557 hashwrite(f, (*list)->object.oid.hash, (int)hash_len);
561 static const unsigned char *commit_to_sha1(size_t index, void *table)
563 struct commit **commits = table;
564 return commits[index]->object.oid.hash;
567 static void write_graph_chunk_data(struct hashfile *f, int hash_len,
568 struct commit **commits, int nr_commits,
569 struct progress *progress,
570 uint64_t *progress_cnt)
572 struct commit **list = commits;
573 struct commit **last = commits + nr_commits;
574 uint32_t num_extra_edges = 0;
576 while (list < last) {
577 struct commit_list *parent;
578 int edge_value;
579 uint32_t packedDate[2];
580 display_progress(progress, ++*progress_cnt);
582 parse_commit_no_graph(*list);
583 hashwrite(f, get_commit_tree_oid(*list)->hash, hash_len);
585 parent = (*list)->parents;
587 if (!parent)
588 edge_value = GRAPH_PARENT_NONE;
589 else {
590 edge_value = sha1_pos(parent->item->object.oid.hash,
591 commits,
592 nr_commits,
593 commit_to_sha1);
595 if (edge_value < 0)
596 BUG("missing parent %s for commit %s",
597 oid_to_hex(&parent->item->object.oid),
598 oid_to_hex(&(*list)->object.oid));
601 hashwrite_be32(f, edge_value);
603 if (parent)
604 parent = parent->next;
606 if (!parent)
607 edge_value = GRAPH_PARENT_NONE;
608 else if (parent->next)
609 edge_value = GRAPH_EXTRA_EDGES_NEEDED | num_extra_edges;
610 else {
611 edge_value = sha1_pos(parent->item->object.oid.hash,
612 commits,
613 nr_commits,
614 commit_to_sha1);
615 if (edge_value < 0)
616 BUG("missing parent %s for commit %s",
617 oid_to_hex(&parent->item->object.oid),
618 oid_to_hex(&(*list)->object.oid));
621 hashwrite_be32(f, edge_value);
623 if (edge_value & GRAPH_EXTRA_EDGES_NEEDED) {
624 do {
625 num_extra_edges++;
626 parent = parent->next;
627 } while (parent);
630 if (sizeof((*list)->date) > 4)
631 packedDate[0] = htonl(((*list)->date >> 32) & 0x3);
632 else
633 packedDate[0] = 0;
635 packedDate[0] |= htonl((*list)->generation << 2);
637 packedDate[1] = htonl((*list)->date);
638 hashwrite(f, packedDate, 8);
640 list++;
644 static void write_graph_chunk_extra_edges(struct hashfile *f,
645 struct commit **commits,
646 int nr_commits,
647 struct progress *progress,
648 uint64_t *progress_cnt)
650 struct commit **list = commits;
651 struct commit **last = commits + nr_commits;
652 struct commit_list *parent;
654 while (list < last) {
655 int num_parents = 0;
657 display_progress(progress, ++*progress_cnt);
659 for (parent = (*list)->parents; num_parents < 3 && parent;
660 parent = parent->next)
661 num_parents++;
663 if (num_parents <= 2) {
664 list++;
665 continue;
668 /* Since num_parents > 2, this initializer is safe. */
669 for (parent = (*list)->parents->next; parent; parent = parent->next) {
670 int edge_value = sha1_pos(parent->item->object.oid.hash,
671 commits,
672 nr_commits,
673 commit_to_sha1);
675 if (edge_value < 0)
676 BUG("missing parent %s for commit %s",
677 oid_to_hex(&parent->item->object.oid),
678 oid_to_hex(&(*list)->object.oid));
679 else if (!parent->next)
680 edge_value |= GRAPH_LAST_EDGE;
682 hashwrite_be32(f, edge_value);
685 list++;
689 static int commit_compare(const void *_a, const void *_b)
691 const struct object_id *a = (const struct object_id *)_a;
692 const struct object_id *b = (const struct object_id *)_b;
693 return oidcmp(a, b);
696 struct packed_commit_list {
697 struct commit **list;
698 int nr;
699 int alloc;
702 struct packed_oid_list {
703 struct object_id *list;
704 int nr;
705 int alloc;
706 struct progress *progress;
707 int progress_done;
710 static int add_packed_commits(const struct object_id *oid,
711 struct packed_git *pack,
712 uint32_t pos,
713 void *data)
715 struct packed_oid_list *list = (struct packed_oid_list*)data;
716 enum object_type type;
717 off_t offset = nth_packed_object_offset(pack, pos);
718 struct object_info oi = OBJECT_INFO_INIT;
720 if (list->progress)
721 display_progress(list->progress, ++list->progress_done);
723 oi.typep = &type;
724 if (packed_object_info(the_repository, pack, offset, &oi) < 0)
725 die(_("unable to get type of object %s"), oid_to_hex(oid));
727 if (type != OBJ_COMMIT)
728 return 0;
730 ALLOC_GROW(list->list, list->nr + 1, list->alloc);
731 oidcpy(&(list->list[list->nr]), oid);
732 list->nr++;
734 return 0;
737 static void add_missing_parents(struct packed_oid_list *oids, struct commit *commit)
739 struct commit_list *parent;
740 for (parent = commit->parents; parent; parent = parent->next) {
741 if (!(parent->item->object.flags & UNINTERESTING)) {
742 ALLOC_GROW(oids->list, oids->nr + 1, oids->alloc);
743 oidcpy(&oids->list[oids->nr], &(parent->item->object.oid));
744 oids->nr++;
745 parent->item->object.flags |= UNINTERESTING;
750 static void close_reachable(struct packed_oid_list *oids, int report_progress)
752 int i;
753 struct commit *commit;
754 struct progress *progress = NULL;
756 if (report_progress)
757 progress = start_delayed_progress(
758 _("Loading known commits in commit graph"), oids->nr);
759 for (i = 0; i < oids->nr; i++) {
760 display_progress(progress, i + 1);
761 commit = lookup_commit(the_repository, &oids->list[i]);
762 if (commit)
763 commit->object.flags |= UNINTERESTING;
765 stop_progress(&progress);
768 * As this loop runs, oids->nr may grow, but not more
769 * than the number of missing commits in the reachable
770 * closure.
772 if (report_progress)
773 progress = start_delayed_progress(
774 _("Expanding reachable commits in commit graph"), oids->nr);
775 for (i = 0; i < oids->nr; i++) {
776 display_progress(progress, i + 1);
777 commit = lookup_commit(the_repository, &oids->list[i]);
779 if (commit && !parse_commit_no_graph(commit))
780 add_missing_parents(oids, commit);
782 stop_progress(&progress);
784 if (report_progress)
785 progress = start_delayed_progress(
786 _("Clearing commit marks in commit graph"), oids->nr);
787 for (i = 0; i < oids->nr; i++) {
788 display_progress(progress, i + 1);
789 commit = lookup_commit(the_repository, &oids->list[i]);
791 if (commit)
792 commit->object.flags &= ~UNINTERESTING;
794 stop_progress(&progress);
797 static void compute_generation_numbers(struct packed_commit_list* commits,
798 int report_progress)
800 int i;
801 struct commit_list *list = NULL;
802 struct progress *progress = NULL;
804 if (report_progress)
805 progress = start_progress(
806 _("Computing commit graph generation numbers"),
807 commits->nr);
808 for (i = 0; i < commits->nr; i++) {
809 display_progress(progress, i + 1);
810 if (commits->list[i]->generation != GENERATION_NUMBER_INFINITY &&
811 commits->list[i]->generation != GENERATION_NUMBER_ZERO)
812 continue;
814 commit_list_insert(commits->list[i], &list);
815 while (list) {
816 struct commit *current = list->item;
817 struct commit_list *parent;
818 int all_parents_computed = 1;
819 uint32_t max_generation = 0;
821 for (parent = current->parents; parent; parent = parent->next) {
822 if (parent->item->generation == GENERATION_NUMBER_INFINITY ||
823 parent->item->generation == GENERATION_NUMBER_ZERO) {
824 all_parents_computed = 0;
825 commit_list_insert(parent->item, &list);
826 break;
827 } else if (parent->item->generation > max_generation) {
828 max_generation = parent->item->generation;
832 if (all_parents_computed) {
833 current->generation = max_generation + 1;
834 pop_commit(&list);
836 if (current->generation > GENERATION_NUMBER_MAX)
837 current->generation = GENERATION_NUMBER_MAX;
841 stop_progress(&progress);
844 static int add_ref_to_list(const char *refname,
845 const struct object_id *oid,
846 int flags, void *cb_data)
848 struct string_list *list = (struct string_list *)cb_data;
850 string_list_append(list, oid_to_hex(oid));
851 return 0;
854 void write_commit_graph_reachable(const char *obj_dir, int append,
855 int report_progress)
857 struct string_list list = STRING_LIST_INIT_DUP;
859 for_each_ref(add_ref_to_list, &list);
860 write_commit_graph(obj_dir, NULL, &list, append, report_progress);
862 string_list_clear(&list, 0);
865 void write_commit_graph(const char *obj_dir,
866 struct string_list *pack_indexes,
867 struct string_list *commit_hex,
868 int append, int report_progress)
870 struct packed_oid_list oids;
871 struct packed_commit_list commits;
872 struct hashfile *f;
873 uint32_t i, count_distinct = 0;
874 char *graph_name;
875 struct lock_file lk = LOCK_INIT;
876 uint32_t chunk_ids[5];
877 uint64_t chunk_offsets[5];
878 int num_chunks;
879 int num_extra_edges;
880 struct commit_list *parent;
881 struct progress *progress = NULL;
882 const unsigned hashsz = the_hash_algo->rawsz;
883 uint64_t progress_cnt = 0;
884 struct strbuf progress_title = STRBUF_INIT;
885 unsigned long approx_nr_objects;
887 if (!commit_graph_compatible(the_repository))
888 return;
890 oids.nr = 0;
891 approx_nr_objects = approximate_object_count();
892 oids.alloc = approx_nr_objects / 32;
893 oids.progress = NULL;
894 oids.progress_done = 0;
896 if (append) {
897 prepare_commit_graph_one(the_repository, obj_dir);
898 if (the_repository->objects->commit_graph)
899 oids.alloc += the_repository->objects->commit_graph->num_commits;
902 if (oids.alloc < 1024)
903 oids.alloc = 1024;
904 ALLOC_ARRAY(oids.list, oids.alloc);
906 if (append && the_repository->objects->commit_graph) {
907 struct commit_graph *commit_graph =
908 the_repository->objects->commit_graph;
909 for (i = 0; i < commit_graph->num_commits; i++) {
910 const unsigned char *hash = commit_graph->chunk_oid_lookup +
911 commit_graph->hash_len * i;
912 hashcpy(oids.list[oids.nr++].hash, hash);
916 if (pack_indexes) {
917 struct strbuf packname = STRBUF_INIT;
918 int dirlen;
919 strbuf_addf(&packname, "%s/pack/", obj_dir);
920 dirlen = packname.len;
921 if (report_progress) {
922 strbuf_addf(&progress_title,
923 Q_("Finding commits for commit graph in %d pack",
924 "Finding commits for commit graph in %d packs",
925 pack_indexes->nr),
926 pack_indexes->nr);
927 oids.progress = start_delayed_progress(progress_title.buf, 0);
928 oids.progress_done = 0;
930 for (i = 0; i < pack_indexes->nr; i++) {
931 struct packed_git *p;
932 strbuf_setlen(&packname, dirlen);
933 strbuf_addstr(&packname, pack_indexes->items[i].string);
934 p = add_packed_git(packname.buf, packname.len, 1);
935 if (!p)
936 die(_("error adding pack %s"), packname.buf);
937 if (open_pack_index(p))
938 die(_("error opening index for %s"), packname.buf);
939 for_each_object_in_pack(p, add_packed_commits, &oids,
940 FOR_EACH_OBJECT_PACK_ORDER);
941 close_pack(p);
942 free(p);
944 stop_progress(&oids.progress);
945 strbuf_reset(&progress_title);
946 strbuf_release(&packname);
949 if (commit_hex) {
950 if (report_progress) {
951 strbuf_addf(&progress_title,
952 Q_("Finding commits for commit graph from %d ref",
953 "Finding commits for commit graph from %d refs",
954 commit_hex->nr),
955 commit_hex->nr);
956 progress = start_delayed_progress(progress_title.buf,
957 commit_hex->nr);
959 for (i = 0; i < commit_hex->nr; i++) {
960 const char *end;
961 struct object_id oid;
962 struct commit *result;
964 display_progress(progress, i + 1);
965 if (commit_hex->items[i].string &&
966 parse_oid_hex(commit_hex->items[i].string, &oid, &end))
967 continue;
969 result = lookup_commit_reference_gently(the_repository, &oid, 1);
971 if (result) {
972 ALLOC_GROW(oids.list, oids.nr + 1, oids.alloc);
973 oidcpy(&oids.list[oids.nr], &(result->object.oid));
974 oids.nr++;
977 stop_progress(&progress);
978 strbuf_reset(&progress_title);
981 if (!pack_indexes && !commit_hex) {
982 if (report_progress)
983 oids.progress = start_delayed_progress(
984 _("Finding commits for commit graph among packed objects"),
985 approx_nr_objects);
986 for_each_packed_object(add_packed_commits, &oids,
987 FOR_EACH_OBJECT_PACK_ORDER);
988 if (oids.progress_done < approx_nr_objects)
989 display_progress(oids.progress, approx_nr_objects);
990 stop_progress(&oids.progress);
993 close_reachable(&oids, report_progress);
995 if (report_progress)
996 progress = start_delayed_progress(
997 _("Counting distinct commits in commit graph"),
998 oids.nr);
999 display_progress(progress, 0); /* TODO: Measure QSORT() progress */
1000 QSORT(oids.list, oids.nr, commit_compare);
1001 count_distinct = 1;
1002 for (i = 1; i < oids.nr; i++) {
1003 display_progress(progress, i + 1);
1004 if (!oideq(&oids.list[i - 1], &oids.list[i]))
1005 count_distinct++;
1007 stop_progress(&progress);
1009 if (count_distinct >= GRAPH_EDGE_LAST_MASK)
1010 die(_("the commit graph format cannot write %d commits"), count_distinct);
1012 commits.nr = 0;
1013 commits.alloc = count_distinct;
1014 ALLOC_ARRAY(commits.list, commits.alloc);
1016 num_extra_edges = 0;
1017 if (report_progress)
1018 progress = start_delayed_progress(
1019 _("Finding extra edges in commit graph"),
1020 oids.nr);
1021 for (i = 0; i < oids.nr; i++) {
1022 int num_parents = 0;
1023 display_progress(progress, i + 1);
1024 if (i > 0 && oideq(&oids.list[i - 1], &oids.list[i]))
1025 continue;
1027 commits.list[commits.nr] = lookup_commit(the_repository, &oids.list[i]);
1028 parse_commit_no_graph(commits.list[commits.nr]);
1030 for (parent = commits.list[commits.nr]->parents;
1031 parent; parent = parent->next)
1032 num_parents++;
1034 if (num_parents > 2)
1035 num_extra_edges += num_parents - 1;
1037 commits.nr++;
1039 num_chunks = num_extra_edges ? 4 : 3;
1040 stop_progress(&progress);
1042 if (commits.nr >= GRAPH_EDGE_LAST_MASK)
1043 die(_("too many commits to write graph"));
1045 compute_generation_numbers(&commits, report_progress);
1047 graph_name = get_commit_graph_filename(obj_dir);
1048 if (safe_create_leading_directories(graph_name)) {
1049 UNLEAK(graph_name);
1050 die_errno(_("unable to create leading directories of %s"),
1051 graph_name);
1054 hold_lock_file_for_update(&lk, graph_name, LOCK_DIE_ON_ERROR);
1055 f = hashfd(lk.tempfile->fd, lk.tempfile->filename.buf);
1057 hashwrite_be32(f, GRAPH_SIGNATURE);
1059 hashwrite_u8(f, GRAPH_VERSION);
1060 hashwrite_u8(f, oid_version());
1061 hashwrite_u8(f, num_chunks);
1062 hashwrite_u8(f, 0); /* unused padding byte */
1064 chunk_ids[0] = GRAPH_CHUNKID_OIDFANOUT;
1065 chunk_ids[1] = GRAPH_CHUNKID_OIDLOOKUP;
1066 chunk_ids[2] = GRAPH_CHUNKID_DATA;
1067 if (num_extra_edges)
1068 chunk_ids[3] = GRAPH_CHUNKID_EXTRAEDGES;
1069 else
1070 chunk_ids[3] = 0;
1071 chunk_ids[4] = 0;
1073 chunk_offsets[0] = 8 + (num_chunks + 1) * GRAPH_CHUNKLOOKUP_WIDTH;
1074 chunk_offsets[1] = chunk_offsets[0] + GRAPH_FANOUT_SIZE;
1075 chunk_offsets[2] = chunk_offsets[1] + hashsz * commits.nr;
1076 chunk_offsets[3] = chunk_offsets[2] + (hashsz + 16) * commits.nr;
1077 chunk_offsets[4] = chunk_offsets[3] + 4 * num_extra_edges;
1079 for (i = 0; i <= num_chunks; i++) {
1080 uint32_t chunk_write[3];
1082 chunk_write[0] = htonl(chunk_ids[i]);
1083 chunk_write[1] = htonl(chunk_offsets[i] >> 32);
1084 chunk_write[2] = htonl(chunk_offsets[i] & 0xffffffff);
1085 hashwrite(f, chunk_write, 12);
1088 if (report_progress) {
1089 strbuf_addf(&progress_title,
1090 Q_("Writing out commit graph in %d pass",
1091 "Writing out commit graph in %d passes",
1092 num_chunks),
1093 num_chunks);
1094 progress = start_delayed_progress(
1095 progress_title.buf,
1096 num_chunks * commits.nr);
1098 write_graph_chunk_fanout(f, commits.list, commits.nr, progress, &progress_cnt);
1099 write_graph_chunk_oids(f, hashsz, commits.list, commits.nr, progress, &progress_cnt);
1100 write_graph_chunk_data(f, hashsz, commits.list, commits.nr, progress, &progress_cnt);
1101 if (num_extra_edges)
1102 write_graph_chunk_extra_edges(f, commits.list, commits.nr, progress, &progress_cnt);
1103 stop_progress(&progress);
1104 strbuf_release(&progress_title);
1106 close_commit_graph(the_repository);
1107 finalize_hashfile(f, NULL, CSUM_HASH_IN_STREAM | CSUM_FSYNC);
1108 commit_lock_file(&lk);
1110 free(graph_name);
1111 free(commits.list);
1112 free(oids.list);
1115 #define VERIFY_COMMIT_GRAPH_ERROR_HASH 2
1116 static int verify_commit_graph_error;
1118 static void graph_report(const char *fmt, ...)
1120 va_list ap;
1122 verify_commit_graph_error = 1;
1123 va_start(ap, fmt);
1124 vfprintf(stderr, fmt, ap);
1125 fprintf(stderr, "\n");
1126 va_end(ap);
1129 #define GENERATION_ZERO_EXISTS 1
1130 #define GENERATION_NUMBER_EXISTS 2
1132 int verify_commit_graph(struct repository *r, struct commit_graph *g)
1134 uint32_t i, cur_fanout_pos = 0;
1135 struct object_id prev_oid, cur_oid, checksum;
1136 int generation_zero = 0;
1137 struct hashfile *f;
1138 int devnull;
1139 struct progress *progress = NULL;
1141 if (!g) {
1142 graph_report("no commit-graph file loaded");
1143 return 1;
1146 verify_commit_graph_error = verify_commit_graph_lite(g);
1147 if (verify_commit_graph_error)
1148 return verify_commit_graph_error;
1150 devnull = open("/dev/null", O_WRONLY);
1151 f = hashfd(devnull, NULL);
1152 hashwrite(f, g->data, g->data_len - g->hash_len);
1153 finalize_hashfile(f, checksum.hash, CSUM_CLOSE);
1154 if (!hasheq(checksum.hash, g->data + g->data_len - g->hash_len)) {
1155 graph_report(_("the commit-graph file has incorrect checksum and is likely corrupt"));
1156 verify_commit_graph_error = VERIFY_COMMIT_GRAPH_ERROR_HASH;
1159 for (i = 0; i < g->num_commits; i++) {
1160 struct commit *graph_commit;
1162 hashcpy(cur_oid.hash, g->chunk_oid_lookup + g->hash_len * i);
1164 if (i && oidcmp(&prev_oid, &cur_oid) >= 0)
1165 graph_report(_("commit-graph has incorrect OID order: %s then %s"),
1166 oid_to_hex(&prev_oid),
1167 oid_to_hex(&cur_oid));
1169 oidcpy(&prev_oid, &cur_oid);
1171 while (cur_oid.hash[0] > cur_fanout_pos) {
1172 uint32_t fanout_value = get_be32(g->chunk_oid_fanout + cur_fanout_pos);
1174 if (i != fanout_value)
1175 graph_report(_("commit-graph has incorrect fanout value: fanout[%d] = %u != %u"),
1176 cur_fanout_pos, fanout_value, i);
1177 cur_fanout_pos++;
1180 graph_commit = lookup_commit(r, &cur_oid);
1181 if (!parse_commit_in_graph_one(r, g, graph_commit))
1182 graph_report(_("failed to parse commit %s from commit-graph"),
1183 oid_to_hex(&cur_oid));
1186 while (cur_fanout_pos < 256) {
1187 uint32_t fanout_value = get_be32(g->chunk_oid_fanout + cur_fanout_pos);
1189 if (g->num_commits != fanout_value)
1190 graph_report(_("commit-graph has incorrect fanout value: fanout[%d] = %u != %u"),
1191 cur_fanout_pos, fanout_value, i);
1193 cur_fanout_pos++;
1196 if (verify_commit_graph_error & ~VERIFY_COMMIT_GRAPH_ERROR_HASH)
1197 return verify_commit_graph_error;
1199 progress = start_progress(_("Verifying commits in commit graph"),
1200 g->num_commits);
1201 for (i = 0; i < g->num_commits; i++) {
1202 struct commit *graph_commit, *odb_commit;
1203 struct commit_list *graph_parents, *odb_parents;
1204 uint32_t max_generation = 0;
1206 display_progress(progress, i + 1);
1207 hashcpy(cur_oid.hash, g->chunk_oid_lookup + g->hash_len * i);
1209 graph_commit = lookup_commit(r, &cur_oid);
1210 odb_commit = (struct commit *)create_object(r, cur_oid.hash, alloc_commit_node(r));
1211 if (parse_commit_internal(odb_commit, 0, 0)) {
1212 graph_report(_("failed to parse commit %s from object database for commit-graph"),
1213 oid_to_hex(&cur_oid));
1214 continue;
1217 if (!oideq(&get_commit_tree_in_graph_one(r, g, graph_commit)->object.oid,
1218 get_commit_tree_oid(odb_commit)))
1219 graph_report(_("root tree OID for commit %s in commit-graph is %s != %s"),
1220 oid_to_hex(&cur_oid),
1221 oid_to_hex(get_commit_tree_oid(graph_commit)),
1222 oid_to_hex(get_commit_tree_oid(odb_commit)));
1224 graph_parents = graph_commit->parents;
1225 odb_parents = odb_commit->parents;
1227 while (graph_parents) {
1228 if (odb_parents == NULL) {
1229 graph_report(_("commit-graph parent list for commit %s is too long"),
1230 oid_to_hex(&cur_oid));
1231 break;
1234 if (!oideq(&graph_parents->item->object.oid, &odb_parents->item->object.oid))
1235 graph_report(_("commit-graph parent for %s is %s != %s"),
1236 oid_to_hex(&cur_oid),
1237 oid_to_hex(&graph_parents->item->object.oid),
1238 oid_to_hex(&odb_parents->item->object.oid));
1240 if (graph_parents->item->generation > max_generation)
1241 max_generation = graph_parents->item->generation;
1243 graph_parents = graph_parents->next;
1244 odb_parents = odb_parents->next;
1247 if (odb_parents != NULL)
1248 graph_report(_("commit-graph parent list for commit %s terminates early"),
1249 oid_to_hex(&cur_oid));
1251 if (!graph_commit->generation) {
1252 if (generation_zero == GENERATION_NUMBER_EXISTS)
1253 graph_report(_("commit-graph has generation number zero for commit %s, but non-zero elsewhere"),
1254 oid_to_hex(&cur_oid));
1255 generation_zero = GENERATION_ZERO_EXISTS;
1256 } else if (generation_zero == GENERATION_ZERO_EXISTS)
1257 graph_report(_("commit-graph has non-zero generation number for commit %s, but zero elsewhere"),
1258 oid_to_hex(&cur_oid));
1260 if (generation_zero == GENERATION_ZERO_EXISTS)
1261 continue;
1264 * If one of our parents has generation GENERATION_NUMBER_MAX, then
1265 * our generation is also GENERATION_NUMBER_MAX. Decrement to avoid
1266 * extra logic in the following condition.
1268 if (max_generation == GENERATION_NUMBER_MAX)
1269 max_generation--;
1271 if (graph_commit->generation != max_generation + 1)
1272 graph_report(_("commit-graph generation for commit %s is %u != %u"),
1273 oid_to_hex(&cur_oid),
1274 graph_commit->generation,
1275 max_generation + 1);
1277 if (graph_commit->date != odb_commit->date)
1278 graph_report(_("commit date for commit %s in commit-graph is %"PRItime" != %"PRItime),
1279 oid_to_hex(&cur_oid),
1280 graph_commit->date,
1281 odb_commit->date);
1283 stop_progress(&progress);
1285 return verify_commit_graph_error;
1288 void free_commit_graph(struct commit_graph *g)
1290 if (!g)
1291 return;
1292 if (g->graph_fd >= 0) {
1293 munmap((void *)g->data, g->data_len);
1294 g->data = NULL;
1295 close(g->graph_fd);
1297 free(g);