9 #include "sha1-array.h"
12 #include "commit-slab.h"
14 #include "list-objects.h"
15 #include "commit-slab.h"
17 static int is_shallow
= -1;
18 static struct stat_validity shallow_stat
;
19 static char *alternate_shallow_file
;
21 void set_alternate_shallow_file(const char *path
, int override
)
24 BUG("is_repository_shallow must not be called before set_alternate_shallow_file");
25 if (alternate_shallow_file
&& !override
)
27 free(alternate_shallow_file
);
28 alternate_shallow_file
= xstrdup_or_null(path
);
31 int register_shallow(const struct object_id
*oid
)
33 struct commit_graft
*graft
=
34 xmalloc(sizeof(struct commit_graft
));
35 struct commit
*commit
= lookup_commit(oid
);
37 oidcpy(&graft
->oid
, oid
);
38 graft
->nr_parent
= -1;
39 if (commit
&& commit
->object
.parsed
)
40 commit
->parents
= NULL
;
41 return register_commit_graft(graft
, 0);
44 int is_repository_shallow(void)
48 const char *path
= alternate_shallow_file
;
54 path
= git_path_shallow();
56 * fetch-pack sets '--shallow-file ""' as an indicator that no
57 * shallow file should be used. We could just open it and it
58 * will likely fail. But let's do an explicit check instead.
60 if (!*path
|| (fp
= fopen(path
, "r")) == NULL
) {
61 stat_validity_clear(&shallow_stat
);
65 stat_validity_update(&shallow_stat
, fileno(fp
));
68 while (fgets(buf
, sizeof(buf
), fp
)) {
70 if (get_oid_hex(buf
, &oid
))
71 die("bad shallow line: %s", buf
);
72 register_shallow(&oid
);
79 * TODO: use "int" elemtype instead of "int *" when/if commit-slab
80 * supports a "valid" flag.
82 define_commit_slab(commit_depth
, int *);
83 struct commit_list
*get_shallow_commits(struct object_array
*heads
, int depth
,
84 int shallow_flag
, int not_shallow_flag
)
86 int i
= 0, cur_depth
= 0;
87 struct commit_list
*result
= NULL
;
88 struct object_array stack
= OBJECT_ARRAY_INIT
;
89 struct commit
*commit
= NULL
;
90 struct commit_graft
*graft
;
91 struct commit_depth depths
;
93 init_commit_depth(&depths
);
94 while (commit
|| i
< heads
->nr
|| stack
.nr
) {
95 struct commit_list
*p
;
99 commit
= (struct commit
*)
100 deref_tag(heads
->objects
[i
++].item
, NULL
, 0);
101 if (!commit
|| commit
->object
.type
!= OBJ_COMMIT
) {
105 depth_slot
= commit_depth_at(&depths
, commit
);
107 *depth_slot
= xmalloc(sizeof(int));
111 commit
= (struct commit
*)
112 object_array_pop(&stack
);
113 cur_depth
= **commit_depth_at(&depths
, commit
);
116 parse_commit_or_die(commit
);
118 if ((depth
!= INFINITE_DEPTH
&& cur_depth
>= depth
) ||
119 (is_repository_shallow() && !commit
->parents
&&
120 (graft
= lookup_commit_graft(&commit
->object
.oid
)) != NULL
&&
121 graft
->nr_parent
< 0)) {
122 commit_list_insert(commit
, &result
);
123 commit
->object
.flags
|= shallow_flag
;
127 commit
->object
.flags
|= not_shallow_flag
;
128 for (p
= commit
->parents
, commit
= NULL
; p
; p
= p
->next
) {
129 int **depth_slot
= commit_depth_at(&depths
, p
->item
);
131 *depth_slot
= xmalloc(sizeof(int));
132 **depth_slot
= cur_depth
;
134 if (cur_depth
>= **depth_slot
)
136 **depth_slot
= cur_depth
;
139 add_object_array(&p
->item
->object
,
143 cur_depth
= **commit_depth_at(&depths
, commit
);
147 for (i
= 0; i
< depths
.slab_count
; i
++) {
150 for (j
= 0; j
< depths
.slab_size
; j
++)
151 free(depths
.slab
[i
][j
]);
153 clear_commit_depth(&depths
);
158 static void show_commit(struct commit
*commit
, void *data
)
160 commit_list_insert(commit
, data
);
164 * Given rev-list arguments, run rev-list. All reachable commits
165 * except border ones are marked with not_shallow_flag. Border commits
166 * are marked with shallow_flag. The list of border/shallow commits
169 struct commit_list
*get_shallow_commits_by_rev_list(int ac
, const char **av
,
171 int not_shallow_flag
)
173 struct commit_list
*result
= NULL
, *p
;
174 struct commit_list
*not_shallow_list
= NULL
;
175 struct rev_info revs
;
176 int both_flags
= shallow_flag
| not_shallow_flag
;
179 * SHALLOW (excluded) and NOT_SHALLOW (included) should not be
180 * set at this point. But better be safe than sorry.
182 clear_object_flags(both_flags
);
184 is_repository_shallow(); /* make sure shallows are read */
186 init_revisions(&revs
, NULL
);
187 save_commit_buffer
= 0;
188 setup_revisions(ac
, av
, &revs
, NULL
);
190 if (prepare_revision_walk(&revs
))
191 die("revision walk setup failed");
192 traverse_commit_list(&revs
, show_commit
, NULL
, ¬_shallow_list
);
194 if (!not_shallow_list
)
195 die("no commits selected for shallow requests");
197 /* Mark all reachable commits as NOT_SHALLOW */
198 for (p
= not_shallow_list
; p
; p
= p
->next
)
199 p
->item
->object
.flags
|= not_shallow_flag
;
202 * mark border commits SHALLOW + NOT_SHALLOW.
203 * We cannot clear NOT_SHALLOW right now. Imagine border
204 * commit A is processed first, then commit B, whose parent is
205 * A, later. If NOT_SHALLOW on A is cleared at step 1, B
206 * itself is considered border at step 2, which is incorrect.
208 for (p
= not_shallow_list
; p
; p
= p
->next
) {
209 struct commit
*c
= p
->item
;
210 struct commit_list
*parent
;
213 die("unable to parse commit %s",
214 oid_to_hex(&c
->object
.oid
));
216 for (parent
= c
->parents
; parent
; parent
= parent
->next
)
217 if (!(parent
->item
->object
.flags
& not_shallow_flag
)) {
218 c
->object
.flags
|= shallow_flag
;
219 commit_list_insert(c
, &result
);
223 free_commit_list(not_shallow_list
);
226 * Now we can clean up NOT_SHALLOW on border commits. Having
227 * both flags set can confuse the caller.
229 for (p
= result
; p
; p
= p
->next
) {
230 struct object
*o
= &p
->item
->object
;
231 if ((o
->flags
& both_flags
) == both_flags
)
232 o
->flags
&= ~not_shallow_flag
;
237 static void check_shallow_file_for_update(void)
239 if (is_shallow
== -1)
240 BUG("shallow must be initialized by now");
242 if (!stat_validity_check(&shallow_stat
, git_path_shallow()))
243 die("shallow file has changed since we read it");
249 struct write_shallow_data
{
251 int use_pack_protocol
;
256 static int write_one_shallow(const struct commit_graft
*graft
, void *cb_data
)
258 struct write_shallow_data
*data
= cb_data
;
259 const char *hex
= oid_to_hex(&graft
->oid
);
260 if (graft
->nr_parent
!= -1)
262 if (data
->flags
& SEEN_ONLY
) {
263 struct commit
*c
= lookup_commit(&graft
->oid
);
264 if (!c
|| !(c
->object
.flags
& SEEN
)) {
265 if (data
->flags
& VERBOSE
)
266 printf("Removing %s from .git/shallow\n",
267 oid_to_hex(&c
->object
.oid
));
272 if (data
->use_pack_protocol
)
273 packet_buf_write(data
->out
, "shallow %s", hex
);
275 strbuf_addstr(data
->out
, hex
);
276 strbuf_addch(data
->out
, '\n');
281 static int write_shallow_commits_1(struct strbuf
*out
, int use_pack_protocol
,
282 const struct oid_array
*extra
,
285 struct write_shallow_data data
;
288 data
.use_pack_protocol
= use_pack_protocol
;
291 for_each_commit_graft(write_one_shallow
, &data
);
294 for (i
= 0; i
< extra
->nr
; i
++) {
295 strbuf_addstr(out
, oid_to_hex(extra
->oid
+ i
));
296 strbuf_addch(out
, '\n');
302 int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
303 const struct oid_array
*extra
)
305 return write_shallow_commits_1(out
, use_pack_protocol
, extra
, 0);
308 const char *setup_temporary_shallow(const struct oid_array
*extra
)
310 struct tempfile
*temp
;
311 struct strbuf sb
= STRBUF_INIT
;
313 if (write_shallow_commits(&sb
, 0, extra
)) {
314 temp
= xmks_tempfile(git_path("shallow_XXXXXX"));
316 if (write_in_full(temp
->fd
, sb
.buf
, sb
.len
) < 0 ||
317 close_tempfile_gently(temp
) < 0)
318 die_errno("failed to write to %s",
319 get_tempfile_path(temp
));
321 return get_tempfile_path(temp
);
324 * is_repository_shallow() sees empty string as "no shallow
330 void setup_alternate_shallow(struct lock_file
*shallow_lock
,
331 const char **alternate_shallow_file
,
332 const struct oid_array
*extra
)
334 struct strbuf sb
= STRBUF_INIT
;
337 fd
= hold_lock_file_for_update(shallow_lock
, git_path_shallow(),
339 check_shallow_file_for_update();
340 if (write_shallow_commits(&sb
, 0, extra
)) {
341 if (write_in_full(fd
, sb
.buf
, sb
.len
) < 0)
342 die_errno("failed to write to %s",
343 get_lock_file_path(shallow_lock
));
344 *alternate_shallow_file
= get_lock_file_path(shallow_lock
);
347 * is_repository_shallow() sees empty string as "no
350 *alternate_shallow_file
= "";
354 static int advertise_shallow_grafts_cb(const struct commit_graft
*graft
, void *cb
)
357 if (graft
->nr_parent
== -1)
358 packet_write_fmt(fd
, "shallow %s\n", oid_to_hex(&graft
->oid
));
362 void advertise_shallow_grafts(int fd
)
364 if (!is_repository_shallow())
366 for_each_commit_graft(advertise_shallow_grafts_cb
, &fd
);
370 * mark_reachable_objects() should have been run prior to this and all
371 * reachable commits marked as "SEEN".
373 void prune_shallow(int show_only
)
375 struct lock_file shallow_lock
= LOCK_INIT
;
376 struct strbuf sb
= STRBUF_INIT
;
380 write_shallow_commits_1(&sb
, 0, NULL
, SEEN_ONLY
| VERBOSE
);
384 fd
= hold_lock_file_for_update(&shallow_lock
, git_path_shallow(),
386 check_shallow_file_for_update();
387 if (write_shallow_commits_1(&sb
, 0, NULL
, SEEN_ONLY
)) {
388 if (write_in_full(fd
, sb
.buf
, sb
.len
) < 0)
389 die_errno("failed to write to %s",
390 get_lock_file_path(&shallow_lock
));
391 commit_lock_file(&shallow_lock
);
393 unlink(git_path_shallow());
394 rollback_lock_file(&shallow_lock
);
399 struct trace_key trace_shallow
= TRACE_KEY_INIT(SHALLOW
);
402 * Step 1, split sender shallow commits into "ours" and "theirs"
403 * Step 2, clean "ours" based on .git/shallow
405 void prepare_shallow_info(struct shallow_info
*info
, struct oid_array
*sa
)
408 trace_printf_key(&trace_shallow
, "shallow: prepare_shallow_info\n");
409 memset(info
, 0, sizeof(*info
));
413 ALLOC_ARRAY(info
->ours
, sa
->nr
);
414 ALLOC_ARRAY(info
->theirs
, sa
->nr
);
415 for (i
= 0; i
< sa
->nr
; i
++) {
416 if (has_object_file(sa
->oid
+ i
)) {
417 struct commit_graft
*graft
;
418 graft
= lookup_commit_graft(&sa
->oid
[i
]);
419 if (graft
&& graft
->nr_parent
< 0)
421 info
->ours
[info
->nr_ours
++] = i
;
423 info
->theirs
[info
->nr_theirs
++] = i
;
427 void clear_shallow_info(struct shallow_info
*info
)
433 /* Step 4, remove non-existent ones in "theirs" after getting the pack */
435 void remove_nonexistent_theirs_shallow(struct shallow_info
*info
)
437 struct object_id
*oid
= info
->shallow
->oid
;
439 trace_printf_key(&trace_shallow
, "shallow: remove_nonexistent_theirs_shallow\n");
440 for (i
= dst
= 0; i
< info
->nr_theirs
; i
++) {
442 info
->theirs
[dst
] = info
->theirs
[i
];
443 if (has_object_file(oid
+ info
->theirs
[i
]))
446 info
->nr_theirs
= dst
;
449 define_commit_slab(ref_bitmap
, uint32_t *);
451 #define POOL_SIZE (512 * 1024)
454 struct ref_bitmap ref_bitmap
;
461 static uint32_t *paint_alloc(struct paint_info
*info
)
463 unsigned nr
= DIV_ROUND_UP(info
->nr_bits
, 32);
464 unsigned size
= nr
* sizeof(uint32_t);
466 if (!info
->pool_count
|| size
> info
->end
- info
->free
) {
467 if (size
> POOL_SIZE
)
468 BUG("pool size too small for %d in paint_alloc()",
471 REALLOC_ARRAY(info
->pools
, info
->pool_count
);
472 info
->free
= xmalloc(POOL_SIZE
);
473 info
->pools
[info
->pool_count
- 1] = info
->free
;
474 info
->end
= info
->free
+ POOL_SIZE
;
482 * Given a commit SHA-1, walk down to parents until either SEEN,
483 * UNINTERESTING or BOTTOM is hit. Set the id-th bit in ref_bitmap for
484 * all walked commits.
486 static void paint_down(struct paint_info
*info
, const struct object_id
*oid
,
490 struct commit_list
*head
= NULL
;
491 int bitmap_nr
= DIV_ROUND_UP(info
->nr_bits
, 32);
492 size_t bitmap_size
= st_mult(sizeof(uint32_t), bitmap_nr
);
493 struct commit
*c
= lookup_commit_reference_gently(oid
, 1);
494 uint32_t *tmp
; /* to be freed before return */
500 tmp
= xmalloc(bitmap_size
);
501 bitmap
= paint_alloc(info
);
502 memset(bitmap
, 0, bitmap_size
);
503 bitmap
[id
/ 32] |= (1U << (id
% 32));
504 commit_list_insert(c
, &head
);
506 struct commit_list
*p
;
507 struct commit
*c
= pop_commit(&head
);
508 uint32_t **refs
= ref_bitmap_at(&info
->ref_bitmap
, c
);
510 /* XXX check "UNINTERESTING" from pack bitmaps if available */
511 if (c
->object
.flags
& (SEEN
| UNINTERESTING
))
514 c
->object
.flags
|= SEEN
;
519 memcpy(tmp
, *refs
, bitmap_size
);
520 for (i
= 0; i
< bitmap_nr
; i
++)
522 if (memcmp(tmp
, *refs
, bitmap_size
)) {
523 *refs
= paint_alloc(info
);
524 memcpy(*refs
, tmp
, bitmap_size
);
528 if (c
->object
.flags
& BOTTOM
)
532 die("unable to parse commit %s",
533 oid_to_hex(&c
->object
.oid
));
535 for (p
= c
->parents
; p
; p
= p
->next
) {
536 if (p
->item
->object
.flags
& SEEN
)
538 commit_list_insert(p
->item
, &head
);
542 nr
= get_max_object_index();
543 for (i
= 0; i
< nr
; i
++) {
544 struct object
*o
= get_indexed_object(i
);
545 if (o
&& o
->type
== OBJ_COMMIT
)
552 static int mark_uninteresting(const char *refname
, const struct object_id
*oid
,
553 int flags
, void *cb_data
)
555 struct commit
*commit
= lookup_commit_reference_gently(oid
, 1);
558 commit
->object
.flags
|= UNINTERESTING
;
559 mark_parents_uninteresting(commit
);
563 static void post_assign_shallow(struct shallow_info
*info
,
564 struct ref_bitmap
*ref_bitmap
,
567 * Step 6(+7), associate shallow commits with new refs
569 * info->ref must be initialized before calling this function.
571 * If used is not NULL, it's an array of info->shallow->nr
572 * bitmaps. The n-th bit set in the m-th bitmap if ref[n] needs the
573 * m-th shallow commit from info->shallow.
575 * If used is NULL, "ours" and "theirs" are updated. And if ref_status
576 * is not NULL it's an array of ref->nr ints. ref_status[i] is true if
577 * the ref needs some shallow commits from either info->ours or
580 void assign_shallow_commits_to_refs(struct shallow_info
*info
,
581 uint32_t **used
, int *ref_status
)
583 struct object_id
*oid
= info
->shallow
->oid
;
584 struct oid_array
*ref
= info
->ref
;
586 int *shallow
, nr_shallow
= 0;
587 struct paint_info pi
;
589 trace_printf_key(&trace_shallow
, "shallow: assign_shallow_commits_to_refs\n");
590 ALLOC_ARRAY(shallow
, info
->nr_ours
+ info
->nr_theirs
);
591 for (i
= 0; i
< info
->nr_ours
; i
++)
592 shallow
[nr_shallow
++] = info
->ours
[i
];
593 for (i
= 0; i
< info
->nr_theirs
; i
++)
594 shallow
[nr_shallow
++] = info
->theirs
[i
];
597 * Prepare the commit graph to track what refs can reach what
598 * (new) shallow commits.
600 nr
= get_max_object_index();
601 for (i
= 0; i
< nr
; i
++) {
602 struct object
*o
= get_indexed_object(i
);
603 if (!o
|| o
->type
!= OBJ_COMMIT
)
606 o
->flags
&= ~(UNINTERESTING
| BOTTOM
| SEEN
);
609 memset(&pi
, 0, sizeof(pi
));
610 init_ref_bitmap(&pi
.ref_bitmap
);
611 pi
.nr_bits
= ref
->nr
;
614 * "--not --all" to cut short the traversal if new refs
615 * connect to old refs. If not (e.g. force ref updates) it'll
616 * have to go down to the current shallow commits.
618 head_ref(mark_uninteresting
, NULL
);
619 for_each_ref(mark_uninteresting
, NULL
);
621 /* Mark potential bottoms so we won't go out of bound */
622 for (i
= 0; i
< nr_shallow
; i
++) {
623 struct commit
*c
= lookup_commit(&oid
[shallow
[i
]]);
624 c
->object
.flags
|= BOTTOM
;
627 for (i
= 0; i
< ref
->nr
; i
++)
628 paint_down(&pi
, ref
->oid
+ i
, i
);
631 int bitmap_size
= DIV_ROUND_UP(pi
.nr_bits
, 32) * sizeof(uint32_t);
632 memset(used
, 0, sizeof(*used
) * info
->shallow
->nr
);
633 for (i
= 0; i
< nr_shallow
; i
++) {
634 const struct commit
*c
= lookup_commit(&oid
[shallow
[i
]]);
635 uint32_t **map
= ref_bitmap_at(&pi
.ref_bitmap
, c
);
637 used
[shallow
[i
]] = xmemdupz(*map
, bitmap_size
);
640 * unreachable shallow commits are not removed from
641 * "ours" and "theirs". The user is supposed to run
642 * step 7 on every ref separately and not trust "ours"
643 * and "theirs" any more.
646 post_assign_shallow(info
, &pi
.ref_bitmap
, ref_status
);
648 clear_ref_bitmap(&pi
.ref_bitmap
);
649 for (i
= 0; i
< pi
.pool_count
; i
++)
655 struct commit_array
{
656 struct commit
**commits
;
660 static int add_ref(const char *refname
, const struct object_id
*oid
,
661 int flags
, void *cb_data
)
663 struct commit_array
*ca
= cb_data
;
664 ALLOC_GROW(ca
->commits
, ca
->nr
+ 1, ca
->alloc
);
665 ca
->commits
[ca
->nr
] = lookup_commit_reference_gently(oid
, 1);
666 if (ca
->commits
[ca
->nr
])
671 static void update_refstatus(int *ref_status
, int nr
, uint32_t *bitmap
)
676 for (i
= 0; i
< nr
; i
++)
677 if (bitmap
[i
/ 32] & (1U << (i
% 32)))
682 * Step 7, reachability test on "ours" at commit level
684 static void post_assign_shallow(struct shallow_info
*info
,
685 struct ref_bitmap
*ref_bitmap
,
688 struct object_id
*oid
= info
->shallow
->oid
;
692 int bitmap_nr
= DIV_ROUND_UP(info
->ref
->nr
, 32);
693 struct commit_array ca
;
695 trace_printf_key(&trace_shallow
, "shallow: post_assign_shallow\n");
697 memset(ref_status
, 0, sizeof(*ref_status
) * info
->ref
->nr
);
699 /* Remove unreachable shallow commits from "theirs" */
700 for (i
= dst
= 0; i
< info
->nr_theirs
; i
++) {
702 info
->theirs
[dst
] = info
->theirs
[i
];
703 c
= lookup_commit(&oid
[info
->theirs
[i
]]);
704 bitmap
= ref_bitmap_at(ref_bitmap
, c
);
707 for (j
= 0; j
< bitmap_nr
; j
++)
709 update_refstatus(ref_status
, info
->ref
->nr
, *bitmap
);
714 info
->nr_theirs
= dst
;
716 memset(&ca
, 0, sizeof(ca
));
717 head_ref(add_ref
, &ca
);
718 for_each_ref(add_ref
, &ca
);
720 /* Remove unreachable shallow commits from "ours" */
721 for (i
= dst
= 0; i
< info
->nr_ours
; i
++) {
723 info
->ours
[dst
] = info
->ours
[i
];
724 c
= lookup_commit(&oid
[info
->ours
[i
]]);
725 bitmap
= ref_bitmap_at(ref_bitmap
, c
);
728 for (j
= 0; j
< bitmap_nr
; j
++)
730 /* Step 7, reachability test at commit level */
731 !in_merge_bases_many(c
, ca
.nr
, ca
.commits
)) {
732 update_refstatus(ref_status
, info
->ref
->nr
, *bitmap
);
742 /* (Delayed) step 7, reachability test at commit level */
743 int delayed_reachability_test(struct shallow_info
*si
, int c
)
745 if (si
->need_reachability_test
[c
]) {
746 struct commit
*commit
= lookup_commit(&si
->shallow
->oid
[c
]);
749 struct commit_array ca
;
751 memset(&ca
, 0, sizeof(ca
));
752 head_ref(add_ref
, &ca
);
753 for_each_ref(add_ref
, &ca
);
754 si
->commits
= ca
.commits
;
755 si
->nr_commits
= ca
.nr
;
758 si
->reachable
[c
] = in_merge_bases_many(commit
,
761 si
->need_reachability_test
[c
] = 0;
763 return si
->reachable
[c
];