t/README: link to metacpan.org, not search.cpan.org
[alt-git.git] / transport-helper.c
blob1258d6aedd26538f55c60495a61608236262cfc1
1 #include "cache.h"
2 #include "transport.h"
3 #include "quote.h"
4 #include "run-command.h"
5 #include "commit.h"
6 #include "diff.h"
7 #include "revision.h"
8 #include "remote.h"
9 #include "string-list.h"
10 #include "thread-utils.h"
11 #include "sigchain.h"
12 #include "argv-array.h"
13 #include "refs.h"
15 static int debug;
17 struct helper_data {
18 const char *name;
19 struct child_process *helper;
20 FILE *out;
21 unsigned fetch : 1,
22 import : 1,
23 bidi_import : 1,
24 export : 1,
25 option : 1,
26 push : 1,
27 connect : 1,
28 signed_tags : 1,
29 check_connectivity : 1,
30 no_disconnect_req : 1,
31 no_private_update : 1;
32 char *export_marks;
33 char *import_marks;
34 /* These go from remote name (as in "list") to private name */
35 struct refspec *refspecs;
36 int refspec_nr;
37 /* Transport options for fetch-pack/send-pack (should one of
38 * those be invoked).
40 struct git_transport_options transport_options;
43 static void sendline(struct helper_data *helper, struct strbuf *buffer)
45 if (debug)
46 fprintf(stderr, "Debug: Remote helper: -> %s", buffer->buf);
47 if (write_in_full(helper->helper->in, buffer->buf, buffer->len)
48 != buffer->len)
49 die_errno("Full write to remote helper failed");
52 static int recvline_fh(FILE *helper, struct strbuf *buffer, const char *name)
54 strbuf_reset(buffer);
55 if (debug)
56 fprintf(stderr, "Debug: Remote helper: Waiting...\n");
57 if (strbuf_getline(buffer, helper) == EOF) {
58 if (debug)
59 fprintf(stderr, "Debug: Remote helper quit.\n");
60 return 1;
63 if (debug)
64 fprintf(stderr, "Debug: Remote helper: <- %s\n", buffer->buf);
65 return 0;
68 static int recvline(struct helper_data *helper, struct strbuf *buffer)
70 return recvline_fh(helper->out, buffer, helper->name);
73 static void write_constant(int fd, const char *str)
75 if (debug)
76 fprintf(stderr, "Debug: Remote helper: -> %s", str);
77 if (write_in_full(fd, str, strlen(str)) != strlen(str))
78 die_errno("Full write to remote helper failed");
81 static const char *remove_ext_force(const char *url)
83 if (url) {
84 const char *colon = strchr(url, ':');
85 if (colon && colon[1] == ':')
86 return colon + 2;
88 return url;
91 static void do_take_over(struct transport *transport)
93 struct helper_data *data;
94 data = (struct helper_data *)transport->data;
95 transport_take_over(transport, data->helper);
96 fclose(data->out);
97 free(data);
100 static void standard_options(struct transport *t);
102 static struct child_process *get_helper(struct transport *transport)
104 struct helper_data *data = transport->data;
105 struct strbuf buf = STRBUF_INIT;
106 struct child_process *helper;
107 const char **refspecs = NULL;
108 int refspec_nr = 0;
109 int refspec_alloc = 0;
110 int duped;
111 int code;
113 if (data->helper)
114 return data->helper;
116 helper = xmalloc(sizeof(*helper));
117 child_process_init(helper);
118 helper->in = -1;
119 helper->out = -1;
120 helper->err = 0;
121 argv_array_pushf(&helper->args, "git-remote-%s", data->name);
122 argv_array_push(&helper->args, transport->remote->name);
123 argv_array_push(&helper->args, remove_ext_force(transport->url));
124 helper->git_cmd = 0;
125 helper->silent_exec_failure = 1;
127 argv_array_pushf(&helper->env_array, "%s=%s", GIT_DIR_ENVIRONMENT,
128 get_git_dir());
130 code = start_command(helper);
131 if (code < 0 && errno == ENOENT)
132 die("Unable to find remote helper for '%s'", data->name);
133 else if (code != 0)
134 exit(code);
136 data->helper = helper;
137 data->no_disconnect_req = 0;
140 * Open the output as FILE* so strbuf_getline_*() family of
141 * functions can be used.
142 * Do this with duped fd because fclose() will close the fd,
143 * and stuff like taking over will require the fd to remain.
145 duped = dup(helper->out);
146 if (duped < 0)
147 die_errno("Can't dup helper output fd");
148 data->out = xfdopen(duped, "r");
150 write_constant(helper->in, "capabilities\n");
152 while (1) {
153 const char *capname, *arg;
154 int mandatory = 0;
155 if (recvline(data, &buf))
156 exit(128);
158 if (!*buf.buf)
159 break;
161 if (*buf.buf == '*') {
162 capname = buf.buf + 1;
163 mandatory = 1;
164 } else
165 capname = buf.buf;
167 if (debug)
168 fprintf(stderr, "Debug: Got cap %s\n", capname);
169 if (!strcmp(capname, "fetch"))
170 data->fetch = 1;
171 else if (!strcmp(capname, "option"))
172 data->option = 1;
173 else if (!strcmp(capname, "push"))
174 data->push = 1;
175 else if (!strcmp(capname, "import"))
176 data->import = 1;
177 else if (!strcmp(capname, "bidi-import"))
178 data->bidi_import = 1;
179 else if (!strcmp(capname, "export"))
180 data->export = 1;
181 else if (!strcmp(capname, "check-connectivity"))
182 data->check_connectivity = 1;
183 else if (!data->refspecs && skip_prefix(capname, "refspec ", &arg)) {
184 ALLOC_GROW(refspecs,
185 refspec_nr + 1,
186 refspec_alloc);
187 refspecs[refspec_nr++] = xstrdup(arg);
188 } else if (!strcmp(capname, "connect")) {
189 data->connect = 1;
190 } else if (!strcmp(capname, "signed-tags")) {
191 data->signed_tags = 1;
192 } else if (skip_prefix(capname, "export-marks ", &arg)) {
193 data->export_marks = xstrdup(arg);
194 } else if (skip_prefix(capname, "import-marks ", &arg)) {
195 data->import_marks = xstrdup(arg);
196 } else if (starts_with(capname, "no-private-update")) {
197 data->no_private_update = 1;
198 } else if (mandatory) {
199 die("Unknown mandatory capability %s. This remote "
200 "helper probably needs newer version of Git.",
201 capname);
204 if (refspecs) {
205 int i;
206 data->refspec_nr = refspec_nr;
207 data->refspecs = parse_fetch_refspec(refspec_nr, refspecs);
208 for (i = 0; i < refspec_nr; i++)
209 free((char *)refspecs[i]);
210 free(refspecs);
211 } else if (data->import || data->bidi_import || data->export) {
212 warning("This remote helper should implement refspec capability.");
214 strbuf_release(&buf);
215 if (debug)
216 fprintf(stderr, "Debug: Capabilities complete.\n");
217 standard_options(transport);
218 return data->helper;
221 static int disconnect_helper(struct transport *transport)
223 struct helper_data *data = transport->data;
224 int res = 0;
226 if (data->helper) {
227 if (debug)
228 fprintf(stderr, "Debug: Disconnecting.\n");
229 if (!data->no_disconnect_req) {
231 * Ignore write errors; there's nothing we can do,
232 * since we're about to close the pipe anyway. And the
233 * most likely error is EPIPE due to the helper dying
234 * to report an error itself.
236 sigchain_push(SIGPIPE, SIG_IGN);
237 xwrite(data->helper->in, "\n", 1);
238 sigchain_pop(SIGPIPE);
240 close(data->helper->in);
241 close(data->helper->out);
242 fclose(data->out);
243 res = finish_command(data->helper);
244 free(data->helper);
245 data->helper = NULL;
247 return res;
250 static const char *unsupported_options[] = {
251 TRANS_OPT_UPLOADPACK,
252 TRANS_OPT_RECEIVEPACK,
253 TRANS_OPT_THIN,
254 TRANS_OPT_KEEP
257 static const char *boolean_options[] = {
258 TRANS_OPT_THIN,
259 TRANS_OPT_KEEP,
260 TRANS_OPT_FOLLOWTAGS,
261 TRANS_OPT_DEEPEN_RELATIVE
264 static int strbuf_set_helper_option(struct helper_data *data,
265 struct strbuf *buf)
267 int ret;
269 sendline(data, buf);
270 if (recvline(data, buf))
271 exit(128);
273 if (!strcmp(buf->buf, "ok"))
274 ret = 0;
275 else if (starts_with(buf->buf, "error"))
276 ret = -1;
277 else if (!strcmp(buf->buf, "unsupported"))
278 ret = 1;
279 else {
280 warning("%s unexpectedly said: '%s'", data->name, buf->buf);
281 ret = 1;
283 return ret;
286 static int string_list_set_helper_option(struct helper_data *data,
287 const char *name,
288 struct string_list *list)
290 struct strbuf buf = STRBUF_INIT;
291 int i, ret = 0;
293 for (i = 0; i < list->nr; i++) {
294 strbuf_addf(&buf, "option %s ", name);
295 quote_c_style(list->items[i].string, &buf, NULL, 0);
296 strbuf_addch(&buf, '\n');
298 if ((ret = strbuf_set_helper_option(data, &buf)))
299 break;
300 strbuf_reset(&buf);
302 strbuf_release(&buf);
303 return ret;
306 static int set_helper_option(struct transport *transport,
307 const char *name, const char *value)
309 struct helper_data *data = transport->data;
310 struct strbuf buf = STRBUF_INIT;
311 int i, ret, is_bool = 0;
313 get_helper(transport);
315 if (!data->option)
316 return 1;
318 if (!strcmp(name, "deepen-not"))
319 return string_list_set_helper_option(data, name,
320 (struct string_list *)value);
322 for (i = 0; i < ARRAY_SIZE(unsupported_options); i++) {
323 if (!strcmp(name, unsupported_options[i]))
324 return 1;
327 for (i = 0; i < ARRAY_SIZE(boolean_options); i++) {
328 if (!strcmp(name, boolean_options[i])) {
329 is_bool = 1;
330 break;
334 strbuf_addf(&buf, "option %s ", name);
335 if (is_bool)
336 strbuf_addstr(&buf, value ? "true" : "false");
337 else
338 quote_c_style(value, &buf, NULL, 0);
339 strbuf_addch(&buf, '\n');
341 ret = strbuf_set_helper_option(data, &buf);
342 strbuf_release(&buf);
343 return ret;
346 static void standard_options(struct transport *t)
348 char buf[16];
349 int n;
350 int v = t->verbose;
352 set_helper_option(t, "progress", t->progress ? "true" : "false");
354 n = snprintf(buf, sizeof(buf), "%d", v + 1);
355 if (n >= sizeof(buf))
356 die("impossibly large verbosity value");
357 set_helper_option(t, "verbosity", buf);
359 switch (t->family) {
360 case TRANSPORT_FAMILY_ALL:
362 * this is already the default,
363 * do not break old remote helpers by setting "all" here
365 break;
366 case TRANSPORT_FAMILY_IPV4:
367 set_helper_option(t, "family", "ipv4");
368 break;
369 case TRANSPORT_FAMILY_IPV6:
370 set_helper_option(t, "family", "ipv6");
371 break;
375 static int release_helper(struct transport *transport)
377 int res = 0;
378 struct helper_data *data = transport->data;
379 free_refspec(data->refspec_nr, data->refspecs);
380 data->refspecs = NULL;
381 res = disconnect_helper(transport);
382 free(transport->data);
383 return res;
386 static int fetch_with_fetch(struct transport *transport,
387 int nr_heads, struct ref **to_fetch)
389 struct helper_data *data = transport->data;
390 int i;
391 struct strbuf buf = STRBUF_INIT;
393 for (i = 0; i < nr_heads; i++) {
394 const struct ref *posn = to_fetch[i];
395 if (posn->status & REF_STATUS_UPTODATE)
396 continue;
398 strbuf_addf(&buf, "fetch %s %s\n",
399 oid_to_hex(&posn->old_oid),
400 posn->symref ? posn->symref : posn->name);
403 strbuf_addch(&buf, '\n');
404 sendline(data, &buf);
406 while (1) {
407 if (recvline(data, &buf))
408 exit(128);
410 if (starts_with(buf.buf, "lock ")) {
411 const char *name = buf.buf + 5;
412 if (transport->pack_lockfile)
413 warning("%s also locked %s", data->name, name);
414 else
415 transport->pack_lockfile = xstrdup(name);
417 else if (data->check_connectivity &&
418 data->transport_options.check_self_contained_and_connected &&
419 !strcmp(buf.buf, "connectivity-ok"))
420 data->transport_options.self_contained_and_connected = 1;
421 else if (!buf.len)
422 break;
423 else
424 warning("%s unexpectedly said: '%s'", data->name, buf.buf);
426 strbuf_release(&buf);
427 return 0;
430 static int get_importer(struct transport *transport, struct child_process *fastimport)
432 struct child_process *helper = get_helper(transport);
433 struct helper_data *data = transport->data;
434 int cat_blob_fd, code;
435 child_process_init(fastimport);
436 fastimport->in = helper->out;
437 argv_array_push(&fastimport->args, "fast-import");
438 argv_array_push(&fastimport->args, debug ? "--stats" : "--quiet");
440 if (data->bidi_import) {
441 cat_blob_fd = xdup(helper->in);
442 argv_array_pushf(&fastimport->args, "--cat-blob-fd=%d", cat_blob_fd);
444 fastimport->git_cmd = 1;
446 code = start_command(fastimport);
447 return code;
450 static int get_exporter(struct transport *transport,
451 struct child_process *fastexport,
452 struct string_list *revlist_args)
454 struct helper_data *data = transport->data;
455 struct child_process *helper = get_helper(transport);
456 int i;
458 child_process_init(fastexport);
460 /* we need to duplicate helper->in because we want to use it after
461 * fastexport is done with it. */
462 fastexport->out = dup(helper->in);
463 argv_array_push(&fastexport->args, "fast-export");
464 argv_array_push(&fastexport->args, "--use-done-feature");
465 argv_array_push(&fastexport->args, data->signed_tags ?
466 "--signed-tags=verbatim" : "--signed-tags=warn-strip");
467 if (data->export_marks)
468 argv_array_pushf(&fastexport->args, "--export-marks=%s.tmp", data->export_marks);
469 if (data->import_marks)
470 argv_array_pushf(&fastexport->args, "--import-marks=%s", data->import_marks);
472 for (i = 0; i < revlist_args->nr; i++)
473 argv_array_push(&fastexport->args, revlist_args->items[i].string);
475 fastexport->git_cmd = 1;
476 return start_command(fastexport);
479 static int fetch_with_import(struct transport *transport,
480 int nr_heads, struct ref **to_fetch)
482 struct child_process fastimport;
483 struct helper_data *data = transport->data;
484 int i;
485 struct ref *posn;
486 struct strbuf buf = STRBUF_INIT;
488 get_helper(transport);
490 if (get_importer(transport, &fastimport))
491 die("Couldn't run fast-import");
493 for (i = 0; i < nr_heads; i++) {
494 posn = to_fetch[i];
495 if (posn->status & REF_STATUS_UPTODATE)
496 continue;
498 strbuf_addf(&buf, "import %s\n",
499 posn->symref ? posn->symref : posn->name);
500 sendline(data, &buf);
501 strbuf_reset(&buf);
504 write_constant(data->helper->in, "\n");
506 * remote-helpers that advertise the bidi-import capability are required to
507 * buffer the complete batch of import commands until this newline before
508 * sending data to fast-import.
509 * These helpers read back data from fast-import on their stdin, which could
510 * be mixed with import commands, otherwise.
513 if (finish_command(&fastimport))
514 die("Error while running fast-import");
517 * The fast-import stream of a remote helper that advertises
518 * the "refspec" capability writes to the refs named after the
519 * right hand side of the first refspec matching each ref we
520 * were fetching.
522 * (If no "refspec" capability was specified, for historical
523 * reasons we default to the equivalent of *:*.)
525 * Store the result in to_fetch[i].old_sha1. Callers such
526 * as "git fetch" can use the value to write feedback to the
527 * terminal, populate FETCH_HEAD, and determine what new value
528 * should be written to peer_ref if the update is a
529 * fast-forward or this is a forced update.
531 for (i = 0; i < nr_heads; i++) {
532 char *private, *name;
533 posn = to_fetch[i];
534 if (posn->status & REF_STATUS_UPTODATE)
535 continue;
536 name = posn->symref ? posn->symref : posn->name;
537 if (data->refspecs)
538 private = apply_refspecs(data->refspecs, data->refspec_nr, name);
539 else
540 private = xstrdup(name);
541 if (private) {
542 if (read_ref(private, posn->old_oid.hash) < 0)
543 die("Could not read ref %s", private);
544 free(private);
547 strbuf_release(&buf);
548 return 0;
551 static int process_connect_service(struct transport *transport,
552 const char *name, const char *exec)
554 struct helper_data *data = transport->data;
555 struct strbuf cmdbuf = STRBUF_INIT;
556 struct child_process *helper;
557 int r, duped, ret = 0;
558 FILE *input;
560 helper = get_helper(transport);
563 * Yes, dup the pipe another time, as we need unbuffered version
564 * of input pipe as FILE*. fclose() closes the underlying fd and
565 * stream buffering only can be changed before first I/O operation
566 * on it.
568 duped = dup(helper->out);
569 if (duped < 0)
570 die_errno("Can't dup helper output fd");
571 input = xfdopen(duped, "r");
572 setvbuf(input, NULL, _IONBF, 0);
575 * Handle --upload-pack and friends. This is fire and forget...
576 * just warn if it fails.
578 if (strcmp(name, exec)) {
579 r = set_helper_option(transport, "servpath", exec);
580 if (r > 0)
581 warning("Setting remote service path not supported by protocol.");
582 else if (r < 0)
583 warning("Invalid remote service path.");
586 if (data->connect)
587 strbuf_addf(&cmdbuf, "connect %s\n", name);
588 else
589 goto exit;
591 sendline(data, &cmdbuf);
592 if (recvline_fh(input, &cmdbuf, name))
593 exit(128);
595 if (!strcmp(cmdbuf.buf, "")) {
596 data->no_disconnect_req = 1;
597 if (debug)
598 fprintf(stderr, "Debug: Smart transport connection "
599 "ready.\n");
600 ret = 1;
601 } else if (!strcmp(cmdbuf.buf, "fallback")) {
602 if (debug)
603 fprintf(stderr, "Debug: Falling back to dumb "
604 "transport.\n");
605 } else
606 die("Unknown response to connect: %s",
607 cmdbuf.buf);
609 exit:
610 fclose(input);
611 return ret;
614 static int process_connect(struct transport *transport,
615 int for_push)
617 struct helper_data *data = transport->data;
618 const char *name;
619 const char *exec;
621 name = for_push ? "git-receive-pack" : "git-upload-pack";
622 if (for_push)
623 exec = data->transport_options.receivepack;
624 else
625 exec = data->transport_options.uploadpack;
627 return process_connect_service(transport, name, exec);
630 static int connect_helper(struct transport *transport, const char *name,
631 const char *exec, int fd[2])
633 struct helper_data *data = transport->data;
635 /* Get_helper so connect is inited. */
636 get_helper(transport);
637 if (!data->connect)
638 die("Operation not supported by protocol.");
640 if (!process_connect_service(transport, name, exec))
641 die("Can't connect to subservice %s.", name);
643 fd[0] = data->helper->out;
644 fd[1] = data->helper->in;
645 return 0;
648 static int fetch(struct transport *transport,
649 int nr_heads, struct ref **to_fetch)
651 struct helper_data *data = transport->data;
652 int i, count;
654 if (process_connect(transport, 0)) {
655 do_take_over(transport);
656 return transport->fetch(transport, nr_heads, to_fetch);
659 count = 0;
660 for (i = 0; i < nr_heads; i++)
661 if (!(to_fetch[i]->status & REF_STATUS_UPTODATE))
662 count++;
664 if (!count)
665 return 0;
667 if (data->check_connectivity &&
668 data->transport_options.check_self_contained_and_connected)
669 set_helper_option(transport, "check-connectivity", "true");
671 if (transport->cloning)
672 set_helper_option(transport, "cloning", "true");
674 if (data->transport_options.update_shallow)
675 set_helper_option(transport, "update-shallow", "true");
677 if (data->fetch)
678 return fetch_with_fetch(transport, nr_heads, to_fetch);
680 if (data->import)
681 return fetch_with_import(transport, nr_heads, to_fetch);
683 return -1;
686 static int push_update_ref_status(struct strbuf *buf,
687 struct ref **ref,
688 struct ref *remote_refs)
690 char *refname, *msg;
691 int status, forced = 0;
693 if (starts_with(buf->buf, "ok ")) {
694 status = REF_STATUS_OK;
695 refname = buf->buf + 3;
696 } else if (starts_with(buf->buf, "error ")) {
697 status = REF_STATUS_REMOTE_REJECT;
698 refname = buf->buf + 6;
699 } else
700 die("expected ok/error, helper said '%s'", buf->buf);
702 msg = strchr(refname, ' ');
703 if (msg) {
704 struct strbuf msg_buf = STRBUF_INIT;
705 const char *end;
707 *msg++ = '\0';
708 if (!unquote_c_style(&msg_buf, msg, &end))
709 msg = strbuf_detach(&msg_buf, NULL);
710 else
711 msg = xstrdup(msg);
712 strbuf_release(&msg_buf);
714 if (!strcmp(msg, "no match")) {
715 status = REF_STATUS_NONE;
716 free(msg);
717 msg = NULL;
719 else if (!strcmp(msg, "up to date")) {
720 status = REF_STATUS_UPTODATE;
721 free(msg);
722 msg = NULL;
724 else if (!strcmp(msg, "non-fast forward")) {
725 status = REF_STATUS_REJECT_NONFASTFORWARD;
726 free(msg);
727 msg = NULL;
729 else if (!strcmp(msg, "already exists")) {
730 status = REF_STATUS_REJECT_ALREADY_EXISTS;
731 free(msg);
732 msg = NULL;
734 else if (!strcmp(msg, "fetch first")) {
735 status = REF_STATUS_REJECT_FETCH_FIRST;
736 free(msg);
737 msg = NULL;
739 else if (!strcmp(msg, "needs force")) {
740 status = REF_STATUS_REJECT_NEEDS_FORCE;
741 free(msg);
742 msg = NULL;
744 else if (!strcmp(msg, "stale info")) {
745 status = REF_STATUS_REJECT_STALE;
746 free(msg);
747 msg = NULL;
749 else if (!strcmp(msg, "forced update")) {
750 forced = 1;
751 free(msg);
752 msg = NULL;
756 if (*ref)
757 *ref = find_ref_by_name(*ref, refname);
758 if (!*ref)
759 *ref = find_ref_by_name(remote_refs, refname);
760 if (!*ref) {
761 warning("helper reported unexpected status of %s", refname);
762 return 1;
765 if ((*ref)->status != REF_STATUS_NONE) {
767 * Earlier, the ref was marked not to be pushed, so ignore the ref
768 * status reported by the remote helper if the latter is 'no match'.
770 if (status == REF_STATUS_NONE)
771 return 1;
774 (*ref)->status = status;
775 (*ref)->forced_update |= forced;
776 (*ref)->remote_status = msg;
777 return !(status == REF_STATUS_OK);
780 static int push_update_refs_status(struct helper_data *data,
781 struct ref *remote_refs,
782 int flags)
784 struct strbuf buf = STRBUF_INIT;
785 struct ref *ref = remote_refs;
786 int ret = 0;
788 for (;;) {
789 char *private;
791 if (recvline(data, &buf)) {
792 ret = 1;
793 break;
796 if (!buf.len)
797 break;
799 if (push_update_ref_status(&buf, &ref, remote_refs))
800 continue;
802 if (flags & TRANSPORT_PUSH_DRY_RUN || !data->refspecs || data->no_private_update)
803 continue;
805 /* propagate back the update to the remote namespace */
806 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
807 if (!private)
808 continue;
809 update_ref("update by helper", private, ref->new_oid.hash, NULL, 0, 0);
810 free(private);
812 strbuf_release(&buf);
813 return ret;
816 static void set_common_push_options(struct transport *transport,
817 const char *name, int flags)
819 if (flags & TRANSPORT_PUSH_DRY_RUN) {
820 if (set_helper_option(transport, "dry-run", "true") != 0)
821 die("helper %s does not support dry-run", name);
822 } else if (flags & TRANSPORT_PUSH_CERT_ALWAYS) {
823 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
824 die("helper %s does not support --signed", name);
825 } else if (flags & TRANSPORT_PUSH_CERT_IF_ASKED) {
826 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "if-asked") != 0)
827 die("helper %s does not support --signed=if-asked", name);
830 if (flags & TRANSPORT_PUSH_OPTIONS) {
831 struct string_list_item *item;
832 for_each_string_list_item(item, transport->push_options)
833 if (set_helper_option(transport, "push-option", item->string) != 0)
834 die("helper %s does not support 'push-option'", name);
838 static int push_refs_with_push(struct transport *transport,
839 struct ref *remote_refs, int flags)
841 int force_all = flags & TRANSPORT_PUSH_FORCE;
842 int mirror = flags & TRANSPORT_PUSH_MIRROR;
843 struct helper_data *data = transport->data;
844 struct strbuf buf = STRBUF_INIT;
845 struct ref *ref;
846 struct string_list cas_options = STRING_LIST_INIT_DUP;
847 struct string_list_item *cas_option;
849 get_helper(transport);
850 if (!data->push)
851 return 1;
853 for (ref = remote_refs; ref; ref = ref->next) {
854 if (!ref->peer_ref && !mirror)
855 continue;
857 /* Check for statuses set by set_ref_status_for_push() */
858 switch (ref->status) {
859 case REF_STATUS_REJECT_NONFASTFORWARD:
860 case REF_STATUS_REJECT_STALE:
861 case REF_STATUS_REJECT_ALREADY_EXISTS:
862 case REF_STATUS_UPTODATE:
863 continue;
864 default:
865 ; /* do nothing */
868 if (force_all)
869 ref->force = 1;
871 strbuf_addstr(&buf, "push ");
872 if (!ref->deletion) {
873 if (ref->force)
874 strbuf_addch(&buf, '+');
875 if (ref->peer_ref)
876 strbuf_addstr(&buf, ref->peer_ref->name);
877 else
878 strbuf_addstr(&buf, oid_to_hex(&ref->new_oid));
880 strbuf_addch(&buf, ':');
881 strbuf_addstr(&buf, ref->name);
882 strbuf_addch(&buf, '\n');
885 * The "--force-with-lease" options without explicit
886 * values to expect have already been expanded into
887 * the ref->old_oid_expect[] field; we can ignore
888 * transport->smart_options->cas altogether and instead
889 * can enumerate them from the refs.
891 if (ref->expect_old_sha1) {
892 struct strbuf cas = STRBUF_INIT;
893 strbuf_addf(&cas, "%s:%s",
894 ref->name, oid_to_hex(&ref->old_oid_expect));
895 string_list_append(&cas_options, strbuf_detach(&cas, NULL));
898 if (buf.len == 0) {
899 string_list_clear(&cas_options, 0);
900 return 0;
903 for_each_string_list_item(cas_option, &cas_options)
904 set_helper_option(transport, "cas", cas_option->string);
905 set_common_push_options(transport, data->name, flags);
907 strbuf_addch(&buf, '\n');
908 sendline(data, &buf);
909 strbuf_release(&buf);
911 return push_update_refs_status(data, remote_refs, flags);
914 static int push_refs_with_export(struct transport *transport,
915 struct ref *remote_refs, int flags)
917 struct ref *ref;
918 struct child_process *helper, exporter;
919 struct helper_data *data = transport->data;
920 struct string_list revlist_args = STRING_LIST_INIT_DUP;
921 struct strbuf buf = STRBUF_INIT;
923 if (!data->refspecs)
924 die("remote-helper doesn't support push; refspec needed");
926 set_common_push_options(transport, data->name, flags);
927 if (flags & TRANSPORT_PUSH_FORCE) {
928 if (set_helper_option(transport, "force", "true") != 0)
929 warning("helper %s does not support 'force'", data->name);
932 helper = get_helper(transport);
934 write_constant(helper->in, "export\n");
936 for (ref = remote_refs; ref; ref = ref->next) {
937 char *private;
938 struct object_id oid;
940 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
941 if (private && !get_sha1(private, oid.hash)) {
942 strbuf_addf(&buf, "^%s", private);
943 string_list_append(&revlist_args, strbuf_detach(&buf, NULL));
944 oidcpy(&ref->old_oid, &oid);
946 free(private);
948 if (ref->peer_ref) {
949 if (strcmp(ref->name, ref->peer_ref->name)) {
950 if (!ref->deletion) {
951 const char *name;
952 int flag;
954 /* Follow symbolic refs (mainly for HEAD). */
955 name = resolve_ref_unsafe(
956 ref->peer_ref->name,
957 RESOLVE_REF_READING,
958 oid.hash, &flag);
959 if (!name || !(flag & REF_ISSYMREF))
960 name = ref->peer_ref->name;
962 strbuf_addf(&buf, "%s:%s", name, ref->name);
963 } else
964 strbuf_addf(&buf, ":%s", ref->name);
966 string_list_append(&revlist_args, "--refspec");
967 string_list_append(&revlist_args, buf.buf);
968 strbuf_release(&buf);
970 if (!ref->deletion)
971 string_list_append(&revlist_args, ref->peer_ref->name);
975 if (get_exporter(transport, &exporter, &revlist_args))
976 die("Couldn't run fast-export");
978 string_list_clear(&revlist_args, 1);
980 if (finish_command(&exporter))
981 die("Error while running fast-export");
982 if (push_update_refs_status(data, remote_refs, flags))
983 return 1;
985 if (data->export_marks) {
986 strbuf_addf(&buf, "%s.tmp", data->export_marks);
987 rename(buf.buf, data->export_marks);
988 strbuf_release(&buf);
991 return 0;
994 static int push_refs(struct transport *transport,
995 struct ref *remote_refs, int flags)
997 struct helper_data *data = transport->data;
999 if (process_connect(transport, 1)) {
1000 do_take_over(transport);
1001 return transport->push_refs(transport, remote_refs, flags);
1004 if (!remote_refs) {
1005 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
1006 "Perhaps you should specify a branch such as 'master'.\n");
1007 return 0;
1010 if (data->push)
1011 return push_refs_with_push(transport, remote_refs, flags);
1013 if (data->export)
1014 return push_refs_with_export(transport, remote_refs, flags);
1016 return -1;
1020 static int has_attribute(const char *attrs, const char *attr) {
1021 int len;
1022 if (!attrs)
1023 return 0;
1025 len = strlen(attr);
1026 for (;;) {
1027 const char *space = strchrnul(attrs, ' ');
1028 if (len == space - attrs && !strncmp(attrs, attr, len))
1029 return 1;
1030 if (!*space)
1031 return 0;
1032 attrs = space + 1;
1036 static struct ref *get_refs_list(struct transport *transport, int for_push)
1038 struct helper_data *data = transport->data;
1039 struct child_process *helper;
1040 struct ref *ret = NULL;
1041 struct ref **tail = &ret;
1042 struct ref *posn;
1043 struct strbuf buf = STRBUF_INIT;
1045 helper = get_helper(transport);
1047 if (process_connect(transport, for_push)) {
1048 do_take_over(transport);
1049 return transport->get_refs_list(transport, for_push);
1052 if (data->push && for_push)
1053 write_str_in_full(helper->in, "list for-push\n");
1054 else
1055 write_str_in_full(helper->in, "list\n");
1057 while (1) {
1058 char *eov, *eon;
1059 if (recvline(data, &buf))
1060 exit(128);
1062 if (!*buf.buf)
1063 break;
1065 eov = strchr(buf.buf, ' ');
1066 if (!eov)
1067 die("Malformed response in ref list: %s", buf.buf);
1068 eon = strchr(eov + 1, ' ');
1069 *eov = '\0';
1070 if (eon)
1071 *eon = '\0';
1072 *tail = alloc_ref(eov + 1);
1073 if (buf.buf[0] == '@')
1074 (*tail)->symref = xstrdup(buf.buf + 1);
1075 else if (buf.buf[0] != '?')
1076 get_oid_hex(buf.buf, &(*tail)->old_oid);
1077 if (eon) {
1078 if (has_attribute(eon + 1, "unchanged")) {
1079 (*tail)->status |= REF_STATUS_UPTODATE;
1080 if (read_ref((*tail)->name,
1081 (*tail)->old_oid.hash) < 0)
1082 die(_("Could not read ref %s"),
1083 (*tail)->name);
1086 tail = &((*tail)->next);
1088 if (debug)
1089 fprintf(stderr, "Debug: Read ref listing.\n");
1090 strbuf_release(&buf);
1092 for (posn = ret; posn; posn = posn->next)
1093 resolve_remote_symref(posn, ret);
1095 return ret;
1098 int transport_helper_init(struct transport *transport, const char *name)
1100 struct helper_data *data = xcalloc(1, sizeof(*data));
1101 data->name = name;
1103 transport_check_allowed(name);
1105 if (getenv("GIT_TRANSPORT_HELPER_DEBUG"))
1106 debug = 1;
1108 transport->data = data;
1109 transport->set_option = set_helper_option;
1110 transport->get_refs_list = get_refs_list;
1111 transport->fetch = fetch;
1112 transport->push_refs = push_refs;
1113 transport->disconnect = release_helper;
1114 transport->connect = connect_helper;
1115 transport->smart_options = &(data->transport_options);
1116 return 0;
1120 * Linux pipes can buffer 65536 bytes at once (and most platforms can
1121 * buffer less), so attempt reads and writes with up to that size.
1123 #define BUFFERSIZE 65536
1124 /* This should be enough to hold debugging message. */
1125 #define PBUFFERSIZE 8192
1127 /* Print bidirectional transfer loop debug message. */
1128 __attribute__((format (printf, 1, 2)))
1129 static void transfer_debug(const char *fmt, ...)
1131 va_list args;
1132 char msgbuf[PBUFFERSIZE];
1133 static int debug_enabled = -1;
1135 if (debug_enabled < 0)
1136 debug_enabled = getenv("GIT_TRANSLOOP_DEBUG") ? 1 : 0;
1137 if (!debug_enabled)
1138 return;
1140 va_start(args, fmt);
1141 vsnprintf(msgbuf, PBUFFERSIZE, fmt, args);
1142 va_end(args);
1143 fprintf(stderr, "Transfer loop debugging: %s\n", msgbuf);
1146 /* Stream state: More data may be coming in this direction. */
1147 #define SSTATE_TRANSFERRING 0
1149 * Stream state: No more data coming in this direction, flushing rest of
1150 * data.
1152 #define SSTATE_FLUSHING 1
1153 /* Stream state: Transfer in this direction finished. */
1154 #define SSTATE_FINISHED 2
1156 #define STATE_NEEDS_READING(state) ((state) <= SSTATE_TRANSFERRING)
1157 #define STATE_NEEDS_WRITING(state) ((state) <= SSTATE_FLUSHING)
1158 #define STATE_NEEDS_CLOSING(state) ((state) == SSTATE_FLUSHING)
1160 /* Unidirectional transfer. */
1161 struct unidirectional_transfer {
1162 /* Source */
1163 int src;
1164 /* Destination */
1165 int dest;
1166 /* Is source socket? */
1167 int src_is_sock;
1168 /* Is destination socket? */
1169 int dest_is_sock;
1170 /* Transfer state (TRANSFERRING/FLUSHING/FINISHED) */
1171 int state;
1172 /* Buffer. */
1173 char buf[BUFFERSIZE];
1174 /* Buffer used. */
1175 size_t bufuse;
1176 /* Name of source. */
1177 const char *src_name;
1178 /* Name of destination. */
1179 const char *dest_name;
1182 /* Closes the target (for writing) if transfer has finished. */
1183 static void udt_close_if_finished(struct unidirectional_transfer *t)
1185 if (STATE_NEEDS_CLOSING(t->state) && !t->bufuse) {
1186 t->state = SSTATE_FINISHED;
1187 if (t->dest_is_sock)
1188 shutdown(t->dest, SHUT_WR);
1189 else
1190 close(t->dest);
1191 transfer_debug("Closed %s.", t->dest_name);
1196 * Tries to read data from source into buffer. If buffer is full,
1197 * no data is read. Returns 0 on success, -1 on error.
1199 static int udt_do_read(struct unidirectional_transfer *t)
1201 ssize_t bytes;
1203 if (t->bufuse == BUFFERSIZE)
1204 return 0; /* No space for more. */
1206 transfer_debug("%s is readable", t->src_name);
1207 bytes = read(t->src, t->buf + t->bufuse, BUFFERSIZE - t->bufuse);
1208 if (bytes < 0 && errno != EWOULDBLOCK && errno != EAGAIN &&
1209 errno != EINTR) {
1210 error_errno("read(%s) failed", t->src_name);
1211 return -1;
1212 } else if (bytes == 0) {
1213 transfer_debug("%s EOF (with %i bytes in buffer)",
1214 t->src_name, (int)t->bufuse);
1215 t->state = SSTATE_FLUSHING;
1216 } else if (bytes > 0) {
1217 t->bufuse += bytes;
1218 transfer_debug("Read %i bytes from %s (buffer now at %i)",
1219 (int)bytes, t->src_name, (int)t->bufuse);
1221 return 0;
1224 /* Tries to write data from buffer into destination. If buffer is empty,
1225 * no data is written. Returns 0 on success, -1 on error.
1227 static int udt_do_write(struct unidirectional_transfer *t)
1229 ssize_t bytes;
1231 if (t->bufuse == 0)
1232 return 0; /* Nothing to write. */
1234 transfer_debug("%s is writable", t->dest_name);
1235 bytes = xwrite(t->dest, t->buf, t->bufuse);
1236 if (bytes < 0 && errno != EWOULDBLOCK) {
1237 error_errno("write(%s) failed", t->dest_name);
1238 return -1;
1239 } else if (bytes > 0) {
1240 t->bufuse -= bytes;
1241 if (t->bufuse)
1242 memmove(t->buf, t->buf + bytes, t->bufuse);
1243 transfer_debug("Wrote %i bytes to %s (buffer now at %i)",
1244 (int)bytes, t->dest_name, (int)t->bufuse);
1246 return 0;
1250 /* State of bidirectional transfer loop. */
1251 struct bidirectional_transfer_state {
1252 /* Direction from program to git. */
1253 struct unidirectional_transfer ptg;
1254 /* Direction from git to program. */
1255 struct unidirectional_transfer gtp;
1258 static void *udt_copy_task_routine(void *udt)
1260 struct unidirectional_transfer *t = (struct unidirectional_transfer *)udt;
1261 while (t->state != SSTATE_FINISHED) {
1262 if (STATE_NEEDS_READING(t->state))
1263 if (udt_do_read(t))
1264 return NULL;
1265 if (STATE_NEEDS_WRITING(t->state))
1266 if (udt_do_write(t))
1267 return NULL;
1268 if (STATE_NEEDS_CLOSING(t->state))
1269 udt_close_if_finished(t);
1271 return udt; /* Just some non-NULL value. */
1274 #ifndef NO_PTHREADS
1277 * Join thread, with appropriate errors on failure. Name is name for the
1278 * thread (for error messages). Returns 0 on success, 1 on failure.
1280 static int tloop_join(pthread_t thread, const char *name)
1282 int err;
1283 void *tret;
1284 err = pthread_join(thread, &tret);
1285 if (!tret) {
1286 error("%s thread failed", name);
1287 return 1;
1289 if (err) {
1290 error("%s thread failed to join: %s", name, strerror(err));
1291 return 1;
1293 return 0;
1297 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1298 * -1 on failure.
1300 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1302 pthread_t gtp_thread;
1303 pthread_t ptg_thread;
1304 int err;
1305 int ret = 0;
1306 err = pthread_create(&gtp_thread, NULL, udt_copy_task_routine,
1307 &s->gtp);
1308 if (err)
1309 die("Can't start thread for copying data: %s", strerror(err));
1310 err = pthread_create(&ptg_thread, NULL, udt_copy_task_routine,
1311 &s->ptg);
1312 if (err)
1313 die("Can't start thread for copying data: %s", strerror(err));
1315 ret |= tloop_join(gtp_thread, "Git to program copy");
1316 ret |= tloop_join(ptg_thread, "Program to git copy");
1317 return ret;
1319 #else
1321 /* Close the source and target (for writing) for transfer. */
1322 static void udt_kill_transfer(struct unidirectional_transfer *t)
1324 t->state = SSTATE_FINISHED;
1326 * Socket read end left open isn't a disaster if nobody
1327 * attempts to read from it (mingw compat headers do not
1328 * have SHUT_RD)...
1330 * We can't fully close the socket since otherwise gtp
1331 * task would first close the socket it sends data to
1332 * while closing the ptg file descriptors.
1334 if (!t->src_is_sock)
1335 close(t->src);
1336 if (t->dest_is_sock)
1337 shutdown(t->dest, SHUT_WR);
1338 else
1339 close(t->dest);
1343 * Join process, with appropriate errors on failure. Name is name for the
1344 * process (for error messages). Returns 0 on success, 1 on failure.
1346 static int tloop_join(pid_t pid, const char *name)
1348 int tret;
1349 if (waitpid(pid, &tret, 0) < 0) {
1350 error_errno("%s process failed to wait", name);
1351 return 1;
1353 if (!WIFEXITED(tret) || WEXITSTATUS(tret)) {
1354 error("%s process failed", name);
1355 return 1;
1357 return 0;
1361 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1362 * -1 on failure.
1364 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1366 pid_t pid1, pid2;
1367 int ret = 0;
1369 /* Fork thread #1: git to program. */
1370 pid1 = fork();
1371 if (pid1 < 0)
1372 die_errno("Can't start thread for copying data");
1373 else if (pid1 == 0) {
1374 udt_kill_transfer(&s->ptg);
1375 exit(udt_copy_task_routine(&s->gtp) ? 0 : 1);
1378 /* Fork thread #2: program to git. */
1379 pid2 = fork();
1380 if (pid2 < 0)
1381 die_errno("Can't start thread for copying data");
1382 else if (pid2 == 0) {
1383 udt_kill_transfer(&s->gtp);
1384 exit(udt_copy_task_routine(&s->ptg) ? 0 : 1);
1388 * Close both streams in parent as to not interfere with
1389 * end of file detection and wait for both tasks to finish.
1391 udt_kill_transfer(&s->gtp);
1392 udt_kill_transfer(&s->ptg);
1393 ret |= tloop_join(pid1, "Git to program copy");
1394 ret |= tloop_join(pid2, "Program to git copy");
1395 return ret;
1397 #endif
1400 * Copies data from stdin to output and from input to stdout simultaneously.
1401 * Additionally filtering through given filter. If filter is NULL, uses
1402 * identity filter.
1404 int bidirectional_transfer_loop(int input, int output)
1406 struct bidirectional_transfer_state state;
1408 /* Fill the state fields. */
1409 state.ptg.src = input;
1410 state.ptg.dest = 1;
1411 state.ptg.src_is_sock = (input == output);
1412 state.ptg.dest_is_sock = 0;
1413 state.ptg.state = SSTATE_TRANSFERRING;
1414 state.ptg.bufuse = 0;
1415 state.ptg.src_name = "remote input";
1416 state.ptg.dest_name = "stdout";
1418 state.gtp.src = 0;
1419 state.gtp.dest = output;
1420 state.gtp.src_is_sock = 0;
1421 state.gtp.dest_is_sock = (input == output);
1422 state.gtp.state = SSTATE_TRANSFERRING;
1423 state.gtp.bufuse = 0;
1424 state.gtp.src_name = "stdin";
1425 state.gtp.dest_name = "remote output";
1427 return tloop_spawnwait_tasks(&state);