7 #include "sha1-array.h"
10 #include "commit-slab.h"
12 static int is_shallow
= -1;
13 static struct stat 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.
56 stat(path
, &shallow_stat
) ||
57 (fp
= fopen(path
, "r")) == NULL
) {
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 if (parse_commit(commit
))
103 die("invalid commit");
105 if ((depth
!= INFINITE_DEPTH
&& cur_depth
>= depth
) ||
106 (is_repository_shallow() && !commit
->parents
&&
107 (graft
= lookup_commit_graft(commit
->object
.sha1
)) != NULL
&&
108 graft
->nr_parent
< 0)) {
109 commit_list_insert(commit
, &result
);
110 commit
->object
.flags
|= shallow_flag
;
114 commit
->object
.flags
|= not_shallow_flag
;
115 for (p
= commit
->parents
, commit
= NULL
; p
; p
= p
->next
) {
116 if (!p
->item
->util
) {
117 int *pointer
= xmalloc(sizeof(int));
118 p
->item
->util
= pointer
;
119 *pointer
= cur_depth
;
121 int *pointer
= p
->item
->util
;
122 if (cur_depth
>= *pointer
)
124 *pointer
= cur_depth
;
127 add_object_array(&p
->item
->object
,
131 cur_depth
= *(int *)commit
->util
;
139 void check_shallow_file_for_update(void)
145 else if (is_shallow
== -1)
146 die("BUG: shallow must be initialized by now");
148 if (stat(git_path("shallow"), &st
))
149 die("shallow file was removed during fetch");
150 else if (st
.st_mtime
!= shallow_stat
.st_mtime
152 || ST_MTIME_NSEC(st
) != ST_MTIME_NSEC(shallow_stat
)
155 die("shallow file was changed during fetch");
161 struct write_shallow_data
{
163 int use_pack_protocol
;
168 static int write_one_shallow(const struct commit_graft
*graft
, void *cb_data
)
170 struct write_shallow_data
*data
= cb_data
;
171 const char *hex
= sha1_to_hex(graft
->sha1
);
172 if (graft
->nr_parent
!= -1)
174 if (data
->flags
& SEEN_ONLY
) {
175 struct commit
*c
= lookup_commit(graft
->sha1
);
176 if (!c
|| !(c
->object
.flags
& SEEN
)) {
177 if (data
->flags
& VERBOSE
)
178 printf("Removing %s from .git/shallow\n",
179 sha1_to_hex(c
->object
.sha1
));
184 if (data
->use_pack_protocol
)
185 packet_buf_write(data
->out
, "shallow %s", hex
);
187 strbuf_addstr(data
->out
, hex
);
188 strbuf_addch(data
->out
, '\n');
193 static int write_shallow_commits_1(struct strbuf
*out
, int use_pack_protocol
,
194 const struct sha1_array
*extra
,
197 struct write_shallow_data data
;
200 data
.use_pack_protocol
= use_pack_protocol
;
203 for_each_commit_graft(write_one_shallow
, &data
);
206 for (i
= 0; i
< extra
->nr
; i
++) {
207 strbuf_addstr(out
, sha1_to_hex(extra
->sha1
[i
]));
208 strbuf_addch(out
, '\n');
214 int write_shallow_commits(struct strbuf
*out
, int use_pack_protocol
,
215 const struct sha1_array
*extra
)
217 return write_shallow_commits_1(out
, use_pack_protocol
, extra
, 0);
220 char *setup_temporary_shallow(const struct sha1_array
*extra
)
222 struct strbuf sb
= STRBUF_INIT
;
225 if (write_shallow_commits(&sb
, 0, extra
)) {
226 struct strbuf path
= STRBUF_INIT
;
227 strbuf_addstr(&path
, git_path("shallow_XXXXXX"));
228 fd
= xmkstemp(path
.buf
);
229 if (write_in_full(fd
, sb
.buf
, sb
.len
) != sb
.len
)
230 die_errno("failed to write to %s",
234 return strbuf_detach(&path
, NULL
);
237 * is_repository_shallow() sees empty string as "no shallow
243 void setup_alternate_shallow(struct lock_file
*shallow_lock
,
244 const char **alternate_shallow_file
,
245 const struct sha1_array
*extra
)
247 struct strbuf sb
= STRBUF_INIT
;
250 check_shallow_file_for_update();
251 fd
= hold_lock_file_for_update(shallow_lock
, git_path("shallow"),
253 if (write_shallow_commits(&sb
, 0, extra
)) {
254 if (write_in_full(fd
, sb
.buf
, sb
.len
) != sb
.len
)
255 die_errno("failed to write to %s",
256 shallow_lock
->filename
);
257 *alternate_shallow_file
= shallow_lock
->filename
;
260 * is_repository_shallow() sees empty string as "no
263 *alternate_shallow_file
= "";
267 static int advertise_shallow_grafts_cb(const struct commit_graft
*graft
, void *cb
)
270 if (graft
->nr_parent
== -1)
271 packet_write(fd
, "shallow %s\n", sha1_to_hex(graft
->sha1
));
275 void advertise_shallow_grafts(int fd
)
277 if (!is_repository_shallow())
279 for_each_commit_graft(advertise_shallow_grafts_cb
, &fd
);
283 * mark_reachable_objects() should have been run prior to this and all
284 * reachable commits marked as "SEEN".
286 void prune_shallow(int show_only
)
288 static struct lock_file shallow_lock
;
289 struct strbuf sb
= STRBUF_INIT
;
293 write_shallow_commits_1(&sb
, 0, NULL
, SEEN_ONLY
| VERBOSE
);
297 check_shallow_file_for_update();
298 fd
= hold_lock_file_for_update(&shallow_lock
, git_path("shallow"),
300 if (write_shallow_commits_1(&sb
, 0, NULL
, SEEN_ONLY
)) {
301 if (write_in_full(fd
, sb
.buf
, sb
.len
) != sb
.len
)
302 die_errno("failed to write to %s",
303 shallow_lock
.filename
);
304 commit_lock_file(&shallow_lock
);
306 unlink(git_path("shallow"));
307 rollback_lock_file(&shallow_lock
);
312 #define TRACE_KEY "GIT_TRACE_SHALLOW"
315 * Step 1, split sender shallow commits into "ours" and "theirs"
316 * Step 2, clean "ours" based on .git/shallow
318 void prepare_shallow_info(struct shallow_info
*info
, struct sha1_array
*sa
)
321 trace_printf_key(TRACE_KEY
, "shallow: prepare_shallow_info\n");
322 memset(info
, 0, sizeof(*info
));
326 info
->ours
= xmalloc(sizeof(*info
->ours
) * sa
->nr
);
327 info
->theirs
= xmalloc(sizeof(*info
->theirs
) * sa
->nr
);
328 for (i
= 0; i
< sa
->nr
; i
++) {
329 if (has_sha1_file(sa
->sha1
[i
])) {
330 struct commit_graft
*graft
;
331 graft
= lookup_commit_graft(sa
->sha1
[i
]);
332 if (graft
&& graft
->nr_parent
< 0)
334 info
->ours
[info
->nr_ours
++] = i
;
336 info
->theirs
[info
->nr_theirs
++] = i
;
340 void clear_shallow_info(struct shallow_info
*info
)
346 /* Step 4, remove non-existent ones in "theirs" after getting the pack */
348 void remove_nonexistent_theirs_shallow(struct shallow_info
*info
)
350 unsigned char (*sha1
)[20] = info
->shallow
->sha1
;
352 trace_printf_key(TRACE_KEY
, "shallow: remove_nonexistent_theirs_shallow\n");
353 for (i
= dst
= 0; i
< info
->nr_theirs
; i
++) {
355 info
->theirs
[dst
] = info
->theirs
[i
];
356 if (has_sha1_file(sha1
[info
->theirs
[i
]]))
359 info
->nr_theirs
= dst
;
362 /* Step 5, remove non-existent ones in "ours" in the pack */
363 void remove_nonexistent_ours_in_pack(struct shallow_info
*info
,
364 struct packed_git
*p
)
366 unsigned char (*sha1
)[20] = info
->shallow
->sha1
;
368 trace_printf_key(TRACE_KEY
, "shallow: remove_nonexistent_ours_in_pack\n");
369 for (i
= dst
= 0; i
< info
->nr_ours
; i
++) {
371 info
->ours
[dst
] = info
->ours
[i
];
372 if (find_pack_entry_one(sha1
[info
->ours
[i
]], p
))
378 define_commit_slab(ref_bitmap
, uint32_t *);
381 struct ref_bitmap ref_bitmap
;
388 static uint32_t *paint_alloc(struct paint_info
*info
)
390 unsigned nr
= (info
->nr_bits
+ 31) / 32;
391 unsigned size
= nr
* sizeof(uint32_t);
393 if (!info
->slab_count
|| info
->free
+ size
> info
->end
) {
395 info
->slab
= xrealloc(info
->slab
,
396 info
->slab_count
* sizeof(*info
->slab
));
397 info
->free
= xmalloc(COMMIT_SLAB_SIZE
);
398 info
->slab
[info
->slab_count
- 1] = info
->free
;
399 info
->end
= info
->free
+ COMMIT_SLAB_SIZE
;
407 * Given a commit SHA-1, walk down to parents until either SEEN,
408 * UNINTERESTING or BOTTOM is hit. Set the id-th bit in ref_bitmap for
409 * all walked commits.
411 static void paint_down(struct paint_info
*info
, const unsigned char *sha1
,
415 struct commit_list
*head
= NULL
;
416 int bitmap_nr
= (info
->nr_bits
+ 31) / 32;
417 int bitmap_size
= bitmap_nr
* sizeof(uint32_t);
418 uint32_t *tmp
= xmalloc(bitmap_size
); /* to be freed before return */
419 uint32_t *bitmap
= paint_alloc(info
);
420 struct commit
*c
= lookup_commit_reference_gently(sha1
, 1);
423 memset(bitmap
, 0, bitmap_size
);
424 bitmap
[id
/ 32] |= (1 << (id
% 32));
425 commit_list_insert(c
, &head
);
427 struct commit_list
*p
;
428 struct commit
*c
= head
->item
;
429 uint32_t **refs
= ref_bitmap_at(&info
->ref_bitmap
, c
);
435 /* XXX check "UNINTERESTING" from pack bitmaps if available */
436 if (c
->object
.flags
& (SEEN
| UNINTERESTING
))
439 c
->object
.flags
|= SEEN
;
444 memcpy(tmp
, *refs
, bitmap_size
);
445 for (i
= 0; i
< bitmap_nr
; i
++)
447 if (memcmp(tmp
, *refs
, bitmap_size
)) {
448 *refs
= paint_alloc(info
);
449 memcpy(*refs
, tmp
, bitmap_size
);
453 if (c
->object
.flags
& BOTTOM
)
457 die("unable to parse commit %s",
458 sha1_to_hex(c
->object
.sha1
));
460 for (p
= c
->parents
; p
; p
= p
->next
) {
461 uint32_t **p_refs
= ref_bitmap_at(&info
->ref_bitmap
,
463 if (p
->item
->object
.flags
& SEEN
)
465 if (*p_refs
== NULL
|| *p_refs
== *refs
)
467 commit_list_insert(p
->item
, &head
);
471 nr
= get_max_object_index();
472 for (i
= 0; i
< nr
; i
++) {
473 struct object
*o
= get_indexed_object(i
);
474 if (o
&& o
->type
== OBJ_COMMIT
)
481 static int mark_uninteresting(const char *refname
,
482 const unsigned char *sha1
,
483 int flags
, void *cb_data
)
485 struct commit
*commit
= lookup_commit_reference_gently(sha1
, 1);
488 commit
->object
.flags
|= UNINTERESTING
;
489 mark_parents_uninteresting(commit
);
493 static void post_assign_shallow(struct shallow_info
*info
,
494 struct ref_bitmap
*ref_bitmap
,
497 * Step 6(+7), associate shallow commits with new refs
499 * info->ref must be initialized before calling this function.
501 * If used is not NULL, it's an array of info->shallow->nr
502 * bitmaps. The n-th bit set in the m-th bitmap if ref[n] needs the
503 * m-th shallow commit from info->shallow.
505 * If used is NULL, "ours" and "theirs" are updated. And if ref_status
506 * is not NULL it's an array of ref->nr ints. ref_status[i] is true if
507 * the ref needs some shallow commits from either info->ours or
510 void assign_shallow_commits_to_refs(struct shallow_info
*info
,
511 uint32_t **used
, int *ref_status
)
513 unsigned char (*sha1
)[20] = info
->shallow
->sha1
;
514 struct sha1_array
*ref
= info
->ref
;
516 int *shallow
, nr_shallow
= 0;
517 struct paint_info pi
;
519 trace_printf_key(TRACE_KEY
, "shallow: assign_shallow_commits_to_refs\n");
520 shallow
= xmalloc(sizeof(*shallow
) * (info
->nr_ours
+ info
->nr_theirs
));
521 for (i
= 0; i
< info
->nr_ours
; i
++)
522 shallow
[nr_shallow
++] = info
->ours
[i
];
523 for (i
= 0; i
< info
->nr_theirs
; i
++)
524 shallow
[nr_shallow
++] = info
->theirs
[i
];
527 * Prepare the commit graph to track what refs can reach what
528 * (new) shallow commits.
530 nr
= get_max_object_index();
531 for (i
= 0; i
< nr
; i
++) {
532 struct object
*o
= get_indexed_object(i
);
533 if (!o
|| o
->type
!= OBJ_COMMIT
)
536 o
->flags
&= ~(UNINTERESTING
| BOTTOM
| SEEN
);
539 memset(&pi
, 0, sizeof(pi
));
540 init_ref_bitmap(&pi
.ref_bitmap
);
541 pi
.nr_bits
= ref
->nr
;
544 * "--not --all" to cut short the traversal if new refs
545 * connect to old refs. If not (e.g. force ref updates) it'll
546 * have to go down to the current shallow commits.
548 head_ref(mark_uninteresting
, NULL
);
549 for_each_ref(mark_uninteresting
, NULL
);
551 /* Mark potential bottoms so we won't go out of bound */
552 for (i
= 0; i
< nr_shallow
; i
++) {
553 struct commit
*c
= lookup_commit(sha1
[shallow
[i
]]);
554 c
->object
.flags
|= BOTTOM
;
557 for (i
= 0; i
< ref
->nr
; i
++)
558 paint_down(&pi
, ref
->sha1
[i
], i
);
561 int bitmap_size
= ((pi
.nr_bits
+ 31) / 32) * sizeof(uint32_t);
562 memset(used
, 0, sizeof(*used
) * info
->shallow
->nr
);
563 for (i
= 0; i
< nr_shallow
; i
++) {
564 const struct commit
*c
= lookup_commit(sha1
[shallow
[i
]]);
565 uint32_t **map
= ref_bitmap_at(&pi
.ref_bitmap
, c
);
567 used
[shallow
[i
]] = xmemdupz(*map
, bitmap_size
);
570 * unreachable shallow commits are not removed from
571 * "ours" and "theirs". The user is supposed to run
572 * step 7 on every ref separately and not trust "ours"
573 * and "theirs" any more.
576 post_assign_shallow(info
, &pi
.ref_bitmap
, ref_status
);
578 clear_ref_bitmap(&pi
.ref_bitmap
);
579 for (i
= 0; i
< pi
.slab_count
; i
++)
585 struct commit_array
{
586 struct commit
**commits
;
590 static int add_ref(const char *refname
,
591 const unsigned char *sha1
, int flags
, void *cb_data
)
593 struct commit_array
*ca
= cb_data
;
594 ALLOC_GROW(ca
->commits
, ca
->nr
+ 1, ca
->alloc
);
595 ca
->commits
[ca
->nr
] = lookup_commit_reference_gently(sha1
, 1);
596 if (ca
->commits
[ca
->nr
])
601 static void update_refstatus(int *ref_status
, int nr
, uint32_t *bitmap
)
606 for (i
= 0; i
< nr
; i
++)
607 if (bitmap
[i
/ 32] & (1 << (i
% 32)))
612 * Step 7, reachability test on "ours" at commit level
614 static void post_assign_shallow(struct shallow_info
*info
,
615 struct ref_bitmap
*ref_bitmap
,
618 unsigned char (*sha1
)[20] = info
->shallow
->sha1
;
622 int bitmap_nr
= (info
->ref
->nr
+ 31) / 32;
623 struct commit_array ca
;
625 trace_printf_key(TRACE_KEY
, "shallow: post_assign_shallow\n");
627 memset(ref_status
, 0, sizeof(*ref_status
) * info
->ref
->nr
);
629 /* Remove unreachable shallow commits from "theirs" */
630 for (i
= dst
= 0; i
< info
->nr_theirs
; i
++) {
632 info
->theirs
[dst
] = info
->theirs
[i
];
633 c
= lookup_commit(sha1
[info
->theirs
[i
]]);
634 bitmap
= ref_bitmap_at(ref_bitmap
, c
);
637 for (j
= 0; j
< bitmap_nr
; j
++)
639 update_refstatus(ref_status
, info
->ref
->nr
, *bitmap
);
644 info
->nr_theirs
= dst
;
646 memset(&ca
, 0, sizeof(ca
));
647 head_ref(add_ref
, &ca
);
648 for_each_ref(add_ref
, &ca
);
650 /* Remove unreachable shallow commits from "ours" */
651 for (i
= dst
= 0; i
< info
->nr_ours
; i
++) {
653 info
->ours
[dst
] = info
->ours
[i
];
654 c
= lookup_commit(sha1
[info
->ours
[i
]]);
655 bitmap
= ref_bitmap_at(ref_bitmap
, c
);
658 for (j
= 0; j
< bitmap_nr
; j
++)
660 /* Step 7, reachability test at commit level */
661 !in_merge_bases_many(c
, ca
.nr
, ca
.commits
)) {
662 update_refstatus(ref_status
, info
->ref
->nr
, *bitmap
);
672 /* (Delayed) step 7, reachability test at commit level */
673 int delayed_reachability_test(struct shallow_info
*si
, int c
)
675 if (si
->need_reachability_test
[c
]) {
676 struct commit
*commit
= lookup_commit(si
->shallow
->sha1
[c
]);
679 struct commit_array ca
;
680 memset(&ca
, 0, sizeof(ca
));
681 head_ref(add_ref
, &ca
);
682 for_each_ref(add_ref
, &ca
);
683 si
->commits
= ca
.commits
;
684 si
->nr_commits
= ca
.nr
;
687 si
->reachable
[c
] = in_merge_bases_many(commit
,
690 si
->need_reachability_test
[c
] = 0;
692 return si
->reachable
[c
];