7 #include "sha1-array.h"
10 #include "commit-slab.h"
12 static int is_shallow = -1;
13 static struct stat_validity shallow_stat;
14 static char *alternate_shallow_file;
16 void set_alternate_shallow_file(const char *path, int override)
19 die("BUG: is_repository_shallow must not be called before set_alternate_shallow_file");
20 if (alternate_shallow_file && !override)
22 free(alternate_shallow_file);
23 alternate_shallow_file = path ? xstrdup(path) : NULL;
26 int register_shallow(const unsigned char *sha1)
28 struct commit_graft *graft =
29 xmalloc(sizeof(struct commit_graft));
30 struct commit *commit = lookup_commit(sha1);
32 hashcpy(graft->sha1, sha1);
33 graft->nr_parent = -1;
34 if (commit && commit->object.parsed)
35 commit->parents = NULL;
36 return register_commit_graft(graft, 0);
39 int is_repository_shallow(void)
43 const char *path = alternate_shallow_file;
49 path = git_path("shallow");
51 * fetch-pack sets '--shallow-file ""' as an indicator that no
52 * shallow file should be used. We could just open it and it
53 * will likely fail. But let's do an explicit check instead.
55 if (!*path || (fp = fopen(path, "r")) == NULL) {
56 stat_validity_clear(&shallow_stat);
60 stat_validity_update(&shallow_stat, fileno(fp));
63 while (fgets(buf, sizeof(buf), fp)) {
64 unsigned char sha1[20];
65 if (get_sha1_hex(buf, sha1))
66 die("bad shallow line: %s", buf);
67 register_shallow(sha1);
73 struct commit_list *get_shallow_commits(struct object_array *heads, int depth,
74 int shallow_flag, int not_shallow_flag)
76 int i = 0, cur_depth = 0;
77 struct commit_list *result = NULL;
78 struct object_array stack = OBJECT_ARRAY_INIT;
79 struct commit *commit = NULL;
80 struct commit_graft *graft;
82 while (commit || i < heads->nr || stack.nr) {
83 struct commit_list *p;
86 commit = (struct commit *)
87 deref_tag(heads->objects[i++].item, NULL, 0);
88 if (!commit || commit->object.type != OBJ_COMMIT) {
93 commit->util = xmalloc(sizeof(int));
94 *(int *)commit->util = 0;
97 commit = (struct commit *)
98 stack.objects[--stack.nr].item;
99 cur_depth = *(int *)commit->util;
102 parse_commit_or_die(commit);
104 if ((depth != INFINITE_DEPTH && cur_depth >= depth) ||
105 (is_repository_shallow() && !commit->parents &&
106 (graft = lookup_commit_graft(commit->object.sha1)) != NULL &&
107 graft->nr_parent < 0)) {
108 commit_list_insert(commit, &result);
109 commit->object.flags |= shallow_flag;
113 commit->object.flags |= not_shallow_flag;
114 for (p = commit->parents, commit = NULL; p; p = p->next) {
115 if (!p->item->util) {
116 int *pointer = xmalloc(sizeof(int));
117 p->item->util = pointer;
118 *pointer = cur_depth;
120 int *pointer = p->item->util;
121 if (cur_depth >= *pointer)
123 *pointer = cur_depth;
126 add_object_array(&p->item->object,
130 cur_depth = *(int *)commit->util;
138 void check_shallow_file_for_update(void)
140 if (is_shallow == -1)
141 die("BUG: shallow must be initialized by now");
143 if (!stat_validity_check(&shallow_stat, git_path("shallow")))
144 die("shallow file has changed since we read it");
150 struct write_shallow_data {
152 int use_pack_protocol;
157 static int write_one_shallow(const struct commit_graft *graft, void *cb_data)
159 struct write_shallow_data *data = cb_data;
160 const char *hex = sha1_to_hex(graft->sha1);
161 if (graft->nr_parent != -1)
163 if (data->flags & SEEN_ONLY) {
164 struct commit *c = lookup_commit(graft->sha1);
165 if (!c || !(c->object.flags & SEEN)) {
166 if (data->flags & VERBOSE)
167 printf("Removing %s from .git/shallow\n",
168 sha1_to_hex(c->object.sha1));
173 if (data->use_pack_protocol)
174 packet_buf_write(data->out, "shallow %s", hex);
176 strbuf_addstr(data->out, hex);
177 strbuf_addch(data->out, '\n');
182 static int write_shallow_commits_1(struct strbuf *out, int use_pack_protocol,
183 const struct sha1_array *extra,
186 struct write_shallow_data data;
189 data.use_pack_protocol = use_pack_protocol;
192 for_each_commit_graft(write_one_shallow, &data);
195 for (i = 0; i < extra->nr; i++) {
196 strbuf_addstr(out, sha1_to_hex(extra->sha1[i]));
197 strbuf_addch(out, '\n');
203 int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
204 const struct sha1_array *extra)
206 return write_shallow_commits_1(out, use_pack_protocol, extra, 0);
209 char *setup_temporary_shallow(const struct sha1_array *extra)
211 struct strbuf sb = STRBUF_INIT;
214 if (write_shallow_commits(&sb, 0, extra)) {
215 struct strbuf path = STRBUF_INIT;
216 strbuf_addstr(&path, git_path("shallow_XXXXXX"));
217 fd = xmkstemp(path.buf);
218 if (write_in_full(fd, sb.buf, sb.len) != sb.len)
219 die_errno("failed to write to %s",
223 return strbuf_detach(&path, NULL);
226 * is_repository_shallow() sees empty string as "no shallow
232 void setup_alternate_shallow(struct lock_file *shallow_lock,
233 const char **alternate_shallow_file,
234 const struct sha1_array *extra)
236 struct strbuf sb = STRBUF_INIT;
239 check_shallow_file_for_update();
240 fd = hold_lock_file_for_update(shallow_lock, git_path("shallow"),
242 if (write_shallow_commits(&sb, 0, extra)) {
243 if (write_in_full(fd, sb.buf, sb.len) != sb.len)
244 die_errno("failed to write to %s",
245 shallow_lock->filename);
246 *alternate_shallow_file = shallow_lock->filename;
249 * is_repository_shallow() sees empty string as "no
252 *alternate_shallow_file = "";
256 static int advertise_shallow_grafts_cb(const struct commit_graft *graft, void *cb)
259 if (graft->nr_parent == -1)
260 packet_write(fd, "shallow %s\n", sha1_to_hex(graft->sha1));
264 void advertise_shallow_grafts(int fd)
266 if (!is_repository_shallow())
268 for_each_commit_graft(advertise_shallow_grafts_cb, &fd);
272 * mark_reachable_objects() should have been run prior to this and all
273 * reachable commits marked as "SEEN".
275 void prune_shallow(int show_only)
277 static struct lock_file shallow_lock;
278 struct strbuf sb = STRBUF_INIT;
282 write_shallow_commits_1(&sb, 0, NULL, SEEN_ONLY | VERBOSE);
286 check_shallow_file_for_update();
287 fd = hold_lock_file_for_update(&shallow_lock, git_path("shallow"),
289 if (write_shallow_commits_1(&sb, 0, NULL, SEEN_ONLY)) {
290 if (write_in_full(fd, sb.buf, sb.len) != sb.len)
291 die_errno("failed to write to %s",
292 shallow_lock.filename);
293 commit_lock_file(&shallow_lock);
295 unlink(git_path("shallow"));
296 rollback_lock_file(&shallow_lock);
301 #define TRACE_KEY "GIT_TRACE_SHALLOW"
304 * Step 1, split sender shallow commits into "ours" and "theirs"
305 * Step 2, clean "ours" based on .git/shallow
307 void prepare_shallow_info(struct shallow_info *info, struct sha1_array *sa)
310 trace_printf_key(TRACE_KEY, "shallow: prepare_shallow_info\n");
311 memset(info, 0, sizeof(*info));
315 info->ours = xmalloc(sizeof(*info->ours) * sa->nr);
316 info->theirs = xmalloc(sizeof(*info->theirs) * sa->nr);
317 for (i = 0; i < sa->nr; i++) {
318 if (has_sha1_file(sa->sha1[i])) {
319 struct commit_graft *graft;
320 graft = lookup_commit_graft(sa->sha1[i]);
321 if (graft && graft->nr_parent < 0)
323 info->ours[info->nr_ours++] = i;
325 info->theirs[info->nr_theirs++] = i;
329 void clear_shallow_info(struct shallow_info *info)
335 /* Step 4, remove non-existent ones in "theirs" after getting the pack */
337 void remove_nonexistent_theirs_shallow(struct shallow_info *info)
339 unsigned char (*sha1)[20] = info->shallow->sha1;
341 trace_printf_key(TRACE_KEY, "shallow: remove_nonexistent_theirs_shallow\n");
342 for (i = dst = 0; i < info->nr_theirs; i++) {
344 info->theirs[dst] = info->theirs[i];
345 if (has_sha1_file(sha1[info->theirs[i]]))
348 info->nr_theirs = dst;
351 define_commit_slab(ref_bitmap, uint32_t *);
354 struct ref_bitmap ref_bitmap;
361 static uint32_t *paint_alloc(struct paint_info *info)
363 unsigned nr = (info->nr_bits + 31) / 32;
364 unsigned size = nr * sizeof(uint32_t);
366 if (!info->slab_count || info->free + size > info->end) {
368 info->slab = xrealloc(info->slab,
369 info->slab_count * sizeof(*info->slab));
370 info->free = xmalloc(COMMIT_SLAB_SIZE);
371 info->slab[info->slab_count - 1] = info->free;
372 info->end = info->free + COMMIT_SLAB_SIZE;
380 * Given a commit SHA-1, walk down to parents until either SEEN,
381 * UNINTERESTING or BOTTOM is hit. Set the id-th bit in ref_bitmap for
382 * all walked commits.
384 static void paint_down(struct paint_info *info, const unsigned char *sha1,
388 struct commit_list *head = NULL;
389 int bitmap_nr = (info->nr_bits + 31) / 32;
390 int bitmap_size = bitmap_nr * sizeof(uint32_t);
391 uint32_t *tmp = xmalloc(bitmap_size); /* to be freed before return */
392 uint32_t *bitmap = paint_alloc(info);
393 struct commit *c = lookup_commit_reference_gently(sha1, 1);
396 memset(bitmap, 0, bitmap_size);
397 bitmap[id / 32] |= (1 << (id % 32));
398 commit_list_insert(c, &head);
400 struct commit_list *p;
401 struct commit *c = head->item;
402 uint32_t **refs = ref_bitmap_at(&info->ref_bitmap, c);
408 /* XXX check "UNINTERESTING" from pack bitmaps if available */
409 if (c->object.flags & (SEEN | UNINTERESTING))
412 c->object.flags |= SEEN;
417 memcpy(tmp, *refs, bitmap_size);
418 for (i = 0; i < bitmap_nr; i++)
420 if (memcmp(tmp, *refs, bitmap_size)) {
421 *refs = paint_alloc(info);
422 memcpy(*refs, tmp, bitmap_size);
426 if (c->object.flags & BOTTOM)
430 die("unable to parse commit %s",
431 sha1_to_hex(c->object.sha1));
433 for (p = c->parents; p; p = p->next) {
434 uint32_t **p_refs = ref_bitmap_at(&info->ref_bitmap,
436 if (p->item->object.flags & SEEN)
438 if (*p_refs == NULL || *p_refs == *refs)
440 commit_list_insert(p->item, &head);
444 nr = get_max_object_index();
445 for (i = 0; i < nr; i++) {
446 struct object *o = get_indexed_object(i);
447 if (o && o->type == OBJ_COMMIT)
454 static int mark_uninteresting(const char *refname,
455 const unsigned char *sha1,
456 int flags, void *cb_data)
458 struct commit *commit = lookup_commit_reference_gently(sha1, 1);
461 commit->object.flags |= UNINTERESTING;
462 mark_parents_uninteresting(commit);
466 static void post_assign_shallow(struct shallow_info *info,
467 struct ref_bitmap *ref_bitmap,
470 * Step 6(+7), associate shallow commits with new refs
472 * info->ref must be initialized before calling this function.
474 * If used is not NULL, it's an array of info->shallow->nr
475 * bitmaps. The n-th bit set in the m-th bitmap if ref[n] needs the
476 * m-th shallow commit from info->shallow.
478 * If used is NULL, "ours" and "theirs" are updated. And if ref_status
479 * is not NULL it's an array of ref->nr ints. ref_status[i] is true if
480 * the ref needs some shallow commits from either info->ours or
483 void assign_shallow_commits_to_refs(struct shallow_info *info,
484 uint32_t **used, int *ref_status)
486 unsigned char (*sha1)[20] = info->shallow->sha1;
487 struct sha1_array *ref = info->ref;
489 int *shallow, nr_shallow = 0;
490 struct paint_info pi;
492 trace_printf_key(TRACE_KEY, "shallow: assign_shallow_commits_to_refs\n");
493 shallow = xmalloc(sizeof(*shallow) * (info->nr_ours + info->nr_theirs));
494 for (i = 0; i < info->nr_ours; i++)
495 shallow[nr_shallow++] = info->ours[i];
496 for (i = 0; i < info->nr_theirs; i++)
497 shallow[nr_shallow++] = info->theirs[i];
500 * Prepare the commit graph to track what refs can reach what
501 * (new) shallow commits.
503 nr = get_max_object_index();
504 for (i = 0; i < nr; i++) {
505 struct object *o = get_indexed_object(i);
506 if (!o || o->type != OBJ_COMMIT)
509 o->flags &= ~(UNINTERESTING | BOTTOM | SEEN);
512 memset(&pi, 0, sizeof(pi));
513 init_ref_bitmap(&pi.ref_bitmap);
514 pi.nr_bits = ref->nr;
517 * "--not --all" to cut short the traversal if new refs
518 * connect to old refs. If not (e.g. force ref updates) it'll
519 * have to go down to the current shallow commits.
521 head_ref(mark_uninteresting, NULL);
522 for_each_ref(mark_uninteresting, NULL);
524 /* Mark potential bottoms so we won't go out of bound */
525 for (i = 0; i < nr_shallow; i++) {
526 struct commit *c = lookup_commit(sha1[shallow[i]]);
527 c->object.flags |= BOTTOM;
530 for (i = 0; i < ref->nr; i++)
531 paint_down(&pi, ref->sha1[i], i);
534 int bitmap_size = ((pi.nr_bits + 31) / 32) * sizeof(uint32_t);
535 memset(used, 0, sizeof(*used) * info->shallow->nr);
536 for (i = 0; i < nr_shallow; i++) {
537 const struct commit *c = lookup_commit(sha1[shallow[i]]);
538 uint32_t **map = ref_bitmap_at(&pi.ref_bitmap, c);
540 used[shallow[i]] = xmemdupz(*map, bitmap_size);
543 * unreachable shallow commits are not removed from
544 * "ours" and "theirs". The user is supposed to run
545 * step 7 on every ref separately and not trust "ours"
546 * and "theirs" any more.
549 post_assign_shallow(info, &pi.ref_bitmap, ref_status);
551 clear_ref_bitmap(&pi.ref_bitmap);
552 for (i = 0; i < pi.slab_count; i++)
558 struct commit_array {
559 struct commit **commits;
563 static int add_ref(const char *refname,
564 const unsigned char *sha1, int flags, void *cb_data)
566 struct commit_array *ca = cb_data;
567 ALLOC_GROW(ca->commits, ca->nr + 1, ca->alloc);
568 ca->commits[ca->nr] = lookup_commit_reference_gently(sha1, 1);
569 if (ca->commits[ca->nr])
574 static void update_refstatus(int *ref_status, int nr, uint32_t *bitmap)
579 for (i = 0; i < nr; i++)
580 if (bitmap[i / 32] & (1 << (i % 32)))
585 * Step 7, reachability test on "ours" at commit level
587 static void post_assign_shallow(struct shallow_info *info,
588 struct ref_bitmap *ref_bitmap,
591 unsigned char (*sha1)[20] = info->shallow->sha1;
595 int bitmap_nr = (info->ref->nr + 31) / 32;
596 struct commit_array ca;
598 trace_printf_key(TRACE_KEY, "shallow: post_assign_shallow\n");
600 memset(ref_status, 0, sizeof(*ref_status) * info->ref->nr);
602 /* Remove unreachable shallow commits from "theirs" */
603 for (i = dst = 0; i < info->nr_theirs; i++) {
605 info->theirs[dst] = info->theirs[i];
606 c = lookup_commit(sha1[info->theirs[i]]);
607 bitmap = ref_bitmap_at(ref_bitmap, c);
610 for (j = 0; j < bitmap_nr; j++)
612 update_refstatus(ref_status, info->ref->nr, *bitmap);
617 info->nr_theirs = dst;
619 memset(&ca, 0, sizeof(ca));
620 head_ref(add_ref, &ca);
621 for_each_ref(add_ref, &ca);
623 /* Remove unreachable shallow commits from "ours" */
624 for (i = dst = 0; i < info->nr_ours; i++) {
626 info->ours[dst] = info->ours[i];
627 c = lookup_commit(sha1[info->ours[i]]);
628 bitmap = ref_bitmap_at(ref_bitmap, c);
631 for (j = 0; j < bitmap_nr; j++)
633 /* Step 7, reachability test at commit level */
634 !in_merge_bases_many(c, ca.nr, ca.commits)) {
635 update_refstatus(ref_status, info->ref->nr, *bitmap);
645 /* (Delayed) step 7, reachability test at commit level */
646 int delayed_reachability_test(struct shallow_info *si, int c)
648 if (si->need_reachability_test[c]) {
649 struct commit *commit = lookup_commit(si->shallow->sha1[c]);
652 struct commit_array ca;
653 memset(&ca, 0, sizeof(ca));
654 head_ref(add_ref, &ca);
655 for_each_ref(add_ref, &ca);
656 si->commits = ca.commits;
657 si->nr_commits = ca.nr;
660 si->reachable[c] = in_merge_bases_many(commit,
663 si->need_reachability_test[c] = 0;
665 return si->reachable[c];