do not include the same header twice
[git.git] / transport-helper.c
blob3652b164c3b87330ae074dacc8ee8e25c518ed60
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, '\n') == 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 struct child_process *get_helper(struct transport *transport)
102 struct helper_data *data = transport->data;
103 struct strbuf buf = STRBUF_INIT;
104 struct child_process *helper;
105 const char **refspecs = NULL;
106 int refspec_nr = 0;
107 int refspec_alloc = 0;
108 int duped;
109 int code;
111 if (data->helper)
112 return data->helper;
114 helper = xmalloc(sizeof(*helper));
115 child_process_init(helper);
116 helper->in = -1;
117 helper->out = -1;
118 helper->err = 0;
119 argv_array_pushf(&helper->args, "git-remote-%s", data->name);
120 argv_array_push(&helper->args, transport->remote->name);
121 argv_array_push(&helper->args, remove_ext_force(transport->url));
122 helper->git_cmd = 0;
123 helper->silent_exec_failure = 1;
125 argv_array_pushf(&helper->env_array, "%s=%s", GIT_DIR_ENVIRONMENT,
126 get_git_dir());
128 code = start_command(helper);
129 if (code < 0 && errno == ENOENT)
130 die("Unable to find remote helper for '%s'", data->name);
131 else if (code != 0)
132 exit(code);
134 data->helper = helper;
135 data->no_disconnect_req = 0;
138 * Open the output as FILE* so strbuf_getline() can be used.
139 * Do this with duped fd because fclose() will close the fd,
140 * and stuff like taking over will require the fd to remain.
142 duped = dup(helper->out);
143 if (duped < 0)
144 die_errno("Can't dup helper output fd");
145 data->out = xfdopen(duped, "r");
147 write_constant(helper->in, "capabilities\n");
149 while (1) {
150 const char *capname, *arg;
151 int mandatory = 0;
152 if (recvline(data, &buf))
153 exit(128);
155 if (!*buf.buf)
156 break;
158 if (*buf.buf == '*') {
159 capname = buf.buf + 1;
160 mandatory = 1;
161 } else
162 capname = buf.buf;
164 if (debug)
165 fprintf(stderr, "Debug: Got cap %s\n", capname);
166 if (!strcmp(capname, "fetch"))
167 data->fetch = 1;
168 else if (!strcmp(capname, "option"))
169 data->option = 1;
170 else if (!strcmp(capname, "push"))
171 data->push = 1;
172 else if (!strcmp(capname, "import"))
173 data->import = 1;
174 else if (!strcmp(capname, "bidi-import"))
175 data->bidi_import = 1;
176 else if (!strcmp(capname, "export"))
177 data->export = 1;
178 else if (!strcmp(capname, "check-connectivity"))
179 data->check_connectivity = 1;
180 else if (!data->refspecs && skip_prefix(capname, "refspec ", &arg)) {
181 ALLOC_GROW(refspecs,
182 refspec_nr + 1,
183 refspec_alloc);
184 refspecs[refspec_nr++] = xstrdup(arg);
185 } else if (!strcmp(capname, "connect")) {
186 data->connect = 1;
187 } else if (!strcmp(capname, "signed-tags")) {
188 data->signed_tags = 1;
189 } else if (skip_prefix(capname, "export-marks ", &arg)) {
190 data->export_marks = xstrdup(arg);
191 } else if (skip_prefix(capname, "import-marks ", &arg)) {
192 data->import_marks = xstrdup(arg);
193 } else if (starts_with(capname, "no-private-update")) {
194 data->no_private_update = 1;
195 } else if (mandatory) {
196 die("Unknown mandatory capability %s. This remote "
197 "helper probably needs newer version of Git.",
198 capname);
201 if (refspecs) {
202 int i;
203 data->refspec_nr = refspec_nr;
204 data->refspecs = parse_fetch_refspec(refspec_nr, refspecs);
205 for (i = 0; i < refspec_nr; i++)
206 free((char *)refspecs[i]);
207 free(refspecs);
208 } else if (data->import || data->bidi_import || data->export) {
209 warning("This remote helper should implement refspec capability.");
211 strbuf_release(&buf);
212 if (debug)
213 fprintf(stderr, "Debug: Capabilities complete.\n");
214 return data->helper;
217 static int disconnect_helper(struct transport *transport)
219 struct helper_data *data = transport->data;
220 int res = 0;
222 if (data->helper) {
223 if (debug)
224 fprintf(stderr, "Debug: Disconnecting.\n");
225 if (!data->no_disconnect_req) {
227 * Ignore write errors; there's nothing we can do,
228 * since we're about to close the pipe anyway. And the
229 * most likely error is EPIPE due to the helper dying
230 * to report an error itself.
232 sigchain_push(SIGPIPE, SIG_IGN);
233 xwrite(data->helper->in, "\n", 1);
234 sigchain_pop(SIGPIPE);
236 close(data->helper->in);
237 close(data->helper->out);
238 fclose(data->out);
239 res = finish_command(data->helper);
240 free(data->helper);
241 data->helper = NULL;
243 return res;
246 static const char *unsupported_options[] = {
247 TRANS_OPT_UPLOADPACK,
248 TRANS_OPT_RECEIVEPACK,
249 TRANS_OPT_THIN,
250 TRANS_OPT_KEEP
253 static const char *boolean_options[] = {
254 TRANS_OPT_THIN,
255 TRANS_OPT_KEEP,
256 TRANS_OPT_FOLLOWTAGS,
257 TRANS_OPT_PUSH_CERT
260 static int set_helper_option(struct transport *transport,
261 const char *name, const char *value)
263 struct helper_data *data = transport->data;
264 struct strbuf buf = STRBUF_INIT;
265 int i, ret, is_bool = 0;
267 get_helper(transport);
269 if (!data->option)
270 return 1;
272 for (i = 0; i < ARRAY_SIZE(unsupported_options); i++) {
273 if (!strcmp(name, unsupported_options[i]))
274 return 1;
277 for (i = 0; i < ARRAY_SIZE(boolean_options); i++) {
278 if (!strcmp(name, boolean_options[i])) {
279 is_bool = 1;
280 break;
284 strbuf_addf(&buf, "option %s ", name);
285 if (is_bool)
286 strbuf_addstr(&buf, value ? "true" : "false");
287 else
288 quote_c_style(value, &buf, NULL, 0);
289 strbuf_addch(&buf, '\n');
291 sendline(data, &buf);
292 if (recvline(data, &buf))
293 exit(128);
295 if (!strcmp(buf.buf, "ok"))
296 ret = 0;
297 else if (starts_with(buf.buf, "error")) {
298 ret = -1;
299 } else if (!strcmp(buf.buf, "unsupported"))
300 ret = 1;
301 else {
302 warning("%s unexpectedly said: '%s'", data->name, buf.buf);
303 ret = 1;
305 strbuf_release(&buf);
306 return ret;
309 static void standard_options(struct transport *t)
311 char buf[16];
312 int n;
313 int v = t->verbose;
315 set_helper_option(t, "progress", t->progress ? "true" : "false");
317 n = snprintf(buf, sizeof(buf), "%d", v + 1);
318 if (n >= sizeof(buf))
319 die("impossibly large verbosity value");
320 set_helper_option(t, "verbosity", buf);
323 static int release_helper(struct transport *transport)
325 int res = 0;
326 struct helper_data *data = transport->data;
327 free_refspec(data->refspec_nr, data->refspecs);
328 data->refspecs = NULL;
329 res = disconnect_helper(transport);
330 free(transport->data);
331 return res;
334 static int fetch_with_fetch(struct transport *transport,
335 int nr_heads, struct ref **to_fetch)
337 struct helper_data *data = transport->data;
338 int i;
339 struct strbuf buf = STRBUF_INIT;
341 standard_options(transport);
342 if (data->check_connectivity &&
343 data->transport_options.check_self_contained_and_connected)
344 set_helper_option(transport, "check-connectivity", "true");
346 if (transport->cloning)
347 set_helper_option(transport, "cloning", "true");
349 if (data->transport_options.update_shallow)
350 set_helper_option(transport, "update-shallow", "true");
352 for (i = 0; i < nr_heads; i++) {
353 const struct ref *posn = to_fetch[i];
354 if (posn->status & REF_STATUS_UPTODATE)
355 continue;
357 strbuf_addf(&buf, "fetch %s %s\n",
358 sha1_to_hex(posn->old_sha1), posn->name);
361 strbuf_addch(&buf, '\n');
362 sendline(data, &buf);
364 while (1) {
365 if (recvline(data, &buf))
366 exit(128);
368 if (starts_with(buf.buf, "lock ")) {
369 const char *name = buf.buf + 5;
370 if (transport->pack_lockfile)
371 warning("%s also locked %s", data->name, name);
372 else
373 transport->pack_lockfile = xstrdup(name);
375 else if (data->check_connectivity &&
376 data->transport_options.check_self_contained_and_connected &&
377 !strcmp(buf.buf, "connectivity-ok"))
378 data->transport_options.self_contained_and_connected = 1;
379 else if (!buf.len)
380 break;
381 else
382 warning("%s unexpectedly said: '%s'", data->name, buf.buf);
384 strbuf_release(&buf);
385 return 0;
388 static int get_importer(struct transport *transport, struct child_process *fastimport)
390 struct child_process *helper = get_helper(transport);
391 struct helper_data *data = transport->data;
392 int cat_blob_fd, code;
393 child_process_init(fastimport);
394 fastimport->in = helper->out;
395 argv_array_push(&fastimport->args, "fast-import");
396 argv_array_push(&fastimport->args, debug ? "--stats" : "--quiet");
398 if (data->bidi_import) {
399 cat_blob_fd = xdup(helper->in);
400 argv_array_pushf(&fastimport->args, "--cat-blob-fd=%d", cat_blob_fd);
402 fastimport->git_cmd = 1;
404 code = start_command(fastimport);
405 return code;
408 static int get_exporter(struct transport *transport,
409 struct child_process *fastexport,
410 struct string_list *revlist_args)
412 struct helper_data *data = transport->data;
413 struct child_process *helper = get_helper(transport);
414 int i;
416 child_process_init(fastexport);
418 /* we need to duplicate helper->in because we want to use it after
419 * fastexport is done with it. */
420 fastexport->out = dup(helper->in);
421 argv_array_push(&fastexport->args, "fast-export");
422 argv_array_push(&fastexport->args, "--use-done-feature");
423 argv_array_push(&fastexport->args, data->signed_tags ?
424 "--signed-tags=verbatim" : "--signed-tags=warn-strip");
425 if (data->export_marks)
426 argv_array_pushf(&fastexport->args, "--export-marks=%s.tmp", data->export_marks);
427 if (data->import_marks)
428 argv_array_pushf(&fastexport->args, "--import-marks=%s", data->import_marks);
430 for (i = 0; i < revlist_args->nr; i++)
431 argv_array_push(&fastexport->args, revlist_args->items[i].string);
433 fastexport->git_cmd = 1;
434 return start_command(fastexport);
437 static int fetch_with_import(struct transport *transport,
438 int nr_heads, struct ref **to_fetch)
440 struct child_process fastimport;
441 struct helper_data *data = transport->data;
442 int i;
443 struct ref *posn;
444 struct strbuf buf = STRBUF_INIT;
446 get_helper(transport);
448 if (get_importer(transport, &fastimport))
449 die("Couldn't run fast-import");
451 for (i = 0; i < nr_heads; i++) {
452 posn = to_fetch[i];
453 if (posn->status & REF_STATUS_UPTODATE)
454 continue;
456 strbuf_addf(&buf, "import %s\n", posn->name);
457 sendline(data, &buf);
458 strbuf_reset(&buf);
461 write_constant(data->helper->in, "\n");
463 * remote-helpers that advertise the bidi-import capability are required to
464 * buffer the complete batch of import commands until this newline before
465 * sending data to fast-import.
466 * These helpers read back data from fast-import on their stdin, which could
467 * be mixed with import commands, otherwise.
470 if (finish_command(&fastimport))
471 die("Error while running fast-import");
474 * The fast-import stream of a remote helper that advertises
475 * the "refspec" capability writes to the refs named after the
476 * right hand side of the first refspec matching each ref we
477 * were fetching.
479 * (If no "refspec" capability was specified, for historical
480 * reasons we default to the equivalent of *:*.)
482 * Store the result in to_fetch[i].old_sha1. Callers such
483 * as "git fetch" can use the value to write feedback to the
484 * terminal, populate FETCH_HEAD, and determine what new value
485 * should be written to peer_ref if the update is a
486 * fast-forward or this is a forced update.
488 for (i = 0; i < nr_heads; i++) {
489 char *private;
490 posn = to_fetch[i];
491 if (posn->status & REF_STATUS_UPTODATE)
492 continue;
493 if (data->refspecs)
494 private = apply_refspecs(data->refspecs, data->refspec_nr, posn->name);
495 else
496 private = xstrdup(posn->name);
497 if (private) {
498 read_ref(private, posn->old_sha1);
499 free(private);
502 strbuf_release(&buf);
503 return 0;
506 static int process_connect_service(struct transport *transport,
507 const char *name, const char *exec)
509 struct helper_data *data = transport->data;
510 struct strbuf cmdbuf = STRBUF_INIT;
511 struct child_process *helper;
512 int r, duped, ret = 0;
513 FILE *input;
515 helper = get_helper(transport);
518 * Yes, dup the pipe another time, as we need unbuffered version
519 * of input pipe as FILE*. fclose() closes the underlying fd and
520 * stream buffering only can be changed before first I/O operation
521 * on it.
523 duped = dup(helper->out);
524 if (duped < 0)
525 die_errno("Can't dup helper output fd");
526 input = xfdopen(duped, "r");
527 setvbuf(input, NULL, _IONBF, 0);
530 * Handle --upload-pack and friends. This is fire and forget...
531 * just warn if it fails.
533 if (strcmp(name, exec)) {
534 r = set_helper_option(transport, "servpath", exec);
535 if (r > 0)
536 warning("Setting remote service path not supported by protocol.");
537 else if (r < 0)
538 warning("Invalid remote service path.");
541 if (data->connect)
542 strbuf_addf(&cmdbuf, "connect %s\n", name);
543 else
544 goto exit;
546 sendline(data, &cmdbuf);
547 if (recvline_fh(input, &cmdbuf, name))
548 exit(128);
550 if (!strcmp(cmdbuf.buf, "")) {
551 data->no_disconnect_req = 1;
552 if (debug)
553 fprintf(stderr, "Debug: Smart transport connection "
554 "ready.\n");
555 ret = 1;
556 } else if (!strcmp(cmdbuf.buf, "fallback")) {
557 if (debug)
558 fprintf(stderr, "Debug: Falling back to dumb "
559 "transport.\n");
560 } else
561 die("Unknown response to connect: %s",
562 cmdbuf.buf);
564 exit:
565 fclose(input);
566 return ret;
569 static int process_connect(struct transport *transport,
570 int for_push)
572 struct helper_data *data = transport->data;
573 const char *name;
574 const char *exec;
576 name = for_push ? "git-receive-pack" : "git-upload-pack";
577 if (for_push)
578 exec = data->transport_options.receivepack;
579 else
580 exec = data->transport_options.uploadpack;
582 return process_connect_service(transport, name, exec);
585 static int connect_helper(struct transport *transport, const char *name,
586 const char *exec, int fd[2])
588 struct helper_data *data = transport->data;
590 /* Get_helper so connect is inited. */
591 get_helper(transport);
592 if (!data->connect)
593 die("Operation not supported by protocol.");
595 if (!process_connect_service(transport, name, exec))
596 die("Can't connect to subservice %s.", name);
598 fd[0] = data->helper->out;
599 fd[1] = data->helper->in;
600 return 0;
603 static int fetch(struct transport *transport,
604 int nr_heads, struct ref **to_fetch)
606 struct helper_data *data = transport->data;
607 int i, count;
609 if (process_connect(transport, 0)) {
610 do_take_over(transport);
611 return transport->fetch(transport, nr_heads, to_fetch);
614 count = 0;
615 for (i = 0; i < nr_heads; i++)
616 if (!(to_fetch[i]->status & REF_STATUS_UPTODATE))
617 count++;
619 if (!count)
620 return 0;
622 if (data->fetch)
623 return fetch_with_fetch(transport, nr_heads, to_fetch);
625 if (data->import)
626 return fetch_with_import(transport, nr_heads, to_fetch);
628 return -1;
631 static int push_update_ref_status(struct strbuf *buf,
632 struct ref **ref,
633 struct ref *remote_refs)
635 char *refname, *msg;
636 int status, forced = 0;
638 if (starts_with(buf->buf, "ok ")) {
639 status = REF_STATUS_OK;
640 refname = buf->buf + 3;
641 } else if (starts_with(buf->buf, "error ")) {
642 status = REF_STATUS_REMOTE_REJECT;
643 refname = buf->buf + 6;
644 } else
645 die("expected ok/error, helper said '%s'", buf->buf);
647 msg = strchr(refname, ' ');
648 if (msg) {
649 struct strbuf msg_buf = STRBUF_INIT;
650 const char *end;
652 *msg++ = '\0';
653 if (!unquote_c_style(&msg_buf, msg, &end))
654 msg = strbuf_detach(&msg_buf, NULL);
655 else
656 msg = xstrdup(msg);
657 strbuf_release(&msg_buf);
659 if (!strcmp(msg, "no match")) {
660 status = REF_STATUS_NONE;
661 free(msg);
662 msg = NULL;
664 else if (!strcmp(msg, "up to date")) {
665 status = REF_STATUS_UPTODATE;
666 free(msg);
667 msg = NULL;
669 else if (!strcmp(msg, "non-fast forward")) {
670 status = REF_STATUS_REJECT_NONFASTFORWARD;
671 free(msg);
672 msg = NULL;
674 else if (!strcmp(msg, "already exists")) {
675 status = REF_STATUS_REJECT_ALREADY_EXISTS;
676 free(msg);
677 msg = NULL;
679 else if (!strcmp(msg, "fetch first")) {
680 status = REF_STATUS_REJECT_FETCH_FIRST;
681 free(msg);
682 msg = NULL;
684 else if (!strcmp(msg, "needs force")) {
685 status = REF_STATUS_REJECT_NEEDS_FORCE;
686 free(msg);
687 msg = NULL;
689 else if (!strcmp(msg, "stale info")) {
690 status = REF_STATUS_REJECT_STALE;
691 free(msg);
692 msg = NULL;
694 else if (!strcmp(msg, "forced update")) {
695 forced = 1;
696 free(msg);
697 msg = NULL;
701 if (*ref)
702 *ref = find_ref_by_name(*ref, refname);
703 if (!*ref)
704 *ref = find_ref_by_name(remote_refs, refname);
705 if (!*ref) {
706 warning("helper reported unexpected status of %s", refname);
707 return 1;
710 if ((*ref)->status != REF_STATUS_NONE) {
712 * Earlier, the ref was marked not to be pushed, so ignore the ref
713 * status reported by the remote helper if the latter is 'no match'.
715 if (status == REF_STATUS_NONE)
716 return 1;
719 (*ref)->status = status;
720 (*ref)->forced_update |= forced;
721 (*ref)->remote_status = msg;
722 return !(status == REF_STATUS_OK);
725 static int push_update_refs_status(struct helper_data *data,
726 struct ref *remote_refs,
727 int flags)
729 struct strbuf buf = STRBUF_INIT;
730 struct ref *ref = remote_refs;
731 int ret = 0;
733 for (;;) {
734 char *private;
736 if (recvline(data, &buf)) {
737 ret = 1;
738 break;
741 if (!buf.len)
742 break;
744 if (push_update_ref_status(&buf, &ref, remote_refs))
745 continue;
747 if (flags & TRANSPORT_PUSH_DRY_RUN || !data->refspecs || data->no_private_update)
748 continue;
750 /* propagate back the update to the remote namespace */
751 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
752 if (!private)
753 continue;
754 update_ref("update by helper", private, ref->new_sha1, NULL, 0, 0);
755 free(private);
757 strbuf_release(&buf);
758 return ret;
761 static int push_refs_with_push(struct transport *transport,
762 struct ref *remote_refs, int flags)
764 int force_all = flags & TRANSPORT_PUSH_FORCE;
765 int mirror = flags & TRANSPORT_PUSH_MIRROR;
766 struct helper_data *data = transport->data;
767 struct strbuf buf = STRBUF_INIT;
768 struct ref *ref;
769 struct string_list cas_options = STRING_LIST_INIT_DUP;
770 struct string_list_item *cas_option;
772 get_helper(transport);
773 if (!data->push)
774 return 1;
776 for (ref = remote_refs; ref; ref = ref->next) {
777 if (!ref->peer_ref && !mirror)
778 continue;
780 /* Check for statuses set by set_ref_status_for_push() */
781 switch (ref->status) {
782 case REF_STATUS_REJECT_NONFASTFORWARD:
783 case REF_STATUS_REJECT_STALE:
784 case REF_STATUS_REJECT_ALREADY_EXISTS:
785 case REF_STATUS_UPTODATE:
786 continue;
787 default:
788 ; /* do nothing */
791 if (force_all)
792 ref->force = 1;
794 strbuf_addstr(&buf, "push ");
795 if (!ref->deletion) {
796 if (ref->force)
797 strbuf_addch(&buf, '+');
798 if (ref->peer_ref)
799 strbuf_addstr(&buf, ref->peer_ref->name);
800 else
801 strbuf_addstr(&buf, sha1_to_hex(ref->new_sha1));
803 strbuf_addch(&buf, ':');
804 strbuf_addstr(&buf, ref->name);
805 strbuf_addch(&buf, '\n');
808 * The "--force-with-lease" options without explicit
809 * values to expect have already been expanded into
810 * the ref->old_sha1_expect[] field; we can ignore
811 * transport->smart_options->cas altogether and instead
812 * can enumerate them from the refs.
814 if (ref->expect_old_sha1) {
815 struct strbuf cas = STRBUF_INIT;
816 strbuf_addf(&cas, "%s:%s",
817 ref->name, sha1_to_hex(ref->old_sha1_expect));
818 string_list_append(&cas_options, strbuf_detach(&cas, NULL));
821 if (buf.len == 0) {
822 string_list_clear(&cas_options, 0);
823 return 0;
826 standard_options(transport);
827 for_each_string_list_item(cas_option, &cas_options)
828 set_helper_option(transport, "cas", cas_option->string);
830 if (flags & TRANSPORT_PUSH_DRY_RUN) {
831 if (set_helper_option(transport, "dry-run", "true") != 0)
832 die("helper %s does not support dry-run", data->name);
833 } else if (flags & TRANSPORT_PUSH_CERT) {
834 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
835 die("helper %s does not support --signed", data->name);
838 strbuf_addch(&buf, '\n');
839 sendline(data, &buf);
840 strbuf_release(&buf);
842 return push_update_refs_status(data, remote_refs, flags);
845 static int push_refs_with_export(struct transport *transport,
846 struct ref *remote_refs, int flags)
848 struct ref *ref;
849 struct child_process *helper, exporter;
850 struct helper_data *data = transport->data;
851 struct string_list revlist_args = STRING_LIST_INIT_DUP;
852 struct strbuf buf = STRBUF_INIT;
854 if (!data->refspecs)
855 die("remote-helper doesn't support push; refspec needed");
857 if (flags & TRANSPORT_PUSH_DRY_RUN) {
858 if (set_helper_option(transport, "dry-run", "true") != 0)
859 die("helper %s does not support dry-run", data->name);
860 } else if (flags & TRANSPORT_PUSH_CERT) {
861 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
862 die("helper %s does not support dry-run", data->name);
865 if (flags & TRANSPORT_PUSH_FORCE) {
866 if (set_helper_option(transport, "force", "true") != 0)
867 warning("helper %s does not support 'force'", data->name);
870 helper = get_helper(transport);
872 write_constant(helper->in, "export\n");
874 for (ref = remote_refs; ref; ref = ref->next) {
875 char *private;
876 unsigned char sha1[20];
878 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
879 if (private && !get_sha1(private, sha1)) {
880 strbuf_addf(&buf, "^%s", private);
881 string_list_append(&revlist_args, strbuf_detach(&buf, NULL));
882 hashcpy(ref->old_sha1, sha1);
884 free(private);
886 if (ref->peer_ref) {
887 if (strcmp(ref->name, ref->peer_ref->name)) {
888 if (!ref->deletion) {
889 const char *name;
890 int flag;
892 /* Follow symbolic refs (mainly for HEAD). */
893 name = resolve_ref_unsafe(
894 ref->peer_ref->name,
895 RESOLVE_REF_READING,
896 sha1, &flag);
897 if (!name || !(flag & REF_ISSYMREF))
898 name = ref->peer_ref->name;
900 strbuf_addf(&buf, "%s:%s", name, ref->name);
901 } else
902 strbuf_addf(&buf, ":%s", ref->name);
904 string_list_append(&revlist_args, "--refspec");
905 string_list_append(&revlist_args, buf.buf);
906 strbuf_release(&buf);
908 if (!ref->deletion)
909 string_list_append(&revlist_args, ref->peer_ref->name);
913 if (get_exporter(transport, &exporter, &revlist_args))
914 die("Couldn't run fast-export");
916 string_list_clear(&revlist_args, 1);
918 if (finish_command(&exporter))
919 die("Error while running fast-export");
920 if (push_update_refs_status(data, remote_refs, flags))
921 return 1;
923 if (data->export_marks) {
924 strbuf_addf(&buf, "%s.tmp", data->export_marks);
925 rename(buf.buf, data->export_marks);
926 strbuf_release(&buf);
929 return 0;
932 static int push_refs(struct transport *transport,
933 struct ref *remote_refs, int flags)
935 struct helper_data *data = transport->data;
937 if (process_connect(transport, 1)) {
938 do_take_over(transport);
939 return transport->push_refs(transport, remote_refs, flags);
942 if (!remote_refs) {
943 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
944 "Perhaps you should specify a branch such as 'master'.\n");
945 return 0;
948 if (data->push)
949 return push_refs_with_push(transport, remote_refs, flags);
951 if (data->export)
952 return push_refs_with_export(transport, remote_refs, flags);
954 return -1;
958 static int has_attribute(const char *attrs, const char *attr) {
959 int len;
960 if (!attrs)
961 return 0;
963 len = strlen(attr);
964 for (;;) {
965 const char *space = strchrnul(attrs, ' ');
966 if (len == space - attrs && !strncmp(attrs, attr, len))
967 return 1;
968 if (!*space)
969 return 0;
970 attrs = space + 1;
974 static struct ref *get_refs_list(struct transport *transport, int for_push)
976 struct helper_data *data = transport->data;
977 struct child_process *helper;
978 struct ref *ret = NULL;
979 struct ref **tail = &ret;
980 struct ref *posn;
981 struct strbuf buf = STRBUF_INIT;
983 helper = get_helper(transport);
985 if (process_connect(transport, for_push)) {
986 do_take_over(transport);
987 return transport->get_refs_list(transport, for_push);
990 if (data->push && for_push)
991 write_str_in_full(helper->in, "list for-push\n");
992 else
993 write_str_in_full(helper->in, "list\n");
995 while (1) {
996 char *eov, *eon;
997 if (recvline(data, &buf))
998 exit(128);
1000 if (!*buf.buf)
1001 break;
1003 eov = strchr(buf.buf, ' ');
1004 if (!eov)
1005 die("Malformed response in ref list: %s", buf.buf);
1006 eon = strchr(eov + 1, ' ');
1007 *eov = '\0';
1008 if (eon)
1009 *eon = '\0';
1010 *tail = alloc_ref(eov + 1);
1011 if (buf.buf[0] == '@')
1012 (*tail)->symref = xstrdup(buf.buf + 1);
1013 else if (buf.buf[0] != '?')
1014 get_sha1_hex(buf.buf, (*tail)->old_sha1);
1015 if (eon) {
1016 if (has_attribute(eon + 1, "unchanged")) {
1017 (*tail)->status |= REF_STATUS_UPTODATE;
1018 read_ref((*tail)->name, (*tail)->old_sha1);
1021 tail = &((*tail)->next);
1023 if (debug)
1024 fprintf(stderr, "Debug: Read ref listing.\n");
1025 strbuf_release(&buf);
1027 for (posn = ret; posn; posn = posn->next)
1028 resolve_remote_symref(posn, ret);
1030 return ret;
1033 int transport_helper_init(struct transport *transport, const char *name)
1035 struct helper_data *data = xcalloc(1, sizeof(*data));
1036 data->name = name;
1038 if (getenv("GIT_TRANSPORT_HELPER_DEBUG"))
1039 debug = 1;
1041 transport->data = data;
1042 transport->set_option = set_helper_option;
1043 transport->get_refs_list = get_refs_list;
1044 transport->fetch = fetch;
1045 transport->push_refs = push_refs;
1046 transport->disconnect = release_helper;
1047 transport->connect = connect_helper;
1048 transport->smart_options = &(data->transport_options);
1049 return 0;
1053 * Linux pipes can buffer 65536 bytes at once (and most platforms can
1054 * buffer less), so attempt reads and writes with up to that size.
1056 #define BUFFERSIZE 65536
1057 /* This should be enough to hold debugging message. */
1058 #define PBUFFERSIZE 8192
1060 /* Print bidirectional transfer loop debug message. */
1061 __attribute__((format (printf, 1, 2)))
1062 static void transfer_debug(const char *fmt, ...)
1064 va_list args;
1065 char msgbuf[PBUFFERSIZE];
1066 static int debug_enabled = -1;
1068 if (debug_enabled < 0)
1069 debug_enabled = getenv("GIT_TRANSLOOP_DEBUG") ? 1 : 0;
1070 if (!debug_enabled)
1071 return;
1073 va_start(args, fmt);
1074 vsnprintf(msgbuf, PBUFFERSIZE, fmt, args);
1075 va_end(args);
1076 fprintf(stderr, "Transfer loop debugging: %s\n", msgbuf);
1079 /* Stream state: More data may be coming in this direction. */
1080 #define SSTATE_TRANSFERING 0
1082 * Stream state: No more data coming in this direction, flushing rest of
1083 * data.
1085 #define SSTATE_FLUSHING 1
1086 /* Stream state: Transfer in this direction finished. */
1087 #define SSTATE_FINISHED 2
1089 #define STATE_NEEDS_READING(state) ((state) <= SSTATE_TRANSFERING)
1090 #define STATE_NEEDS_WRITING(state) ((state) <= SSTATE_FLUSHING)
1091 #define STATE_NEEDS_CLOSING(state) ((state) == SSTATE_FLUSHING)
1093 /* Unidirectional transfer. */
1094 struct unidirectional_transfer {
1095 /* Source */
1096 int src;
1097 /* Destination */
1098 int dest;
1099 /* Is source socket? */
1100 int src_is_sock;
1101 /* Is destination socket? */
1102 int dest_is_sock;
1103 /* Transfer state (TRANSFERRING/FLUSHING/FINISHED) */
1104 int state;
1105 /* Buffer. */
1106 char buf[BUFFERSIZE];
1107 /* Buffer used. */
1108 size_t bufuse;
1109 /* Name of source. */
1110 const char *src_name;
1111 /* Name of destination. */
1112 const char *dest_name;
1115 /* Closes the target (for writing) if transfer has finished. */
1116 static void udt_close_if_finished(struct unidirectional_transfer *t)
1118 if (STATE_NEEDS_CLOSING(t->state) && !t->bufuse) {
1119 t->state = SSTATE_FINISHED;
1120 if (t->dest_is_sock)
1121 shutdown(t->dest, SHUT_WR);
1122 else
1123 close(t->dest);
1124 transfer_debug("Closed %s.", t->dest_name);
1129 * Tries to read read data from source into buffer. If buffer is full,
1130 * no data is read. Returns 0 on success, -1 on error.
1132 static int udt_do_read(struct unidirectional_transfer *t)
1134 ssize_t bytes;
1136 if (t->bufuse == BUFFERSIZE)
1137 return 0; /* No space for more. */
1139 transfer_debug("%s is readable", t->src_name);
1140 bytes = read(t->src, t->buf + t->bufuse, BUFFERSIZE - t->bufuse);
1141 if (bytes < 0 && errno != EWOULDBLOCK && errno != EAGAIN &&
1142 errno != EINTR) {
1143 error("read(%s) failed: %s", t->src_name, strerror(errno));
1144 return -1;
1145 } else if (bytes == 0) {
1146 transfer_debug("%s EOF (with %i bytes in buffer)",
1147 t->src_name, (int)t->bufuse);
1148 t->state = SSTATE_FLUSHING;
1149 } else if (bytes > 0) {
1150 t->bufuse += bytes;
1151 transfer_debug("Read %i bytes from %s (buffer now at %i)",
1152 (int)bytes, t->src_name, (int)t->bufuse);
1154 return 0;
1157 /* Tries to write data from buffer into destination. If buffer is empty,
1158 * no data is written. Returns 0 on success, -1 on error.
1160 static int udt_do_write(struct unidirectional_transfer *t)
1162 ssize_t bytes;
1164 if (t->bufuse == 0)
1165 return 0; /* Nothing to write. */
1167 transfer_debug("%s is writable", t->dest_name);
1168 bytes = xwrite(t->dest, t->buf, t->bufuse);
1169 if (bytes < 0 && errno != EWOULDBLOCK) {
1170 error("write(%s) failed: %s", t->dest_name, strerror(errno));
1171 return -1;
1172 } else if (bytes > 0) {
1173 t->bufuse -= bytes;
1174 if (t->bufuse)
1175 memmove(t->buf, t->buf + bytes, t->bufuse);
1176 transfer_debug("Wrote %i bytes to %s (buffer now at %i)",
1177 (int)bytes, t->dest_name, (int)t->bufuse);
1179 return 0;
1183 /* State of bidirectional transfer loop. */
1184 struct bidirectional_transfer_state {
1185 /* Direction from program to git. */
1186 struct unidirectional_transfer ptg;
1187 /* Direction from git to program. */
1188 struct unidirectional_transfer gtp;
1191 static void *udt_copy_task_routine(void *udt)
1193 struct unidirectional_transfer *t = (struct unidirectional_transfer *)udt;
1194 while (t->state != SSTATE_FINISHED) {
1195 if (STATE_NEEDS_READING(t->state))
1196 if (udt_do_read(t))
1197 return NULL;
1198 if (STATE_NEEDS_WRITING(t->state))
1199 if (udt_do_write(t))
1200 return NULL;
1201 if (STATE_NEEDS_CLOSING(t->state))
1202 udt_close_if_finished(t);
1204 return udt; /* Just some non-NULL value. */
1207 #ifndef NO_PTHREADS
1210 * Join thread, with appropriate errors on failure. Name is name for the
1211 * thread (for error messages). Returns 0 on success, 1 on failure.
1213 static int tloop_join(pthread_t thread, const char *name)
1215 int err;
1216 void *tret;
1217 err = pthread_join(thread, &tret);
1218 if (!tret) {
1219 error("%s thread failed", name);
1220 return 1;
1222 if (err) {
1223 error("%s thread failed to join: %s", name, strerror(err));
1224 return 1;
1226 return 0;
1230 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1231 * -1 on failure.
1233 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1235 pthread_t gtp_thread;
1236 pthread_t ptg_thread;
1237 int err;
1238 int ret = 0;
1239 err = pthread_create(&gtp_thread, NULL, udt_copy_task_routine,
1240 &s->gtp);
1241 if (err)
1242 die("Can't start thread for copying data: %s", strerror(err));
1243 err = pthread_create(&ptg_thread, NULL, udt_copy_task_routine,
1244 &s->ptg);
1245 if (err)
1246 die("Can't start thread for copying data: %s", strerror(err));
1248 ret |= tloop_join(gtp_thread, "Git to program copy");
1249 ret |= tloop_join(ptg_thread, "Program to git copy");
1250 return ret;
1252 #else
1254 /* Close the source and target (for writing) for transfer. */
1255 static void udt_kill_transfer(struct unidirectional_transfer *t)
1257 t->state = SSTATE_FINISHED;
1259 * Socket read end left open isn't a disaster if nobody
1260 * attempts to read from it (mingw compat headers do not
1261 * have SHUT_RD)...
1263 * We can't fully close the socket since otherwise gtp
1264 * task would first close the socket it sends data to
1265 * while closing the ptg file descriptors.
1267 if (!t->src_is_sock)
1268 close(t->src);
1269 if (t->dest_is_sock)
1270 shutdown(t->dest, SHUT_WR);
1271 else
1272 close(t->dest);
1276 * Join process, with appropriate errors on failure. Name is name for the
1277 * process (for error messages). Returns 0 on success, 1 on failure.
1279 static int tloop_join(pid_t pid, const char *name)
1281 int tret;
1282 if (waitpid(pid, &tret, 0) < 0) {
1283 error("%s process failed to wait: %s", name, strerror(errno));
1284 return 1;
1286 if (!WIFEXITED(tret) || WEXITSTATUS(tret)) {
1287 error("%s process failed", name);
1288 return 1;
1290 return 0;
1294 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1295 * -1 on failure.
1297 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1299 pid_t pid1, pid2;
1300 int ret = 0;
1302 /* Fork thread #1: git to program. */
1303 pid1 = fork();
1304 if (pid1 < 0)
1305 die_errno("Can't start thread for copying data");
1306 else if (pid1 == 0) {
1307 udt_kill_transfer(&s->ptg);
1308 exit(udt_copy_task_routine(&s->gtp) ? 0 : 1);
1311 /* Fork thread #2: program to git. */
1312 pid2 = fork();
1313 if (pid2 < 0)
1314 die_errno("Can't start thread for copying data");
1315 else if (pid2 == 0) {
1316 udt_kill_transfer(&s->gtp);
1317 exit(udt_copy_task_routine(&s->ptg) ? 0 : 1);
1321 * Close both streams in parent as to not interfere with
1322 * end of file detection and wait for both tasks to finish.
1324 udt_kill_transfer(&s->gtp);
1325 udt_kill_transfer(&s->ptg);
1326 ret |= tloop_join(pid1, "Git to program copy");
1327 ret |= tloop_join(pid2, "Program to git copy");
1328 return ret;
1330 #endif
1333 * Copies data from stdin to output and from input to stdout simultaneously.
1334 * Additionally filtering through given filter. If filter is NULL, uses
1335 * identity filter.
1337 int bidirectional_transfer_loop(int input, int output)
1339 struct bidirectional_transfer_state state;
1341 /* Fill the state fields. */
1342 state.ptg.src = input;
1343 state.ptg.dest = 1;
1344 state.ptg.src_is_sock = (input == output);
1345 state.ptg.dest_is_sock = 0;
1346 state.ptg.state = SSTATE_TRANSFERING;
1347 state.ptg.bufuse = 0;
1348 state.ptg.src_name = "remote input";
1349 state.ptg.dest_name = "stdout";
1351 state.gtp.src = 0;
1352 state.gtp.dest = output;
1353 state.gtp.src_is_sock = 0;
1354 state.gtp.dest_is_sock = (input == output);
1355 state.gtp.state = SSTATE_TRANSFERING;
1356 state.gtp.bufuse = 0;
1357 state.gtp.src_name = "stdin";
1358 state.gtp.dest_name = "remote output";
1360 return tloop_spawnwait_tasks(&state);