builtin/gc: move `struct maintenance_run_opts`
[alt-git.git] / upload-pack.c
blob902144b9d3470b9a603a584f7f4207511b15dc2b
1 #include "git-compat-util.h"
2 #include "config.h"
3 #include "environment.h"
4 #include "gettext.h"
5 #include "hex.h"
6 #include "refs.h"
7 #include "pkt-line.h"
8 #include "sideband.h"
9 #include "repository.h"
10 #include "object-store-ll.h"
11 #include "oid-array.h"
12 #include "object.h"
13 #include "commit.h"
14 #include "diff.h"
15 #include "revision.h"
16 #include "list-objects-filter-options.h"
17 #include "run-command.h"
18 #include "connect.h"
19 #include "sigchain.h"
20 #include "version.h"
21 #include "string-list.h"
22 #include "strvec.h"
23 #include "trace2.h"
24 #include "protocol.h"
25 #include "upload-pack.h"
26 #include "commit-graph.h"
27 #include "commit-reach.h"
28 #include "shallow.h"
29 #include "write-or-die.h"
30 #include "json-writer.h"
31 #include "strmap.h"
33 /* Remember to update object flag allocation in object.h */
34 #define THEY_HAVE (1u << 11)
35 #define OUR_REF (1u << 12)
36 #define WANTED (1u << 13)
37 #define COMMON_KNOWN (1u << 14)
39 #define SHALLOW (1u << 16)
40 #define NOT_SHALLOW (1u << 17)
41 #define CLIENT_SHALLOW (1u << 18)
42 #define HIDDEN_REF (1u << 19)
44 #define ALL_FLAGS (THEY_HAVE | OUR_REF | WANTED | COMMON_KNOWN | SHALLOW | \
45 NOT_SHALLOW | CLIENT_SHALLOW | HIDDEN_REF)
47 /* Enum for allowed unadvertised object request (UOR) */
48 enum allow_uor {
49 /* Allow specifying sha1 if it is a ref tip. */
50 ALLOW_TIP_SHA1 = 0x01,
51 /* Allow request of a sha1 if it is reachable from a ref (possibly hidden ref). */
52 ALLOW_REACHABLE_SHA1 = 0x02,
53 /* Allow request of any sha1. Implies ALLOW_TIP_SHA1 and ALLOW_REACHABLE_SHA1. */
54 ALLOW_ANY_SHA1 = 0x07
58 * Please annotate, and if possible group together, fields used only
59 * for protocol v0 or only for protocol v2.
61 struct upload_pack_data {
62 struct string_list symref; /* v0 only */
63 struct object_array want_obj;
64 struct object_array have_obj;
65 struct strmap wanted_refs; /* v2 only */
66 struct strvec hidden_refs;
68 struct object_array shallows;
69 struct oidset deepen_not;
70 struct object_array extra_edge_obj;
71 int depth;
72 timestamp_t deepen_since;
73 int deepen_rev_list;
74 int deepen_relative;
75 int keepalive;
76 int shallow_nr;
77 timestamp_t oldest_have;
79 unsigned int timeout; /* v0 only */
80 enum {
81 NO_MULTI_ACK = 0,
82 MULTI_ACK = 1,
83 MULTI_ACK_DETAILED = 2
84 } multi_ack; /* v0 only */
86 /* 0 for no sideband, otherwise DEFAULT_PACKET_MAX or LARGE_PACKET_MAX */
87 int use_sideband;
89 struct string_list uri_protocols;
90 enum allow_uor allow_uor;
92 struct list_objects_filter_options filter_options;
93 struct string_list allowed_filters;
95 struct packet_writer writer;
97 const char *pack_objects_hook;
99 unsigned stateless_rpc : 1; /* v0 only */
100 unsigned no_done : 1; /* v0 only */
101 unsigned daemon_mode : 1; /* v0 only */
102 unsigned filter_capability_requested : 1; /* v0 only */
104 unsigned use_thin_pack : 1;
105 unsigned use_ofs_delta : 1;
106 unsigned no_progress : 1;
107 unsigned use_include_tag : 1;
108 unsigned wait_for_done : 1;
109 unsigned allow_filter : 1;
110 unsigned allow_filter_fallback : 1;
111 unsigned long tree_filter_max_depth;
113 unsigned done : 1; /* v2 only */
114 unsigned allow_ref_in_want : 1; /* v2 only */
115 unsigned allow_sideband_all : 1; /* v2 only */
116 unsigned seen_haves : 1; /* v2 only */
117 unsigned allow_packfile_uris : 1; /* v2 only */
118 unsigned advertise_sid : 1;
119 unsigned sent_capabilities : 1;
122 static void upload_pack_data_init(struct upload_pack_data *data)
124 struct string_list symref = STRING_LIST_INIT_DUP;
125 struct strmap wanted_refs = STRMAP_INIT;
126 struct strvec hidden_refs = STRVEC_INIT;
127 struct object_array want_obj = OBJECT_ARRAY_INIT;
128 struct object_array have_obj = OBJECT_ARRAY_INIT;
129 struct object_array shallows = OBJECT_ARRAY_INIT;
130 struct oidset deepen_not = OID_ARRAY_INIT;
131 struct string_list uri_protocols = STRING_LIST_INIT_DUP;
132 struct object_array extra_edge_obj = OBJECT_ARRAY_INIT;
133 struct string_list allowed_filters = STRING_LIST_INIT_DUP;
135 memset(data, 0, sizeof(*data));
136 data->symref = symref;
137 data->wanted_refs = wanted_refs;
138 data->hidden_refs = hidden_refs;
139 data->want_obj = want_obj;
140 data->have_obj = have_obj;
141 data->shallows = shallows;
142 data->deepen_not = deepen_not;
143 data->uri_protocols = uri_protocols;
144 data->extra_edge_obj = extra_edge_obj;
145 data->allowed_filters = allowed_filters;
146 data->allow_filter_fallback = 1;
147 data->tree_filter_max_depth = ULONG_MAX;
148 packet_writer_init(&data->writer, 1);
149 list_objects_filter_init(&data->filter_options);
151 data->keepalive = 5;
152 data->advertise_sid = 0;
155 static void upload_pack_data_clear(struct upload_pack_data *data)
157 string_list_clear(&data->symref, 1);
158 strmap_clear(&data->wanted_refs, 1);
159 strvec_clear(&data->hidden_refs);
160 object_array_clear(&data->want_obj);
161 object_array_clear(&data->have_obj);
162 object_array_clear(&data->shallows);
163 oidset_clear(&data->deepen_not);
164 object_array_clear(&data->extra_edge_obj);
165 list_objects_filter_release(&data->filter_options);
166 string_list_clear(&data->allowed_filters, 0);
168 free((char *)data->pack_objects_hook);
171 static void reset_timeout(unsigned int timeout)
173 alarm(timeout);
176 static void send_client_data(int fd, const char *data, ssize_t sz,
177 int use_sideband)
179 if (use_sideband) {
180 send_sideband(1, fd, data, sz, use_sideband);
181 return;
183 if (fd == 3)
184 /* emergency quit */
185 fd = 2;
186 if (fd == 2) {
187 /* XXX: are we happy to lose stuff here? */
188 xwrite(fd, data, sz);
189 return;
191 write_or_die(fd, data, sz);
194 static int write_one_shallow(const struct commit_graft *graft, void *cb_data)
196 FILE *fp = cb_data;
197 if (graft->nr_parent == -1)
198 fprintf(fp, "--shallow %s\n", oid_to_hex(&graft->oid));
199 return 0;
202 struct output_state {
204 * We do writes no bigger than LARGE_PACKET_DATA_MAX - 1, because with
205 * sideband-64k the band designator takes up 1 byte of space. Because
206 * relay_pack_data keeps the last byte to itself, we make the buffer 1
207 * byte bigger than the intended maximum write size.
209 char buffer[(LARGE_PACKET_DATA_MAX - 1) + 1];
210 int used;
211 unsigned packfile_uris_started : 1;
212 unsigned packfile_started : 1;
215 static int relay_pack_data(int pack_objects_out, struct output_state *os,
216 int use_sideband, int write_packfile_line)
219 * We keep the last byte to ourselves
220 * in case we detect broken rev-list, so that we
221 * can leave the stream corrupted. This is
222 * unfortunate -- unpack-objects would happily
223 * accept a valid packdata with trailing garbage,
224 * so appending garbage after we pass all the
225 * pack data is not good enough to signal
226 * breakage to downstream.
228 ssize_t readsz;
230 readsz = xread(pack_objects_out, os->buffer + os->used,
231 sizeof(os->buffer) - os->used);
232 if (readsz < 0) {
233 return readsz;
235 os->used += readsz;
237 while (!os->packfile_started) {
238 char *p;
239 if (os->used >= 4 && !memcmp(os->buffer, "PACK", 4)) {
240 os->packfile_started = 1;
241 if (write_packfile_line) {
242 if (os->packfile_uris_started)
243 packet_delim(1);
244 packet_write_fmt(1, "\1packfile\n");
246 break;
248 if ((p = memchr(os->buffer, '\n', os->used))) {
249 if (!os->packfile_uris_started) {
250 os->packfile_uris_started = 1;
251 if (!write_packfile_line)
252 BUG("packfile_uris requires sideband-all");
253 packet_write_fmt(1, "\1packfile-uris\n");
255 *p = '\0';
256 packet_write_fmt(1, "\1%s\n", os->buffer);
258 os->used -= p - os->buffer + 1;
259 memmove(os->buffer, p + 1, os->used);
260 } else {
262 * Incomplete line.
264 return readsz;
268 if (os->used > 1) {
269 send_client_data(1, os->buffer, os->used - 1, use_sideband);
270 os->buffer[0] = os->buffer[os->used - 1];
271 os->used = 1;
272 } else {
273 send_client_data(1, os->buffer, os->used, use_sideband);
274 os->used = 0;
277 return readsz;
280 static void create_pack_file(struct upload_pack_data *pack_data,
281 const struct string_list *uri_protocols)
283 struct child_process pack_objects = CHILD_PROCESS_INIT;
284 struct output_state *output_state = xcalloc(1, sizeof(struct output_state));
285 char progress[128];
286 char abort_msg[] = "aborting due to possible repository "
287 "corruption on the remote side.";
288 ssize_t sz;
289 int i;
290 FILE *pipe_fd;
292 if (!pack_data->pack_objects_hook)
293 pack_objects.git_cmd = 1;
294 else {
295 strvec_push(&pack_objects.args, pack_data->pack_objects_hook);
296 strvec_push(&pack_objects.args, "git");
297 pack_objects.use_shell = 1;
300 if (pack_data->shallow_nr) {
301 strvec_push(&pack_objects.args, "--shallow-file");
302 strvec_push(&pack_objects.args, "");
304 strvec_push(&pack_objects.args, "pack-objects");
305 strvec_push(&pack_objects.args, "--revs");
306 if (pack_data->use_thin_pack)
307 strvec_push(&pack_objects.args, "--thin");
309 strvec_push(&pack_objects.args, "--stdout");
310 if (pack_data->shallow_nr)
311 strvec_push(&pack_objects.args, "--shallow");
312 if (!pack_data->no_progress)
313 strvec_push(&pack_objects.args, "--progress");
314 if (pack_data->use_ofs_delta)
315 strvec_push(&pack_objects.args, "--delta-base-offset");
316 if (pack_data->use_include_tag)
317 strvec_push(&pack_objects.args, "--include-tag");
318 if (pack_data->filter_options.choice) {
319 const char *spec =
320 expand_list_objects_filter_spec(&pack_data->filter_options);
321 strvec_pushf(&pack_objects.args, "--filter=%s", spec);
323 if (uri_protocols) {
324 for (i = 0; i < uri_protocols->nr; i++)
325 strvec_pushf(&pack_objects.args, "--uri-protocol=%s",
326 uri_protocols->items[i].string);
329 pack_objects.in = -1;
330 pack_objects.out = -1;
331 pack_objects.err = -1;
332 pack_objects.clean_on_exit = 1;
334 if (start_command(&pack_objects))
335 die("git upload-pack: unable to fork git-pack-objects");
337 pipe_fd = xfdopen(pack_objects.in, "w");
339 if (pack_data->shallow_nr)
340 for_each_commit_graft(write_one_shallow, pipe_fd);
342 for (i = 0; i < pack_data->want_obj.nr; i++)
343 fprintf(pipe_fd, "%s\n",
344 oid_to_hex(&pack_data->want_obj.objects[i].item->oid));
345 fprintf(pipe_fd, "--not\n");
346 for (i = 0; i < pack_data->have_obj.nr; i++)
347 fprintf(pipe_fd, "%s\n",
348 oid_to_hex(&pack_data->have_obj.objects[i].item->oid));
349 for (i = 0; i < pack_data->extra_edge_obj.nr; i++)
350 fprintf(pipe_fd, "%s\n",
351 oid_to_hex(&pack_data->extra_edge_obj.objects[i].item->oid));
352 fprintf(pipe_fd, "\n");
353 fflush(pipe_fd);
354 fclose(pipe_fd);
356 /* We read from pack_objects.err to capture stderr output for
357 * progress bar, and pack_objects.out to capture the pack data.
360 while (1) {
361 struct pollfd pfd[2];
362 int pe, pu, pollsize, polltimeout;
363 int ret;
365 reset_timeout(pack_data->timeout);
367 pollsize = 0;
368 pe = pu = -1;
370 if (0 <= pack_objects.out) {
371 pfd[pollsize].fd = pack_objects.out;
372 pfd[pollsize].events = POLLIN;
373 pu = pollsize;
374 pollsize++;
376 if (0 <= pack_objects.err) {
377 pfd[pollsize].fd = pack_objects.err;
378 pfd[pollsize].events = POLLIN;
379 pe = pollsize;
380 pollsize++;
383 if (!pollsize)
384 break;
386 polltimeout = pack_data->keepalive < 0
387 ? -1
388 : 1000 * pack_data->keepalive;
390 ret = poll(pfd, pollsize, polltimeout);
392 if (ret < 0) {
393 if (errno != EINTR) {
394 error_errno("poll failed, resuming");
395 sleep(1);
397 continue;
399 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
400 /* Status ready; we ship that in the side-band
401 * or dump to the standard error.
403 sz = xread(pack_objects.err, progress,
404 sizeof(progress));
405 if (0 < sz)
406 send_client_data(2, progress, sz,
407 pack_data->use_sideband);
408 else if (sz == 0) {
409 close(pack_objects.err);
410 pack_objects.err = -1;
412 else
413 goto fail;
414 /* give priority to status messages */
415 continue;
417 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
418 int result = relay_pack_data(pack_objects.out,
419 output_state,
420 pack_data->use_sideband,
421 !!uri_protocols);
423 if (result == 0) {
424 close(pack_objects.out);
425 pack_objects.out = -1;
426 } else if (result < 0) {
427 goto fail;
432 * We hit the keepalive timeout without saying anything; send
433 * an empty message on the data sideband just to let the other
434 * side know we're still working on it, but don't have any data
435 * yet.
437 * If we don't have a sideband channel, there's no room in the
438 * protocol to say anything, so those clients are just out of
439 * luck.
441 if (!ret && pack_data->use_sideband) {
442 static const char buf[] = "0005\1";
443 write_or_die(1, buf, 5);
447 if (finish_command(&pack_objects)) {
448 error("git upload-pack: git-pack-objects died with error.");
449 goto fail;
452 /* flush the data */
453 if (output_state->used > 0) {
454 send_client_data(1, output_state->buffer, output_state->used,
455 pack_data->use_sideband);
456 fprintf(stderr, "flushed.\n");
458 free(output_state);
459 if (pack_data->use_sideband)
460 packet_flush(1);
461 return;
463 fail:
464 free(output_state);
465 send_client_data(3, abort_msg, strlen(abort_msg),
466 pack_data->use_sideband);
467 die("git upload-pack: %s", abort_msg);
470 static int do_got_oid(struct upload_pack_data *data, const struct object_id *oid)
472 int we_knew_they_have = 0;
473 struct object *o = parse_object_with_flags(the_repository, oid,
474 PARSE_OBJECT_SKIP_HASH_CHECK |
475 PARSE_OBJECT_DISCARD_TREE);
477 if (!o)
478 die("oops (%s)", oid_to_hex(oid));
479 if (o->type == OBJ_COMMIT) {
480 struct commit_list *parents;
481 struct commit *commit = (struct commit *)o;
482 if (o->flags & THEY_HAVE)
483 we_knew_they_have = 1;
484 else
485 o->flags |= THEY_HAVE;
486 if (!data->oldest_have || (commit->date < data->oldest_have))
487 data->oldest_have = commit->date;
488 for (parents = commit->parents;
489 parents;
490 parents = parents->next)
491 parents->item->object.flags |= THEY_HAVE;
493 if (!we_knew_they_have) {
494 add_object_array(o, NULL, &data->have_obj);
495 return 1;
497 return 0;
500 static int got_oid(struct upload_pack_data *data,
501 const char *hex, struct object_id *oid)
503 if (get_oid_hex(hex, oid))
504 die("git upload-pack: expected SHA1 object, got '%s'", hex);
505 if (!repo_has_object_file_with_flags(the_repository, oid,
506 OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT))
507 return -1;
508 return do_got_oid(data, oid);
511 static int ok_to_give_up(struct upload_pack_data *data)
513 timestamp_t min_generation = GENERATION_NUMBER_ZERO;
515 if (!data->have_obj.nr)
516 return 0;
518 return can_all_from_reach_with_flag(&data->want_obj, THEY_HAVE,
519 COMMON_KNOWN, data->oldest_have,
520 min_generation);
523 static int get_common_commits(struct upload_pack_data *data,
524 struct packet_reader *reader)
526 struct object_id oid;
527 char last_hex[GIT_MAX_HEXSZ + 1];
528 int got_common = 0;
529 int got_other = 0;
530 int sent_ready = 0;
532 for (;;) {
533 const char *arg;
535 reset_timeout(data->timeout);
537 if (packet_reader_read(reader) != PACKET_READ_NORMAL) {
538 if (data->multi_ack == MULTI_ACK_DETAILED
539 && got_common
540 && !got_other
541 && ok_to_give_up(data)) {
542 sent_ready = 1;
543 packet_write_fmt(1, "ACK %s ready\n", last_hex);
545 if (data->have_obj.nr == 0 || data->multi_ack)
546 packet_write_fmt(1, "NAK\n");
548 if (data->no_done && sent_ready) {
549 packet_write_fmt(1, "ACK %s\n", last_hex);
550 return 0;
552 if (data->stateless_rpc)
553 exit(0);
554 got_common = 0;
555 got_other = 0;
556 continue;
558 if (skip_prefix(reader->line, "have ", &arg)) {
559 switch (got_oid(data, arg, &oid)) {
560 case -1: /* they have what we do not */
561 got_other = 1;
562 if (data->multi_ack
563 && ok_to_give_up(data)) {
564 const char *hex = oid_to_hex(&oid);
565 if (data->multi_ack == MULTI_ACK_DETAILED) {
566 sent_ready = 1;
567 packet_write_fmt(1, "ACK %s ready\n", hex);
568 } else
569 packet_write_fmt(1, "ACK %s continue\n", hex);
571 break;
572 default:
573 got_common = 1;
574 oid_to_hex_r(last_hex, &oid);
575 if (data->multi_ack == MULTI_ACK_DETAILED)
576 packet_write_fmt(1, "ACK %s common\n", last_hex);
577 else if (data->multi_ack)
578 packet_write_fmt(1, "ACK %s continue\n", last_hex);
579 else if (data->have_obj.nr == 1)
580 packet_write_fmt(1, "ACK %s\n", last_hex);
581 break;
583 continue;
585 if (!strcmp(reader->line, "done")) {
586 if (data->have_obj.nr > 0) {
587 if (data->multi_ack)
588 packet_write_fmt(1, "ACK %s\n", last_hex);
589 return 0;
591 packet_write_fmt(1, "NAK\n");
592 return -1;
594 die("git upload-pack: expected SHA1 list, got '%s'", reader->line);
598 static int allow_hidden_refs(enum allow_uor allow_uor)
600 if ((allow_uor & ALLOW_ANY_SHA1) == ALLOW_ANY_SHA1)
601 return 1;
602 return !(allow_uor & (ALLOW_TIP_SHA1 | ALLOW_REACHABLE_SHA1));
605 static void for_each_namespaced_ref_1(each_ref_fn fn,
606 struct upload_pack_data *data)
608 const char **excludes = NULL;
610 * If `data->allow_uor` allows fetching hidden refs, we need to
611 * mark all references (including hidden ones), to check in
612 * `is_our_ref()` below.
614 * Otherwise, we only care about whether each reference's object
615 * has the OUR_REF bit set or not, so do not need to visit
616 * hidden references.
618 if (allow_hidden_refs(data->allow_uor))
619 excludes = hidden_refs_to_excludes(&data->hidden_refs);
621 for_each_namespaced_ref(excludes, fn, data);
625 static int is_our_ref(struct object *o, enum allow_uor allow_uor)
627 return o->flags & ((allow_hidden_refs(allow_uor) ? 0 : HIDDEN_REF) | OUR_REF);
631 * on successful case, it's up to the caller to close cmd->out
633 static int do_reachable_revlist(struct child_process *cmd,
634 struct object_array *src,
635 struct object_array *reachable,
636 enum allow_uor allow_uor)
638 struct object *o;
639 FILE *cmd_in = NULL;
640 int i;
642 strvec_pushl(&cmd->args, "rev-list", "--stdin", NULL);
643 cmd->git_cmd = 1;
644 cmd->no_stderr = 1;
645 cmd->in = -1;
646 cmd->out = -1;
649 * If the next rev-list --stdin encounters an unknown commit,
650 * it terminates, which will cause SIGPIPE in the write loop
651 * below.
653 sigchain_push(SIGPIPE, SIG_IGN);
655 if (start_command(cmd))
656 goto error;
658 cmd_in = xfdopen(cmd->in, "w");
660 for (i = get_max_object_index(); 0 < i; ) {
661 o = get_indexed_object(--i);
662 if (!o)
663 continue;
664 if (reachable && o->type == OBJ_COMMIT)
665 o->flags &= ~TMP_MARK;
666 if (!is_our_ref(o, allow_uor))
667 continue;
668 if (fprintf(cmd_in, "^%s\n", oid_to_hex(&o->oid)) < 0)
669 goto error;
671 for (i = 0; i < src->nr; i++) {
672 o = src->objects[i].item;
673 if (is_our_ref(o, allow_uor)) {
674 if (reachable)
675 add_object_array(o, NULL, reachable);
676 continue;
678 if (reachable && o->type == OBJ_COMMIT)
679 o->flags |= TMP_MARK;
680 if (fprintf(cmd_in, "%s\n", oid_to_hex(&o->oid)) < 0)
681 goto error;
683 if (ferror(cmd_in) || fflush(cmd_in))
684 goto error;
685 fclose(cmd_in);
686 cmd->in = -1;
687 sigchain_pop(SIGPIPE);
689 return 0;
691 error:
692 sigchain_pop(SIGPIPE);
694 if (cmd_in)
695 fclose(cmd_in);
696 if (cmd->out >= 0)
697 close(cmd->out);
698 return -1;
701 static int get_reachable_list(struct upload_pack_data *data,
702 struct object_array *reachable)
704 struct child_process cmd = CHILD_PROCESS_INIT;
705 int i;
706 struct object *o;
707 char namebuf[GIT_MAX_HEXSZ + 2]; /* ^ + hash + LF */
708 const unsigned hexsz = the_hash_algo->hexsz;
710 if (do_reachable_revlist(&cmd, &data->shallows, reachable,
711 data->allow_uor) < 0)
712 return -1;
714 while ((i = read_in_full(cmd.out, namebuf, hexsz + 1)) == hexsz + 1) {
715 struct object_id oid;
716 const char *p;
718 if (parse_oid_hex(namebuf, &oid, &p) || *p != '\n')
719 break;
721 o = lookup_object(the_repository, &oid);
722 if (o && o->type == OBJ_COMMIT) {
723 o->flags &= ~TMP_MARK;
726 for (i = get_max_object_index(); 0 < i; i--) {
727 o = get_indexed_object(i - 1);
728 if (o && o->type == OBJ_COMMIT &&
729 (o->flags & TMP_MARK)) {
730 add_object_array(o, NULL, reachable);
731 o->flags &= ~TMP_MARK;
734 close(cmd.out);
736 if (finish_command(&cmd))
737 return -1;
739 return 0;
742 static int has_unreachable(struct object_array *src, enum allow_uor allow_uor)
744 struct child_process cmd = CHILD_PROCESS_INIT;
745 char buf[1];
746 int i;
748 if (do_reachable_revlist(&cmd, src, NULL, allow_uor) < 0)
749 return 1;
752 * The commits out of the rev-list are not ancestors of
753 * our ref.
755 i = read_in_full(cmd.out, buf, 1);
756 if (i)
757 goto error;
758 close(cmd.out);
759 cmd.out = -1;
762 * rev-list may have died by encountering a bad commit
763 * in the history, in which case we do want to bail out
764 * even when it showed no commit.
766 if (finish_command(&cmd))
767 goto error;
769 /* All the non-tip ones are ancestors of what we advertised */
770 return 0;
772 error:
773 if (cmd.out >= 0)
774 close(cmd.out);
775 return 1;
778 static void check_non_tip(struct upload_pack_data *data)
780 int i;
783 * In the normal in-process case without
784 * uploadpack.allowReachableSHA1InWant,
785 * non-tip requests can never happen.
787 if (!data->stateless_rpc && !(data->allow_uor & ALLOW_REACHABLE_SHA1))
788 goto error;
789 if (!has_unreachable(&data->want_obj, data->allow_uor))
790 /* All the non-tip ones are ancestors of what we advertised */
791 return;
793 error:
794 /* Pick one of them (we know there at least is one) */
795 for (i = 0; i < data->want_obj.nr; i++) {
796 struct object *o = data->want_obj.objects[i].item;
797 if (!is_our_ref(o, data->allow_uor)) {
798 error("git upload-pack: not our ref %s",
799 oid_to_hex(&o->oid));
800 packet_writer_error(&data->writer,
801 "upload-pack: not our ref %s",
802 oid_to_hex(&o->oid));
803 exit(128);
808 static void send_shallow(struct upload_pack_data *data,
809 struct commit_list *result)
811 while (result) {
812 struct object *object = &result->item->object;
813 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
814 packet_writer_write(&data->writer, "shallow %s",
815 oid_to_hex(&object->oid));
816 register_shallow(the_repository, &object->oid);
817 data->shallow_nr++;
819 result = result->next;
823 static void send_unshallow(struct upload_pack_data *data)
825 int i;
827 for (i = 0; i < data->shallows.nr; i++) {
828 struct object *object = data->shallows.objects[i].item;
829 if (object->flags & NOT_SHALLOW) {
830 struct commit_list *parents;
831 packet_writer_write(&data->writer, "unshallow %s",
832 oid_to_hex(&object->oid));
833 object->flags &= ~CLIENT_SHALLOW;
835 * We want to _register_ "object" as shallow, but we
836 * also need to traverse object's parents to deepen a
837 * shallow clone. Unregister it for now so we can
838 * parse and add the parents to the want list, then
839 * re-register it.
841 unregister_shallow(&object->oid);
842 object->parsed = 0;
843 parse_commit_or_die((struct commit *)object);
844 parents = ((struct commit *)object)->parents;
845 while (parents) {
846 add_object_array(&parents->item->object,
847 NULL, &data->want_obj);
848 parents = parents->next;
850 add_object_array(object, NULL, &data->extra_edge_obj);
852 /* make sure commit traversal conforms to client */
853 register_shallow(the_repository, &object->oid);
857 static int check_ref(const char *refname_full, const struct object_id *oid,
858 int flag, void *cb_data);
859 static void deepen(struct upload_pack_data *data, int depth)
861 if (depth == INFINITE_DEPTH && !is_repository_shallow(the_repository)) {
862 int i;
864 for (i = 0; i < data->shallows.nr; i++) {
865 struct object *object = data->shallows.objects[i].item;
866 object->flags |= NOT_SHALLOW;
868 } else if (data->deepen_relative) {
869 struct object_array reachable_shallows = OBJECT_ARRAY_INIT;
870 struct commit_list *result;
873 * Checking for reachable shallows requires that our refs be
874 * marked with OUR_REF.
876 head_ref_namespaced(check_ref, data);
877 for_each_namespaced_ref_1(check_ref, data);
879 get_reachable_list(data, &reachable_shallows);
880 result = get_shallow_commits(&reachable_shallows,
881 depth + 1,
882 SHALLOW, NOT_SHALLOW);
883 send_shallow(data, result);
884 free_commit_list(result);
885 object_array_clear(&reachable_shallows);
886 } else {
887 struct commit_list *result;
889 result = get_shallow_commits(&data->want_obj, depth,
890 SHALLOW, NOT_SHALLOW);
891 send_shallow(data, result);
892 free_commit_list(result);
895 send_unshallow(data);
898 static void deepen_by_rev_list(struct upload_pack_data *data,
899 int ac,
900 const char **av)
902 struct commit_list *result;
904 disable_commit_graph(the_repository);
905 result = get_shallow_commits_by_rev_list(ac, av, SHALLOW, NOT_SHALLOW);
906 send_shallow(data, result);
907 free_commit_list(result);
908 send_unshallow(data);
911 /* Returns 1 if a shallow list is sent or 0 otherwise */
912 static int send_shallow_list(struct upload_pack_data *data)
914 int ret = 0;
916 if (data->depth > 0 && data->deepen_rev_list)
917 die("git upload-pack: deepen and deepen-since (or deepen-not) cannot be used together");
918 if (data->depth > 0) {
919 deepen(data, data->depth);
920 ret = 1;
921 } else if (data->deepen_rev_list) {
922 struct strvec av = STRVEC_INIT;
923 int i;
925 strvec_push(&av, "rev-list");
926 if (data->deepen_since)
927 strvec_pushf(&av, "--max-age=%"PRItime, data->deepen_since);
928 if (oidset_size(&data->deepen_not)) {
929 const struct object_id *oid;
930 struct oidset_iter iter;
931 strvec_push(&av, "--not");
932 oidset_iter_init(&data->deepen_not, &iter);
933 while ((oid = oidset_iter_next(&iter)))
934 strvec_push(&av, oid_to_hex(oid));
935 strvec_push(&av, "--not");
937 for (i = 0; i < data->want_obj.nr; i++) {
938 struct object *o = data->want_obj.objects[i].item;
939 strvec_push(&av, oid_to_hex(&o->oid));
941 deepen_by_rev_list(data, av.nr, av.v);
942 strvec_clear(&av);
943 ret = 1;
944 } else {
945 if (data->shallows.nr > 0) {
946 int i;
947 for (i = 0; i < data->shallows.nr; i++)
948 register_shallow(the_repository,
949 &data->shallows.objects[i].item->oid);
953 data->shallow_nr += data->shallows.nr;
954 return ret;
957 static int process_shallow(const char *line, struct object_array *shallows)
959 const char *arg;
960 if (skip_prefix(line, "shallow ", &arg)) {
961 struct object_id oid;
962 struct object *object;
963 if (get_oid_hex(arg, &oid))
964 die("invalid shallow line: %s", line);
965 object = parse_object(the_repository, &oid);
966 if (!object)
967 return 1;
968 if (object->type != OBJ_COMMIT)
969 die("invalid shallow object %s", oid_to_hex(&oid));
970 if (!(object->flags & CLIENT_SHALLOW)) {
971 object->flags |= CLIENT_SHALLOW;
972 add_object_array(object, NULL, shallows);
974 return 1;
977 return 0;
980 static int process_deepen(const char *line, int *depth)
982 const char *arg;
983 if (skip_prefix(line, "deepen ", &arg)) {
984 char *end = NULL;
985 *depth = (int)strtol(arg, &end, 0);
986 if (!end || *end || *depth <= 0)
987 die("Invalid deepen: %s", line);
988 return 1;
991 return 0;
994 static int process_deepen_since(const char *line, timestamp_t *deepen_since, int *deepen_rev_list)
996 const char *arg;
997 if (skip_prefix(line, "deepen-since ", &arg)) {
998 char *end = NULL;
999 *deepen_since = parse_timestamp(arg, &end, 0);
1000 if (!end || *end || !deepen_since ||
1001 /* revisions.c's max_age -1 is special */
1002 *deepen_since == -1)
1003 die("Invalid deepen-since: %s", line);
1004 *deepen_rev_list = 1;
1005 return 1;
1007 return 0;
1010 static int process_deepen_not(const char *line, struct oidset *deepen_not, int *deepen_rev_list)
1012 const char *arg;
1013 if (skip_prefix(line, "deepen-not ", &arg)) {
1014 char *ref = NULL;
1015 struct object_id oid;
1016 if (expand_ref(the_repository, arg, strlen(arg), &oid, &ref) != 1)
1017 die("git upload-pack: ambiguous deepen-not: %s", line);
1018 oidset_insert(deepen_not, &oid);
1019 free(ref);
1020 *deepen_rev_list = 1;
1021 return 1;
1023 return 0;
1026 NORETURN __attribute__((format(printf,2,3)))
1027 static void send_err_and_die(struct upload_pack_data *data,
1028 const char *fmt, ...)
1030 struct strbuf buf = STRBUF_INIT;
1031 va_list ap;
1033 va_start(ap, fmt);
1034 strbuf_vaddf(&buf, fmt, ap);
1035 va_end(ap);
1037 packet_writer_error(&data->writer, "%s", buf.buf);
1038 die("%s", buf.buf);
1041 static void check_one_filter(struct upload_pack_data *data,
1042 struct list_objects_filter_options *opts)
1044 const char *key = list_object_filter_config_name(opts->choice);
1045 struct string_list_item *item = string_list_lookup(&data->allowed_filters,
1046 key);
1047 int allowed;
1049 if (item)
1050 allowed = (intptr_t)item->util;
1051 else
1052 allowed = data->allow_filter_fallback;
1054 if (!allowed)
1055 send_err_and_die(data, "filter '%s' not supported", key);
1057 if (opts->choice == LOFC_TREE_DEPTH &&
1058 opts->tree_exclude_depth > data->tree_filter_max_depth)
1059 send_err_and_die(data,
1060 "tree filter allows max depth %lu, but got %lu",
1061 data->tree_filter_max_depth,
1062 opts->tree_exclude_depth);
1065 static void check_filter_recurse(struct upload_pack_data *data,
1066 struct list_objects_filter_options *opts)
1068 size_t i;
1070 check_one_filter(data, opts);
1071 if (opts->choice != LOFC_COMBINE)
1072 return;
1074 for (i = 0; i < opts->sub_nr; i++)
1075 check_filter_recurse(data, &opts->sub[i]);
1078 static void die_if_using_banned_filter(struct upload_pack_data *data)
1080 check_filter_recurse(data, &data->filter_options);
1083 static void receive_needs(struct upload_pack_data *data,
1084 struct packet_reader *reader)
1086 int has_non_tip = 0;
1088 data->shallow_nr = 0;
1089 for (;;) {
1090 struct object *o;
1091 const char *features;
1092 struct object_id oid_buf;
1093 const char *arg;
1094 size_t feature_len;
1096 reset_timeout(data->timeout);
1097 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
1098 break;
1100 if (process_shallow(reader->line, &data->shallows))
1101 continue;
1102 if (process_deepen(reader->line, &data->depth))
1103 continue;
1104 if (process_deepen_since(reader->line, &data->deepen_since, &data->deepen_rev_list))
1105 continue;
1106 if (process_deepen_not(reader->line, &data->deepen_not, &data->deepen_rev_list))
1107 continue;
1109 if (skip_prefix(reader->line, "filter ", &arg)) {
1110 if (!data->filter_capability_requested)
1111 die("git upload-pack: filtering capability not negotiated");
1112 list_objects_filter_die_if_populated(&data->filter_options);
1113 parse_list_objects_filter(&data->filter_options, arg);
1114 die_if_using_banned_filter(data);
1115 continue;
1118 if (!skip_prefix(reader->line, "want ", &arg) ||
1119 parse_oid_hex(arg, &oid_buf, &features))
1120 die("git upload-pack: protocol error, "
1121 "expected to get object ID, not '%s'", reader->line);
1123 if (parse_feature_request(features, "deepen-relative"))
1124 data->deepen_relative = 1;
1125 if (parse_feature_request(features, "multi_ack_detailed"))
1126 data->multi_ack = MULTI_ACK_DETAILED;
1127 else if (parse_feature_request(features, "multi_ack"))
1128 data->multi_ack = MULTI_ACK;
1129 if (parse_feature_request(features, "no-done"))
1130 data->no_done = 1;
1131 if (parse_feature_request(features, "thin-pack"))
1132 data->use_thin_pack = 1;
1133 if (parse_feature_request(features, "ofs-delta"))
1134 data->use_ofs_delta = 1;
1135 if (parse_feature_request(features, "side-band-64k"))
1136 data->use_sideband = LARGE_PACKET_MAX;
1137 else if (parse_feature_request(features, "side-band"))
1138 data->use_sideband = DEFAULT_PACKET_MAX;
1139 if (parse_feature_request(features, "no-progress"))
1140 data->no_progress = 1;
1141 if (parse_feature_request(features, "include-tag"))
1142 data->use_include_tag = 1;
1143 if (data->allow_filter &&
1144 parse_feature_request(features, "filter"))
1145 data->filter_capability_requested = 1;
1147 arg = parse_feature_value(features, "session-id", &feature_len, NULL);
1148 if (arg) {
1149 char *client_sid = xstrndup(arg, feature_len);
1150 trace2_data_string("transfer", NULL, "client-sid", client_sid);
1151 free(client_sid);
1154 o = parse_object_with_flags(the_repository, &oid_buf,
1155 PARSE_OBJECT_SKIP_HASH_CHECK |
1156 PARSE_OBJECT_DISCARD_TREE);
1157 if (!o) {
1158 packet_writer_error(&data->writer,
1159 "upload-pack: not our ref %s",
1160 oid_to_hex(&oid_buf));
1161 die("git upload-pack: not our ref %s",
1162 oid_to_hex(&oid_buf));
1164 if (!(o->flags & WANTED)) {
1165 o->flags |= WANTED;
1166 if (!((data->allow_uor & ALLOW_ANY_SHA1) == ALLOW_ANY_SHA1
1167 || is_our_ref(o, data->allow_uor)))
1168 has_non_tip = 1;
1169 add_object_array(o, NULL, &data->want_obj);
1174 * We have sent all our refs already, and the other end
1175 * should have chosen out of them. When we are operating
1176 * in the stateless RPC mode, however, their choice may
1177 * have been based on the set of older refs advertised
1178 * by another process that handled the initial request.
1180 if (has_non_tip)
1181 check_non_tip(data);
1183 if (!data->use_sideband && data->daemon_mode)
1184 data->no_progress = 1;
1186 if (data->depth == 0 && !data->deepen_rev_list && data->shallows.nr == 0)
1187 return;
1189 if (send_shallow_list(data))
1190 packet_flush(1);
1193 /* return non-zero if the ref is hidden, otherwise 0 */
1194 static int mark_our_ref(const char *refname, const char *refname_full,
1195 const struct object_id *oid, const struct strvec *hidden_refs)
1197 struct object *o = lookup_unknown_object(the_repository, oid);
1199 if (ref_is_hidden(refname, refname_full, hidden_refs)) {
1200 o->flags |= HIDDEN_REF;
1201 return 1;
1203 o->flags |= OUR_REF;
1204 return 0;
1207 static int check_ref(const char *refname_full, const struct object_id *oid,
1208 int flag UNUSED, void *cb_data)
1210 const char *refname = strip_namespace(refname_full);
1211 struct upload_pack_data *data = cb_data;
1213 mark_our_ref(refname, refname_full, oid, &data->hidden_refs);
1214 return 0;
1217 static void format_symref_info(struct strbuf *buf, struct string_list *symref)
1219 struct string_list_item *item;
1221 if (!symref->nr)
1222 return;
1223 for_each_string_list_item(item, symref)
1224 strbuf_addf(buf, " symref=%s:%s", item->string, (char *)item->util);
1227 static void format_session_id(struct strbuf *buf, struct upload_pack_data *d) {
1228 if (d->advertise_sid)
1229 strbuf_addf(buf, " session-id=%s", trace2_session_id());
1232 static void write_v0_ref(struct upload_pack_data *data,
1233 const char *refname, const char *refname_nons,
1234 const struct object_id *oid)
1236 static const char *capabilities = "multi_ack thin-pack side-band"
1237 " side-band-64k ofs-delta shallow deepen-since deepen-not"
1238 " deepen-relative no-progress include-tag multi_ack_detailed";
1239 struct object_id peeled;
1241 if (mark_our_ref(refname_nons, refname, oid, &data->hidden_refs))
1242 return;
1244 if (capabilities) {
1245 struct strbuf symref_info = STRBUF_INIT;
1246 struct strbuf session_id = STRBUF_INIT;
1248 format_symref_info(&symref_info, &data->symref);
1249 format_session_id(&session_id, data);
1250 packet_fwrite_fmt(stdout, "%s %s%c%s%s%s%s%s%s%s object-format=%s agent=%s\n",
1251 oid_to_hex(oid), refname_nons,
1252 0, capabilities,
1253 (data->allow_uor & ALLOW_TIP_SHA1) ?
1254 " allow-tip-sha1-in-want" : "",
1255 (data->allow_uor & ALLOW_REACHABLE_SHA1) ?
1256 " allow-reachable-sha1-in-want" : "",
1257 data->no_done ? " no-done" : "",
1258 symref_info.buf,
1259 data->allow_filter ? " filter" : "",
1260 session_id.buf,
1261 the_hash_algo->name,
1262 git_user_agent_sanitized());
1263 strbuf_release(&symref_info);
1264 strbuf_release(&session_id);
1265 data->sent_capabilities = 1;
1266 } else {
1267 packet_fwrite_fmt(stdout, "%s %s\n", oid_to_hex(oid), refname_nons);
1269 capabilities = NULL;
1270 if (!peel_iterated_oid(oid, &peeled))
1271 packet_fwrite_fmt(stdout, "%s %s^{}\n", oid_to_hex(&peeled), refname_nons);
1272 return;
1275 static int send_ref(const char *refname, const struct object_id *oid,
1276 int flag UNUSED, void *cb_data)
1278 write_v0_ref(cb_data, refname, strip_namespace(refname), oid);
1279 return 0;
1282 static int find_symref(const char *refname,
1283 const struct object_id *oid UNUSED,
1284 int flag, void *cb_data)
1286 const char *symref_target;
1287 struct string_list_item *item;
1289 if ((flag & REF_ISSYMREF) == 0)
1290 return 0;
1291 symref_target = resolve_ref_unsafe(refname, 0, NULL, &flag);
1292 if (!symref_target || (flag & REF_ISSYMREF) == 0)
1293 die("'%s' is a symref but it is not?", refname);
1294 item = string_list_append(cb_data, strip_namespace(refname));
1295 item->util = xstrdup(strip_namespace(symref_target));
1296 return 0;
1299 static int parse_object_filter_config(const char *var, const char *value,
1300 const struct key_value_info *kvi,
1301 struct upload_pack_data *data)
1303 struct strbuf buf = STRBUF_INIT;
1304 const char *sub, *key;
1305 size_t sub_len;
1307 if (parse_config_key(var, "uploadpackfilter", &sub, &sub_len, &key))
1308 return 0;
1310 if (!sub) {
1311 if (!strcmp(key, "allow"))
1312 data->allow_filter_fallback = git_config_bool(var, value);
1313 return 0;
1316 strbuf_add(&buf, sub, sub_len);
1318 if (!strcmp(key, "allow"))
1319 string_list_insert(&data->allowed_filters, buf.buf)->util =
1320 (void *)(intptr_t)git_config_bool(var, value);
1321 else if (!strcmp(buf.buf, "tree") && !strcmp(key, "maxdepth")) {
1322 if (!value) {
1323 strbuf_release(&buf);
1324 return config_error_nonbool(var);
1326 string_list_insert(&data->allowed_filters, buf.buf)->util =
1327 (void *)(intptr_t)1;
1328 data->tree_filter_max_depth = git_config_ulong(var, value,
1329 kvi);
1332 strbuf_release(&buf);
1333 return 0;
1336 static int upload_pack_config(const char *var, const char *value,
1337 const struct config_context *ctx,
1338 void *cb_data)
1340 struct upload_pack_data *data = cb_data;
1342 if (!strcmp("uploadpack.allowtipsha1inwant", var)) {
1343 if (git_config_bool(var, value))
1344 data->allow_uor |= ALLOW_TIP_SHA1;
1345 else
1346 data->allow_uor &= ~ALLOW_TIP_SHA1;
1347 } else if (!strcmp("uploadpack.allowreachablesha1inwant", var)) {
1348 if (git_config_bool(var, value))
1349 data->allow_uor |= ALLOW_REACHABLE_SHA1;
1350 else
1351 data->allow_uor &= ~ALLOW_REACHABLE_SHA1;
1352 } else if (!strcmp("uploadpack.allowanysha1inwant", var)) {
1353 if (git_config_bool(var, value))
1354 data->allow_uor |= ALLOW_ANY_SHA1;
1355 else
1356 data->allow_uor &= ~ALLOW_ANY_SHA1;
1357 } else if (!strcmp("uploadpack.keepalive", var)) {
1358 data->keepalive = git_config_int(var, value, ctx->kvi);
1359 if (!data->keepalive)
1360 data->keepalive = -1;
1361 } else if (!strcmp("uploadpack.allowfilter", var)) {
1362 data->allow_filter = git_config_bool(var, value);
1363 } else if (!strcmp("uploadpack.allowrefinwant", var)) {
1364 data->allow_ref_in_want = git_config_bool(var, value);
1365 } else if (!strcmp("uploadpack.allowsidebandall", var)) {
1366 data->allow_sideband_all = git_config_bool(var, value);
1367 } else if (!strcmp("uploadpack.blobpackfileuri", var)) {
1368 if (value)
1369 data->allow_packfile_uris = 1;
1370 } else if (!strcmp("core.precomposeunicode", var)) {
1371 precomposed_unicode = git_config_bool(var, value);
1372 } else if (!strcmp("transfer.advertisesid", var)) {
1373 data->advertise_sid = git_config_bool(var, value);
1376 if (parse_object_filter_config(var, value, ctx->kvi, data) < 0)
1377 return -1;
1379 return parse_hide_refs_config(var, value, "uploadpack", &data->hidden_refs);
1382 static int upload_pack_protected_config(const char *var, const char *value,
1383 const struct config_context *ctx UNUSED,
1384 void *cb_data)
1386 struct upload_pack_data *data = cb_data;
1388 if (!strcmp("uploadpack.packobjectshook", var))
1389 return git_config_string(&data->pack_objects_hook, var, value);
1390 return 0;
1393 static void get_upload_pack_config(struct repository *r,
1394 struct upload_pack_data *data)
1396 repo_config(r, upload_pack_config, data);
1397 git_protected_config(upload_pack_protected_config, data);
1399 data->allow_sideband_all |= git_env_bool("GIT_TEST_SIDEBAND_ALL", 0);
1402 void upload_pack(const int advertise_refs, const int stateless_rpc,
1403 const int timeout)
1405 struct packet_reader reader;
1406 struct upload_pack_data data;
1408 upload_pack_data_init(&data);
1409 get_upload_pack_config(the_repository, &data);
1411 data.stateless_rpc = stateless_rpc;
1412 data.timeout = timeout;
1413 if (data.timeout)
1414 data.daemon_mode = 1;
1416 head_ref_namespaced(find_symref, &data.symref);
1418 if (advertise_refs || !data.stateless_rpc) {
1419 reset_timeout(data.timeout);
1420 if (advertise_refs)
1421 data.no_done = 1;
1422 head_ref_namespaced(send_ref, &data);
1423 for_each_namespaced_ref_1(send_ref, &data);
1424 if (!data.sent_capabilities) {
1425 const char *refname = "capabilities^{}";
1426 write_v0_ref(&data, refname, refname, null_oid());
1429 * fflush stdout before calling advertise_shallow_grafts because send_ref
1430 * uses stdio.
1432 fflush_or_die(stdout);
1433 advertise_shallow_grafts(1);
1434 packet_flush(1);
1435 } else {
1436 head_ref_namespaced(check_ref, &data);
1437 for_each_namespaced_ref_1(check_ref, &data);
1440 if (!advertise_refs) {
1441 packet_reader_init(&reader, 0, NULL, 0,
1442 PACKET_READ_CHOMP_NEWLINE |
1443 PACKET_READ_DIE_ON_ERR_PACKET);
1445 receive_needs(&data, &reader);
1448 * An EOF at this exact point in negotiation should be
1449 * acceptable from stateless clients as they will consume the
1450 * shallow list before doing subsequent rpc with haves/etc.
1452 if (data.stateless_rpc)
1453 reader.options |= PACKET_READ_GENTLE_ON_EOF;
1455 if (data.want_obj.nr &&
1456 packet_reader_peek(&reader) != PACKET_READ_EOF) {
1457 reader.options &= ~PACKET_READ_GENTLE_ON_EOF;
1458 get_common_commits(&data, &reader);
1459 create_pack_file(&data, NULL);
1463 upload_pack_data_clear(&data);
1466 static int parse_want(struct packet_writer *writer, const char *line,
1467 struct object_array *want_obj)
1469 const char *arg;
1470 if (skip_prefix(line, "want ", &arg)) {
1471 struct object_id oid;
1472 struct object *o;
1474 if (get_oid_hex(arg, &oid))
1475 die("git upload-pack: protocol error, "
1476 "expected to get oid, not '%s'", line);
1478 o = parse_object_with_flags(the_repository, &oid,
1479 PARSE_OBJECT_SKIP_HASH_CHECK |
1480 PARSE_OBJECT_DISCARD_TREE);
1482 if (!o) {
1483 packet_writer_error(writer,
1484 "upload-pack: not our ref %s",
1485 oid_to_hex(&oid));
1486 die("git upload-pack: not our ref %s",
1487 oid_to_hex(&oid));
1490 if (!(o->flags & WANTED)) {
1491 o->flags |= WANTED;
1492 add_object_array(o, NULL, want_obj);
1495 return 1;
1498 return 0;
1501 static int parse_want_ref(struct packet_writer *writer, const char *line,
1502 struct strmap *wanted_refs,
1503 struct strvec *hidden_refs,
1504 struct object_array *want_obj)
1506 const char *refname_nons;
1507 if (skip_prefix(line, "want-ref ", &refname_nons)) {
1508 struct object_id oid;
1509 struct object *o = NULL;
1510 struct strbuf refname = STRBUF_INIT;
1512 strbuf_addf(&refname, "%s%s", get_git_namespace(), refname_nons);
1513 if (ref_is_hidden(refname_nons, refname.buf, hidden_refs) ||
1514 read_ref(refname.buf, &oid)) {
1515 packet_writer_error(writer, "unknown ref %s", refname_nons);
1516 die("unknown ref %s", refname_nons);
1518 strbuf_release(&refname);
1520 if (strmap_put(wanted_refs, refname_nons, oiddup(&oid))) {
1521 packet_writer_error(writer, "duplicate want-ref %s",
1522 refname_nons);
1523 die("duplicate want-ref %s", refname_nons);
1526 if (!starts_with(refname_nons, "refs/tags/")) {
1527 struct commit *commit = lookup_commit_in_graph(the_repository, &oid);
1528 if (commit)
1529 o = &commit->object;
1532 if (!o)
1533 o = parse_object_or_die(&oid, refname_nons);
1535 if (!(o->flags & WANTED)) {
1536 o->flags |= WANTED;
1537 add_object_array(o, NULL, want_obj);
1540 return 1;
1543 return 0;
1546 static int parse_have(const char *line, struct upload_pack_data *data)
1548 const char *arg;
1549 if (skip_prefix(line, "have ", &arg)) {
1550 struct object_id oid;
1552 got_oid(data, arg, &oid);
1553 data->seen_haves = 1;
1554 return 1;
1557 return 0;
1560 static void trace2_fetch_info(struct upload_pack_data *data)
1562 struct json_writer jw = JSON_WRITER_INIT;
1564 jw_object_begin(&jw, 0);
1565 jw_object_intmax(&jw, "haves", data->have_obj.nr);
1566 jw_object_intmax(&jw, "wants", data->want_obj.nr);
1567 jw_object_intmax(&jw, "want-refs", strmap_get_size(&data->wanted_refs));
1568 jw_object_intmax(&jw, "depth", data->depth);
1569 jw_object_intmax(&jw, "shallows", data->shallows.nr);
1570 jw_object_bool(&jw, "deepen-since", data->deepen_since);
1571 jw_object_intmax(&jw, "deepen-not", oidset_size(&data->deepen_not));
1572 jw_object_bool(&jw, "deepen-relative", data->deepen_relative);
1573 if (data->filter_options.choice)
1574 jw_object_string(&jw, "filter", list_object_filter_config_name(data->filter_options.choice));
1575 else
1576 jw_object_null(&jw, "filter");
1577 jw_end(&jw);
1579 trace2_data_json("upload-pack", the_repository, "fetch-info", &jw);
1581 jw_release(&jw);
1584 static void process_args(struct packet_reader *request,
1585 struct upload_pack_data *data)
1587 while (packet_reader_read(request) == PACKET_READ_NORMAL) {
1588 const char *arg = request->line;
1589 const char *p;
1591 /* process want */
1592 if (parse_want(&data->writer, arg, &data->want_obj))
1593 continue;
1594 if (data->allow_ref_in_want &&
1595 parse_want_ref(&data->writer, arg, &data->wanted_refs,
1596 &data->hidden_refs, &data->want_obj))
1597 continue;
1598 /* process have line */
1599 if (parse_have(arg, data))
1600 continue;
1602 /* process args like thin-pack */
1603 if (!strcmp(arg, "thin-pack")) {
1604 data->use_thin_pack = 1;
1605 continue;
1607 if (!strcmp(arg, "ofs-delta")) {
1608 data->use_ofs_delta = 1;
1609 continue;
1611 if (!strcmp(arg, "no-progress")) {
1612 data->no_progress = 1;
1613 continue;
1615 if (!strcmp(arg, "include-tag")) {
1616 data->use_include_tag = 1;
1617 continue;
1619 if (!strcmp(arg, "done")) {
1620 data->done = 1;
1621 continue;
1623 if (!strcmp(arg, "wait-for-done")) {
1624 data->wait_for_done = 1;
1625 continue;
1628 /* Shallow related arguments */
1629 if (process_shallow(arg, &data->shallows))
1630 continue;
1631 if (process_deepen(arg, &data->depth))
1632 continue;
1633 if (process_deepen_since(arg, &data->deepen_since,
1634 &data->deepen_rev_list))
1635 continue;
1636 if (process_deepen_not(arg, &data->deepen_not,
1637 &data->deepen_rev_list))
1638 continue;
1639 if (!strcmp(arg, "deepen-relative")) {
1640 data->deepen_relative = 1;
1641 continue;
1644 if (data->allow_filter && skip_prefix(arg, "filter ", &p)) {
1645 list_objects_filter_die_if_populated(&data->filter_options);
1646 parse_list_objects_filter(&data->filter_options, p);
1647 die_if_using_banned_filter(data);
1648 continue;
1651 if (data->allow_sideband_all &&
1652 !strcmp(arg, "sideband-all")) {
1653 data->writer.use_sideband = 1;
1654 continue;
1657 if (data->allow_packfile_uris &&
1658 skip_prefix(arg, "packfile-uris ", &p)) {
1659 if (data->uri_protocols.nr)
1660 send_err_and_die(data,
1661 "multiple packfile-uris lines forbidden");
1662 string_list_split(&data->uri_protocols, p, ',', -1);
1663 continue;
1666 /* ignore unknown lines maybe? */
1667 die("unexpected line: '%s'", arg);
1670 if (data->uri_protocols.nr && !data->writer.use_sideband)
1671 string_list_clear(&data->uri_protocols, 0);
1673 if (request->status != PACKET_READ_FLUSH)
1674 die(_("expected flush after fetch arguments"));
1676 if (trace2_is_enabled())
1677 trace2_fetch_info(data);
1680 static int send_acks(struct upload_pack_data *data, struct object_array *acks)
1682 int i;
1684 packet_writer_write(&data->writer, "acknowledgments\n");
1686 /* Send Acks */
1687 if (!acks->nr)
1688 packet_writer_write(&data->writer, "NAK\n");
1690 for (i = 0; i < acks->nr; i++) {
1691 packet_writer_write(&data->writer, "ACK %s\n",
1692 oid_to_hex(&acks->objects[i].item->oid));
1695 if (!data->wait_for_done && ok_to_give_up(data)) {
1696 /* Send Ready */
1697 packet_writer_write(&data->writer, "ready\n");
1698 return 1;
1701 return 0;
1704 static int process_haves_and_send_acks(struct upload_pack_data *data)
1706 int ret = 0;
1708 if (data->done) {
1709 ret = 1;
1710 } else if (send_acks(data, &data->have_obj)) {
1711 packet_writer_delim(&data->writer);
1712 ret = 1;
1713 } else {
1714 /* Add Flush */
1715 packet_writer_flush(&data->writer);
1716 ret = 0;
1719 return ret;
1722 static void send_wanted_ref_info(struct upload_pack_data *data)
1724 struct hashmap_iter iter;
1725 const struct strmap_entry *e;
1727 if (strmap_empty(&data->wanted_refs))
1728 return;
1730 packet_writer_write(&data->writer, "wanted-refs\n");
1732 strmap_for_each_entry(&data->wanted_refs, &iter, e) {
1733 packet_writer_write(&data->writer, "%s %s\n",
1734 oid_to_hex(e->value),
1735 e->key);
1738 packet_writer_delim(&data->writer);
1741 static void send_shallow_info(struct upload_pack_data *data)
1743 /* No shallow info needs to be sent */
1744 if (!data->depth && !data->deepen_rev_list && !data->shallows.nr &&
1745 !is_repository_shallow(the_repository))
1746 return;
1748 packet_writer_write(&data->writer, "shallow-info\n");
1750 if (!send_shallow_list(data) &&
1751 is_repository_shallow(the_repository))
1752 deepen(data, INFINITE_DEPTH);
1754 packet_delim(1);
1757 enum fetch_state {
1758 FETCH_PROCESS_ARGS = 0,
1759 FETCH_SEND_ACKS,
1760 FETCH_SEND_PACK,
1761 FETCH_DONE,
1764 int upload_pack_v2(struct repository *r, struct packet_reader *request)
1766 enum fetch_state state = FETCH_PROCESS_ARGS;
1767 struct upload_pack_data data;
1769 clear_object_flags(ALL_FLAGS);
1771 upload_pack_data_init(&data);
1772 data.use_sideband = LARGE_PACKET_MAX;
1773 get_upload_pack_config(r, &data);
1775 while (state != FETCH_DONE) {
1776 switch (state) {
1777 case FETCH_PROCESS_ARGS:
1778 process_args(request, &data);
1780 if (!data.want_obj.nr && !data.wait_for_done) {
1782 * Request didn't contain any 'want' lines (and
1783 * the request does not contain
1784 * "wait-for-done", in which it is reasonable
1785 * to just send 'have's without 'want's); guess
1786 * they didn't want anything.
1788 state = FETCH_DONE;
1789 } else if (data.seen_haves) {
1791 * Request had 'have' lines, so lets ACK them.
1793 state = FETCH_SEND_ACKS;
1794 } else {
1796 * Request had 'want's but no 'have's so we can
1797 * immedietly go to construct and send a pack.
1799 state = FETCH_SEND_PACK;
1801 break;
1802 case FETCH_SEND_ACKS:
1803 if (process_haves_and_send_acks(&data))
1804 state = FETCH_SEND_PACK;
1805 else
1806 state = FETCH_DONE;
1807 break;
1808 case FETCH_SEND_PACK:
1809 send_wanted_ref_info(&data);
1810 send_shallow_info(&data);
1812 if (data.uri_protocols.nr) {
1813 create_pack_file(&data, &data.uri_protocols);
1814 } else {
1815 packet_writer_write(&data.writer, "packfile\n");
1816 create_pack_file(&data, NULL);
1818 state = FETCH_DONE;
1819 break;
1820 case FETCH_DONE:
1821 continue;
1825 upload_pack_data_clear(&data);
1826 return 0;
1829 int upload_pack_advertise(struct repository *r,
1830 struct strbuf *value)
1832 struct upload_pack_data data;
1834 upload_pack_data_init(&data);
1835 get_upload_pack_config(r, &data);
1837 if (value) {
1838 strbuf_addstr(value, "shallow wait-for-done");
1840 if (data.allow_filter)
1841 strbuf_addstr(value, " filter");
1843 if (data.allow_ref_in_want)
1844 strbuf_addstr(value, " ref-in-want");
1846 if (data.allow_sideband_all)
1847 strbuf_addstr(value, " sideband-all");
1849 if (data.allow_packfile_uris)
1850 strbuf_addstr(value, " packfile-uris");
1853 upload_pack_data_clear(&data);
1855 return 1;