archive: release refname after use
[git/debian.git] / fetch-pack.c
blobb10c4323155b77f2ef271564cef862147a880596
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "lockfile.h"
5 #include "refs.h"
6 #include "pkt-line.h"
7 #include "commit.h"
8 #include "tag.h"
9 #include "exec-cmd.h"
10 #include "pack.h"
11 #include "sideband.h"
12 #include "fetch-pack.h"
13 #include "remote.h"
14 #include "run-command.h"
15 #include "connect.h"
16 #include "transport.h"
17 #include "version.h"
18 #include "oid-array.h"
19 #include "oidset.h"
20 #include "packfile.h"
21 #include "object-store.h"
22 #include "connected.h"
23 #include "fetch-negotiator.h"
24 #include "fsck.h"
25 #include "shallow.h"
27 static int transfer_unpack_limit = -1;
28 static int fetch_unpack_limit = -1;
29 static int unpack_limit = 100;
30 static int prefer_ofs_delta = 1;
31 static int no_done;
32 static int deepen_since_ok;
33 static int deepen_not_ok;
34 static int fetch_fsck_objects = -1;
35 static int transfer_fsck_objects = -1;
36 static int agent_supported;
37 static int server_supports_filtering;
38 static struct shallow_lock shallow_lock;
39 static const char *alternate_shallow_file;
40 static struct strbuf fsck_msg_types = STRBUF_INIT;
41 static struct string_list uri_protocols = STRING_LIST_INIT_DUP;
43 /* Remember to update object flag allocation in object.h */
44 #define COMPLETE (1U << 0)
45 #define ALTERNATE (1U << 1)
48 * After sending this many "have"s if we do not get any new ACK , we
49 * give up traversing our history.
51 #define MAX_IN_VAIN 256
53 static int multi_ack, use_sideband;
54 /* Allow specifying sha1 if it is a ref tip. */
55 #define ALLOW_TIP_SHA1 01
56 /* Allow request of a sha1 if it is reachable from a ref (possibly hidden ref). */
57 #define ALLOW_REACHABLE_SHA1 02
58 static unsigned int allow_unadvertised_object_request;
60 __attribute__((format (printf, 2, 3)))
61 static inline void print_verbose(const struct fetch_pack_args *args,
62 const char *fmt, ...)
64 va_list params;
66 if (!args->verbose)
67 return;
69 va_start(params, fmt);
70 vfprintf(stderr, fmt, params);
71 va_end(params);
72 fputc('\n', stderr);
75 struct alternate_object_cache {
76 struct object **items;
77 size_t nr, alloc;
80 static void cache_one_alternate(const struct object_id *oid,
81 void *vcache)
83 struct alternate_object_cache *cache = vcache;
84 struct object *obj = parse_object(the_repository, oid);
86 if (!obj || (obj->flags & ALTERNATE))
87 return;
89 obj->flags |= ALTERNATE;
90 ALLOC_GROW(cache->items, cache->nr + 1, cache->alloc);
91 cache->items[cache->nr++] = obj;
94 static void for_each_cached_alternate(struct fetch_negotiator *negotiator,
95 void (*cb)(struct fetch_negotiator *,
96 struct object *))
98 static int initialized;
99 static struct alternate_object_cache cache;
100 size_t i;
102 if (!initialized) {
103 for_each_alternate_ref(cache_one_alternate, &cache);
104 initialized = 1;
107 for (i = 0; i < cache.nr; i++)
108 cb(negotiator, cache.items[i]);
111 static struct commit *deref_without_lazy_fetch(const struct object_id *oid,
112 int mark_tags_complete)
114 enum object_type type;
115 struct object_info info = { .typep = &type };
117 while (1) {
118 if (oid_object_info_extended(the_repository, oid, &info,
119 OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_QUICK))
120 return NULL;
121 if (type == OBJ_TAG) {
122 struct tag *tag = (struct tag *)
123 parse_object(the_repository, oid);
125 if (!tag->tagged)
126 return NULL;
127 if (mark_tags_complete)
128 tag->object.flags |= COMPLETE;
129 oid = &tag->tagged->oid;
130 } else {
131 break;
134 if (type == OBJ_COMMIT)
135 return (struct commit *) parse_object(the_repository, oid);
136 return NULL;
139 static int rev_list_insert_ref(struct fetch_negotiator *negotiator,
140 const struct object_id *oid)
142 struct commit *c = deref_without_lazy_fetch(oid, 0);
144 if (c)
145 negotiator->add_tip(negotiator, c);
146 return 0;
149 static int rev_list_insert_ref_oid(const char *refname, const struct object_id *oid,
150 int flag, void *cb_data)
152 return rev_list_insert_ref(cb_data, oid);
155 enum ack_type {
156 NAK = 0,
157 ACK,
158 ACK_continue,
159 ACK_common,
160 ACK_ready
163 static void consume_shallow_list(struct fetch_pack_args *args,
164 struct packet_reader *reader)
166 if (args->stateless_rpc && args->deepen) {
167 /* If we sent a depth we will get back "duplicate"
168 * shallow and unshallow commands every time there
169 * is a block of have lines exchanged.
171 while (packet_reader_read(reader) == PACKET_READ_NORMAL) {
172 if (starts_with(reader->line, "shallow "))
173 continue;
174 if (starts_with(reader->line, "unshallow "))
175 continue;
176 die(_("git fetch-pack: expected shallow list"));
178 if (reader->status != PACKET_READ_FLUSH)
179 die(_("git fetch-pack: expected a flush packet after shallow list"));
183 static enum ack_type get_ack(struct packet_reader *reader,
184 struct object_id *result_oid)
186 int len;
187 const char *arg;
189 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
190 die(_("git fetch-pack: expected ACK/NAK, got a flush packet"));
191 len = reader->pktlen;
193 if (!strcmp(reader->line, "NAK"))
194 return NAK;
195 if (skip_prefix(reader->line, "ACK ", &arg)) {
196 const char *p;
197 if (!parse_oid_hex(arg, result_oid, &p)) {
198 len -= p - reader->line;
199 if (len < 1)
200 return ACK;
201 if (strstr(p, "continue"))
202 return ACK_continue;
203 if (strstr(p, "common"))
204 return ACK_common;
205 if (strstr(p, "ready"))
206 return ACK_ready;
207 return ACK;
210 die(_("git fetch-pack: expected ACK/NAK, got '%s'"), reader->line);
213 static void send_request(struct fetch_pack_args *args,
214 int fd, struct strbuf *buf)
216 if (args->stateless_rpc) {
217 send_sideband(fd, -1, buf->buf, buf->len, LARGE_PACKET_MAX);
218 packet_flush(fd);
219 } else {
220 if (write_in_full(fd, buf->buf, buf->len) < 0)
221 die_errno(_("unable to write to remote"));
225 static void insert_one_alternate_object(struct fetch_negotiator *negotiator,
226 struct object *obj)
228 rev_list_insert_ref(negotiator, &obj->oid);
231 #define INITIAL_FLUSH 16
232 #define PIPESAFE_FLUSH 32
233 #define LARGE_FLUSH 16384
235 static int next_flush(int stateless_rpc, int count)
237 if (stateless_rpc) {
238 if (count < LARGE_FLUSH)
239 count <<= 1;
240 else
241 count = count * 11 / 10;
242 } else {
243 if (count < PIPESAFE_FLUSH)
244 count <<= 1;
245 else
246 count += PIPESAFE_FLUSH;
248 return count;
251 static void mark_tips(struct fetch_negotiator *negotiator,
252 const struct oid_array *negotiation_tips)
254 int i;
256 if (!negotiation_tips) {
257 for_each_rawref(rev_list_insert_ref_oid, negotiator);
258 return;
261 for (i = 0; i < negotiation_tips->nr; i++)
262 rev_list_insert_ref(negotiator, &negotiation_tips->oid[i]);
263 return;
266 static int find_common(struct fetch_negotiator *negotiator,
267 struct fetch_pack_args *args,
268 int fd[2], struct object_id *result_oid,
269 struct ref *refs)
271 int fetching;
272 int count = 0, flushes = 0, flush_at = INITIAL_FLUSH, retval;
273 const struct object_id *oid;
274 unsigned in_vain = 0;
275 int got_continue = 0;
276 int got_ready = 0;
277 struct strbuf req_buf = STRBUF_INIT;
278 size_t state_len = 0;
279 struct packet_reader reader;
281 if (args->stateless_rpc && multi_ack == 1)
282 die(_("--stateless-rpc requires multi_ack_detailed"));
284 packet_reader_init(&reader, fd[0], NULL, 0,
285 PACKET_READ_CHOMP_NEWLINE |
286 PACKET_READ_DIE_ON_ERR_PACKET);
288 mark_tips(negotiator, args->negotiation_tips);
289 for_each_cached_alternate(negotiator, insert_one_alternate_object);
291 fetching = 0;
292 for ( ; refs ; refs = refs->next) {
293 struct object_id *remote = &refs->old_oid;
294 const char *remote_hex;
295 struct object *o;
298 * If that object is complete (i.e. it is an ancestor of a
299 * local ref), we tell them we have it but do not have to
300 * tell them about its ancestors, which they already know
301 * about.
303 * We use lookup_object here because we are only
304 * interested in the case we *know* the object is
305 * reachable and we have already scanned it.
307 if (((o = lookup_object(the_repository, remote)) != NULL) &&
308 (o->flags & COMPLETE)) {
309 continue;
312 remote_hex = oid_to_hex(remote);
313 if (!fetching) {
314 struct strbuf c = STRBUF_INIT;
315 if (multi_ack == 2) strbuf_addstr(&c, " multi_ack_detailed");
316 if (multi_ack == 1) strbuf_addstr(&c, " multi_ack");
317 if (no_done) strbuf_addstr(&c, " no-done");
318 if (use_sideband == 2) strbuf_addstr(&c, " side-band-64k");
319 if (use_sideband == 1) strbuf_addstr(&c, " side-band");
320 if (args->deepen_relative) strbuf_addstr(&c, " deepen-relative");
321 if (args->use_thin_pack) strbuf_addstr(&c, " thin-pack");
322 if (args->no_progress) strbuf_addstr(&c, " no-progress");
323 if (args->include_tag) strbuf_addstr(&c, " include-tag");
324 if (prefer_ofs_delta) strbuf_addstr(&c, " ofs-delta");
325 if (deepen_since_ok) strbuf_addstr(&c, " deepen-since");
326 if (deepen_not_ok) strbuf_addstr(&c, " deepen-not");
327 if (agent_supported) strbuf_addf(&c, " agent=%s",
328 git_user_agent_sanitized());
329 if (args->filter_options.choice)
330 strbuf_addstr(&c, " filter");
331 packet_buf_write(&req_buf, "want %s%s\n", remote_hex, c.buf);
332 strbuf_release(&c);
333 } else
334 packet_buf_write(&req_buf, "want %s\n", remote_hex);
335 fetching++;
338 if (!fetching) {
339 strbuf_release(&req_buf);
340 packet_flush(fd[1]);
341 return 1;
344 if (is_repository_shallow(the_repository))
345 write_shallow_commits(&req_buf, 1, NULL);
346 if (args->depth > 0)
347 packet_buf_write(&req_buf, "deepen %d", args->depth);
348 if (args->deepen_since) {
349 timestamp_t max_age = approxidate(args->deepen_since);
350 packet_buf_write(&req_buf, "deepen-since %"PRItime, max_age);
352 if (args->deepen_not) {
353 int i;
354 for (i = 0; i < args->deepen_not->nr; i++) {
355 struct string_list_item *s = args->deepen_not->items + i;
356 packet_buf_write(&req_buf, "deepen-not %s", s->string);
359 if (server_supports_filtering && args->filter_options.choice) {
360 const char *spec =
361 expand_list_objects_filter_spec(&args->filter_options);
362 packet_buf_write(&req_buf, "filter %s", spec);
364 packet_buf_flush(&req_buf);
365 state_len = req_buf.len;
367 if (args->deepen) {
368 const char *arg;
369 struct object_id oid;
371 send_request(args, fd[1], &req_buf);
372 while (packet_reader_read(&reader) == PACKET_READ_NORMAL) {
373 if (skip_prefix(reader.line, "shallow ", &arg)) {
374 if (get_oid_hex(arg, &oid))
375 die(_("invalid shallow line: %s"), reader.line);
376 register_shallow(the_repository, &oid);
377 continue;
379 if (skip_prefix(reader.line, "unshallow ", &arg)) {
380 if (get_oid_hex(arg, &oid))
381 die(_("invalid unshallow line: %s"), reader.line);
382 if (!lookup_object(the_repository, &oid))
383 die(_("object not found: %s"), reader.line);
384 /* make sure that it is parsed as shallow */
385 if (!parse_object(the_repository, &oid))
386 die(_("error in object: %s"), reader.line);
387 if (unregister_shallow(&oid))
388 die(_("no shallow found: %s"), reader.line);
389 continue;
391 die(_("expected shallow/unshallow, got %s"), reader.line);
393 } else if (!args->stateless_rpc)
394 send_request(args, fd[1], &req_buf);
396 if (!args->stateless_rpc) {
397 /* If we aren't using the stateless-rpc interface
398 * we don't need to retain the headers.
400 strbuf_setlen(&req_buf, 0);
401 state_len = 0;
404 trace2_region_enter("fetch-pack", "negotiation_v0_v1", the_repository);
405 flushes = 0;
406 retval = -1;
407 while ((oid = negotiator->next(negotiator))) {
408 packet_buf_write(&req_buf, "have %s\n", oid_to_hex(oid));
409 print_verbose(args, "have %s", oid_to_hex(oid));
410 in_vain++;
411 if (flush_at <= ++count) {
412 int ack;
414 packet_buf_flush(&req_buf);
415 send_request(args, fd[1], &req_buf);
416 strbuf_setlen(&req_buf, state_len);
417 flushes++;
418 flush_at = next_flush(args->stateless_rpc, count);
421 * We keep one window "ahead" of the other side, and
422 * will wait for an ACK only on the next one
424 if (!args->stateless_rpc && count == INITIAL_FLUSH)
425 continue;
427 consume_shallow_list(args, &reader);
428 do {
429 ack = get_ack(&reader, result_oid);
430 if (ack)
431 print_verbose(args, _("got %s %d %s"), "ack",
432 ack, oid_to_hex(result_oid));
433 switch (ack) {
434 case ACK:
435 flushes = 0;
436 multi_ack = 0;
437 retval = 0;
438 goto done;
439 case ACK_common:
440 case ACK_ready:
441 case ACK_continue: {
442 struct commit *commit =
443 lookup_commit(the_repository,
444 result_oid);
445 int was_common;
447 if (!commit)
448 die(_("invalid commit %s"), oid_to_hex(result_oid));
449 was_common = negotiator->ack(negotiator, commit);
450 if (args->stateless_rpc
451 && ack == ACK_common
452 && !was_common) {
453 /* We need to replay the have for this object
454 * on the next RPC request so the peer knows
455 * it is in common with us.
457 const char *hex = oid_to_hex(result_oid);
458 packet_buf_write(&req_buf, "have %s\n", hex);
459 state_len = req_buf.len;
461 * Reset in_vain because an ack
462 * for this commit has not been
463 * seen.
465 in_vain = 0;
466 } else if (!args->stateless_rpc
467 || ack != ACK_common)
468 in_vain = 0;
469 retval = 0;
470 got_continue = 1;
471 if (ack == ACK_ready)
472 got_ready = 1;
473 break;
476 } while (ack);
477 flushes--;
478 if (got_continue && MAX_IN_VAIN < in_vain) {
479 print_verbose(args, _("giving up"));
480 break; /* give up */
482 if (got_ready)
483 break;
486 done:
487 trace2_region_leave("fetch-pack", "negotiation_v0_v1", the_repository);
488 if (!got_ready || !no_done) {
489 packet_buf_write(&req_buf, "done\n");
490 send_request(args, fd[1], &req_buf);
492 print_verbose(args, _("done"));
493 if (retval != 0) {
494 multi_ack = 0;
495 flushes++;
497 strbuf_release(&req_buf);
499 if (!got_ready || !no_done)
500 consume_shallow_list(args, &reader);
501 while (flushes || multi_ack) {
502 int ack = get_ack(&reader, result_oid);
503 if (ack) {
504 print_verbose(args, _("got %s (%d) %s"), "ack",
505 ack, oid_to_hex(result_oid));
506 if (ack == ACK)
507 return 0;
508 multi_ack = 1;
509 continue;
511 flushes--;
513 /* it is no error to fetch into a completely empty repo */
514 return count ? retval : 0;
517 static struct commit_list *complete;
519 static int mark_complete(const struct object_id *oid)
521 struct commit *commit = deref_without_lazy_fetch(oid, 1);
523 if (commit && !(commit->object.flags & COMPLETE)) {
524 commit->object.flags |= COMPLETE;
525 commit_list_insert(commit, &complete);
527 return 0;
530 static int mark_complete_oid(const char *refname, const struct object_id *oid,
531 int flag, void *cb_data)
533 return mark_complete(oid);
536 static void mark_recent_complete_commits(struct fetch_pack_args *args,
537 timestamp_t cutoff)
539 while (complete && cutoff <= complete->item->date) {
540 print_verbose(args, _("Marking %s as complete"),
541 oid_to_hex(&complete->item->object.oid));
542 pop_most_recent_commit(&complete, COMPLETE);
546 static void add_refs_to_oidset(struct oidset *oids, struct ref *refs)
548 for (; refs; refs = refs->next)
549 oidset_insert(oids, &refs->old_oid);
552 static int is_unmatched_ref(const struct ref *ref)
554 struct object_id oid;
555 const char *p;
556 return ref->match_status == REF_NOT_MATCHED &&
557 !parse_oid_hex(ref->name, &oid, &p) &&
558 *p == '\0' &&
559 oideq(&oid, &ref->old_oid);
562 static void filter_refs(struct fetch_pack_args *args,
563 struct ref **refs,
564 struct ref **sought, int nr_sought)
566 struct ref *newlist = NULL;
567 struct ref **newtail = &newlist;
568 struct ref *unmatched = NULL;
569 struct ref *ref, *next;
570 struct oidset tip_oids = OIDSET_INIT;
571 int i;
572 int strict = !(allow_unadvertised_object_request &
573 (ALLOW_TIP_SHA1 | ALLOW_REACHABLE_SHA1));
575 i = 0;
576 for (ref = *refs; ref; ref = next) {
577 int keep = 0;
578 next = ref->next;
580 if (starts_with(ref->name, "refs/") &&
581 check_refname_format(ref->name, 0)) {
583 * trash or a peeled value; do not even add it to
584 * unmatched list
586 free_one_ref(ref);
587 continue;
588 } else {
589 while (i < nr_sought) {
590 int cmp = strcmp(ref->name, sought[i]->name);
591 if (cmp < 0)
592 break; /* definitely do not have it */
593 else if (cmp == 0) {
594 keep = 1; /* definitely have it */
595 sought[i]->match_status = REF_MATCHED;
597 i++;
600 if (!keep && args->fetch_all &&
601 (!args->deepen || !starts_with(ref->name, "refs/tags/")))
602 keep = 1;
605 if (keep) {
606 *newtail = ref;
607 ref->next = NULL;
608 newtail = &ref->next;
609 } else {
610 ref->next = unmatched;
611 unmatched = ref;
615 if (strict) {
616 for (i = 0; i < nr_sought; i++) {
617 ref = sought[i];
618 if (!is_unmatched_ref(ref))
619 continue;
621 add_refs_to_oidset(&tip_oids, unmatched);
622 add_refs_to_oidset(&tip_oids, newlist);
623 break;
627 /* Append unmatched requests to the list */
628 for (i = 0; i < nr_sought; i++) {
629 ref = sought[i];
630 if (!is_unmatched_ref(ref))
631 continue;
633 if (!strict || oidset_contains(&tip_oids, &ref->old_oid)) {
634 ref->match_status = REF_MATCHED;
635 *newtail = copy_ref(ref);
636 newtail = &(*newtail)->next;
637 } else {
638 ref->match_status = REF_UNADVERTISED_NOT_ALLOWED;
642 oidset_clear(&tip_oids);
643 free_refs(unmatched);
645 *refs = newlist;
648 static void mark_alternate_complete(struct fetch_negotiator *unused,
649 struct object *obj)
651 mark_complete(&obj->oid);
654 struct loose_object_iter {
655 struct oidset *loose_object_set;
656 struct ref *refs;
660 * Mark recent commits available locally and reachable from a local ref as
661 * COMPLETE.
663 * The cutoff time for recency is determined by this heuristic: it is the
664 * earliest commit time of the objects in refs that are commits and that we know
665 * the commit time of.
667 static void mark_complete_and_common_ref(struct fetch_negotiator *negotiator,
668 struct fetch_pack_args *args,
669 struct ref **refs)
671 struct ref *ref;
672 int old_save_commit_buffer = save_commit_buffer;
673 timestamp_t cutoff = 0;
675 save_commit_buffer = 0;
677 trace2_region_enter("fetch-pack", "parse_remote_refs_and_find_cutoff", NULL);
678 for (ref = *refs; ref; ref = ref->next) {
679 struct object *o;
681 if (!has_object_file_with_flags(&ref->old_oid,
682 OBJECT_INFO_QUICK |
683 OBJECT_INFO_SKIP_FETCH_OBJECT))
684 continue;
685 o = parse_object(the_repository, &ref->old_oid);
686 if (!o)
687 continue;
690 * We already have it -- which may mean that we were
691 * in sync with the other side at some time after
692 * that (it is OK if we guess wrong here).
694 if (o->type == OBJ_COMMIT) {
695 struct commit *commit = (struct commit *)o;
696 if (!cutoff || cutoff < commit->date)
697 cutoff = commit->date;
700 trace2_region_leave("fetch-pack", "parse_remote_refs_and_find_cutoff", NULL);
703 * This block marks all local refs as COMPLETE, and then recursively marks all
704 * parents of those refs as COMPLETE.
706 trace2_region_enter("fetch-pack", "mark_complete_local_refs", NULL);
707 if (!args->deepen) {
708 for_each_rawref(mark_complete_oid, NULL);
709 for_each_cached_alternate(NULL, mark_alternate_complete);
710 commit_list_sort_by_date(&complete);
711 if (cutoff)
712 mark_recent_complete_commits(args, cutoff);
714 trace2_region_leave("fetch-pack", "mark_complete_local_refs", NULL);
717 * Mark all complete remote refs as common refs.
718 * Don't mark them common yet; the server has to be told so first.
720 trace2_region_enter("fetch-pack", "mark_common_remote_refs", NULL);
721 for (ref = *refs; ref; ref = ref->next) {
722 struct commit *c = deref_without_lazy_fetch(&ref->old_oid, 0);
724 if (!c || !(c->object.flags & COMPLETE))
725 continue;
727 negotiator->known_common(negotiator, c);
729 trace2_region_leave("fetch-pack", "mark_common_remote_refs", NULL);
731 save_commit_buffer = old_save_commit_buffer;
735 * Returns 1 if every object pointed to by the given remote refs is available
736 * locally and reachable from a local ref, and 0 otherwise.
738 static int everything_local(struct fetch_pack_args *args,
739 struct ref **refs)
741 struct ref *ref;
742 int retval;
744 for (retval = 1, ref = *refs; ref ; ref = ref->next) {
745 const struct object_id *remote = &ref->old_oid;
746 struct object *o;
748 o = lookup_object(the_repository, remote);
749 if (!o || !(o->flags & COMPLETE)) {
750 retval = 0;
751 print_verbose(args, "want %s (%s)", oid_to_hex(remote),
752 ref->name);
753 continue;
755 print_verbose(args, _("already have %s (%s)"), oid_to_hex(remote),
756 ref->name);
759 return retval;
762 static int sideband_demux(int in, int out, void *data)
764 int *xd = data;
765 int ret;
767 ret = recv_sideband("fetch-pack", xd[0], out);
768 close(out);
769 return ret;
772 static void write_promisor_file(const char *keep_name,
773 struct ref **sought, int nr_sought)
775 struct strbuf promisor_name = STRBUF_INIT;
776 int suffix_stripped;
777 FILE *output;
778 int i;
780 strbuf_addstr(&promisor_name, keep_name);
781 suffix_stripped = strbuf_strip_suffix(&promisor_name, ".keep");
782 if (!suffix_stripped)
783 BUG("name of pack lockfile should end with .keep (was '%s')",
784 keep_name);
785 strbuf_addstr(&promisor_name, ".promisor");
787 output = xfopen(promisor_name.buf, "w");
788 for (i = 0; i < nr_sought; i++)
789 fprintf(output, "%s %s\n", oid_to_hex(&sought[i]->old_oid),
790 sought[i]->name);
791 fclose(output);
793 strbuf_release(&promisor_name);
797 * Pass 1 as "only_packfile" if the pack received is the only pack in this
798 * fetch request (that is, if there were no packfile URIs provided).
800 static int get_pack(struct fetch_pack_args *args,
801 int xd[2], struct string_list *pack_lockfiles,
802 int only_packfile,
803 struct ref **sought, int nr_sought)
805 struct async demux;
806 int do_keep = args->keep_pack;
807 const char *cmd_name;
808 struct pack_header header;
809 int pass_header = 0;
810 struct child_process cmd = CHILD_PROCESS_INIT;
811 int ret;
813 memset(&demux, 0, sizeof(demux));
814 if (use_sideband) {
815 /* xd[] is talking with upload-pack; subprocess reads from
816 * xd[0], spits out band#2 to stderr, and feeds us band#1
817 * through demux->out.
819 demux.proc = sideband_demux;
820 demux.data = xd;
821 demux.out = -1;
822 demux.isolate_sigpipe = 1;
823 if (start_async(&demux))
824 die(_("fetch-pack: unable to fork off sideband demultiplexer"));
826 else
827 demux.out = xd[0];
829 if (!args->keep_pack && unpack_limit) {
831 if (read_pack_header(demux.out, &header))
832 die(_("protocol error: bad pack header"));
833 pass_header = 1;
834 if (ntohl(header.hdr_entries) < unpack_limit)
835 do_keep = 0;
836 else
837 do_keep = 1;
840 if (alternate_shallow_file) {
841 strvec_push(&cmd.args, "--shallow-file");
842 strvec_push(&cmd.args, alternate_shallow_file);
845 if (do_keep || args->from_promisor) {
846 if (pack_lockfiles)
847 cmd.out = -1;
848 cmd_name = "index-pack";
849 strvec_push(&cmd.args, cmd_name);
850 strvec_push(&cmd.args, "--stdin");
851 if (!args->quiet && !args->no_progress)
852 strvec_push(&cmd.args, "-v");
853 if (args->use_thin_pack)
854 strvec_push(&cmd.args, "--fix-thin");
855 if (do_keep && (args->lock_pack || unpack_limit)) {
856 char hostname[HOST_NAME_MAX + 1];
857 if (xgethostname(hostname, sizeof(hostname)))
858 xsnprintf(hostname, sizeof(hostname), "localhost");
859 strvec_pushf(&cmd.args,
860 "--keep=fetch-pack %"PRIuMAX " on %s",
861 (uintmax_t)getpid(), hostname);
863 if (only_packfile && args->check_self_contained_and_connected)
864 strvec_push(&cmd.args, "--check-self-contained-and-connected");
865 else
867 * We cannot perform any connectivity checks because
868 * not all packs have been downloaded; let the caller
869 * have this responsibility.
871 args->check_self_contained_and_connected = 0;
873 if (args->from_promisor)
875 * write_promisor_file() may be called afterwards but
876 * we still need index-pack to know that this is a
877 * promisor pack. For example, if transfer.fsckobjects
878 * is true, index-pack needs to know that .gitmodules
879 * is a promisor object (so that it won't complain if
880 * it is missing).
882 strvec_push(&cmd.args, "--promisor");
884 else {
885 cmd_name = "unpack-objects";
886 strvec_push(&cmd.args, cmd_name);
887 if (args->quiet || args->no_progress)
888 strvec_push(&cmd.args, "-q");
889 args->check_self_contained_and_connected = 0;
892 if (pass_header)
893 strvec_pushf(&cmd.args, "--pack_header=%"PRIu32",%"PRIu32,
894 ntohl(header.hdr_version),
895 ntohl(header.hdr_entries));
896 if (fetch_fsck_objects >= 0
897 ? fetch_fsck_objects
898 : transfer_fsck_objects >= 0
899 ? transfer_fsck_objects
900 : 0) {
901 if (args->from_promisor || !only_packfile)
903 * We cannot use --strict in index-pack because it
904 * checks both broken objects and links, but we only
905 * want to check for broken objects.
907 strvec_push(&cmd.args, "--fsck-objects");
908 else
909 strvec_pushf(&cmd.args, "--strict%s",
910 fsck_msg_types.buf);
913 cmd.in = demux.out;
914 cmd.git_cmd = 1;
915 if (start_command(&cmd))
916 die(_("fetch-pack: unable to fork off %s"), cmd_name);
917 if (do_keep && pack_lockfiles) {
918 string_list_append_nodup(pack_lockfiles,
919 index_pack_lockfile(cmd.out));
920 close(cmd.out);
923 if (!use_sideband)
924 /* Closed by start_command() */
925 xd[0] = -1;
927 ret = finish_command(&cmd);
928 if (!ret || (args->check_self_contained_and_connected && ret == 1))
929 args->self_contained_and_connected =
930 args->check_self_contained_and_connected &&
931 ret == 0;
932 else
933 die(_("%s failed"), cmd_name);
934 if (use_sideband && finish_async(&demux))
935 die(_("error in sideband demultiplexer"));
938 * Now that index-pack has succeeded, write the promisor file using the
939 * obtained .keep filename if necessary
941 if (do_keep && pack_lockfiles && pack_lockfiles->nr && args->from_promisor)
942 write_promisor_file(pack_lockfiles->items[0].string, sought, nr_sought);
944 return 0;
947 static int cmp_ref_by_name(const void *a_, const void *b_)
949 const struct ref *a = *((const struct ref **)a_);
950 const struct ref *b = *((const struct ref **)b_);
951 return strcmp(a->name, b->name);
954 static struct ref *do_fetch_pack(struct fetch_pack_args *args,
955 int fd[2],
956 const struct ref *orig_ref,
957 struct ref **sought, int nr_sought,
958 struct shallow_info *si,
959 struct string_list *pack_lockfiles)
961 struct repository *r = the_repository;
962 struct ref *ref = copy_ref_list(orig_ref);
963 struct object_id oid;
964 const char *agent_feature;
965 int agent_len;
966 struct fetch_negotiator negotiator_alloc;
967 struct fetch_negotiator *negotiator;
969 negotiator = &negotiator_alloc;
970 fetch_negotiator_init(r, negotiator);
972 sort_ref_list(&ref, ref_compare_name);
973 QSORT(sought, nr_sought, cmp_ref_by_name);
975 if ((agent_feature = server_feature_value("agent", &agent_len))) {
976 agent_supported = 1;
977 if (agent_len)
978 print_verbose(args, _("Server version is %.*s"),
979 agent_len, agent_feature);
982 if (server_supports("shallow"))
983 print_verbose(args, _("Server supports %s"), "shallow");
984 else if (args->depth > 0 || is_repository_shallow(r))
985 die(_("Server does not support shallow clients"));
986 if (args->depth > 0 || args->deepen_since || args->deepen_not)
987 args->deepen = 1;
988 if (server_supports("multi_ack_detailed")) {
989 print_verbose(args, _("Server supports %s"), "multi_ack_detailed");
990 multi_ack = 2;
991 if (server_supports("no-done")) {
992 print_verbose(args, _("Server supports %s"), "no-done");
993 if (args->stateless_rpc)
994 no_done = 1;
997 else if (server_supports("multi_ack")) {
998 print_verbose(args, _("Server supports %s"), "multi_ack");
999 multi_ack = 1;
1001 if (server_supports("side-band-64k")) {
1002 print_verbose(args, _("Server supports %s"), "side-band-64k");
1003 use_sideband = 2;
1005 else if (server_supports("side-band")) {
1006 print_verbose(args, _("Server supports %s"), "side-band");
1007 use_sideband = 1;
1009 if (server_supports("allow-tip-sha1-in-want")) {
1010 print_verbose(args, _("Server supports %s"), "allow-tip-sha1-in-want");
1011 allow_unadvertised_object_request |= ALLOW_TIP_SHA1;
1013 if (server_supports("allow-reachable-sha1-in-want")) {
1014 print_verbose(args, _("Server supports %s"), "allow-reachable-sha1-in-want");
1015 allow_unadvertised_object_request |= ALLOW_REACHABLE_SHA1;
1017 if (server_supports("thin-pack"))
1018 print_verbose(args, _("Server supports %s"), "thin-pack");
1019 else
1020 args->use_thin_pack = 0;
1021 if (server_supports("no-progress"))
1022 print_verbose(args, _("Server supports %s"), "no-progress");
1023 else
1024 args->no_progress = 0;
1025 if (server_supports("include-tag"))
1026 print_verbose(args, _("Server supports %s"), "include-tag");
1027 else
1028 args->include_tag = 0;
1029 if (server_supports("ofs-delta"))
1030 print_verbose(args, _("Server supports %s"), "ofs-delta");
1031 else
1032 prefer_ofs_delta = 0;
1034 if (server_supports("filter")) {
1035 server_supports_filtering = 1;
1036 print_verbose(args, _("Server supports %s"), "filter");
1037 } else if (args->filter_options.choice) {
1038 warning("filtering not recognized by server, ignoring");
1041 if (server_supports("deepen-since")) {
1042 print_verbose(args, _("Server supports %s"), "deepen-since");
1043 deepen_since_ok = 1;
1044 } else if (args->deepen_since)
1045 die(_("Server does not support --shallow-since"));
1046 if (server_supports("deepen-not")) {
1047 print_verbose(args, _("Server supports %s"), "deepen-not");
1048 deepen_not_ok = 1;
1049 } else if (args->deepen_not)
1050 die(_("Server does not support --shallow-exclude"));
1051 if (server_supports("deepen-relative"))
1052 print_verbose(args, _("Server supports %s"), "deepen-relative");
1053 else if (args->deepen_relative)
1054 die(_("Server does not support --deepen"));
1055 if (!server_supports_hash(the_hash_algo->name, NULL))
1056 die(_("Server does not support this repository's object format"));
1058 mark_complete_and_common_ref(negotiator, args, &ref);
1059 filter_refs(args, &ref, sought, nr_sought);
1060 if (everything_local(args, &ref)) {
1061 packet_flush(fd[1]);
1062 goto all_done;
1064 if (find_common(negotiator, args, fd, &oid, ref) < 0)
1065 if (!args->keep_pack)
1066 /* When cloning, it is not unusual to have
1067 * no common commit.
1069 warning(_("no common commits"));
1071 if (args->stateless_rpc)
1072 packet_flush(fd[1]);
1073 if (args->deepen)
1074 setup_alternate_shallow(&shallow_lock, &alternate_shallow_file,
1075 NULL);
1076 else if (si->nr_ours || si->nr_theirs)
1077 alternate_shallow_file = setup_temporary_shallow(si->shallow);
1078 else
1079 alternate_shallow_file = NULL;
1080 if (get_pack(args, fd, pack_lockfiles, 1, sought, nr_sought))
1081 die(_("git fetch-pack: fetch failed."));
1083 all_done:
1084 if (negotiator)
1085 negotiator->release(negotiator);
1086 return ref;
1089 static void add_shallow_requests(struct strbuf *req_buf,
1090 const struct fetch_pack_args *args)
1092 if (is_repository_shallow(the_repository))
1093 write_shallow_commits(req_buf, 1, NULL);
1094 if (args->depth > 0)
1095 packet_buf_write(req_buf, "deepen %d", args->depth);
1096 if (args->deepen_since) {
1097 timestamp_t max_age = approxidate(args->deepen_since);
1098 packet_buf_write(req_buf, "deepen-since %"PRItime, max_age);
1100 if (args->deepen_not) {
1101 int i;
1102 for (i = 0; i < args->deepen_not->nr; i++) {
1103 struct string_list_item *s = args->deepen_not->items + i;
1104 packet_buf_write(req_buf, "deepen-not %s", s->string);
1107 if (args->deepen_relative)
1108 packet_buf_write(req_buf, "deepen-relative\n");
1111 static void add_wants(const struct ref *wants, struct strbuf *req_buf)
1113 int use_ref_in_want = server_supports_feature("fetch", "ref-in-want", 0);
1115 for ( ; wants ; wants = wants->next) {
1116 const struct object_id *remote = &wants->old_oid;
1117 struct object *o;
1120 * If that object is complete (i.e. it is an ancestor of a
1121 * local ref), we tell them we have it but do not have to
1122 * tell them about its ancestors, which they already know
1123 * about.
1125 * We use lookup_object here because we are only
1126 * interested in the case we *know* the object is
1127 * reachable and we have already scanned it.
1129 if (((o = lookup_object(the_repository, remote)) != NULL) &&
1130 (o->flags & COMPLETE)) {
1131 continue;
1134 if (!use_ref_in_want || wants->exact_oid)
1135 packet_buf_write(req_buf, "want %s\n", oid_to_hex(remote));
1136 else
1137 packet_buf_write(req_buf, "want-ref %s\n", wants->name);
1141 static void add_common(struct strbuf *req_buf, struct oidset *common)
1143 struct oidset_iter iter;
1144 const struct object_id *oid;
1145 oidset_iter_init(common, &iter);
1147 while ((oid = oidset_iter_next(&iter))) {
1148 packet_buf_write(req_buf, "have %s\n", oid_to_hex(oid));
1152 static int add_haves(struct fetch_negotiator *negotiator,
1153 int seen_ack,
1154 struct strbuf *req_buf,
1155 int *haves_to_send, int *in_vain)
1157 int ret = 0;
1158 int haves_added = 0;
1159 const struct object_id *oid;
1161 while ((oid = negotiator->next(negotiator))) {
1162 packet_buf_write(req_buf, "have %s\n", oid_to_hex(oid));
1163 if (++haves_added >= *haves_to_send)
1164 break;
1167 *in_vain += haves_added;
1168 if (!haves_added || (seen_ack && *in_vain >= MAX_IN_VAIN)) {
1169 /* Send Done */
1170 packet_buf_write(req_buf, "done\n");
1171 ret = 1;
1174 /* Increase haves to send on next round */
1175 *haves_to_send = next_flush(1, *haves_to_send);
1177 return ret;
1180 static int send_fetch_request(struct fetch_negotiator *negotiator, int fd_out,
1181 struct fetch_pack_args *args,
1182 const struct ref *wants, struct oidset *common,
1183 int *haves_to_send, int *in_vain,
1184 int sideband_all, int seen_ack)
1186 int ret = 0;
1187 const char *hash_name;
1188 struct strbuf req_buf = STRBUF_INIT;
1190 if (server_supports_v2("fetch", 1))
1191 packet_buf_write(&req_buf, "command=fetch");
1192 if (server_supports_v2("agent", 0))
1193 packet_buf_write(&req_buf, "agent=%s", git_user_agent_sanitized());
1194 if (args->server_options && args->server_options->nr &&
1195 server_supports_v2("server-option", 1)) {
1196 int i;
1197 for (i = 0; i < args->server_options->nr; i++)
1198 packet_buf_write(&req_buf, "server-option=%s",
1199 args->server_options->items[i].string);
1202 if (server_feature_v2("object-format", &hash_name)) {
1203 int hash_algo = hash_algo_by_name(hash_name);
1204 if (hash_algo_by_ptr(the_hash_algo) != hash_algo)
1205 die(_("mismatched algorithms: client %s; server %s"),
1206 the_hash_algo->name, hash_name);
1207 packet_write_fmt(fd_out, "object-format=%s", the_hash_algo->name);
1208 } else if (hash_algo_by_ptr(the_hash_algo) != GIT_HASH_SHA1) {
1209 die(_("the server does not support algorithm '%s'"),
1210 the_hash_algo->name);
1213 packet_buf_delim(&req_buf);
1214 if (args->use_thin_pack)
1215 packet_buf_write(&req_buf, "thin-pack");
1216 if (args->no_progress)
1217 packet_buf_write(&req_buf, "no-progress");
1218 if (args->include_tag)
1219 packet_buf_write(&req_buf, "include-tag");
1220 if (prefer_ofs_delta)
1221 packet_buf_write(&req_buf, "ofs-delta");
1222 if (sideband_all)
1223 packet_buf_write(&req_buf, "sideband-all");
1225 /* Add shallow-info and deepen request */
1226 if (server_supports_feature("fetch", "shallow", 0))
1227 add_shallow_requests(&req_buf, args);
1228 else if (is_repository_shallow(the_repository) || args->deepen)
1229 die(_("Server does not support shallow requests"));
1231 /* Add filter */
1232 if (server_supports_feature("fetch", "filter", 0) &&
1233 args->filter_options.choice) {
1234 const char *spec =
1235 expand_list_objects_filter_spec(&args->filter_options);
1236 print_verbose(args, _("Server supports filter"));
1237 packet_buf_write(&req_buf, "filter %s", spec);
1238 } else if (args->filter_options.choice) {
1239 warning("filtering not recognized by server, ignoring");
1242 if (server_supports_feature("fetch", "packfile-uris", 0)) {
1243 int i;
1244 struct strbuf to_send = STRBUF_INIT;
1246 for (i = 0; i < uri_protocols.nr; i++) {
1247 const char *s = uri_protocols.items[i].string;
1249 if (!strcmp(s, "https") || !strcmp(s, "http")) {
1250 if (to_send.len)
1251 strbuf_addch(&to_send, ',');
1252 strbuf_addstr(&to_send, s);
1255 if (to_send.len) {
1256 packet_buf_write(&req_buf, "packfile-uris %s",
1257 to_send.buf);
1258 strbuf_release(&to_send);
1262 /* add wants */
1263 add_wants(wants, &req_buf);
1265 /* Add all of the common commits we've found in previous rounds */
1266 add_common(&req_buf, common);
1268 /* Add initial haves */
1269 ret = add_haves(negotiator, seen_ack, &req_buf,
1270 haves_to_send, in_vain);
1272 /* Send request */
1273 packet_buf_flush(&req_buf);
1274 if (write_in_full(fd_out, req_buf.buf, req_buf.len) < 0)
1275 die_errno(_("unable to write request to remote"));
1277 strbuf_release(&req_buf);
1278 return ret;
1282 * Processes a section header in a server's response and checks if it matches
1283 * `section`. If the value of `peek` is 1, the header line will be peeked (and
1284 * not consumed); if 0, the line will be consumed and the function will die if
1285 * the section header doesn't match what was expected.
1287 static int process_section_header(struct packet_reader *reader,
1288 const char *section, int peek)
1290 int ret;
1292 if (packet_reader_peek(reader) != PACKET_READ_NORMAL)
1293 die(_("error reading section header '%s'"), section);
1295 ret = !strcmp(reader->line, section);
1297 if (!peek) {
1298 if (!ret)
1299 die(_("expected '%s', received '%s'"),
1300 section, reader->line);
1301 packet_reader_read(reader);
1304 return ret;
1307 enum common_found {
1309 * No commit was found to be possessed by both the client and the
1310 * server, and "ready" was not received.
1312 NO_COMMON_FOUND,
1315 * At least one commit was found to be possessed by both the client and
1316 * the server, and "ready" was not received.
1318 COMMON_FOUND,
1321 * "ready" was received, indicating that the server is ready to send
1322 * the packfile without any further negotiation.
1324 READY
1327 static enum common_found process_acks(struct fetch_negotiator *negotiator,
1328 struct packet_reader *reader,
1329 struct oidset *common)
1331 /* received */
1332 int received_ready = 0;
1333 int received_ack = 0;
1335 process_section_header(reader, "acknowledgments", 0);
1336 while (packet_reader_read(reader) == PACKET_READ_NORMAL) {
1337 const char *arg;
1339 if (!strcmp(reader->line, "NAK"))
1340 continue;
1342 if (skip_prefix(reader->line, "ACK ", &arg)) {
1343 struct object_id oid;
1344 received_ack = 1;
1345 if (!get_oid_hex(arg, &oid)) {
1346 struct commit *commit;
1347 oidset_insert(common, &oid);
1348 commit = lookup_commit(the_repository, &oid);
1349 if (negotiator)
1350 negotiator->ack(negotiator, commit);
1352 continue;
1355 if (!strcmp(reader->line, "ready")) {
1356 received_ready = 1;
1357 continue;
1360 die(_("unexpected acknowledgment line: '%s'"), reader->line);
1363 if (reader->status != PACKET_READ_FLUSH &&
1364 reader->status != PACKET_READ_DELIM)
1365 die(_("error processing acks: %d"), reader->status);
1368 * If an "acknowledgments" section is sent, a packfile is sent if and
1369 * only if "ready" was sent in this section. The other sections
1370 * ("shallow-info" and "wanted-refs") are sent only if a packfile is
1371 * sent. Therefore, a DELIM is expected if "ready" is sent, and a FLUSH
1372 * otherwise.
1374 if (received_ready && reader->status != PACKET_READ_DELIM)
1375 die(_("expected packfile to be sent after 'ready'"));
1376 if (!received_ready && reader->status != PACKET_READ_FLUSH)
1377 die(_("expected no other sections to be sent after no 'ready'"));
1379 return received_ready ? READY :
1380 (received_ack ? COMMON_FOUND : NO_COMMON_FOUND);
1383 static void receive_shallow_info(struct fetch_pack_args *args,
1384 struct packet_reader *reader,
1385 struct oid_array *shallows,
1386 struct shallow_info *si)
1388 int unshallow_received = 0;
1390 process_section_header(reader, "shallow-info", 0);
1391 while (packet_reader_read(reader) == PACKET_READ_NORMAL) {
1392 const char *arg;
1393 struct object_id oid;
1395 if (skip_prefix(reader->line, "shallow ", &arg)) {
1396 if (get_oid_hex(arg, &oid))
1397 die(_("invalid shallow line: %s"), reader->line);
1398 oid_array_append(shallows, &oid);
1399 continue;
1401 if (skip_prefix(reader->line, "unshallow ", &arg)) {
1402 if (get_oid_hex(arg, &oid))
1403 die(_("invalid unshallow line: %s"), reader->line);
1404 if (!lookup_object(the_repository, &oid))
1405 die(_("object not found: %s"), reader->line);
1406 /* make sure that it is parsed as shallow */
1407 if (!parse_object(the_repository, &oid))
1408 die(_("error in object: %s"), reader->line);
1409 if (unregister_shallow(&oid))
1410 die(_("no shallow found: %s"), reader->line);
1411 unshallow_received = 1;
1412 continue;
1414 die(_("expected shallow/unshallow, got %s"), reader->line);
1417 if (reader->status != PACKET_READ_FLUSH &&
1418 reader->status != PACKET_READ_DELIM)
1419 die(_("error processing shallow info: %d"), reader->status);
1421 if (args->deepen || unshallow_received) {
1423 * Treat these as shallow lines caused by our depth settings.
1424 * In v0, these lines cannot cause refs to be rejected; do the
1425 * same.
1427 int i;
1429 for (i = 0; i < shallows->nr; i++)
1430 register_shallow(the_repository, &shallows->oid[i]);
1431 setup_alternate_shallow(&shallow_lock, &alternate_shallow_file,
1432 NULL);
1433 args->deepen = 1;
1434 } else if (shallows->nr) {
1436 * Treat these as shallow lines caused by the remote being
1437 * shallow. In v0, remote refs that reach these objects are
1438 * rejected (unless --update-shallow is set); do the same.
1440 prepare_shallow_info(si, shallows);
1441 if (si->nr_ours || si->nr_theirs)
1442 alternate_shallow_file =
1443 setup_temporary_shallow(si->shallow);
1444 else
1445 alternate_shallow_file = NULL;
1446 } else {
1447 alternate_shallow_file = NULL;
1451 static int cmp_name_ref(const void *name, const void *ref)
1453 return strcmp(name, (*(struct ref **)ref)->name);
1456 static void receive_wanted_refs(struct packet_reader *reader,
1457 struct ref **sought, int nr_sought)
1459 process_section_header(reader, "wanted-refs", 0);
1460 while (packet_reader_read(reader) == PACKET_READ_NORMAL) {
1461 struct object_id oid;
1462 const char *end;
1463 struct ref **found;
1465 if (parse_oid_hex(reader->line, &oid, &end) || *end++ != ' ')
1466 die(_("expected wanted-ref, got '%s'"), reader->line);
1468 found = bsearch(end, sought, nr_sought, sizeof(*sought),
1469 cmp_name_ref);
1470 if (!found)
1471 die(_("unexpected wanted-ref: '%s'"), reader->line);
1472 oidcpy(&(*found)->old_oid, &oid);
1475 if (reader->status != PACKET_READ_DELIM)
1476 die(_("error processing wanted refs: %d"), reader->status);
1479 static void receive_packfile_uris(struct packet_reader *reader,
1480 struct string_list *uris)
1482 process_section_header(reader, "packfile-uris", 0);
1483 while (packet_reader_read(reader) == PACKET_READ_NORMAL) {
1484 if (reader->pktlen < the_hash_algo->hexsz ||
1485 reader->line[the_hash_algo->hexsz] != ' ')
1486 die("expected '<hash> <uri>', got: %s\n", reader->line);
1488 string_list_append(uris, reader->line);
1490 if (reader->status != PACKET_READ_DELIM)
1491 die("expected DELIM");
1494 enum fetch_state {
1495 FETCH_CHECK_LOCAL = 0,
1496 FETCH_SEND_REQUEST,
1497 FETCH_PROCESS_ACKS,
1498 FETCH_GET_PACK,
1499 FETCH_DONE,
1502 static void do_check_stateless_delimiter(const struct fetch_pack_args *args,
1503 struct packet_reader *reader)
1505 check_stateless_delimiter(args->stateless_rpc, reader,
1506 _("git fetch-pack: expected response end packet"));
1509 static struct ref *do_fetch_pack_v2(struct fetch_pack_args *args,
1510 int fd[2],
1511 const struct ref *orig_ref,
1512 struct ref **sought, int nr_sought,
1513 struct oid_array *shallows,
1514 struct shallow_info *si,
1515 struct string_list *pack_lockfiles)
1517 struct repository *r = the_repository;
1518 struct ref *ref = copy_ref_list(orig_ref);
1519 enum fetch_state state = FETCH_CHECK_LOCAL;
1520 struct oidset common = OIDSET_INIT;
1521 struct packet_reader reader;
1522 int in_vain = 0, negotiation_started = 0;
1523 int haves_to_send = INITIAL_FLUSH;
1524 struct fetch_negotiator negotiator_alloc;
1525 struct fetch_negotiator *negotiator;
1526 int seen_ack = 0;
1527 struct string_list packfile_uris = STRING_LIST_INIT_DUP;
1528 int i;
1530 negotiator = &negotiator_alloc;
1531 fetch_negotiator_init(r, negotiator);
1533 packet_reader_init(&reader, fd[0], NULL, 0,
1534 PACKET_READ_CHOMP_NEWLINE |
1535 PACKET_READ_DIE_ON_ERR_PACKET);
1536 if (git_env_bool("GIT_TEST_SIDEBAND_ALL", 1) &&
1537 server_supports_feature("fetch", "sideband-all", 0)) {
1538 reader.use_sideband = 1;
1539 reader.me = "fetch-pack";
1542 while (state != FETCH_DONE) {
1543 switch (state) {
1544 case FETCH_CHECK_LOCAL:
1545 sort_ref_list(&ref, ref_compare_name);
1546 QSORT(sought, nr_sought, cmp_ref_by_name);
1548 /* v2 supports these by default */
1549 allow_unadvertised_object_request |= ALLOW_REACHABLE_SHA1;
1550 use_sideband = 2;
1551 if (args->depth > 0 || args->deepen_since || args->deepen_not)
1552 args->deepen = 1;
1554 /* Filter 'ref' by 'sought' and those that aren't local */
1555 mark_complete_and_common_ref(negotiator, args, &ref);
1556 filter_refs(args, &ref, sought, nr_sought);
1557 if (everything_local(args, &ref))
1558 state = FETCH_DONE;
1559 else
1560 state = FETCH_SEND_REQUEST;
1562 mark_tips(negotiator, args->negotiation_tips);
1563 for_each_cached_alternate(negotiator,
1564 insert_one_alternate_object);
1565 break;
1566 case FETCH_SEND_REQUEST:
1567 if (!negotiation_started) {
1568 negotiation_started = 1;
1569 trace2_region_enter("fetch-pack",
1570 "negotiation_v2",
1571 the_repository);
1573 if (send_fetch_request(negotiator, fd[1], args, ref,
1574 &common,
1575 &haves_to_send, &in_vain,
1576 reader.use_sideband,
1577 seen_ack))
1578 state = FETCH_GET_PACK;
1579 else
1580 state = FETCH_PROCESS_ACKS;
1581 break;
1582 case FETCH_PROCESS_ACKS:
1583 /* Process ACKs/NAKs */
1584 switch (process_acks(negotiator, &reader, &common)) {
1585 case READY:
1587 * Don't check for response delimiter; get_pack() will
1588 * read the rest of this response.
1590 state = FETCH_GET_PACK;
1591 break;
1592 case COMMON_FOUND:
1593 in_vain = 0;
1594 seen_ack = 1;
1595 /* fallthrough */
1596 case NO_COMMON_FOUND:
1597 do_check_stateless_delimiter(args, &reader);
1598 state = FETCH_SEND_REQUEST;
1599 break;
1601 break;
1602 case FETCH_GET_PACK:
1603 trace2_region_leave("fetch-pack",
1604 "negotiation_v2",
1605 the_repository);
1606 /* Check for shallow-info section */
1607 if (process_section_header(&reader, "shallow-info", 1))
1608 receive_shallow_info(args, &reader, shallows, si);
1610 if (process_section_header(&reader, "wanted-refs", 1))
1611 receive_wanted_refs(&reader, sought, nr_sought);
1613 /* get the pack(s) */
1614 if (process_section_header(&reader, "packfile-uris", 1))
1615 receive_packfile_uris(&reader, &packfile_uris);
1616 process_section_header(&reader, "packfile", 0);
1617 if (get_pack(args, fd, pack_lockfiles,
1618 !packfile_uris.nr, sought, nr_sought))
1619 die(_("git fetch-pack: fetch failed."));
1620 do_check_stateless_delimiter(args, &reader);
1622 state = FETCH_DONE;
1623 break;
1624 case FETCH_DONE:
1625 continue;
1629 for (i = 0; i < packfile_uris.nr; i++) {
1630 struct child_process cmd = CHILD_PROCESS_INIT;
1631 char packname[GIT_MAX_HEXSZ + 1];
1632 const char *uri = packfile_uris.items[i].string +
1633 the_hash_algo->hexsz + 1;
1635 strvec_push(&cmd.args, "http-fetch");
1636 strvec_pushf(&cmd.args, "--packfile=%.*s",
1637 (int) the_hash_algo->hexsz,
1638 packfile_uris.items[i].string);
1639 strvec_push(&cmd.args, uri);
1640 cmd.git_cmd = 1;
1641 cmd.no_stdin = 1;
1642 cmd.out = -1;
1643 if (start_command(&cmd))
1644 die("fetch-pack: unable to spawn http-fetch");
1646 if (read_in_full(cmd.out, packname, 5) < 0 ||
1647 memcmp(packname, "keep\t", 5))
1648 die("fetch-pack: expected keep then TAB at start of http-fetch output");
1650 if (read_in_full(cmd.out, packname,
1651 the_hash_algo->hexsz + 1) < 0 ||
1652 packname[the_hash_algo->hexsz] != '\n')
1653 die("fetch-pack: expected hash then LF at end of http-fetch output");
1655 packname[the_hash_algo->hexsz] = '\0';
1657 close(cmd.out);
1659 if (finish_command(&cmd))
1660 die("fetch-pack: unable to finish http-fetch");
1662 if (memcmp(packfile_uris.items[i].string, packname,
1663 the_hash_algo->hexsz))
1664 die("fetch-pack: pack downloaded from %s does not match expected hash %.*s",
1665 uri, (int) the_hash_algo->hexsz,
1666 packfile_uris.items[i].string);
1668 string_list_append_nodup(pack_lockfiles,
1669 xstrfmt("%s/pack/pack-%s.keep",
1670 get_object_directory(),
1671 packname));
1673 string_list_clear(&packfile_uris, 0);
1675 if (negotiator)
1676 negotiator->release(negotiator);
1678 oidset_clear(&common);
1679 return ref;
1682 static int fetch_pack_config_cb(const char *var, const char *value, void *cb)
1684 if (strcmp(var, "fetch.fsck.skiplist") == 0) {
1685 const char *path;
1687 if (git_config_pathname(&path, var, value))
1688 return 1;
1689 strbuf_addf(&fsck_msg_types, "%cskiplist=%s",
1690 fsck_msg_types.len ? ',' : '=', path);
1691 free((char *)path);
1692 return 0;
1695 if (skip_prefix(var, "fetch.fsck.", &var)) {
1696 if (is_valid_msg_type(var, value))
1697 strbuf_addf(&fsck_msg_types, "%c%s=%s",
1698 fsck_msg_types.len ? ',' : '=', var, value);
1699 else
1700 warning("Skipping unknown msg id '%s'", var);
1701 return 0;
1704 return git_default_config(var, value, cb);
1707 static void fetch_pack_config(void)
1709 git_config_get_int("fetch.unpacklimit", &fetch_unpack_limit);
1710 git_config_get_int("transfer.unpacklimit", &transfer_unpack_limit);
1711 git_config_get_bool("repack.usedeltabaseoffset", &prefer_ofs_delta);
1712 git_config_get_bool("fetch.fsckobjects", &fetch_fsck_objects);
1713 git_config_get_bool("transfer.fsckobjects", &transfer_fsck_objects);
1714 if (!uri_protocols.nr) {
1715 char *str;
1717 if (!git_config_get_string("fetch.uriprotocols", &str) && str) {
1718 string_list_split(&uri_protocols, str, ',', -1);
1719 free(str);
1723 git_config(fetch_pack_config_cb, NULL);
1726 static void fetch_pack_setup(void)
1728 static int did_setup;
1729 if (did_setup)
1730 return;
1731 fetch_pack_config();
1732 if (0 <= transfer_unpack_limit)
1733 unpack_limit = transfer_unpack_limit;
1734 else if (0 <= fetch_unpack_limit)
1735 unpack_limit = fetch_unpack_limit;
1736 did_setup = 1;
1739 static int remove_duplicates_in_refs(struct ref **ref, int nr)
1741 struct string_list names = STRING_LIST_INIT_NODUP;
1742 int src, dst;
1744 for (src = dst = 0; src < nr; src++) {
1745 struct string_list_item *item;
1746 item = string_list_insert(&names, ref[src]->name);
1747 if (item->util)
1748 continue; /* already have it */
1749 item->util = ref[src];
1750 if (src != dst)
1751 ref[dst] = ref[src];
1752 dst++;
1754 for (src = dst; src < nr; src++)
1755 ref[src] = NULL;
1756 string_list_clear(&names, 0);
1757 return dst;
1760 static void update_shallow(struct fetch_pack_args *args,
1761 struct ref **sought, int nr_sought,
1762 struct shallow_info *si)
1764 struct oid_array ref = OID_ARRAY_INIT;
1765 int *status;
1766 int i;
1768 if (args->deepen && alternate_shallow_file) {
1769 if (*alternate_shallow_file == '\0') { /* --unshallow */
1770 unlink_or_warn(git_path_shallow(the_repository));
1771 rollback_shallow_file(the_repository, &shallow_lock);
1772 } else
1773 commit_shallow_file(the_repository, &shallow_lock);
1774 alternate_shallow_file = NULL;
1775 return;
1778 if (!si->shallow || !si->shallow->nr)
1779 return;
1781 if (args->cloning) {
1783 * remote is shallow, but this is a clone, there are
1784 * no objects in repo to worry about. Accept any
1785 * shallow points that exist in the pack (iow in repo
1786 * after get_pack() and reprepare_packed_git())
1788 struct oid_array extra = OID_ARRAY_INIT;
1789 struct object_id *oid = si->shallow->oid;
1790 for (i = 0; i < si->shallow->nr; i++)
1791 if (has_object_file(&oid[i]))
1792 oid_array_append(&extra, &oid[i]);
1793 if (extra.nr) {
1794 setup_alternate_shallow(&shallow_lock,
1795 &alternate_shallow_file,
1796 &extra);
1797 commit_shallow_file(the_repository, &shallow_lock);
1798 alternate_shallow_file = NULL;
1800 oid_array_clear(&extra);
1801 return;
1804 if (!si->nr_ours && !si->nr_theirs)
1805 return;
1807 remove_nonexistent_theirs_shallow(si);
1808 if (!si->nr_ours && !si->nr_theirs)
1809 return;
1810 for (i = 0; i < nr_sought; i++)
1811 oid_array_append(&ref, &sought[i]->old_oid);
1812 si->ref = &ref;
1814 if (args->update_shallow) {
1816 * remote is also shallow, .git/shallow may be updated
1817 * so all refs can be accepted. Make sure we only add
1818 * shallow roots that are actually reachable from new
1819 * refs.
1821 struct oid_array extra = OID_ARRAY_INIT;
1822 struct object_id *oid = si->shallow->oid;
1823 assign_shallow_commits_to_refs(si, NULL, NULL);
1824 if (!si->nr_ours && !si->nr_theirs) {
1825 oid_array_clear(&ref);
1826 return;
1828 for (i = 0; i < si->nr_ours; i++)
1829 oid_array_append(&extra, &oid[si->ours[i]]);
1830 for (i = 0; i < si->nr_theirs; i++)
1831 oid_array_append(&extra, &oid[si->theirs[i]]);
1832 setup_alternate_shallow(&shallow_lock,
1833 &alternate_shallow_file,
1834 &extra);
1835 commit_shallow_file(the_repository, &shallow_lock);
1836 oid_array_clear(&extra);
1837 oid_array_clear(&ref);
1838 alternate_shallow_file = NULL;
1839 return;
1843 * remote is also shallow, check what ref is safe to update
1844 * without updating .git/shallow
1846 status = xcalloc(nr_sought, sizeof(*status));
1847 assign_shallow_commits_to_refs(si, NULL, status);
1848 if (si->nr_ours || si->nr_theirs) {
1849 for (i = 0; i < nr_sought; i++)
1850 if (status[i])
1851 sought[i]->status = REF_STATUS_REJECT_SHALLOW;
1853 free(status);
1854 oid_array_clear(&ref);
1857 static int iterate_ref_map(void *cb_data, struct object_id *oid)
1859 struct ref **rm = cb_data;
1860 struct ref *ref = *rm;
1862 if (!ref)
1863 return -1; /* end of the list */
1864 *rm = ref->next;
1865 oidcpy(oid, &ref->old_oid);
1866 return 0;
1869 struct ref *fetch_pack(struct fetch_pack_args *args,
1870 int fd[],
1871 const struct ref *ref,
1872 struct ref **sought, int nr_sought,
1873 struct oid_array *shallow,
1874 struct string_list *pack_lockfiles,
1875 enum protocol_version version)
1877 struct ref *ref_cpy;
1878 struct shallow_info si;
1879 struct oid_array shallows_scratch = OID_ARRAY_INIT;
1881 fetch_pack_setup();
1882 if (nr_sought)
1883 nr_sought = remove_duplicates_in_refs(sought, nr_sought);
1885 if (version != protocol_v2 && !ref) {
1886 packet_flush(fd[1]);
1887 die(_("no matching remote head"));
1889 if (version == protocol_v2) {
1890 if (shallow->nr)
1891 BUG("Protocol V2 does not provide shallows at this point in the fetch");
1892 memset(&si, 0, sizeof(si));
1893 ref_cpy = do_fetch_pack_v2(args, fd, ref, sought, nr_sought,
1894 &shallows_scratch, &si,
1895 pack_lockfiles);
1896 } else {
1897 prepare_shallow_info(&si, shallow);
1898 ref_cpy = do_fetch_pack(args, fd, ref, sought, nr_sought,
1899 &si, pack_lockfiles);
1901 reprepare_packed_git(the_repository);
1903 if (!args->cloning && args->deepen) {
1904 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1905 struct ref *iterator = ref_cpy;
1906 opt.shallow_file = alternate_shallow_file;
1907 if (args->deepen)
1908 opt.is_deepening_fetch = 1;
1909 if (check_connected(iterate_ref_map, &iterator, &opt)) {
1910 error(_("remote did not send all necessary objects"));
1911 free_refs(ref_cpy);
1912 ref_cpy = NULL;
1913 rollback_shallow_file(the_repository, &shallow_lock);
1914 goto cleanup;
1916 args->connectivity_checked = 1;
1919 update_shallow(args, sought, nr_sought, &si);
1920 cleanup:
1921 clear_shallow_info(&si);
1922 oid_array_clear(&shallows_scratch);
1923 return ref_cpy;
1926 int report_unmatched_refs(struct ref **sought, int nr_sought)
1928 int i, ret = 0;
1930 for (i = 0; i < nr_sought; i++) {
1931 if (!sought[i])
1932 continue;
1933 switch (sought[i]->match_status) {
1934 case REF_MATCHED:
1935 continue;
1936 case REF_NOT_MATCHED:
1937 error(_("no such remote ref %s"), sought[i]->name);
1938 break;
1939 case REF_UNADVERTISED_NOT_ALLOWED:
1940 error(_("Server does not allow request for unadvertised object %s"),
1941 sought[i]->name);
1942 break;
1944 ret = 1;
1946 return ret;