6 #include "repository.h"
7 #include "object-store.h"
13 #include "list-objects.h"
14 #include "list-objects-filter.h"
15 #include "list-objects-filter-options.h"
16 #include "run-command.h"
20 #include "string-list.h"
22 #include "prio-queue.h"
25 #include "upload-pack.h"
27 #include "commit-graph.h"
28 #include "commit-reach.h"
31 /* Remember to update object flag allocation in object.h */
32 #define THEY_HAVE (1u << 11)
33 #define OUR_REF (1u << 12)
34 #define WANTED (1u << 13)
35 #define COMMON_KNOWN (1u << 14)
37 #define SHALLOW (1u << 16)
38 #define NOT_SHALLOW (1u << 17)
39 #define CLIENT_SHALLOW (1u << 18)
40 #define HIDDEN_REF (1u << 19)
42 #define ALL_FLAGS (THEY_HAVE | OUR_REF | WANTED | COMMON_KNOWN | SHALLOW | \
43 NOT_SHALLOW | CLIENT_SHALLOW | HIDDEN_REF)
45 /* Enum for allowed unadvertised object request (UOR) */
47 /* Allow specifying sha1 if it is a ref tip. */
48 ALLOW_TIP_SHA1 = 0x01,
49 /* Allow request of a sha1 if it is reachable from a ref (possibly hidden ref). */
50 ALLOW_REACHABLE_SHA1 = 0x02,
51 /* Allow request of any sha1. Implies ALLOW_TIP_SHA1 and ALLOW_REACHABLE_SHA1. */
56 * Please annotate, and if possible group together, fields used only
57 * for protocol v0 or only for protocol v2.
59 struct upload_pack_data {
60 struct string_list symref; /* v0 only */
61 struct object_array want_obj;
62 struct object_array have_obj;
63 struct oid_array haves; /* v2 only */
64 struct string_list wanted_refs; /* v2 only */
66 struct object_array shallows;
67 struct string_list deepen_not;
68 struct object_array extra_edge_obj;
70 timestamp_t deepen_since;
75 timestamp_t oldest_have;
77 unsigned int timeout; /* v0 only */
81 MULTI_ACK_DETAILED = 2
82 } multi_ack; /* v0 only */
84 /* 0 for no sideband, otherwise DEFAULT_PACKET_MAX or LARGE_PACKET_MAX */
87 struct string_list uri_protocols;
88 enum allow_uor allow_uor;
90 struct list_objects_filter_options filter_options;
91 struct string_list allowed_filters;
93 struct packet_writer writer;
95 const char *pack_objects_hook;
97 unsigned stateless_rpc : 1; /* v0 only */
98 unsigned no_done : 1; /* v0 only */
99 unsigned daemon_mode : 1; /* v0 only */
100 unsigned filter_capability_requested : 1; /* v0 only */
102 unsigned use_thin_pack : 1;
103 unsigned use_ofs_delta : 1;
104 unsigned no_progress : 1;
105 unsigned use_include_tag : 1;
106 unsigned allow_filter : 1;
107 unsigned allow_filter_fallback : 1;
108 unsigned long tree_filter_max_depth;
110 unsigned done : 1; /* v2 only */
111 unsigned allow_ref_in_want : 1; /* v2 only */
112 unsigned allow_sideband_all : 1; /* v2 only */
113 unsigned advertise_sid : 1;
116 static void upload_pack_data_init(struct upload_pack_data *data)
118 struct string_list symref = STRING_LIST_INIT_DUP;
119 struct string_list wanted_refs = STRING_LIST_INIT_DUP;
120 struct object_array want_obj = OBJECT_ARRAY_INIT;
121 struct object_array have_obj = OBJECT_ARRAY_INIT;
122 struct oid_array haves = OID_ARRAY_INIT;
123 struct object_array shallows = OBJECT_ARRAY_INIT;
124 struct string_list deepen_not = STRING_LIST_INIT_DUP;
125 struct string_list uri_protocols = STRING_LIST_INIT_DUP;
126 struct object_array extra_edge_obj = OBJECT_ARRAY_INIT;
127 struct string_list allowed_filters = STRING_LIST_INIT_DUP;
129 memset(data, 0, sizeof(*data));
130 data->symref = symref;
131 data->wanted_refs = wanted_refs;
132 data->want_obj = want_obj;
133 data->have_obj = have_obj;
135 data->shallows = shallows;
136 data->deepen_not = deepen_not;
137 data->uri_protocols = uri_protocols;
138 data->extra_edge_obj = extra_edge_obj;
139 data->allowed_filters = allowed_filters;
140 data->allow_filter_fallback = 1;
141 data->tree_filter_max_depth = ULONG_MAX;
142 packet_writer_init(&data->writer, 1);
145 data->advertise_sid = 0;
148 static void upload_pack_data_clear(struct upload_pack_data *data)
150 string_list_clear(&data->symref, 1);
151 string_list_clear(&data->wanted_refs, 1);
152 object_array_clear(&data->want_obj);
153 object_array_clear(&data->have_obj);
154 oid_array_clear(&data->haves);
155 object_array_clear(&data->shallows);
156 string_list_clear(&data->deepen_not, 0);
157 object_array_clear(&data->extra_edge_obj);
158 list_objects_filter_release(&data->filter_options);
159 string_list_clear(&data->allowed_filters, 0);
161 free((char *)data->pack_objects_hook);
164 static void reset_timeout(unsigned int timeout)
169 static void send_client_data(int fd, const char *data, ssize_t sz,
173 send_sideband(1, fd, data, sz, use_sideband);
180 /* XXX: are we happy to lose stuff here? */
181 xwrite(fd, data, sz);
184 write_or_die(fd, data, sz);
187 static int write_one_shallow(const struct commit_graft *graft, void *cb_data)
190 if (graft->nr_parent == -1)
191 fprintf(fp, "--shallow %s\n", oid_to_hex(&graft->oid));
195 struct output_state {
198 unsigned packfile_uris_started : 1;
199 unsigned packfile_started : 1;
202 static int relay_pack_data(int pack_objects_out, struct output_state *os,
203 int use_sideband, int write_packfile_line)
206 * We keep the last byte to ourselves
207 * in case we detect broken rev-list, so that we
208 * can leave the stream corrupted. This is
209 * unfortunate -- unpack-objects would happily
210 * accept a valid packdata with trailing garbage,
211 * so appending garbage after we pass all the
212 * pack data is not good enough to signal
213 * breakage to downstream.
217 readsz = xread(pack_objects_out, os->buffer + os->used,
218 sizeof(os->buffer) - os->used);
224 while (!os->packfile_started) {
226 if (os->used >= 4 && !memcmp(os->buffer, "PACK", 4)) {
227 os->packfile_started = 1;
228 if (write_packfile_line) {
229 if (os->packfile_uris_started)
231 packet_write_fmt(1, "\1packfile\n");
235 if ((p = memchr(os->buffer, '\n', os->used))) {
236 if (!os->packfile_uris_started) {
237 os->packfile_uris_started = 1;
238 if (!write_packfile_line)
239 BUG("packfile_uris requires sideband-all");
240 packet_write_fmt(1, "\1packfile-uris\n");
243 packet_write_fmt(1, "\1%s\n", os->buffer);
245 os->used -= p - os->buffer + 1;
246 memmove(os->buffer, p + 1, os->used);
256 send_client_data(1, os->buffer, os->used - 1, use_sideband);
257 os->buffer[0] = os->buffer[os->used - 1];
260 send_client_data(1, os->buffer, os->used, use_sideband);
267 static void create_pack_file(struct upload_pack_data *pack_data,
268 const struct string_list *uri_protocols)
270 struct child_process pack_objects = CHILD_PROCESS_INIT;
271 struct output_state output_state = { { 0 } };
273 char abort_msg[] = "aborting due to possible repository "
274 "corruption on the remote side.";
279 if (!pack_data->pack_objects_hook)
280 pack_objects.git_cmd = 1;
282 strvec_push(&pack_objects.args, pack_data->pack_objects_hook);
283 strvec_push(&pack_objects.args, "git");
284 pack_objects.use_shell = 1;
287 if (pack_data->shallow_nr) {
288 strvec_push(&pack_objects.args, "--shallow-file");
289 strvec_push(&pack_objects.args, "");
291 strvec_push(&pack_objects.args, "pack-objects");
292 strvec_push(&pack_objects.args, "--revs");
293 if (pack_data->use_thin_pack)
294 strvec_push(&pack_objects.args, "--thin");
296 strvec_push(&pack_objects.args, "--stdout");
297 if (pack_data->shallow_nr)
298 strvec_push(&pack_objects.args, "--shallow");
299 if (!pack_data->no_progress)
300 strvec_push(&pack_objects.args, "--progress");
301 if (pack_data->use_ofs_delta)
302 strvec_push(&pack_objects.args, "--delta-base-offset");
303 if (pack_data->use_include_tag)
304 strvec_push(&pack_objects.args, "--include-tag");
305 if (pack_data->filter_options.choice) {
307 expand_list_objects_filter_spec(&pack_data->filter_options);
308 if (pack_objects.use_shell) {
309 struct strbuf buf = STRBUF_INIT;
310 sq_quote_buf(&buf, spec);
311 strvec_pushf(&pack_objects.args, "--filter=%s", buf.buf);
312 strbuf_release(&buf);
314 strvec_pushf(&pack_objects.args, "--filter=%s", spec);
318 for (i = 0; i < uri_protocols->nr; i++)
319 strvec_pushf(&pack_objects.args, "--uri-protocol=%s",
320 uri_protocols->items[i].string);
323 pack_objects.in = -1;
324 pack_objects.out = -1;
325 pack_objects.err = -1;
326 pack_objects.clean_on_exit = 1;
328 if (start_command(&pack_objects))
329 die("git upload-pack: unable to fork git-pack-objects");
331 pipe_fd = xfdopen(pack_objects.in, "w");
333 if (pack_data->shallow_nr)
334 for_each_commit_graft(write_one_shallow, pipe_fd);
336 for (i = 0; i < pack_data->want_obj.nr; i++)
337 fprintf(pipe_fd, "%s\n",
338 oid_to_hex(&pack_data->want_obj.objects[i].item->oid));
339 fprintf(pipe_fd, "--not\n");
340 for (i = 0; i < pack_data->have_obj.nr; i++)
341 fprintf(pipe_fd, "%s\n",
342 oid_to_hex(&pack_data->have_obj.objects[i].item->oid));
343 for (i = 0; i < pack_data->extra_edge_obj.nr; i++)
344 fprintf(pipe_fd, "%s\n",
345 oid_to_hex(&pack_data->extra_edge_obj.objects[i].item->oid));
346 fprintf(pipe_fd, "\n");
350 /* We read from pack_objects.err to capture stderr output for
351 * progress bar, and pack_objects.out to capture the pack data.
355 struct pollfd pfd[2];
356 int pe, pu, pollsize, polltimeout;
359 reset_timeout(pack_data->timeout);
364 if (0 <= pack_objects.out) {
365 pfd[pollsize].fd = pack_objects.out;
366 pfd[pollsize].events = POLLIN;
370 if (0 <= pack_objects.err) {
371 pfd[pollsize].fd = pack_objects.err;
372 pfd[pollsize].events = POLLIN;
380 polltimeout = pack_data->keepalive < 0
382 : 1000 * pack_data->keepalive;
384 ret = poll(pfd, pollsize, polltimeout);
387 if (errno != EINTR) {
388 error_errno("poll failed, resuming");
393 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
394 /* Status ready; we ship that in the side-band
395 * or dump to the standard error.
397 sz = xread(pack_objects.err, progress,
400 send_client_data(2, progress, sz,
401 pack_data->use_sideband);
403 close(pack_objects.err);
404 pack_objects.err = -1;
408 /* give priority to status messages */
411 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
412 int result = relay_pack_data(pack_objects.out,
414 pack_data->use_sideband,
418 close(pack_objects.out);
419 pack_objects.out = -1;
420 } else if (result < 0) {
426 * We hit the keepalive timeout without saying anything; send
427 * an empty message on the data sideband just to let the other
428 * side know we're still working on it, but don't have any data
431 * If we don't have a sideband channel, there's no room in the
432 * protocol to say anything, so those clients are just out of
435 if (!ret && pack_data->use_sideband) {
436 static const char buf[] = "0005\1";
437 write_or_die(1, buf, 5);
441 if (finish_command(&pack_objects)) {
442 error("git upload-pack: git-pack-objects died with error.");
447 if (output_state.used > 0) {
448 send_client_data(1, output_state.buffer, output_state.used,
449 pack_data->use_sideband);
450 fprintf(stderr, "flushed.\n");
452 if (pack_data->use_sideband)
457 send_client_data(3, abort_msg, sizeof(abort_msg),
458 pack_data->use_sideband);
459 die("git upload-pack: %s", abort_msg);
462 static int do_got_oid(struct upload_pack_data *data, const struct object_id *oid)
464 int we_knew_they_have = 0;
465 struct object *o = parse_object(the_repository, oid);
468 die("oops (%s)", oid_to_hex(oid));
469 if (o->type == OBJ_COMMIT) {
470 struct commit_list *parents;
471 struct commit *commit = (struct commit *)o;
472 if (o->flags & THEY_HAVE)
473 we_knew_they_have = 1;
475 o->flags |= THEY_HAVE;
476 if (!data->oldest_have || (commit->date < data->oldest_have))
477 data->oldest_have = commit->date;
478 for (parents = commit->parents;
480 parents = parents->next)
481 parents->item->object.flags |= THEY_HAVE;
483 if (!we_knew_they_have) {
484 add_object_array(o, NULL, &data->have_obj);
490 static int got_oid(struct upload_pack_data *data,
491 const char *hex, struct object_id *oid)
493 if (get_oid_hex(hex, oid))
494 die("git upload-pack: expected SHA1 object, got '%s'", hex);
495 if (!has_object_file_with_flags(oid,
496 OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT))
498 return do_got_oid(data, oid);
501 static int ok_to_give_up(struct upload_pack_data *data)
503 uint32_t min_generation = GENERATION_NUMBER_ZERO;
505 if (!data->have_obj.nr)
508 return can_all_from_reach_with_flag(&data->want_obj, THEY_HAVE,
509 COMMON_KNOWN, data->oldest_have,
513 static int get_common_commits(struct upload_pack_data *data,
514 struct packet_reader *reader)
516 struct object_id oid;
517 char last_hex[GIT_MAX_HEXSZ + 1];
522 save_commit_buffer = 0;
527 reset_timeout(data->timeout);
529 if (packet_reader_read(reader) != PACKET_READ_NORMAL) {
530 if (data->multi_ack == MULTI_ACK_DETAILED
533 && ok_to_give_up(data)) {
535 packet_write_fmt(1, "ACK %s ready\n", last_hex);
537 if (data->have_obj.nr == 0 || data->multi_ack)
538 packet_write_fmt(1, "NAK\n");
540 if (data->no_done && sent_ready) {
541 packet_write_fmt(1, "ACK %s\n", last_hex);
544 if (data->stateless_rpc)
550 if (skip_prefix(reader->line, "have ", &arg)) {
551 switch (got_oid(data, arg, &oid)) {
552 case -1: /* they have what we do not */
555 && ok_to_give_up(data)) {
556 const char *hex = oid_to_hex(&oid);
557 if (data->multi_ack == MULTI_ACK_DETAILED) {
559 packet_write_fmt(1, "ACK %s ready\n", hex);
561 packet_write_fmt(1, "ACK %s continue\n", hex);
566 oid_to_hex_r(last_hex, &oid);
567 if (data->multi_ack == MULTI_ACK_DETAILED)
568 packet_write_fmt(1, "ACK %s common\n", last_hex);
569 else if (data->multi_ack)
570 packet_write_fmt(1, "ACK %s continue\n", last_hex);
571 else if (data->have_obj.nr == 1)
572 packet_write_fmt(1, "ACK %s\n", last_hex);
577 if (!strcmp(reader->line, "done")) {
578 if (data->have_obj.nr > 0) {
580 packet_write_fmt(1, "ACK %s\n", last_hex);
583 packet_write_fmt(1, "NAK\n");
586 die("git upload-pack: expected SHA1 list, got '%s'", reader->line);
590 static int is_our_ref(struct object *o, enum allow_uor allow_uor)
592 int allow_hidden_ref = (allow_uor &
593 (ALLOW_TIP_SHA1 | ALLOW_REACHABLE_SHA1));
594 return o->flags & ((allow_hidden_ref ? HIDDEN_REF : 0) | OUR_REF);
598 * on successful case, it's up to the caller to close cmd->out
600 static int do_reachable_revlist(struct child_process *cmd,
601 struct object_array *src,
602 struct object_array *reachable,
603 enum allow_uor allow_uor)
605 static const char *argv[] = {
606 "rev-list", "--stdin", NULL,
619 * If the next rev-list --stdin encounters an unknown commit,
620 * it terminates, which will cause SIGPIPE in the write loop
623 sigchain_push(SIGPIPE, SIG_IGN);
625 if (start_command(cmd))
628 cmd_in = xfdopen(cmd->in, "w");
630 for (i = get_max_object_index(); 0 < i; ) {
631 o = get_indexed_object(--i);
634 if (reachable && o->type == OBJ_COMMIT)
635 o->flags &= ~TMP_MARK;
636 if (!is_our_ref(o, allow_uor))
638 if (fprintf(cmd_in, "^%s\n", oid_to_hex(&o->oid)) < 0)
641 for (i = 0; i < src->nr; i++) {
642 o = src->objects[i].item;
643 if (is_our_ref(o, allow_uor)) {
645 add_object_array(o, NULL, reachable);
648 if (reachable && o->type == OBJ_COMMIT)
649 o->flags |= TMP_MARK;
650 if (fprintf(cmd_in, "%s\n", oid_to_hex(&o->oid)) < 0)
653 if (ferror(cmd_in) || fflush(cmd_in))
657 sigchain_pop(SIGPIPE);
662 sigchain_pop(SIGPIPE);
671 static int get_reachable_list(struct upload_pack_data *data,
672 struct object_array *reachable)
674 struct child_process cmd = CHILD_PROCESS_INIT;
677 char namebuf[GIT_MAX_HEXSZ + 2]; /* ^ + hash + LF */
678 const unsigned hexsz = the_hash_algo->hexsz;
680 if (do_reachable_revlist(&cmd, &data->shallows, reachable,
681 data->allow_uor) < 0)
684 while ((i = read_in_full(cmd.out, namebuf, hexsz + 1)) == hexsz + 1) {
685 struct object_id oid;
688 if (parse_oid_hex(namebuf, &oid, &p) || *p != '\n')
691 o = lookup_object(the_repository, &oid);
692 if (o && o->type == OBJ_COMMIT) {
693 o->flags &= ~TMP_MARK;
696 for (i = get_max_object_index(); 0 < i; i--) {
697 o = get_indexed_object(i - 1);
698 if (o && o->type == OBJ_COMMIT &&
699 (o->flags & TMP_MARK)) {
700 add_object_array(o, NULL, reachable);
701 o->flags &= ~TMP_MARK;
706 if (finish_command(&cmd))
712 static int has_unreachable(struct object_array *src, enum allow_uor allow_uor)
714 struct child_process cmd = CHILD_PROCESS_INIT;
718 if (do_reachable_revlist(&cmd, src, NULL, allow_uor) < 0)
722 * The commits out of the rev-list are not ancestors of
725 i = read_in_full(cmd.out, buf, 1);
732 * rev-list may have died by encountering a bad commit
733 * in the history, in which case we do want to bail out
734 * even when it showed no commit.
736 if (finish_command(&cmd))
739 /* All the non-tip ones are ancestors of what we advertised */
748 static void check_non_tip(struct upload_pack_data *data)
753 * In the normal in-process case without
754 * uploadpack.allowReachableSHA1InWant,
755 * non-tip requests can never happen.
757 if (!data->stateless_rpc && !(data->allow_uor & ALLOW_REACHABLE_SHA1))
759 if (!has_unreachable(&data->want_obj, data->allow_uor))
760 /* All the non-tip ones are ancestors of what we advertised */
764 /* Pick one of them (we know there at least is one) */
765 for (i = 0; i < data->want_obj.nr; i++) {
766 struct object *o = data->want_obj.objects[i].item;
767 if (!is_our_ref(o, data->allow_uor)) {
768 packet_writer_error(&data->writer,
769 "upload-pack: not our ref %s",
770 oid_to_hex(&o->oid));
771 die("git upload-pack: not our ref %s",
772 oid_to_hex(&o->oid));
777 static void send_shallow(struct upload_pack_data *data,
778 struct commit_list *result)
781 struct object *object = &result->item->object;
782 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
783 packet_writer_write(&data->writer, "shallow %s",
784 oid_to_hex(&object->oid));
785 register_shallow(the_repository, &object->oid);
788 result = result->next;
792 static void send_unshallow(struct upload_pack_data *data)
796 for (i = 0; i < data->shallows.nr; i++) {
797 struct object *object = data->shallows.objects[i].item;
798 if (object->flags & NOT_SHALLOW) {
799 struct commit_list *parents;
800 packet_writer_write(&data->writer, "unshallow %s",
801 oid_to_hex(&object->oid));
802 object->flags &= ~CLIENT_SHALLOW;
804 * We want to _register_ "object" as shallow, but we
805 * also need to traverse object's parents to deepen a
806 * shallow clone. Unregister it for now so we can
807 * parse and add the parents to the want list, then
810 unregister_shallow(&object->oid);
812 parse_commit_or_die((struct commit *)object);
813 parents = ((struct commit *)object)->parents;
815 add_object_array(&parents->item->object,
816 NULL, &data->want_obj);
817 parents = parents->next;
819 add_object_array(object, NULL, &data->extra_edge_obj);
821 /* make sure commit traversal conforms to client */
822 register_shallow(the_repository, &object->oid);
826 static int check_ref(const char *refname_full, const struct object_id *oid,
827 int flag, void *cb_data);
828 static void deepen(struct upload_pack_data *data, int depth)
830 if (depth == INFINITE_DEPTH && !is_repository_shallow(the_repository)) {
833 for (i = 0; i < data->shallows.nr; i++) {
834 struct object *object = data->shallows.objects[i].item;
835 object->flags |= NOT_SHALLOW;
837 } else if (data->deepen_relative) {
838 struct object_array reachable_shallows = OBJECT_ARRAY_INIT;
839 struct commit_list *result;
842 * Checking for reachable shallows requires that our refs be
843 * marked with OUR_REF.
845 head_ref_namespaced(check_ref, NULL);
846 for_each_namespaced_ref(check_ref, NULL);
848 get_reachable_list(data, &reachable_shallows);
849 result = get_shallow_commits(&reachable_shallows,
851 SHALLOW, NOT_SHALLOW);
852 send_shallow(data, result);
853 free_commit_list(result);
854 object_array_clear(&reachable_shallows);
856 struct commit_list *result;
858 result = get_shallow_commits(&data->want_obj, depth,
859 SHALLOW, NOT_SHALLOW);
860 send_shallow(data, result);
861 free_commit_list(result);
864 send_unshallow(data);
867 static void deepen_by_rev_list(struct upload_pack_data *data,
871 struct commit_list *result;
873 disable_commit_graph(the_repository);
874 result = get_shallow_commits_by_rev_list(ac, av, SHALLOW, NOT_SHALLOW);
875 send_shallow(data, result);
876 free_commit_list(result);
877 send_unshallow(data);
880 /* Returns 1 if a shallow list is sent or 0 otherwise */
881 static int send_shallow_list(struct upload_pack_data *data)
885 if (data->depth > 0 && data->deepen_rev_list)
886 die("git upload-pack: deepen and deepen-since (or deepen-not) cannot be used together");
887 if (data->depth > 0) {
888 deepen(data, data->depth);
890 } else if (data->deepen_rev_list) {
891 struct strvec av = STRVEC_INIT;
894 strvec_push(&av, "rev-list");
895 if (data->deepen_since)
896 strvec_pushf(&av, "--max-age=%"PRItime, data->deepen_since);
897 if (data->deepen_not.nr) {
898 strvec_push(&av, "--not");
899 for (i = 0; i < data->deepen_not.nr; i++) {
900 struct string_list_item *s = data->deepen_not.items + i;
901 strvec_push(&av, s->string);
903 strvec_push(&av, "--not");
905 for (i = 0; i < data->want_obj.nr; i++) {
906 struct object *o = data->want_obj.objects[i].item;
907 strvec_push(&av, oid_to_hex(&o->oid));
909 deepen_by_rev_list(data, av.nr, av.v);
913 if (data->shallows.nr > 0) {
915 for (i = 0; i < data->shallows.nr; i++)
916 register_shallow(the_repository,
917 &data->shallows.objects[i].item->oid);
921 data->shallow_nr += data->shallows.nr;
925 static int process_shallow(const char *line, struct object_array *shallows)
928 if (skip_prefix(line, "shallow ", &arg)) {
929 struct object_id oid;
930 struct object *object;
931 if (get_oid_hex(arg, &oid))
932 die("invalid shallow line: %s", line);
933 object = parse_object(the_repository, &oid);
936 if (object->type != OBJ_COMMIT)
937 die("invalid shallow object %s", oid_to_hex(&oid));
938 if (!(object->flags & CLIENT_SHALLOW)) {
939 object->flags |= CLIENT_SHALLOW;
940 add_object_array(object, NULL, shallows);
948 static int process_deepen(const char *line, int *depth)
951 if (skip_prefix(line, "deepen ", &arg)) {
953 *depth = (int)strtol(arg, &end, 0);
954 if (!end || *end || *depth <= 0)
955 die("Invalid deepen: %s", line);
962 static int process_deepen_since(const char *line, timestamp_t *deepen_since, int *deepen_rev_list)
965 if (skip_prefix(line, "deepen-since ", &arg)) {
967 *deepen_since = parse_timestamp(arg, &end, 0);
968 if (!end || *end || !deepen_since ||
969 /* revisions.c's max_age -1 is special */
971 die("Invalid deepen-since: %s", line);
972 *deepen_rev_list = 1;
978 static int process_deepen_not(const char *line, struct string_list *deepen_not, int *deepen_rev_list)
981 if (skip_prefix(line, "deepen-not ", &arg)) {
983 struct object_id oid;
984 if (expand_ref(the_repository, arg, strlen(arg), &oid, &ref) != 1)
985 die("git upload-pack: ambiguous deepen-not: %s", line);
986 string_list_append(deepen_not, ref);
988 *deepen_rev_list = 1;
994 NORETURN __attribute__((format(printf,2,3)))
995 static void send_err_and_die(struct upload_pack_data *data,
996 const char *fmt, ...)
998 struct strbuf buf = STRBUF_INIT;
1002 strbuf_vaddf(&buf, fmt, ap);
1005 packet_writer_error(&data->writer, "%s", buf.buf);
1009 static void check_one_filter(struct upload_pack_data *data,
1010 struct list_objects_filter_options *opts)
1012 const char *key = list_object_filter_config_name(opts->choice);
1013 struct string_list_item *item = string_list_lookup(&data->allowed_filters,
1018 allowed = (intptr_t)item->util;
1020 allowed = data->allow_filter_fallback;
1023 send_err_and_die(data, "filter '%s' not supported", key);
1025 if (opts->choice == LOFC_TREE_DEPTH &&
1026 opts->tree_exclude_depth > data->tree_filter_max_depth)
1027 send_err_and_die(data,
1028 "tree filter allows max depth %lu, but got %lu",
1029 data->tree_filter_max_depth,
1030 opts->tree_exclude_depth);
1033 static void check_filter_recurse(struct upload_pack_data *data,
1034 struct list_objects_filter_options *opts)
1038 check_one_filter(data, opts);
1039 if (opts->choice != LOFC_COMBINE)
1042 for (i = 0; i < opts->sub_nr; i++)
1043 check_filter_recurse(data, &opts->sub[i]);
1046 static void die_if_using_banned_filter(struct upload_pack_data *data)
1048 check_filter_recurse(data, &data->filter_options);
1051 static void receive_needs(struct upload_pack_data *data,
1052 struct packet_reader *reader)
1054 int has_non_tip = 0;
1056 data->shallow_nr = 0;
1059 const char *features;
1060 struct object_id oid_buf;
1064 reset_timeout(data->timeout);
1065 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
1068 if (process_shallow(reader->line, &data->shallows))
1070 if (process_deepen(reader->line, &data->depth))
1072 if (process_deepen_since(reader->line, &data->deepen_since, &data->deepen_rev_list))
1074 if (process_deepen_not(reader->line, &data->deepen_not, &data->deepen_rev_list))
1077 if (skip_prefix(reader->line, "filter ", &arg)) {
1078 if (!data->filter_capability_requested)
1079 die("git upload-pack: filtering capability not negotiated");
1080 list_objects_filter_die_if_populated(&data->filter_options);
1081 parse_list_objects_filter(&data->filter_options, arg);
1082 die_if_using_banned_filter(data);
1086 if (!skip_prefix(reader->line, "want ", &arg) ||
1087 parse_oid_hex(arg, &oid_buf, &features))
1088 die("git upload-pack: protocol error, "
1089 "expected to get object ID, not '%s'", reader->line);
1091 if (parse_feature_request(features, "deepen-relative"))
1092 data->deepen_relative = 1;
1093 if (parse_feature_request(features, "multi_ack_detailed"))
1094 data->multi_ack = MULTI_ACK_DETAILED;
1095 else if (parse_feature_request(features, "multi_ack"))
1096 data->multi_ack = MULTI_ACK;
1097 if (parse_feature_request(features, "no-done"))
1099 if (parse_feature_request(features, "thin-pack"))
1100 data->use_thin_pack = 1;
1101 if (parse_feature_request(features, "ofs-delta"))
1102 data->use_ofs_delta = 1;
1103 if (parse_feature_request(features, "side-band-64k"))
1104 data->use_sideband = LARGE_PACKET_MAX;
1105 else if (parse_feature_request(features, "side-band"))
1106 data->use_sideband = DEFAULT_PACKET_MAX;
1107 if (parse_feature_request(features, "no-progress"))
1108 data->no_progress = 1;
1109 if (parse_feature_request(features, "include-tag"))
1110 data->use_include_tag = 1;
1111 if (data->allow_filter &&
1112 parse_feature_request(features, "filter"))
1113 data->filter_capability_requested = 1;
1115 arg = parse_feature_value(features, "session-id", &feature_len, NULL);
1117 char *client_sid = xstrndup(arg, feature_len);
1118 trace2_data_string("transfer", NULL, "client-sid", client_sid);
1122 o = parse_object(the_repository, &oid_buf);
1124 packet_writer_error(&data->writer,
1125 "upload-pack: not our ref %s",
1126 oid_to_hex(&oid_buf));
1127 die("git upload-pack: not our ref %s",
1128 oid_to_hex(&oid_buf));
1130 if (!(o->flags & WANTED)) {
1132 if (!((data->allow_uor & ALLOW_ANY_SHA1) == ALLOW_ANY_SHA1
1133 || is_our_ref(o, data->allow_uor)))
1135 add_object_array(o, NULL, &data->want_obj);
1140 * We have sent all our refs already, and the other end
1141 * should have chosen out of them. When we are operating
1142 * in the stateless RPC mode, however, their choice may
1143 * have been based on the set of older refs advertised
1144 * by another process that handled the initial request.
1147 check_non_tip(data);
1149 if (!data->use_sideband && data->daemon_mode)
1150 data->no_progress = 1;
1152 if (data->depth == 0 && !data->deepen_rev_list && data->shallows.nr == 0)
1155 if (send_shallow_list(data))
1159 /* return non-zero if the ref is hidden, otherwise 0 */
1160 static int mark_our_ref(const char *refname, const char *refname_full,
1161 const struct object_id *oid)
1163 struct object *o = lookup_unknown_object(oid);
1165 if (ref_is_hidden(refname, refname_full)) {
1166 o->flags |= HIDDEN_REF;
1169 o->flags |= OUR_REF;
1173 static int check_ref(const char *refname_full, const struct object_id *oid,
1174 int flag, void *cb_data)
1176 const char *refname = strip_namespace(refname_full);
1178 mark_our_ref(refname, refname_full, oid);
1182 static void format_symref_info(struct strbuf *buf, struct string_list *symref)
1184 struct string_list_item *item;
1188 for_each_string_list_item(item, symref)
1189 strbuf_addf(buf, " symref=%s:%s", item->string, (char *)item->util);
1192 static void format_session_id(struct strbuf *buf, struct upload_pack_data *d) {
1193 if (d->advertise_sid)
1194 strbuf_addf(buf, " session-id=%s", trace2_session_id());
1197 static int send_ref(const char *refname, const struct object_id *oid,
1198 int flag, void *cb_data)
1200 static const char *capabilities = "multi_ack thin-pack side-band"
1201 " side-band-64k ofs-delta shallow deepen-since deepen-not"
1202 " deepen-relative no-progress include-tag multi_ack_detailed";
1203 const char *refname_nons = strip_namespace(refname);
1204 struct object_id peeled;
1205 struct upload_pack_data *data = cb_data;
1207 if (mark_our_ref(refname_nons, refname, oid))
1211 struct strbuf symref_info = STRBUF_INIT;
1212 struct strbuf session_id = STRBUF_INIT;
1214 format_symref_info(&symref_info, &data->symref);
1215 format_session_id(&session_id, data);
1216 packet_write_fmt(1, "%s %s%c%s%s%s%s%s%s%s object-format=%s agent=%s\n",
1217 oid_to_hex(oid), refname_nons,
1219 (data->allow_uor & ALLOW_TIP_SHA1) ?
1220 " allow-tip-sha1-in-want" : "",
1221 (data->allow_uor & ALLOW_REACHABLE_SHA1) ?
1222 " allow-reachable-sha1-in-want" : "",
1223 data->stateless_rpc ? " no-done" : "",
1225 data->allow_filter ? " filter" : "",
1227 the_hash_algo->name,
1228 git_user_agent_sanitized());
1229 strbuf_release(&symref_info);
1230 strbuf_release(&session_id);
1232 packet_write_fmt(1, "%s %s\n", oid_to_hex(oid), refname_nons);
1234 capabilities = NULL;
1235 if (!peel_ref(refname, &peeled))
1236 packet_write_fmt(1, "%s %s^{}\n", oid_to_hex(&peeled), refname_nons);
1240 static int find_symref(const char *refname, const struct object_id *oid,
1241 int flag, void *cb_data)
1243 const char *symref_target;
1244 struct string_list_item *item;
1246 if ((flag & REF_ISSYMREF) == 0)
1248 symref_target = resolve_ref_unsafe(refname, 0, NULL, &flag);
1249 if (!symref_target || (flag & REF_ISSYMREF) == 0)
1250 die("'%s' is a symref but it is not?", refname);
1251 item = string_list_append(cb_data, strip_namespace(refname));
1252 item->util = xstrdup(strip_namespace(symref_target));
1256 static int parse_object_filter_config(const char *var, const char *value,
1257 struct upload_pack_data *data)
1259 struct strbuf buf = STRBUF_INIT;
1260 const char *sub, *key;
1263 if (parse_config_key(var, "uploadpackfilter", &sub, &sub_len, &key))
1267 if (!strcmp(key, "allow"))
1268 data->allow_filter_fallback = git_config_bool(var, value);
1272 strbuf_add(&buf, sub, sub_len);
1274 if (!strcmp(key, "allow"))
1275 string_list_insert(&data->allowed_filters, buf.buf)->util =
1276 (void *)(intptr_t)git_config_bool(var, value);
1277 else if (!strcmp(buf.buf, "tree") && !strcmp(key, "maxdepth")) {
1279 strbuf_release(&buf);
1280 return config_error_nonbool(var);
1282 string_list_insert(&data->allowed_filters, buf.buf)->util =
1283 (void *)(intptr_t)1;
1284 data->tree_filter_max_depth = git_config_ulong(var, value);
1287 strbuf_release(&buf);
1291 static int upload_pack_config(const char *var, const char *value, void *cb_data)
1293 struct upload_pack_data *data = cb_data;
1295 if (!strcmp("uploadpack.allowtipsha1inwant", var)) {
1296 if (git_config_bool(var, value))
1297 data->allow_uor |= ALLOW_TIP_SHA1;
1299 data->allow_uor &= ~ALLOW_TIP_SHA1;
1300 } else if (!strcmp("uploadpack.allowreachablesha1inwant", var)) {
1301 if (git_config_bool(var, value))
1302 data->allow_uor |= ALLOW_REACHABLE_SHA1;
1304 data->allow_uor &= ~ALLOW_REACHABLE_SHA1;
1305 } else if (!strcmp("uploadpack.allowanysha1inwant", var)) {
1306 if (git_config_bool(var, value))
1307 data->allow_uor |= ALLOW_ANY_SHA1;
1309 data->allow_uor &= ~ALLOW_ANY_SHA1;
1310 } else if (!strcmp("uploadpack.keepalive", var)) {
1311 data->keepalive = git_config_int(var, value);
1312 if (!data->keepalive)
1313 data->keepalive = -1;
1314 } else if (!strcmp("uploadpack.allowfilter", var)) {
1315 data->allow_filter = git_config_bool(var, value);
1316 } else if (!strcmp("uploadpack.allowrefinwant", var)) {
1317 data->allow_ref_in_want = git_config_bool(var, value);
1318 } else if (!strcmp("uploadpack.allowsidebandall", var)) {
1319 data->allow_sideband_all = git_config_bool(var, value);
1320 } else if (!strcmp("core.precomposeunicode", var)) {
1321 precomposed_unicode = git_config_bool(var, value);
1322 } else if (!strcmp("transfer.advertisesid", var)) {
1323 data->advertise_sid = git_config_bool(var, value);
1326 if (current_config_scope() != CONFIG_SCOPE_LOCAL &&
1327 current_config_scope() != CONFIG_SCOPE_WORKTREE) {
1328 if (!strcmp("uploadpack.packobjectshook", var))
1329 return git_config_string(&data->pack_objects_hook, var, value);
1332 if (parse_object_filter_config(var, value, data) < 0)
1335 return parse_hide_refs_config(var, value, "uploadpack");
1338 void upload_pack(struct upload_pack_options *options)
1340 struct packet_reader reader;
1341 struct upload_pack_data data;
1343 upload_pack_data_init(&data);
1345 git_config(upload_pack_config, &data);
1347 data.stateless_rpc = options->stateless_rpc;
1348 data.daemon_mode = options->daemon_mode;
1349 data.timeout = options->timeout;
1351 head_ref_namespaced(find_symref, &data.symref);
1353 if (options->advertise_refs || !data.stateless_rpc) {
1354 reset_timeout(data.timeout);
1355 head_ref_namespaced(send_ref, &data);
1356 for_each_namespaced_ref(send_ref, &data);
1357 advertise_shallow_grafts(1);
1360 head_ref_namespaced(check_ref, NULL);
1361 for_each_namespaced_ref(check_ref, NULL);
1364 if (!options->advertise_refs) {
1365 packet_reader_init(&reader, 0, NULL, 0,
1366 PACKET_READ_CHOMP_NEWLINE |
1367 PACKET_READ_DIE_ON_ERR_PACKET);
1369 receive_needs(&data, &reader);
1372 * An EOF at this exact point in negotiation should be
1373 * acceptable from stateless clients as they will consume the
1374 * shallow list before doing subsequent rpc with haves/etc.
1376 if (data.stateless_rpc)
1377 reader.options |= PACKET_READ_GENTLE_ON_EOF;
1379 if (data.want_obj.nr &&
1380 packet_reader_peek(&reader) != PACKET_READ_EOF) {
1381 reader.options &= ~PACKET_READ_GENTLE_ON_EOF;
1382 get_common_commits(&data, &reader);
1383 create_pack_file(&data, NULL);
1387 upload_pack_data_clear(&data);
1390 static int parse_want(struct packet_writer *writer, const char *line,
1391 struct object_array *want_obj)
1394 if (skip_prefix(line, "want ", &arg)) {
1395 struct object_id oid;
1398 if (get_oid_hex(arg, &oid))
1399 die("git upload-pack: protocol error, "
1400 "expected to get oid, not '%s'", line);
1402 o = parse_object(the_repository, &oid);
1404 packet_writer_error(writer,
1405 "upload-pack: not our ref %s",
1407 die("git upload-pack: not our ref %s",
1411 if (!(o->flags & WANTED)) {
1413 add_object_array(o, NULL, want_obj);
1422 static int parse_want_ref(struct packet_writer *writer, const char *line,
1423 struct string_list *wanted_refs,
1424 struct object_array *want_obj)
1427 if (skip_prefix(line, "want-ref ", &arg)) {
1428 struct object_id oid;
1429 struct string_list_item *item;
1432 if (read_ref(arg, &oid)) {
1433 packet_writer_error(writer, "unknown ref %s", arg);
1434 die("unknown ref %s", arg);
1437 item = string_list_append(wanted_refs, arg);
1438 item->util = oiddup(&oid);
1440 o = parse_object_or_die(&oid, arg);
1441 if (!(o->flags & WANTED)) {
1443 add_object_array(o, NULL, want_obj);
1452 static int parse_have(const char *line, struct oid_array *haves)
1455 if (skip_prefix(line, "have ", &arg)) {
1456 struct object_id oid;
1458 if (get_oid_hex(arg, &oid))
1459 die("git upload-pack: expected SHA1 object, got '%s'", arg);
1460 oid_array_append(haves, &oid);
1467 static void process_args(struct packet_reader *request,
1468 struct upload_pack_data *data)
1470 while (packet_reader_read(request) == PACKET_READ_NORMAL) {
1471 const char *arg = request->line;
1475 if (parse_want(&data->writer, arg, &data->want_obj))
1477 if (data->allow_ref_in_want &&
1478 parse_want_ref(&data->writer, arg, &data->wanted_refs,
1481 /* process have line */
1482 if (parse_have(arg, &data->haves))
1485 /* process args like thin-pack */
1486 if (!strcmp(arg, "thin-pack")) {
1487 data->use_thin_pack = 1;
1490 if (!strcmp(arg, "ofs-delta")) {
1491 data->use_ofs_delta = 1;
1494 if (!strcmp(arg, "no-progress")) {
1495 data->no_progress = 1;
1498 if (!strcmp(arg, "include-tag")) {
1499 data->use_include_tag = 1;
1502 if (!strcmp(arg, "done")) {
1507 /* Shallow related arguments */
1508 if (process_shallow(arg, &data->shallows))
1510 if (process_deepen(arg, &data->depth))
1512 if (process_deepen_since(arg, &data->deepen_since,
1513 &data->deepen_rev_list))
1515 if (process_deepen_not(arg, &data->deepen_not,
1516 &data->deepen_rev_list))
1518 if (!strcmp(arg, "deepen-relative")) {
1519 data->deepen_relative = 1;
1523 if (data->allow_filter && skip_prefix(arg, "filter ", &p)) {
1524 list_objects_filter_die_if_populated(&data->filter_options);
1525 parse_list_objects_filter(&data->filter_options, p);
1526 die_if_using_banned_filter(data);
1530 if ((git_env_bool("GIT_TEST_SIDEBAND_ALL", 0) ||
1531 data->allow_sideband_all) &&
1532 !strcmp(arg, "sideband-all")) {
1533 data->writer.use_sideband = 1;
1537 if (skip_prefix(arg, "packfile-uris ", &p)) {
1538 string_list_split(&data->uri_protocols, p, ',', -1);
1542 /* ignore unknown lines maybe? */
1543 die("unexpected line: '%s'", arg);
1546 if (data->uri_protocols.nr && !data->writer.use_sideband)
1547 string_list_clear(&data->uri_protocols, 0);
1549 if (request->status != PACKET_READ_FLUSH)
1550 die(_("expected flush after fetch arguments"));
1553 static int process_haves(struct upload_pack_data *data, struct oid_array *common)
1558 for (i = 0; i < data->haves.nr; i++) {
1559 const struct object_id *oid = &data->haves.oid[i];
1561 if (!has_object_file_with_flags(oid,
1562 OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT))
1565 oid_array_append(common, oid);
1567 do_got_oid(data, oid);
1573 static int send_acks(struct upload_pack_data *data, struct oid_array *acks)
1577 packet_writer_write(&data->writer, "acknowledgments\n");
1581 packet_writer_write(&data->writer, "NAK\n");
1583 for (i = 0; i < acks->nr; i++) {
1584 packet_writer_write(&data->writer, "ACK %s\n",
1585 oid_to_hex(&acks->oid[i]));
1588 if (ok_to_give_up(data)) {
1590 packet_writer_write(&data->writer, "ready\n");
1597 static int process_haves_and_send_acks(struct upload_pack_data *data)
1599 struct oid_array common = OID_ARRAY_INIT;
1602 process_haves(data, &common);
1605 } else if (send_acks(data, &common)) {
1606 packet_writer_delim(&data->writer);
1610 packet_writer_flush(&data->writer);
1614 oid_array_clear(&data->haves);
1615 oid_array_clear(&common);
1619 static void send_wanted_ref_info(struct upload_pack_data *data)
1621 const struct string_list_item *item;
1623 if (!data->wanted_refs.nr)
1626 packet_writer_write(&data->writer, "wanted-refs\n");
1628 for_each_string_list_item(item, &data->wanted_refs) {
1629 packet_writer_write(&data->writer, "%s %s\n",
1630 oid_to_hex(item->util),
1634 packet_writer_delim(&data->writer);
1637 static void send_shallow_info(struct upload_pack_data *data)
1639 /* No shallow info needs to be sent */
1640 if (!data->depth && !data->deepen_rev_list && !data->shallows.nr &&
1641 !is_repository_shallow(the_repository))
1644 packet_writer_write(&data->writer, "shallow-info\n");
1646 if (!send_shallow_list(data) &&
1647 is_repository_shallow(the_repository))
1648 deepen(data, INFINITE_DEPTH);
1654 FETCH_PROCESS_ARGS = 0,
1660 int upload_pack_v2(struct repository *r, struct strvec *keys,
1661 struct packet_reader *request)
1663 enum fetch_state state = FETCH_PROCESS_ARGS;
1664 struct upload_pack_data data;
1666 clear_object_flags(ALL_FLAGS);
1668 upload_pack_data_init(&data);
1669 data.use_sideband = LARGE_PACKET_MAX;
1671 git_config(upload_pack_config, &data);
1673 while (state != FETCH_DONE) {
1675 case FETCH_PROCESS_ARGS:
1676 process_args(request, &data);
1678 if (!data.want_obj.nr) {
1680 * Request didn't contain any 'want' lines,
1681 * guess they didn't want anything.
1684 } else if (data.haves.nr) {
1686 * Request had 'have' lines, so lets ACK them.
1688 state = FETCH_SEND_ACKS;
1691 * Request had 'want's but no 'have's so we can
1692 * immedietly go to construct and send a pack.
1694 state = FETCH_SEND_PACK;
1697 case FETCH_SEND_ACKS:
1698 if (process_haves_and_send_acks(&data))
1699 state = FETCH_SEND_PACK;
1703 case FETCH_SEND_PACK:
1704 send_wanted_ref_info(&data);
1705 send_shallow_info(&data);
1707 if (data.uri_protocols.nr) {
1708 create_pack_file(&data, &data.uri_protocols);
1710 packet_writer_write(&data.writer, "packfile\n");
1711 create_pack_file(&data, NULL);
1720 upload_pack_data_clear(&data);
1724 int upload_pack_advertise(struct repository *r,
1725 struct strbuf *value)
1728 int allow_filter_value;
1729 int allow_ref_in_want;
1730 int allow_sideband_all_value;
1733 strbuf_addstr(value, "shallow");
1735 if (!repo_config_get_bool(the_repository,
1736 "uploadpack.allowfilter",
1737 &allow_filter_value) &&
1739 strbuf_addstr(value, " filter");
1741 if (!repo_config_get_bool(the_repository,
1742 "uploadpack.allowrefinwant",
1743 &allow_ref_in_want) &&
1745 strbuf_addstr(value, " ref-in-want");
1747 if (git_env_bool("GIT_TEST_SIDEBAND_ALL", 0) ||
1748 (!repo_config_get_bool(the_repository,
1749 "uploadpack.allowsidebandall",
1750 &allow_sideband_all_value) &&
1751 allow_sideband_all_value))
1752 strbuf_addstr(value, " sideband-all");
1754 if (!repo_config_get_string(the_repository,
1755 "uploadpack.blobpackfileuri",
1758 strbuf_addstr(value, " packfile-uris");