1#include "cache.h"
2#include "config.h"
3#include "git-compat-util.h"
4#include "lockfile.h"
5#include "pack.h"
6#include "packfile.h"
7#include "commit.h"
8#include "object.h"
9#include "revision.h"
10#include "sha1-lookup.h"
11#include "commit-graph.h"
12
13#define GRAPH_SIGNATURE 0x43475048 /* "CGPH" */
14#define GRAPH_CHUNKID_OIDFANOUT 0x4f494446 /* "OIDF" */
15#define GRAPH_CHUNKID_OIDLOOKUP 0x4f49444c /* "OIDL" */
16#define GRAPH_CHUNKID_DATA 0x43444154 /* "CDAT" */
17#define GRAPH_CHUNKID_LARGEEDGES 0x45444745 /* "EDGE" */
18
19#define GRAPH_DATA_WIDTH 36
20
21#define GRAPH_VERSION_1 0x1
22#define GRAPH_VERSION GRAPH_VERSION_1
23
24#define GRAPH_OID_VERSION_SHA1 1
25#define GRAPH_OID_LEN_SHA1 GIT_SHA1_RAWSZ
26#define GRAPH_OID_VERSION GRAPH_OID_VERSION_SHA1
27#define GRAPH_OID_LEN GRAPH_OID_LEN_SHA1
28
29#define GRAPH_OCTOPUS_EDGES_NEEDED 0x80000000
30#define GRAPH_PARENT_MISSING 0x7fffffff
31#define GRAPH_EDGE_LAST_MASK 0x7fffffff
32#define GRAPH_PARENT_NONE 0x70000000
33
34#define GRAPH_LAST_EDGE 0x80000000
35
36#define GRAPH_FANOUT_SIZE (4 * 256)
37#define GRAPH_CHUNKLOOKUP_WIDTH 12
38#define GRAPH_MIN_SIZE (5 * GRAPH_CHUNKLOOKUP_WIDTH + GRAPH_FANOUT_SIZE + \
39 GRAPH_OID_LEN + 8)
40
41char *get_commit_graph_filename(const char *obj_dir)
42{
43 return xstrfmt("%s/info/commit-graph", obj_dir);
44}
45
46static struct commit_graph *alloc_commit_graph(void)
47{
48 struct commit_graph *g = xcalloc(1, sizeof(*g));
49 g->graph_fd = -1;
50
51 return g;
52}
53
54struct commit_graph *load_commit_graph_one(const char *graph_file)
55{
56 void *graph_map;
57 const unsigned char *data, *chunk_lookup;
58 size_t graph_size;
59 struct stat st;
60 uint32_t i;
61 struct commit_graph *graph;
62 int fd = git_open(graph_file);
63 uint64_t last_chunk_offset;
64 uint32_t last_chunk_id;
65 uint32_t graph_signature;
66 unsigned char graph_version, hash_version;
67
68 if (fd < 0)
69 return NULL;
70 if (fstat(fd, &st)) {
71 close(fd);
72 return NULL;
73 }
74 graph_size = xsize_t(st.st_size);
75
76 if (graph_size < GRAPH_MIN_SIZE) {
77 close(fd);
78 die("graph file %s is too small", graph_file);
79 }
80 graph_map = xmmap(NULL, graph_size, PROT_READ, MAP_PRIVATE, fd, 0);
81 data = (const unsigned char *)graph_map;
82
83 graph_signature = get_be32(data);
84 if (graph_signature != GRAPH_SIGNATURE) {
85 error("graph signature %X does not match signature %X",
86 graph_signature, GRAPH_SIGNATURE);
87 goto cleanup_fail;
88 }
89
90 graph_version = *(unsigned char*)(data + 4);
91 if (graph_version != GRAPH_VERSION) {
92 error("graph version %X does not match version %X",
93 graph_version, GRAPH_VERSION);
94 goto cleanup_fail;
95 }
96
97 hash_version = *(unsigned char*)(data + 5);
98 if (hash_version != GRAPH_OID_VERSION) {
99 error("hash version %X does not match version %X",
100 hash_version, GRAPH_OID_VERSION);
101 goto cleanup_fail;
102 }
103
104 graph = alloc_commit_graph();
105
106 graph->hash_len = GRAPH_OID_LEN;
107 graph->num_chunks = *(unsigned char*)(data + 6);
108 graph->graph_fd = fd;
109 graph->data = graph_map;
110 graph->data_len = graph_size;
111
112 last_chunk_id = 0;
113 last_chunk_offset = 8;
114 chunk_lookup = data + 8;
115 for (i = 0; i < graph->num_chunks; i++) {
116 uint32_t chunk_id = get_be32(chunk_lookup + 0);
117 uint64_t chunk_offset = get_be64(chunk_lookup + 4);
118 int chunk_repeated = 0;
119
120 chunk_lookup += GRAPH_CHUNKLOOKUP_WIDTH;
121
122 if (chunk_offset > graph_size - GIT_MAX_RAWSZ) {
123 error("improper chunk offset %08x%08x", (uint32_t)(chunk_offset >> 32),
124 (uint32_t)chunk_offset);
125 goto cleanup_fail;
126 }
127
128 switch (chunk_id) {
129 case GRAPH_CHUNKID_OIDFANOUT:
130 if (graph->chunk_oid_fanout)
131 chunk_repeated = 1;
132 else
133 graph->chunk_oid_fanout = (uint32_t*)(data + chunk_offset);
134 break;
135
136 case GRAPH_CHUNKID_OIDLOOKUP:
137 if (graph->chunk_oid_lookup)
138 chunk_repeated = 1;
139 else
140 graph->chunk_oid_lookup = data + chunk_offset;
141 break;
142
143 case GRAPH_CHUNKID_DATA:
144 if (graph->chunk_commit_data)
145 chunk_repeated = 1;
146 else
147 graph->chunk_commit_data = data + chunk_offset;
148 break;
149
150 case GRAPH_CHUNKID_LARGEEDGES:
151 if (graph->chunk_large_edges)
152 chunk_repeated = 1;
153 else
154 graph->chunk_large_edges = data + chunk_offset;
155 break;
156 }
157
158 if (chunk_repeated) {
159 error("chunk id %08x appears multiple times", chunk_id);
160 goto cleanup_fail;
161 }
162
163 if (last_chunk_id == GRAPH_CHUNKID_OIDLOOKUP)
164 {
165 graph->num_commits = (chunk_offset - last_chunk_offset)
166 / graph->hash_len;
167 }
168
169 last_chunk_id = chunk_id;
170 last_chunk_offset = chunk_offset;
171 }
172
173 return graph;
174
175cleanup_fail:
176 munmap(graph_map, graph_size);
177 close(fd);
178 exit(1);
179}
180
181/* global storage */
182static struct commit_graph *commit_graph = NULL;
183
184static void prepare_commit_graph_one(const char *obj_dir)
185{
186 char *graph_name;
187
188 if (commit_graph)
189 return;
190
191 graph_name = get_commit_graph_filename(obj_dir);
192 commit_graph = load_commit_graph_one(graph_name);
193
194 FREE_AND_NULL(graph_name);
195}
196
197static int prepare_commit_graph_run_once = 0;
198static void prepare_commit_graph(void)
199{
200 struct alternate_object_database *alt;
201 char *obj_dir;
202
203 if (prepare_commit_graph_run_once)
204 return;
205 prepare_commit_graph_run_once = 1;
206
207 obj_dir = get_object_directory();
208 prepare_commit_graph_one(obj_dir);
209 prepare_alt_odb();
210 for (alt = alt_odb_list; !commit_graph && alt; alt = alt->next)
211 prepare_commit_graph_one(alt->path);
212}
213
214static void close_commit_graph(void)
215{
216 if (!commit_graph)
217 return;
218
219 if (commit_graph->graph_fd >= 0) {
220 munmap((void *)commit_graph->data, commit_graph->data_len);
221 commit_graph->data = NULL;
222 close(commit_graph->graph_fd);
223 }
224
225 FREE_AND_NULL(commit_graph);
226}
227
228static int bsearch_graph(struct commit_graph *g, struct object_id *oid, uint32_t *pos)
229{
230 return bsearch_hash(oid->hash, g->chunk_oid_fanout,
231 g->chunk_oid_lookup, g->hash_len, pos);
232}
233
234static struct commit_list **insert_parent_or_die(struct commit_graph *g,
235 uint64_t pos,
236 struct commit_list **pptr)
237{
238 struct commit *c;
239 struct object_id oid;
240 hashcpy(oid.hash, g->chunk_oid_lookup + g->hash_len * pos);
241 c = lookup_commit(&oid);
242 if (!c)
243 die("could not find commit %s", oid_to_hex(&oid));
244 c->graph_pos = pos;
245 return &commit_list_insert(c, pptr)->next;
246}
247
248static int fill_commit_in_graph(struct commit *item, struct commit_graph *g, uint32_t pos)
249{
250 struct object_id oid;
251 uint32_t edge_value;
252 uint32_t *parent_data_ptr;
253 uint64_t date_low, date_high;
254 struct commit_list **pptr;
255 const unsigned char *commit_data = g->chunk_commit_data + (g->hash_len + 16) * pos;
256
257 item->object.parsed = 1;
258 item->graph_pos = pos;
259
260 hashcpy(oid.hash, commit_data);
261 item->tree = lookup_tree(&oid);
262
263 date_high = get_be32(commit_data + g->hash_len + 8) & 0x3;
264 date_low = get_be32(commit_data + g->hash_len + 12);
265 item->date = (timestamp_t)((date_high << 32) | date_low);
266
267 pptr = &item->parents;
268
269 edge_value = get_be32(commit_data + g->hash_len);
270 if (edge_value == GRAPH_PARENT_NONE)
271 return 1;
272 pptr = insert_parent_or_die(g, edge_value, pptr);
273
274 edge_value = get_be32(commit_data + g->hash_len + 4);
275 if (edge_value == GRAPH_PARENT_NONE)
276 return 1;
277 if (!(edge_value & GRAPH_OCTOPUS_EDGES_NEEDED)) {
278 pptr = insert_parent_or_die(g, edge_value, pptr);
279 return 1;
280 }
281
282 parent_data_ptr = (uint32_t*)(g->chunk_large_edges +
283 4 * (uint64_t)(edge_value & GRAPH_EDGE_LAST_MASK));
284 do {
285 edge_value = get_be32(parent_data_ptr);
286 pptr = insert_parent_or_die(g,
287 edge_value & GRAPH_EDGE_LAST_MASK,
288 pptr);
289 parent_data_ptr++;
290 } while (!(edge_value & GRAPH_LAST_EDGE));
291
292 return 1;
293}
294
295int parse_commit_in_graph(struct commit *item)
296{
297 if (!core_commit_graph)
298 return 0;
299 if (item->object.parsed)
300 return 1;
301
302 prepare_commit_graph();
303 if (commit_graph) {
304 uint32_t pos;
305 int found;
306 if (item->graph_pos != COMMIT_NOT_FROM_GRAPH) {
307 pos = item->graph_pos;
308 found = 1;
309 } else {
310 found = bsearch_graph(commit_graph, &(item->object.oid), &pos);
311 }
312
313 if (found)
314 return fill_commit_in_graph(item, commit_graph, pos);
315 }
316
317 return 0;
318}
319
320static void write_graph_chunk_fanout(struct hashfile *f,
321 struct commit **commits,
322 int nr_commits)
323{
324 int i, count = 0;
325 struct commit **list = commits;
326
327 /*
328 * Write the first-level table (the list is sorted,
329 * but we use a 256-entry lookup to be able to avoid
330 * having to do eight extra binary search iterations).
331 */
332 for (i = 0; i < 256; i++) {
333 while (count < nr_commits) {
334 if ((*list)->object.oid.hash[0] != i)
335 break;
336 count++;
337 list++;
338 }
339
340 hashwrite_be32(f, count);
341 }
342}
343
344static void write_graph_chunk_oids(struct hashfile *f, int hash_len,
345 struct commit **commits, int nr_commits)
346{
347 struct commit **list = commits;
348 int count;
349 for (count = 0; count < nr_commits; count++, list++)
350 hashwrite(f, (*list)->object.oid.hash, (int)hash_len);
351}
352
353static const unsigned char *commit_to_sha1(size_t index, void *table)
354{
355 struct commit **commits = table;
356 return commits[index]->object.oid.hash;
357}
358
359static void write_graph_chunk_data(struct hashfile *f, int hash_len,
360 struct commit **commits, int nr_commits)
361{
362 struct commit **list = commits;
363 struct commit **last = commits + nr_commits;
364 uint32_t num_extra_edges = 0;
365
366 while (list < last) {
367 struct commit_list *parent;
368 int edge_value;
369 uint32_t packedDate[2];
370
371 parse_commit(*list);
372 hashwrite(f, (*list)->tree->object.oid.hash, hash_len);
373
374 parent = (*list)->parents;
375
376 if (!parent)
377 edge_value = GRAPH_PARENT_NONE;
378 else {
379 edge_value = sha1_pos(parent->item->object.oid.hash,
380 commits,
381 nr_commits,
382 commit_to_sha1);
383
384 if (edge_value < 0)
385 edge_value = GRAPH_PARENT_MISSING;
386 }
387
388 hashwrite_be32(f, edge_value);
389
390 if (parent)
391 parent = parent->next;
392
393 if (!parent)
394 edge_value = GRAPH_PARENT_NONE;
395 else if (parent->next)
396 edge_value = GRAPH_OCTOPUS_EDGES_NEEDED | num_extra_edges;
397 else {
398 edge_value = sha1_pos(parent->item->object.oid.hash,
399 commits,
400 nr_commits,
401 commit_to_sha1);
402 if (edge_value < 0)
403 edge_value = GRAPH_PARENT_MISSING;
404 }
405
406 hashwrite_be32(f, edge_value);
407
408 if (edge_value & GRAPH_OCTOPUS_EDGES_NEEDED) {
409 do {
410 num_extra_edges++;
411 parent = parent->next;
412 } while (parent);
413 }
414
415 if (sizeof((*list)->date) > 4)
416 packedDate[0] = htonl(((*list)->date >> 32) & 0x3);
417 else
418 packedDate[0] = 0;
419
420 packedDate[1] = htonl((*list)->date);
421 hashwrite(f, packedDate, 8);
422
423 list++;
424 }
425}
426
427static void write_graph_chunk_large_edges(struct hashfile *f,
428 struct commit **commits,
429 int nr_commits)
430{
431 struct commit **list = commits;
432 struct commit **last = commits + nr_commits;
433 struct commit_list *parent;
434
435 while (list < last) {
436 int num_parents = 0;
437 for (parent = (*list)->parents; num_parents < 3 && parent;
438 parent = parent->next)
439 num_parents++;
440
441 if (num_parents <= 2) {
442 list++;
443 continue;
444 }
445
446 /* Since num_parents > 2, this initializer is safe. */
447 for (parent = (*list)->parents->next; parent; parent = parent->next) {
448 int edge_value = sha1_pos(parent->item->object.oid.hash,
449 commits,
450 nr_commits,
451 commit_to_sha1);
452
453 if (edge_value < 0)
454 edge_value = GRAPH_PARENT_MISSING;
455 else if (!parent->next)
456 edge_value |= GRAPH_LAST_EDGE;
457
458 hashwrite_be32(f, edge_value);
459 }
460
461 list++;
462 }
463}
464
465static int commit_compare(const void *_a, const void *_b)
466{
467 const struct object_id *a = (const struct object_id *)_a;
468 const struct object_id *b = (const struct object_id *)_b;
469 return oidcmp(a, b);
470}
471
472struct packed_commit_list {
473 struct commit **list;
474 int nr;
475 int alloc;
476};
477
478struct packed_oid_list {
479 struct object_id *list;
480 int nr;
481 int alloc;
482};
483
484static int add_packed_commits(const struct object_id *oid,
485 struct packed_git *pack,
486 uint32_t pos,
487 void *data)
488{
489 struct packed_oid_list *list = (struct packed_oid_list*)data;
490 enum object_type type;
491 off_t offset = nth_packed_object_offset(pack, pos);
492 struct object_info oi = OBJECT_INFO_INIT;
493
494 oi.typep = &type;
495 if (packed_object_info(pack, offset, &oi) < 0)
496 die("unable to get type of object %s", oid_to_hex(oid));
497
498 if (type != OBJ_COMMIT)
499 return 0;
500
501 ALLOC_GROW(list->list, list->nr + 1, list->alloc);
502 oidcpy(&(list->list[list->nr]), oid);
503 list->nr++;
504
505 return 0;
506}
507
508static void add_missing_parents(struct packed_oid_list *oids, struct commit *commit)
509{
510 struct commit_list *parent;
511 for (parent = commit->parents; parent; parent = parent->next) {
512 if (!(parent->item->object.flags & UNINTERESTING)) {
513 ALLOC_GROW(oids->list, oids->nr + 1, oids->alloc);
514 oidcpy(&oids->list[oids->nr], &(parent->item->object.oid));
515 oids->nr++;
516 parent->item->object.flags |= UNINTERESTING;
517 }
518 }
519}
520
521static void close_reachable(struct packed_oid_list *oids)
522{
523 int i;
524 struct commit *commit;
525
526 for (i = 0; i < oids->nr; i++) {
527 commit = lookup_commit(&oids->list[i]);
528 if (commit)
529 commit->object.flags |= UNINTERESTING;
530 }
531
532 /*
533 * As this loop runs, oids->nr may grow, but not more
534 * than the number of missing commits in the reachable
535 * closure.
536 */
537 for (i = 0; i < oids->nr; i++) {
538 commit = lookup_commit(&oids->list[i]);
539
540 if (commit && !parse_commit(commit))
541 add_missing_parents(oids, commit);
542 }
543
544 for (i = 0; i < oids->nr; i++) {
545 commit = lookup_commit(&oids->list[i]);
546
547 if (commit)
548 commit->object.flags &= ~UNINTERESTING;
549 }
550}
551
552void write_commit_graph(const char *obj_dir,
553 const char **pack_indexes,
554 int nr_packs)
555{
556 struct packed_oid_list oids;
557 struct packed_commit_list commits;
558 struct hashfile *f;
559 uint32_t i, count_distinct = 0;
560 char *graph_name;
561 int fd;
562 struct lock_file lk = LOCK_INIT;
563 uint32_t chunk_ids[5];
564 uint64_t chunk_offsets[5];
565 int num_chunks;
566 int num_extra_edges;
567 struct commit_list *parent;
568
569 oids.nr = 0;
570 oids.alloc = approximate_object_count() / 4;
571
572 if (oids.alloc < 1024)
573 oids.alloc = 1024;
574 ALLOC_ARRAY(oids.list, oids.alloc);
575
576 if (pack_indexes) {
577 struct strbuf packname = STRBUF_INIT;
578 int dirlen;
579 strbuf_addf(&packname, "%s/pack/", obj_dir);
580 dirlen = packname.len;
581 for (i = 0; i < nr_packs; i++) {
582 struct packed_git *p;
583 strbuf_setlen(&packname, dirlen);
584 strbuf_addstr(&packname, pack_indexes[i]);
585 p = add_packed_git(packname.buf, packname.len, 1);
586 if (!p)
587 die("error adding pack %s", packname.buf);
588 if (open_pack_index(p))
589 die("error opening index for %s", packname.buf);
590 for_each_object_in_pack(p, add_packed_commits, &oids);
591 close_pack(p);
592 }
593 strbuf_release(&packname);
594 } else
595 for_each_packed_object(add_packed_commits, &oids, 0);
596
597 close_reachable(&oids);
598
599 QSORT(oids.list, oids.nr, commit_compare);
600
601 count_distinct = 1;
602 for (i = 1; i < oids.nr; i++) {
603 if (oidcmp(&oids.list[i-1], &oids.list[i]))
604 count_distinct++;
605 }
606
607 if (count_distinct >= GRAPH_PARENT_MISSING)
608 die(_("the commit graph format cannot write %d commits"), count_distinct);
609
610 commits.nr = 0;
611 commits.alloc = count_distinct;
612 ALLOC_ARRAY(commits.list, commits.alloc);
613
614 num_extra_edges = 0;
615 for (i = 0; i < oids.nr; i++) {
616 int num_parents = 0;
617 if (i > 0 && !oidcmp(&oids.list[i-1], &oids.list[i]))
618 continue;
619
620 commits.list[commits.nr] = lookup_commit(&oids.list[i]);
621 parse_commit(commits.list[commits.nr]);
622
623 for (parent = commits.list[commits.nr]->parents;
624 parent; parent = parent->next)
625 num_parents++;
626
627 if (num_parents > 2)
628 num_extra_edges += num_parents - 1;
629
630 commits.nr++;
631 }
632 num_chunks = num_extra_edges ? 4 : 3;
633
634 if (commits.nr >= GRAPH_PARENT_MISSING)
635 die(_("too many commits to write graph"));
636
637 graph_name = get_commit_graph_filename(obj_dir);
638 fd = hold_lock_file_for_update(&lk, graph_name, 0);
639
640 if (fd < 0) {
641 struct strbuf folder = STRBUF_INIT;
642 strbuf_addstr(&folder, graph_name);
643 strbuf_setlen(&folder, strrchr(folder.buf, '/') - folder.buf);
644
645 if (mkdir(folder.buf, 0777) < 0)
646 die_errno(_("cannot mkdir %s"), folder.buf);
647 strbuf_release(&folder);
648
649 fd = hold_lock_file_for_update(&lk, graph_name, LOCK_DIE_ON_ERROR);
650
651 if (fd < 0)
652 die_errno("unable to create '%s'", graph_name);
653 }
654
655 f = hashfd(lk.tempfile->fd, lk.tempfile->filename.buf);
656
657 hashwrite_be32(f, GRAPH_SIGNATURE);
658
659 hashwrite_u8(f, GRAPH_VERSION);
660 hashwrite_u8(f, GRAPH_OID_VERSION);
661 hashwrite_u8(f, num_chunks);
662 hashwrite_u8(f, 0); /* unused padding byte */
663
664 chunk_ids[0] = GRAPH_CHUNKID_OIDFANOUT;
665 chunk_ids[1] = GRAPH_CHUNKID_OIDLOOKUP;
666 chunk_ids[2] = GRAPH_CHUNKID_DATA;
667 if (num_extra_edges)
668 chunk_ids[3] = GRAPH_CHUNKID_LARGEEDGES;
669 else
670 chunk_ids[3] = 0;
671 chunk_ids[4] = 0;
672
673 chunk_offsets[0] = 8 + (num_chunks + 1) * GRAPH_CHUNKLOOKUP_WIDTH;
674 chunk_offsets[1] = chunk_offsets[0] + GRAPH_FANOUT_SIZE;
675 chunk_offsets[2] = chunk_offsets[1] + GRAPH_OID_LEN * commits.nr;
676 chunk_offsets[3] = chunk_offsets[2] + (GRAPH_OID_LEN + 16) * commits.nr;
677 chunk_offsets[4] = chunk_offsets[3] + 4 * num_extra_edges;
678
679 for (i = 0; i <= num_chunks; i++) {
680 uint32_t chunk_write[3];
681
682 chunk_write[0] = htonl(chunk_ids[i]);
683 chunk_write[1] = htonl(chunk_offsets[i] >> 32);
684 chunk_write[2] = htonl(chunk_offsets[i] & 0xffffffff);
685 hashwrite(f, chunk_write, 12);
686 }
687
688 write_graph_chunk_fanout(f, commits.list, commits.nr);
689 write_graph_chunk_oids(f, GRAPH_OID_LEN, commits.list, commits.nr);
690 write_graph_chunk_data(f, GRAPH_OID_LEN, commits.list, commits.nr);
691 write_graph_chunk_large_edges(f, commits.list, commits.nr);
692
693 close_commit_graph();
694 finalize_hashfile(f, NULL, CSUM_HASH_IN_STREAM | CSUM_FSYNC);
695 commit_lock_file(&lk);
696
697 free(oids.list);
698 oids.alloc = 0;
699 oids.nr = 0;
700}