11 #include "list-objects.h"
12 #include "run-command.h"
16 #include "string-list.h"
18 static const char upload_pack_usage[] = "git upload-pack [--strict] [--timeout=<n>] <dir>";
20 /* Remember to update object flag allocation in object.h */
21 #define THEY_HAVE (1u << 11)
22 #define OUR_REF (1u << 12)
23 #define WANTED (1u << 13)
24 #define COMMON_KNOWN (1u << 14)
25 #define REACHABLE (1u << 15)
27 #define SHALLOW (1u << 16)
28 #define NOT_SHALLOW (1u << 17)
29 #define CLIENT_SHALLOW (1u << 18)
30 #define HIDDEN_REF (1u << 19)
32 static unsigned long oldest_have;
36 static int use_thin_pack, use_ofs_delta, use_include_tag;
37 static int no_progress, daemon_mode;
38 /* Allow specifying sha1 if it is a ref tip. */
39 #define ALLOW_TIP_SHA1 01
40 /* Allow request of a sha1 if it is reachable from a ref (possibly hidden ref). */
41 #define ALLOW_REACHABLE_SHA1 02
42 static unsigned int allow_unadvertised_object_request;
43 static int shallow_nr;
44 static struct object_array have_obj;
45 static struct object_array want_obj;
46 static struct object_array extra_edge_obj;
47 static unsigned int timeout;
48 static int keepalive = 5;
50 * otherwise maximum packet size (up to 65520 bytes).
52 static int use_sideband;
53 static int advertise_refs;
54 static int stateless_rpc;
56 static void reset_timeout(void)
61 static ssize_t send_client_data(int fd, const char *data, ssize_t sz)
64 return send_sideband(1, fd, data, sz, use_sideband);
69 /* XXX: are we happy to lose stuff here? */
73 write_or_die(fd, data, sz);
77 static int write_one_shallow(const struct commit_graft *graft, void *cb_data)
80 if (graft->nr_parent == -1)
81 fprintf(fp, "--shallow %s\n", oid_to_hex(&graft->oid));
85 static void create_pack_file(void)
87 struct child_process pack_objects = CHILD_PROCESS_INIT;
88 char data[8193], progress[128];
89 char abort_msg[] = "aborting due to possible repository "
90 "corruption on the remote side.";
98 argv[arg++] = "--shallow-file";
101 argv[arg++] = "pack-objects";
102 argv[arg++] = "--revs";
104 argv[arg++] = "--thin";
106 argv[arg++] = "--stdout";
108 argv[arg++] = "--shallow";
110 argv[arg++] = "--progress";
112 argv[arg++] = "--delta-base-offset";
114 argv[arg++] = "--include-tag";
117 pack_objects.in = -1;
118 pack_objects.out = -1;
119 pack_objects.err = -1;
120 pack_objects.git_cmd = 1;
121 pack_objects.argv = argv;
123 if (start_command(&pack_objects))
124 die("git upload-pack: unable to fork git-pack-objects");
126 pipe_fd = xfdopen(pack_objects.in, "w");
129 for_each_commit_graft(write_one_shallow, pipe_fd);
131 for (i = 0; i < want_obj.nr; i++)
132 fprintf(pipe_fd, "%s\n",
133 oid_to_hex(&want_obj.objects[i].item->oid));
134 fprintf(pipe_fd, "--not\n");
135 for (i = 0; i < have_obj.nr; i++)
136 fprintf(pipe_fd, "%s\n",
137 oid_to_hex(&have_obj.objects[i].item->oid));
138 for (i = 0; i < extra_edge_obj.nr; i++)
139 fprintf(pipe_fd, "%s\n",
140 oid_to_hex(&extra_edge_obj.objects[i].item->oid));
141 fprintf(pipe_fd, "\n");
145 /* We read from pack_objects.err to capture stderr output for
146 * progress bar, and pack_objects.out to capture the pack data.
150 struct pollfd pfd[2];
151 int pe, pu, pollsize;
159 if (0 <= pack_objects.out) {
160 pfd[pollsize].fd = pack_objects.out;
161 pfd[pollsize].events = POLLIN;
165 if (0 <= pack_objects.err) {
166 pfd[pollsize].fd = pack_objects.err;
167 pfd[pollsize].events = POLLIN;
175 ret = poll(pfd, pollsize,
176 keepalive < 0 ? -1 : 1000 * keepalive);
179 if (errno != EINTR) {
180 error("poll failed, resuming: %s",
186 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
187 /* Status ready; we ship that in the side-band
188 * or dump to the standard error.
190 sz = xread(pack_objects.err, progress,
193 send_client_data(2, progress, sz);
195 close(pack_objects.err);
196 pack_objects.err = -1;
200 /* give priority to status messages */
203 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
204 /* Data ready; we keep the last byte to ourselves
205 * in case we detect broken rev-list, so that we
206 * can leave the stream corrupted. This is
207 * unfortunate -- unpack-objects would happily
208 * accept a valid packdata with trailing garbage,
209 * so appending garbage after we pass all the
210 * pack data is not good enough to signal
211 * breakage to downstream.
219 sz = xread(pack_objects.out, cp,
220 sizeof(data) - outsz);
224 close(pack_objects.out);
225 pack_objects.out = -1;
231 buffered = data[sz-1] & 0xFF;
236 sz = send_client_data(1, data, sz);
242 * We hit the keepalive timeout without saying anything; send
243 * an empty message on the data sideband just to let the other
244 * side know we're still working on it, but don't have any data
247 * If we don't have a sideband channel, there's no room in the
248 * protocol to say anything, so those clients are just out of
251 if (!ret && use_sideband) {
252 static const char buf[] = "0005\1";
253 write_or_die(1, buf, 5);
257 if (finish_command(&pack_objects)) {
258 error("git upload-pack: git-pack-objects died with error.");
265 sz = send_client_data(1, data, 1);
268 fprintf(stderr, "flushed.\n");
275 send_client_data(3, abort_msg, sizeof(abort_msg));
276 die("git upload-pack: %s", abort_msg);
279 static int got_sha1(const char *hex, unsigned char *sha1)
282 int we_knew_they_have = 0;
284 if (get_sha1_hex(hex, sha1))
285 die("git upload-pack: expected SHA1 object, got '%s'", hex);
286 if (!has_sha1_file(sha1))
289 o = parse_object(sha1);
291 die("oops (%s)", sha1_to_hex(sha1));
292 if (o->type == OBJ_COMMIT) {
293 struct commit_list *parents;
294 struct commit *commit = (struct commit *)o;
295 if (o->flags & THEY_HAVE)
296 we_knew_they_have = 1;
298 o->flags |= THEY_HAVE;
299 if (!oldest_have || (commit->date < oldest_have))
300 oldest_have = commit->date;
301 for (parents = commit->parents;
303 parents = parents->next)
304 parents->item->object.flags |= THEY_HAVE;
306 if (!we_knew_they_have) {
307 add_object_array(o, NULL, &have_obj);
313 static int reachable(struct commit *want)
315 struct commit_list *work = NULL;
317 commit_list_insert_by_date(want, &work);
319 struct commit_list *list;
320 struct commit *commit = pop_commit(&work);
322 if (commit->object.flags & THEY_HAVE) {
323 want->object.flags |= COMMON_KNOWN;
326 if (!commit->object.parsed)
327 parse_object(commit->object.oid.hash);
328 if (commit->object.flags & REACHABLE)
330 commit->object.flags |= REACHABLE;
331 if (commit->date < oldest_have)
333 for (list = commit->parents; list; list = list->next) {
334 struct commit *parent = list->item;
335 if (!(parent->object.flags & REACHABLE))
336 commit_list_insert_by_date(parent, &work);
339 want->object.flags |= REACHABLE;
340 clear_commit_marks(want, REACHABLE);
341 free_commit_list(work);
342 return (want->object.flags & COMMON_KNOWN);
345 static int ok_to_give_up(void)
352 for (i = 0; i < want_obj.nr; i++) {
353 struct object *want = want_obj.objects[i].item;
355 if (want->flags & COMMON_KNOWN)
357 want = deref_tag(want, "a want line", 0);
358 if (!want || want->type != OBJ_COMMIT) {
359 /* no way to tell if this is reachable by
360 * looking at the ancestry chain alone, so
361 * leave a note to ourselves not to worry about
362 * this object anymore.
364 want_obj.objects[i].item->flags |= COMMON_KNOWN;
367 if (!reachable((struct commit *)want))
373 static int get_common_commits(void)
375 unsigned char sha1[20];
381 save_commit_buffer = 0;
384 char *line = packet_read_line(0, NULL);
390 if (multi_ack == 2 && got_common
391 && !got_other && ok_to_give_up()) {
393 packet_write(1, "ACK %s ready\n", last_hex);
395 if (have_obj.nr == 0 || multi_ack)
396 packet_write(1, "NAK\n");
398 if (no_done && sent_ready) {
399 packet_write(1, "ACK %s\n", last_hex);
408 if (skip_prefix(line, "have ", &arg)) {
409 switch (got_sha1(arg, sha1)) {
410 case -1: /* they have what we do not */
412 if (multi_ack && ok_to_give_up()) {
413 const char *hex = sha1_to_hex(sha1);
414 if (multi_ack == 2) {
416 packet_write(1, "ACK %s ready\n", hex);
418 packet_write(1, "ACK %s continue\n", hex);
423 memcpy(last_hex, sha1_to_hex(sha1), 41);
425 packet_write(1, "ACK %s common\n", last_hex);
427 packet_write(1, "ACK %s continue\n", last_hex);
428 else if (have_obj.nr == 1)
429 packet_write(1, "ACK %s\n", last_hex);
434 if (!strcmp(line, "done")) {
435 if (have_obj.nr > 0) {
437 packet_write(1, "ACK %s\n", last_hex);
440 packet_write(1, "NAK\n");
443 die("git upload-pack: expected SHA1 list, got '%s'", line);
447 static int is_our_ref(struct object *o)
449 int allow_hidden_ref = (allow_unadvertised_object_request &
450 (ALLOW_TIP_SHA1 | ALLOW_REACHABLE_SHA1));
451 return o->flags & ((allow_hidden_ref ? HIDDEN_REF : 0) | OUR_REF);
454 static void check_non_tip(void)
456 static const char *argv[] = {
457 "rev-list", "--stdin", NULL,
459 static struct child_process cmd = CHILD_PROCESS_INIT;
461 char namebuf[42]; /* ^ + SHA-1 + LF */
465 * In the normal in-process case without
466 * uploadpack.allowReachableSHA1InWant,
467 * non-tip requests can never happen.
469 if (!stateless_rpc && !(allow_unadvertised_object_request & ALLOW_REACHABLE_SHA1))
479 * If the next rev-list --stdin encounters an unknown commit,
480 * it terminates, which will cause SIGPIPE in the write loop
483 sigchain_push(SIGPIPE, SIG_IGN);
485 if (start_command(&cmd))
490 for (i = get_max_object_index(); 0 < i; ) {
491 o = get_indexed_object(--i);
496 memcpy(namebuf + 1, oid_to_hex(&o->oid), GIT_SHA1_HEXSZ);
497 if (write_in_full(cmd.in, namebuf, 42) < 0)
501 for (i = 0; i < want_obj.nr; i++) {
502 o = want_obj.objects[i].item;
505 memcpy(namebuf, oid_to_hex(&o->oid), GIT_SHA1_HEXSZ);
506 if (write_in_full(cmd.in, namebuf, 41) < 0)
513 * The commits out of the rev-list are not ancestors of
516 i = read_in_full(cmd.out, namebuf, 1);
523 * rev-list may have died by encountering a bad commit
524 * in the history, in which case we do want to bail out
525 * even when it showed no commit.
527 if (finish_command(&cmd))
530 sigchain_pop(SIGPIPE);
532 /* All the non-tip ones are ancestors of what we advertised */
536 sigchain_pop(SIGPIPE);
543 /* Pick one of them (we know there at least is one) */
544 for (i = 0; i < want_obj.nr; i++) {
545 o = want_obj.objects[i].item;
547 die("git upload-pack: not our ref %s",
548 oid_to_hex(&o->oid));
552 static void send_shallow(struct commit_list *result)
555 struct object *object = &result->item->object;
556 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
557 packet_write(1, "shallow %s",
558 oid_to_hex(&object->oid));
559 register_shallow(object->oid.hash);
562 result = result->next;
566 static void send_unshallow(const struct object_array *shallows)
570 for (i = 0; i < shallows->nr; i++) {
571 struct object *object = shallows->objects[i].item;
572 if (object->flags & NOT_SHALLOW) {
573 struct commit_list *parents;
574 packet_write(1, "unshallow %s",
575 oid_to_hex(&object->oid));
576 object->flags &= ~CLIENT_SHALLOW;
578 * We want to _register_ "object" as shallow, but we
579 * also need to traverse object's parents to deepen a
580 * shallow clone. Unregister it for now so we can
581 * parse and add the parents to the want list, then
584 unregister_shallow(object->oid.hash);
586 parse_commit_or_die((struct commit *)object);
587 parents = ((struct commit *)object)->parents;
589 add_object_array(&parents->item->object,
591 parents = parents->next;
593 add_object_array(object, NULL, &extra_edge_obj);
595 /* make sure commit traversal conforms to client */
596 register_shallow(object->oid.hash);
600 static void deepen(int depth, const struct object_array *shallows)
602 if (depth == INFINITE_DEPTH && !is_repository_shallow()) {
605 for (i = 0; i < shallows->nr; i++) {
606 struct object *object = shallows->objects[i].item;
607 object->flags |= NOT_SHALLOW;
610 struct commit_list *result;
612 result = get_shallow_commits(&want_obj, depth,
613 SHALLOW, NOT_SHALLOW);
614 send_shallow(result);
615 free_commit_list(result);
618 send_unshallow(shallows);
622 static void receive_needs(void)
624 struct object_array shallows = OBJECT_ARRAY_INIT;
631 const char *features;
632 unsigned char sha1_buf[20];
633 char *line = packet_read_line(0, NULL);
640 if (skip_prefix(line, "shallow ", &arg)) {
641 unsigned char sha1[20];
642 struct object *object;
643 if (get_sha1_hex(arg, sha1))
644 die("invalid shallow line: %s", line);
645 object = parse_object(sha1);
648 if (object->type != OBJ_COMMIT)
649 die("invalid shallow object %s", sha1_to_hex(sha1));
650 if (!(object->flags & CLIENT_SHALLOW)) {
651 object->flags |= CLIENT_SHALLOW;
652 add_object_array(object, NULL, &shallows);
656 if (skip_prefix(line, "deepen ", &arg)) {
658 depth = strtol(arg, &end, 0);
659 if (!end || *end || depth <= 0)
660 die("Invalid deepen: %s", line);
663 if (!skip_prefix(line, "want ", &arg) ||
664 get_sha1_hex(arg, sha1_buf))
665 die("git upload-pack: protocol error, "
666 "expected to get sha, not '%s'", line);
670 if (parse_feature_request(features, "multi_ack_detailed"))
672 else if (parse_feature_request(features, "multi_ack"))
674 if (parse_feature_request(features, "no-done"))
676 if (parse_feature_request(features, "thin-pack"))
678 if (parse_feature_request(features, "ofs-delta"))
680 if (parse_feature_request(features, "side-band-64k"))
681 use_sideband = LARGE_PACKET_MAX;
682 else if (parse_feature_request(features, "side-band"))
683 use_sideband = DEFAULT_PACKET_MAX;
684 if (parse_feature_request(features, "no-progress"))
686 if (parse_feature_request(features, "include-tag"))
689 o = parse_object(sha1_buf);
691 die("git upload-pack: not our ref %s",
692 sha1_to_hex(sha1_buf));
693 if (!(o->flags & WANTED)) {
697 add_object_array(o, NULL, &want_obj);
702 * We have sent all our refs already, and the other end
703 * should have chosen out of them. When we are operating
704 * in the stateless RPC mode, however, their choice may
705 * have been based on the set of older refs advertised
706 * by another process that handled the initial request.
711 if (!use_sideband && daemon_mode)
714 if (depth == 0 && shallows.nr == 0)
717 deepen(depth, &shallows);
719 if (shallows.nr > 0) {
721 for (i = 0; i < shallows.nr; i++)
722 register_shallow(shallows.objects[i].item->oid.hash);
725 shallow_nr += shallows.nr;
726 free(shallows.objects);
729 /* return non-zero if the ref is hidden, otherwise 0 */
730 static int mark_our_ref(const char *refname, const char *refname_full,
731 const struct object_id *oid)
733 struct object *o = lookup_unknown_object(oid->hash);
735 if (ref_is_hidden(refname, refname_full)) {
736 o->flags |= HIDDEN_REF;
743 static int check_ref(const char *refname_full, const struct object_id *oid,
744 int flag, void *cb_data)
746 const char *refname = strip_namespace(refname_full);
748 mark_our_ref(refname, refname_full, oid);
752 static void format_symref_info(struct strbuf *buf, struct string_list *symref)
754 struct string_list_item *item;
758 for_each_string_list_item(item, symref)
759 strbuf_addf(buf, " symref=%s:%s", item->string, (char *)item->util);
762 static int send_ref(const char *refname, const struct object_id *oid,
763 int flag, void *cb_data)
765 static const char *capabilities = "multi_ack thin-pack side-band"
766 " side-band-64k ofs-delta shallow no-progress"
767 " include-tag multi_ack_detailed";
768 const char *refname_nons = strip_namespace(refname);
769 struct object_id peeled;
771 if (mark_our_ref(refname_nons, refname, oid))
775 struct strbuf symref_info = STRBUF_INIT;
777 format_symref_info(&symref_info, cb_data);
778 packet_write(1, "%s %s%c%s%s%s%s%s agent=%s\n",
779 oid_to_hex(oid), refname_nons,
781 (allow_unadvertised_object_request & ALLOW_TIP_SHA1) ?
782 " allow-tip-sha1-in-want" : "",
783 (allow_unadvertised_object_request & ALLOW_REACHABLE_SHA1) ?
784 " allow-reachable-sha1-in-want" : "",
785 stateless_rpc ? " no-done" : "",
787 git_user_agent_sanitized());
788 strbuf_release(&symref_info);
790 packet_write(1, "%s %s\n", oid_to_hex(oid), refname_nons);
793 if (!peel_ref(refname, peeled.hash))
794 packet_write(1, "%s %s^{}\n", oid_to_hex(&peeled), refname_nons);
798 static int find_symref(const char *refname, const struct object_id *oid,
799 int flag, void *cb_data)
801 const char *symref_target;
802 struct string_list_item *item;
803 struct object_id unused;
805 if ((flag & REF_ISSYMREF) == 0)
807 symref_target = resolve_ref_unsafe(refname, 0, unused.hash, &flag);
808 if (!symref_target || (flag & REF_ISSYMREF) == 0)
809 die("'%s' is a symref but it is not?", refname);
810 item = string_list_append(cb_data, refname);
811 item->util = xstrdup(symref_target);
815 static void upload_pack(void)
817 struct string_list symref = STRING_LIST_INIT_DUP;
819 head_ref_namespaced(find_symref, &symref);
821 if (advertise_refs || !stateless_rpc) {
823 head_ref_namespaced(send_ref, &symref);
824 for_each_namespaced_ref(send_ref, &symref);
825 advertise_shallow_grafts(1);
828 head_ref_namespaced(check_ref, NULL);
829 for_each_namespaced_ref(check_ref, NULL);
831 string_list_clear(&symref, 1);
837 get_common_commits();
842 static int upload_pack_config(const char *var, const char *value, void *unused)
844 if (!strcmp("uploadpack.allowtipsha1inwant", var)) {
845 if (git_config_bool(var, value))
846 allow_unadvertised_object_request |= ALLOW_TIP_SHA1;
848 allow_unadvertised_object_request &= ~ALLOW_TIP_SHA1;
849 } else if (!strcmp("uploadpack.allowreachablesha1inwant", var)) {
850 if (git_config_bool(var, value))
851 allow_unadvertised_object_request |= ALLOW_REACHABLE_SHA1;
853 allow_unadvertised_object_request &= ~ALLOW_REACHABLE_SHA1;
854 } else if (!strcmp("uploadpack.keepalive", var)) {
855 keepalive = git_config_int(var, value);
859 return parse_hide_refs_config(var, value, "uploadpack");
862 int main(int argc, char **argv)
870 packet_trace_identity("upload-pack");
871 git_extract_argv0_path(argv[0]);
872 check_replace_refs = 0;
874 for (i = 1; i < argc; i++) {
875 const char *arg = argv[i];
879 if (!strcmp(arg, "--advertise-refs")) {
883 if (!strcmp(arg, "--stateless-rpc")) {
887 if (!strcmp(arg, "--strict")) {
891 if (skip_prefix(arg, "--timeout=", &arg)) {
896 if (!strcmp(arg, "--")) {
903 usage(upload_pack_usage);
909 if (!enter_repo(dir, strict))
910 die("'%s' does not appear to be a git repository", dir);
912 git_config(upload_pack_config, NULL);