9 #include "sha1-array.h"
12 #include "commit-slab.h"
14 #include "list-objects.h"
16 static int is_shallow = -1;
17 static struct stat_validity shallow_stat;
18 static char *alternate_shallow_file;
20 void set_alternate_shallow_file(const char *path, int override)
23 die("BUG: is_repository_shallow must not be called before set_alternate_shallow_file");
24 if (alternate_shallow_file && !override)
26 free(alternate_shallow_file);
27 alternate_shallow_file = xstrdup_or_null(path);
30 int register_shallow(const struct object_id *oid)
32 struct commit_graft *graft =
33 xmalloc(sizeof(struct commit_graft));
34 struct commit *commit = lookup_commit(oid);
36 oidcpy(&graft->oid, oid);
37 graft->nr_parent = -1;
38 if (commit && commit->object.parsed)
39 commit->parents = NULL;
40 return register_commit_graft(graft, 0);
43 int is_repository_shallow(void)
47 const char *path = alternate_shallow_file;
53 path = git_path_shallow();
55 * fetch-pack sets '--shallow-file ""' as an indicator that no
56 * shallow file should be used. We could just open it and it
57 * will likely fail. But let's do an explicit check instead.
59 if (!*path || (fp = fopen(path, "r")) == NULL) {
60 stat_validity_clear(&shallow_stat);
64 stat_validity_update(&shallow_stat, fileno(fp));
67 while (fgets(buf, sizeof(buf), fp)) {
69 if (get_oid_hex(buf, &oid))
70 die("bad shallow line: %s", buf);
71 register_shallow(&oid);
77 struct commit_list *get_shallow_commits(struct object_array *heads, int depth,
78 int shallow_flag, int not_shallow_flag)
80 int i = 0, cur_depth = 0;
81 struct commit_list *result = NULL;
82 struct object_array stack = OBJECT_ARRAY_INIT;
83 struct commit *commit = NULL;
84 struct commit_graft *graft;
86 while (commit || i < heads->nr || stack.nr) {
87 struct commit_list *p;
90 commit = (struct commit *)
91 deref_tag(heads->objects[i++].item, NULL, 0);
92 if (!commit || commit->object.type != OBJ_COMMIT) {
97 commit->util = xmalloc(sizeof(int));
98 *(int *)commit->util = 0;
101 commit = (struct commit *)
102 stack.objects[--stack.nr].item;
103 cur_depth = *(int *)commit->util;
106 parse_commit_or_die(commit);
108 if ((depth != INFINITE_DEPTH && cur_depth >= depth) ||
109 (is_repository_shallow() && !commit->parents &&
110 (graft = lookup_commit_graft(&commit->object.oid)) != NULL &&
111 graft->nr_parent < 0)) {
112 commit_list_insert(commit, &result);
113 commit->object.flags |= shallow_flag;
117 commit->object.flags |= not_shallow_flag;
118 for (p = commit->parents, commit = NULL; p; p = p->next) {
119 if (!p->item->util) {
120 int *pointer = xmalloc(sizeof(int));
121 p->item->util = pointer;
122 *pointer = cur_depth;
124 int *pointer = p->item->util;
125 if (cur_depth >= *pointer)
127 *pointer = cur_depth;
130 add_object_array(&p->item->object,
134 cur_depth = *(int *)commit->util;
142 static void show_commit(struct commit *commit, void *data)
144 commit_list_insert(commit, data);
148 * Given rev-list arguments, run rev-list. All reachable commits
149 * except border ones are marked with not_shallow_flag. Border commits
150 * are marked with shallow_flag. The list of border/shallow commits
153 struct commit_list *get_shallow_commits_by_rev_list(int ac, const char **av,
155 int not_shallow_flag)
157 struct commit_list *result = NULL, *p;
158 struct commit_list *not_shallow_list = NULL;
159 struct rev_info revs;
160 int both_flags = shallow_flag | not_shallow_flag;
163 * SHALLOW (excluded) and NOT_SHALLOW (included) should not be
164 * set at this point. But better be safe than sorry.
166 clear_object_flags(both_flags);
168 is_repository_shallow(); /* make sure shallows are read */
170 init_revisions(&revs, NULL);
171 save_commit_buffer = 0;
172 setup_revisions(ac, av, &revs, NULL);
174 if (prepare_revision_walk(&revs))
175 die("revision walk setup failed");
176 traverse_commit_list(&revs, show_commit, NULL, ¬_shallow_list);
178 /* Mark all reachable commits as NOT_SHALLOW */
179 for (p = not_shallow_list; p; p = p->next)
180 p->item->object.flags |= not_shallow_flag;
183 * mark border commits SHALLOW + NOT_SHALLOW.
184 * We cannot clear NOT_SHALLOW right now. Imagine border
185 * commit A is processed first, then commit B, whose parent is
186 * A, later. If NOT_SHALLOW on A is cleared at step 1, B
187 * itself is considered border at step 2, which is incorrect.
189 for (p = not_shallow_list; p; p = p->next) {
190 struct commit *c = p->item;
191 struct commit_list *parent;
194 die("unable to parse commit %s",
195 oid_to_hex(&c->object.oid));
197 for (parent = c->parents; parent; parent = parent->next)
198 if (!(parent->item->object.flags & not_shallow_flag)) {
199 c->object.flags |= shallow_flag;
200 commit_list_insert(c, &result);
204 free_commit_list(not_shallow_list);
207 * Now we can clean up NOT_SHALLOW on border commits. Having
208 * both flags set can confuse the caller.
210 for (p = result; p; p = p->next) {
211 struct object *o = &p->item->object;
212 if ((o->flags & both_flags) == both_flags)
213 o->flags &= ~not_shallow_flag;
218 static void check_shallow_file_for_update(void)
220 if (is_shallow == -1)
221 die("BUG: shallow must be initialized by now");
223 if (!stat_validity_check(&shallow_stat, git_path_shallow()))
224 die("shallow file has changed since we read it");
230 struct write_shallow_data {
232 int use_pack_protocol;
237 static int write_one_shallow(const struct commit_graft *graft, void *cb_data)
239 struct write_shallow_data *data = cb_data;
240 const char *hex = oid_to_hex(&graft->oid);
241 if (graft->nr_parent != -1)
243 if (data->flags & SEEN_ONLY) {
244 struct commit *c = lookup_commit(&graft->oid);
245 if (!c || !(c->object.flags & SEEN)) {
246 if (data->flags & VERBOSE)
247 printf("Removing %s from .git/shallow\n",
248 oid_to_hex(&c->object.oid));
253 if (data->use_pack_protocol)
254 packet_buf_write(data->out, "shallow %s", hex);
256 strbuf_addstr(data->out, hex);
257 strbuf_addch(data->out, '\n');
262 static int write_shallow_commits_1(struct strbuf *out, int use_pack_protocol,
263 const struct oid_array *extra,
266 struct write_shallow_data data;
269 data.use_pack_protocol = use_pack_protocol;
272 for_each_commit_graft(write_one_shallow, &data);
275 for (i = 0; i < extra->nr; i++) {
276 strbuf_addstr(out, oid_to_hex(extra->oid + i));
277 strbuf_addch(out, '\n');
283 int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
284 const struct oid_array *extra)
286 return write_shallow_commits_1(out, use_pack_protocol, extra, 0);
289 const char *setup_temporary_shallow(const struct oid_array *extra)
291 static struct tempfile temp;
292 struct strbuf sb = STRBUF_INIT;
295 if (write_shallow_commits(&sb, 0, extra)) {
296 fd = xmks_tempfile(&temp, git_path("shallow_XXXXXX"));
298 if (write_in_full(fd, sb.buf, sb.len) != sb.len ||
299 close_tempfile_gently(&temp) < 0)
300 die_errno("failed to write to %s",
301 get_tempfile_path(&temp));
303 return get_tempfile_path(&temp);
306 * is_repository_shallow() sees empty string as "no shallow
312 void setup_alternate_shallow(struct lock_file *shallow_lock,
313 const char **alternate_shallow_file,
314 const struct oid_array *extra)
316 struct strbuf sb = STRBUF_INIT;
319 fd = hold_lock_file_for_update(shallow_lock, git_path_shallow(),
321 check_shallow_file_for_update();
322 if (write_shallow_commits(&sb, 0, extra)) {
323 if (write_in_full(fd, sb.buf, sb.len) != sb.len)
324 die_errno("failed to write to %s",
325 get_lock_file_path(shallow_lock));
326 *alternate_shallow_file = get_lock_file_path(shallow_lock);
329 * is_repository_shallow() sees empty string as "no
332 *alternate_shallow_file = "";
336 static int advertise_shallow_grafts_cb(const struct commit_graft *graft, void *cb)
339 if (graft->nr_parent == -1)
340 packet_write_fmt(fd, "shallow %s\n", oid_to_hex(&graft->oid));
344 void advertise_shallow_grafts(int fd)
346 if (!is_repository_shallow())
348 for_each_commit_graft(advertise_shallow_grafts_cb, &fd);
352 * mark_reachable_objects() should have been run prior to this and all
353 * reachable commits marked as "SEEN".
355 void prune_shallow(int show_only)
357 static struct lock_file shallow_lock;
358 struct strbuf sb = STRBUF_INIT;
362 write_shallow_commits_1(&sb, 0, NULL, SEEN_ONLY | VERBOSE);
366 fd = hold_lock_file_for_update(&shallow_lock, git_path_shallow(),
368 check_shallow_file_for_update();
369 if (write_shallow_commits_1(&sb, 0, NULL, SEEN_ONLY)) {
370 if (write_in_full(fd, sb.buf, sb.len) != sb.len)
371 die_errno("failed to write to %s",
372 get_lock_file_path(&shallow_lock));
373 commit_lock_file(&shallow_lock);
375 unlink(git_path_shallow());
376 rollback_lock_file(&shallow_lock);
381 struct trace_key trace_shallow = TRACE_KEY_INIT(SHALLOW);
384 * Step 1, split sender shallow commits into "ours" and "theirs"
385 * Step 2, clean "ours" based on .git/shallow
387 void prepare_shallow_info(struct shallow_info *info, struct oid_array *sa)
390 trace_printf_key(&trace_shallow, "shallow: prepare_shallow_info\n");
391 memset(info, 0, sizeof(*info));
395 ALLOC_ARRAY(info->ours, sa->nr);
396 ALLOC_ARRAY(info->theirs, sa->nr);
397 for (i = 0; i < sa->nr; i++) {
398 if (has_object_file(sa->oid + i)) {
399 struct commit_graft *graft;
400 graft = lookup_commit_graft(&sa->oid[i]);
401 if (graft && graft->nr_parent < 0)
403 info->ours[info->nr_ours++] = i;
405 info->theirs[info->nr_theirs++] = i;
409 void clear_shallow_info(struct shallow_info *info)
415 /* Step 4, remove non-existent ones in "theirs" after getting the pack */
417 void remove_nonexistent_theirs_shallow(struct shallow_info *info)
419 struct object_id *oid = info->shallow->oid;
421 trace_printf_key(&trace_shallow, "shallow: remove_nonexistent_theirs_shallow\n");
422 for (i = dst = 0; i < info->nr_theirs; i++) {
424 info->theirs[dst] = info->theirs[i];
425 if (has_object_file(oid + info->theirs[i]))
428 info->nr_theirs = dst;
431 define_commit_slab(ref_bitmap, uint32_t *);
433 #define POOL_SIZE (512 * 1024)
436 struct ref_bitmap ref_bitmap;
443 static uint32_t *paint_alloc(struct paint_info *info)
445 unsigned nr = DIV_ROUND_UP(info->nr_bits, 32);
446 unsigned size = nr * sizeof(uint32_t);
448 if (!info->pool_count || size > info->end - info->free) {
449 if (size > POOL_SIZE)
450 die("BUG: pool size too small for %d in paint_alloc()",
453 REALLOC_ARRAY(info->pools, info->pool_count);
454 info->free = xmalloc(POOL_SIZE);
455 info->pools[info->pool_count - 1] = info->free;
456 info->end = info->free + POOL_SIZE;
464 * Given a commit SHA-1, walk down to parents until either SEEN,
465 * UNINTERESTING or BOTTOM is hit. Set the id-th bit in ref_bitmap for
466 * all walked commits.
468 static void paint_down(struct paint_info *info, const struct object_id *oid,
472 struct commit_list *head = NULL;
473 int bitmap_nr = DIV_ROUND_UP(info->nr_bits, 32);
474 size_t bitmap_size = st_mult(sizeof(uint32_t), bitmap_nr);
475 struct commit *c = lookup_commit_reference_gently(oid, 1);
476 uint32_t *tmp; /* to be freed before return */
482 tmp = xmalloc(bitmap_size);
483 bitmap = paint_alloc(info);
484 memset(bitmap, 0, bitmap_size);
485 bitmap[id / 32] |= (1U << (id % 32));
486 commit_list_insert(c, &head);
488 struct commit_list *p;
489 struct commit *c = pop_commit(&head);
490 uint32_t **refs = ref_bitmap_at(&info->ref_bitmap, c);
492 /* XXX check "UNINTERESTING" from pack bitmaps if available */
493 if (c->object.flags & (SEEN | UNINTERESTING))
496 c->object.flags |= SEEN;
501 memcpy(tmp, *refs, bitmap_size);
502 for (i = 0; i < bitmap_nr; i++)
504 if (memcmp(tmp, *refs, bitmap_size)) {
505 *refs = paint_alloc(info);
506 memcpy(*refs, tmp, bitmap_size);
510 if (c->object.flags & BOTTOM)
514 die("unable to parse commit %s",
515 oid_to_hex(&c->object.oid));
517 for (p = c->parents; p; p = p->next) {
518 if (p->item->object.flags & SEEN)
520 commit_list_insert(p->item, &head);
524 nr = get_max_object_index();
525 for (i = 0; i < nr; i++) {
526 struct object *o = get_indexed_object(i);
527 if (o && o->type == OBJ_COMMIT)
534 static int mark_uninteresting(const char *refname, const struct object_id *oid,
535 int flags, void *cb_data)
537 struct commit *commit = lookup_commit_reference_gently(oid, 1);
540 commit->object.flags |= UNINTERESTING;
541 mark_parents_uninteresting(commit);
545 static void post_assign_shallow(struct shallow_info *info,
546 struct ref_bitmap *ref_bitmap,
549 * Step 6(+7), associate shallow commits with new refs
551 * info->ref must be initialized before calling this function.
553 * If used is not NULL, it's an array of info->shallow->nr
554 * bitmaps. The n-th bit set in the m-th bitmap if ref[n] needs the
555 * m-th shallow commit from info->shallow.
557 * If used is NULL, "ours" and "theirs" are updated. And if ref_status
558 * is not NULL it's an array of ref->nr ints. ref_status[i] is true if
559 * the ref needs some shallow commits from either info->ours or
562 void assign_shallow_commits_to_refs(struct shallow_info *info,
563 uint32_t **used, int *ref_status)
565 struct object_id *oid = info->shallow->oid;
566 struct oid_array *ref = info->ref;
568 int *shallow, nr_shallow = 0;
569 struct paint_info pi;
571 trace_printf_key(&trace_shallow, "shallow: assign_shallow_commits_to_refs\n");
572 ALLOC_ARRAY(shallow, info->nr_ours + info->nr_theirs);
573 for (i = 0; i < info->nr_ours; i++)
574 shallow[nr_shallow++] = info->ours[i];
575 for (i = 0; i < info->nr_theirs; i++)
576 shallow[nr_shallow++] = info->theirs[i];
579 * Prepare the commit graph to track what refs can reach what
580 * (new) shallow commits.
582 nr = get_max_object_index();
583 for (i = 0; i < nr; i++) {
584 struct object *o = get_indexed_object(i);
585 if (!o || o->type != OBJ_COMMIT)
588 o->flags &= ~(UNINTERESTING | BOTTOM | SEEN);
591 memset(&pi, 0, sizeof(pi));
592 init_ref_bitmap(&pi.ref_bitmap);
593 pi.nr_bits = ref->nr;
596 * "--not --all" to cut short the traversal if new refs
597 * connect to old refs. If not (e.g. force ref updates) it'll
598 * have to go down to the current shallow commits.
600 head_ref(mark_uninteresting, NULL);
601 for_each_ref(mark_uninteresting, NULL);
603 /* Mark potential bottoms so we won't go out of bound */
604 for (i = 0; i < nr_shallow; i++) {
605 struct commit *c = lookup_commit(&oid[shallow[i]]);
606 c->object.flags |= BOTTOM;
609 for (i = 0; i < ref->nr; i++)
610 paint_down(&pi, ref->oid + i, i);
613 int bitmap_size = DIV_ROUND_UP(pi.nr_bits, 32) * sizeof(uint32_t);
614 memset(used, 0, sizeof(*used) * info->shallow->nr);
615 for (i = 0; i < nr_shallow; i++) {
616 const struct commit *c = lookup_commit(&oid[shallow[i]]);
617 uint32_t **map = ref_bitmap_at(&pi.ref_bitmap, c);
619 used[shallow[i]] = xmemdupz(*map, bitmap_size);
622 * unreachable shallow commits are not removed from
623 * "ours" and "theirs". The user is supposed to run
624 * step 7 on every ref separately and not trust "ours"
625 * and "theirs" any more.
628 post_assign_shallow(info, &pi.ref_bitmap, ref_status);
630 clear_ref_bitmap(&pi.ref_bitmap);
631 for (i = 0; i < pi.pool_count; i++)
637 struct commit_array {
638 struct commit **commits;
642 static int add_ref(const char *refname, const struct object_id *oid,
643 int flags, void *cb_data)
645 struct commit_array *ca = cb_data;
646 ALLOC_GROW(ca->commits, ca->nr + 1, ca->alloc);
647 ca->commits[ca->nr] = lookup_commit_reference_gently(oid, 1);
648 if (ca->commits[ca->nr])
653 static void update_refstatus(int *ref_status, int nr, uint32_t *bitmap)
658 for (i = 0; i < nr; i++)
659 if (bitmap[i / 32] & (1U << (i % 32)))
664 * Step 7, reachability test on "ours" at commit level
666 static void post_assign_shallow(struct shallow_info *info,
667 struct ref_bitmap *ref_bitmap,
670 struct object_id *oid = info->shallow->oid;
674 int bitmap_nr = DIV_ROUND_UP(info->ref->nr, 32);
675 struct commit_array ca;
677 trace_printf_key(&trace_shallow, "shallow: post_assign_shallow\n");
679 memset(ref_status, 0, sizeof(*ref_status) * info->ref->nr);
681 /* Remove unreachable shallow commits from "theirs" */
682 for (i = dst = 0; i < info->nr_theirs; i++) {
684 info->theirs[dst] = info->theirs[i];
685 c = lookup_commit(&oid[info->theirs[i]]);
686 bitmap = ref_bitmap_at(ref_bitmap, c);
689 for (j = 0; j < bitmap_nr; j++)
691 update_refstatus(ref_status, info->ref->nr, *bitmap);
696 info->nr_theirs = dst;
698 memset(&ca, 0, sizeof(ca));
699 head_ref(add_ref, &ca);
700 for_each_ref(add_ref, &ca);
702 /* Remove unreachable shallow commits from "ours" */
703 for (i = dst = 0; i < info->nr_ours; i++) {
705 info->ours[dst] = info->ours[i];
706 c = lookup_commit(&oid[info->ours[i]]);
707 bitmap = ref_bitmap_at(ref_bitmap, c);
710 for (j = 0; j < bitmap_nr; j++)
712 /* Step 7, reachability test at commit level */
713 !in_merge_bases_many(c, ca.nr, ca.commits)) {
714 update_refstatus(ref_status, info->ref->nr, *bitmap);
724 /* (Delayed) step 7, reachability test at commit level */
725 int delayed_reachability_test(struct shallow_info *si, int c)
727 if (si->need_reachability_test[c]) {
728 struct commit *commit = lookup_commit(&si->shallow->oid[c]);
731 struct commit_array ca;
733 memset(&ca, 0, sizeof(ca));
734 head_ref(add_ref, &ca);
735 for_each_ref(add_ref, &ca);
736 si->commits = ca.commits;
737 si->nr_commits = ca.nr;
740 si->reachable[c] = in_merge_bases_many(commit,
743 si->need_reachability_test[c] = 0;
745 return si->reachable[c];