The seventh batch
[git.git] / transport-helper.c
blobc6b753bfae4bd4e19fd7e3ea16b9f82a8219f10f
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"
14 #include "refspec.h"
15 #include "transport-internal.h"
16 #include "protocol.h"
18 static int debug;
20 struct helper_data {
21 const char *name;
22 struct child_process *helper;
23 FILE *out;
24 unsigned fetch : 1,
25 import : 1,
26 bidi_import : 1,
27 export : 1,
28 option : 1,
29 push : 1,
30 connect : 1,
31 stateless_connect : 1,
32 signed_tags : 1,
33 check_connectivity : 1,
34 no_disconnect_req : 1,
35 no_private_update : 1,
36 object_format : 1;
39 * As an optimization, the transport code may invoke fetch before
40 * get_refs_list. If this happens, and if the transport helper doesn't
41 * support connect or stateless_connect, we need to invoke
42 * get_refs_list ourselves if we haven't already done so. Keep track of
43 * whether we have invoked get_refs_list.
45 unsigned get_refs_list_called : 1;
47 char *export_marks;
48 char *import_marks;
49 /* These go from remote name (as in "list") to private name */
50 struct refspec rs;
51 /* Transport options for fetch-pack/send-pack (should one of
52 * those be invoked).
54 struct git_transport_options transport_options;
57 static void sendline(struct helper_data *helper, struct strbuf *buffer)
59 if (debug)
60 fprintf(stderr, "Debug: Remote helper: -> %s", buffer->buf);
61 if (write_in_full(helper->helper->in, buffer->buf, buffer->len) < 0)
62 die_errno(_("full write to remote helper failed"));
65 static int recvline_fh(FILE *helper, struct strbuf *buffer)
67 strbuf_reset(buffer);
68 if (debug)
69 fprintf(stderr, "Debug: Remote helper: Waiting...\n");
70 if (strbuf_getline(buffer, helper) == EOF) {
71 if (debug)
72 fprintf(stderr, "Debug: Remote helper quit.\n");
73 return 1;
76 if (debug)
77 fprintf(stderr, "Debug: Remote helper: <- %s\n", buffer->buf);
78 return 0;
81 static int recvline(struct helper_data *helper, struct strbuf *buffer)
83 return recvline_fh(helper->out, buffer);
86 static void write_constant(int fd, const char *str)
88 if (debug)
89 fprintf(stderr, "Debug: Remote helper: -> %s", str);
90 if (write_in_full(fd, str, strlen(str)) < 0)
91 die_errno(_("full write to remote helper failed"));
94 static const char *remove_ext_force(const char *url)
96 if (url) {
97 const char *colon = strchr(url, ':');
98 if (colon && colon[1] == ':')
99 return colon + 2;
101 return url;
104 static void do_take_over(struct transport *transport)
106 struct helper_data *data;
107 data = (struct helper_data *)transport->data;
108 transport_take_over(transport, data->helper);
109 fclose(data->out);
110 free(data);
113 static void standard_options(struct transport *t);
115 static struct child_process *get_helper(struct transport *transport)
117 struct helper_data *data = transport->data;
118 struct strbuf buf = STRBUF_INIT;
119 struct child_process *helper;
120 int duped;
121 int code;
123 if (data->helper)
124 return data->helper;
126 helper = xmalloc(sizeof(*helper));
127 child_process_init(helper);
128 helper->in = -1;
129 helper->out = -1;
130 helper->err = 0;
131 argv_array_pushf(&helper->args, "git-remote-%s", data->name);
132 argv_array_push(&helper->args, transport->remote->name);
133 argv_array_push(&helper->args, remove_ext_force(transport->url));
134 helper->git_cmd = 0;
135 helper->silent_exec_failure = 1;
137 if (have_git_dir())
138 argv_array_pushf(&helper->env_array, "%s=%s",
139 GIT_DIR_ENVIRONMENT, get_git_dir());
141 helper->trace2_child_class = helper->args.argv[0]; /* "remote-<name>" */
143 code = start_command(helper);
144 if (code < 0 && errno == ENOENT)
145 die(_("unable to find remote helper for '%s'"), data->name);
146 else if (code != 0)
147 exit(code);
149 data->helper = helper;
150 data->no_disconnect_req = 0;
151 refspec_init(&data->rs, REFSPEC_FETCH);
154 * Open the output as FILE* so strbuf_getline_*() family of
155 * functions can be used.
156 * Do this with duped fd because fclose() will close the fd,
157 * and stuff like taking over will require the fd to remain.
159 duped = dup(helper->out);
160 if (duped < 0)
161 die_errno(_("can't dup helper output fd"));
162 data->out = xfdopen(duped, "r");
164 write_constant(helper->in, "capabilities\n");
166 while (1) {
167 const char *capname, *arg;
168 int mandatory = 0;
169 if (recvline(data, &buf))
170 exit(128);
172 if (!*buf.buf)
173 break;
175 if (*buf.buf == '*') {
176 capname = buf.buf + 1;
177 mandatory = 1;
178 } else
179 capname = buf.buf;
181 if (debug)
182 fprintf(stderr, "Debug: Got cap %s\n", capname);
183 if (!strcmp(capname, "fetch"))
184 data->fetch = 1;
185 else if (!strcmp(capname, "option"))
186 data->option = 1;
187 else if (!strcmp(capname, "push"))
188 data->push = 1;
189 else if (!strcmp(capname, "import"))
190 data->import = 1;
191 else if (!strcmp(capname, "bidi-import"))
192 data->bidi_import = 1;
193 else if (!strcmp(capname, "export"))
194 data->export = 1;
195 else if (!strcmp(capname, "check-connectivity"))
196 data->check_connectivity = 1;
197 else if (skip_prefix(capname, "refspec ", &arg)) {
198 refspec_append(&data->rs, arg);
199 } else if (!strcmp(capname, "connect")) {
200 data->connect = 1;
201 } else if (!strcmp(capname, "stateless-connect")) {
202 data->stateless_connect = 1;
203 } else if (!strcmp(capname, "signed-tags")) {
204 data->signed_tags = 1;
205 } else if (skip_prefix(capname, "export-marks ", &arg)) {
206 data->export_marks = xstrdup(arg);
207 } else if (skip_prefix(capname, "import-marks ", &arg)) {
208 data->import_marks = xstrdup(arg);
209 } else if (starts_with(capname, "no-private-update")) {
210 data->no_private_update = 1;
211 } else if (starts_with(capname, "object-format")) {
212 data->object_format = 1;
213 } else if (mandatory) {
214 die(_("unknown mandatory capability %s; this remote "
215 "helper probably needs newer version of Git"),
216 capname);
219 if (!data->rs.nr && (data->import || data->bidi_import || data->export)) {
220 warning(_("this remote helper should implement refspec capability"));
222 strbuf_release(&buf);
223 if (debug)
224 fprintf(stderr, "Debug: Capabilities complete.\n");
225 standard_options(transport);
226 return data->helper;
229 static int disconnect_helper(struct transport *transport)
231 struct helper_data *data = transport->data;
232 int res = 0;
234 if (data->helper) {
235 if (debug)
236 fprintf(stderr, "Debug: Disconnecting.\n");
237 if (!data->no_disconnect_req) {
239 * Ignore write errors; there's nothing we can do,
240 * since we're about to close the pipe anyway. And the
241 * most likely error is EPIPE due to the helper dying
242 * to report an error itself.
244 sigchain_push(SIGPIPE, SIG_IGN);
245 xwrite(data->helper->in, "\n", 1);
246 sigchain_pop(SIGPIPE);
248 close(data->helper->in);
249 close(data->helper->out);
250 fclose(data->out);
251 res = finish_command(data->helper);
252 FREE_AND_NULL(data->helper);
254 return res;
257 static const char *unsupported_options[] = {
258 TRANS_OPT_UPLOADPACK,
259 TRANS_OPT_RECEIVEPACK,
260 TRANS_OPT_THIN,
261 TRANS_OPT_KEEP
264 static const char *boolean_options[] = {
265 TRANS_OPT_THIN,
266 TRANS_OPT_KEEP,
267 TRANS_OPT_FOLLOWTAGS,
268 TRANS_OPT_DEEPEN_RELATIVE
271 static int strbuf_set_helper_option(struct helper_data *data,
272 struct strbuf *buf)
274 int ret;
276 sendline(data, buf);
277 if (recvline(data, buf))
278 exit(128);
280 if (!strcmp(buf->buf, "ok"))
281 ret = 0;
282 else if (starts_with(buf->buf, "error"))
283 ret = -1;
284 else if (!strcmp(buf->buf, "unsupported"))
285 ret = 1;
286 else {
287 warning(_("%s unexpectedly said: '%s'"), data->name, buf->buf);
288 ret = 1;
290 return ret;
293 static int string_list_set_helper_option(struct helper_data *data,
294 const char *name,
295 struct string_list *list)
297 struct strbuf buf = STRBUF_INIT;
298 int i, ret = 0;
300 for (i = 0; i < list->nr; i++) {
301 strbuf_addf(&buf, "option %s ", name);
302 quote_c_style(list->items[i].string, &buf, NULL, 0);
303 strbuf_addch(&buf, '\n');
305 if ((ret = strbuf_set_helper_option(data, &buf)))
306 break;
307 strbuf_reset(&buf);
309 strbuf_release(&buf);
310 return ret;
313 static int set_helper_option(struct transport *transport,
314 const char *name, const char *value)
316 struct helper_data *data = transport->data;
317 struct strbuf buf = STRBUF_INIT;
318 int i, ret, is_bool = 0;
320 get_helper(transport);
322 if (!data->option)
323 return 1;
325 if (!strcmp(name, "deepen-not"))
326 return string_list_set_helper_option(data, name,
327 (struct string_list *)value);
329 for (i = 0; i < ARRAY_SIZE(unsupported_options); i++) {
330 if (!strcmp(name, unsupported_options[i]))
331 return 1;
334 for (i = 0; i < ARRAY_SIZE(boolean_options); i++) {
335 if (!strcmp(name, boolean_options[i])) {
336 is_bool = 1;
337 break;
341 strbuf_addf(&buf, "option %s ", name);
342 if (is_bool)
343 strbuf_addstr(&buf, value ? "true" : "false");
344 else
345 quote_c_style(value, &buf, NULL, 0);
346 strbuf_addch(&buf, '\n');
348 ret = strbuf_set_helper_option(data, &buf);
349 strbuf_release(&buf);
350 return ret;
353 static void standard_options(struct transport *t)
355 char buf[16];
356 int v = t->verbose;
358 set_helper_option(t, "progress", t->progress ? "true" : "false");
360 xsnprintf(buf, sizeof(buf), "%d", v + 1);
361 set_helper_option(t, "verbosity", buf);
363 switch (t->family) {
364 case TRANSPORT_FAMILY_ALL:
366 * this is already the default,
367 * do not break old remote helpers by setting "all" here
369 break;
370 case TRANSPORT_FAMILY_IPV4:
371 set_helper_option(t, "family", "ipv4");
372 break;
373 case TRANSPORT_FAMILY_IPV6:
374 set_helper_option(t, "family", "ipv6");
375 break;
379 static int release_helper(struct transport *transport)
381 int res = 0;
382 struct helper_data *data = transport->data;
383 refspec_clear(&data->rs);
384 res = disconnect_helper(transport);
385 free(transport->data);
386 return res;
389 static int fetch_with_fetch(struct transport *transport,
390 int nr_heads, struct ref **to_fetch)
392 struct helper_data *data = transport->data;
393 int i;
394 struct strbuf buf = STRBUF_INIT;
396 for (i = 0; i < nr_heads; i++) {
397 const struct ref *posn = to_fetch[i];
398 if (posn->status & REF_STATUS_UPTODATE)
399 continue;
401 strbuf_addf(&buf, "fetch %s %s\n",
402 oid_to_hex(&posn->old_oid),
403 posn->symref ? posn->symref : posn->name);
406 strbuf_addch(&buf, '\n');
407 sendline(data, &buf);
409 while (1) {
410 const char *name;
412 if (recvline(data, &buf))
413 exit(128);
415 if (skip_prefix(buf.buf, "lock ", &name)) {
416 if (transport->pack_lockfiles.nr)
417 warning(_("%s also locked %s"), data->name, name);
418 else
419 string_list_append(&transport->pack_lockfiles,
420 name);
422 else if (data->check_connectivity &&
423 data->transport_options.check_self_contained_and_connected &&
424 !strcmp(buf.buf, "connectivity-ok"))
425 data->transport_options.self_contained_and_connected = 1;
426 else if (!buf.len)
427 break;
428 else
429 warning(_("%s unexpectedly said: '%s'"), data->name, buf.buf);
431 strbuf_release(&buf);
432 return 0;
435 static int get_importer(struct transport *transport, struct child_process *fastimport)
437 struct child_process *helper = get_helper(transport);
438 struct helper_data *data = transport->data;
439 int cat_blob_fd, code;
440 child_process_init(fastimport);
441 fastimport->in = xdup(helper->out);
442 argv_array_push(&fastimport->args, "fast-import");
443 argv_array_push(&fastimport->args, "--allow-unsafe-features");
444 argv_array_push(&fastimport->args, debug ? "--stats" : "--quiet");
446 if (data->bidi_import) {
447 cat_blob_fd = xdup(helper->in);
448 argv_array_pushf(&fastimport->args, "--cat-blob-fd=%d", cat_blob_fd);
450 fastimport->git_cmd = 1;
452 code = start_command(fastimport);
453 return code;
456 static int get_exporter(struct transport *transport,
457 struct child_process *fastexport,
458 struct string_list *revlist_args)
460 struct helper_data *data = transport->data;
461 struct child_process *helper = get_helper(transport);
462 int i;
464 child_process_init(fastexport);
466 /* we need to duplicate helper->in because we want to use it after
467 * fastexport is done with it. */
468 fastexport->out = dup(helper->in);
469 argv_array_push(&fastexport->args, "fast-export");
470 argv_array_push(&fastexport->args, "--use-done-feature");
471 argv_array_push(&fastexport->args, data->signed_tags ?
472 "--signed-tags=verbatim" : "--signed-tags=warn-strip");
473 if (data->export_marks)
474 argv_array_pushf(&fastexport->args, "--export-marks=%s.tmp", data->export_marks);
475 if (data->import_marks)
476 argv_array_pushf(&fastexport->args, "--import-marks=%s", data->import_marks);
478 for (i = 0; i < revlist_args->nr; i++)
479 argv_array_push(&fastexport->args, revlist_args->items[i].string);
481 fastexport->git_cmd = 1;
482 return start_command(fastexport);
485 static int fetch_with_import(struct transport *transport,
486 int nr_heads, struct ref **to_fetch)
488 struct child_process fastimport;
489 struct helper_data *data = transport->data;
490 int i;
491 struct ref *posn;
492 struct strbuf buf = STRBUF_INIT;
494 get_helper(transport);
496 if (get_importer(transport, &fastimport))
497 die(_("couldn't run fast-import"));
499 for (i = 0; i < nr_heads; i++) {
500 posn = to_fetch[i];
501 if (posn->status & REF_STATUS_UPTODATE)
502 continue;
504 strbuf_addf(&buf, "import %s\n",
505 posn->symref ? posn->symref : posn->name);
506 sendline(data, &buf);
507 strbuf_reset(&buf);
510 write_constant(data->helper->in, "\n");
512 * remote-helpers that advertise the bidi-import capability are required to
513 * buffer the complete batch of import commands until this newline before
514 * sending data to fast-import.
515 * These helpers read back data from fast-import on their stdin, which could
516 * be mixed with import commands, otherwise.
519 if (finish_command(&fastimport))
520 die(_("error while running fast-import"));
523 * The fast-import stream of a remote helper that advertises
524 * the "refspec" capability writes to the refs named after the
525 * right hand side of the first refspec matching each ref we
526 * were fetching.
528 * (If no "refspec" capability was specified, for historical
529 * reasons we default to the equivalent of *:*.)
531 * Store the result in to_fetch[i].old_sha1. Callers such
532 * as "git fetch" can use the value to write feedback to the
533 * terminal, populate FETCH_HEAD, and determine what new value
534 * should be written to peer_ref if the update is a
535 * fast-forward or this is a forced update.
537 for (i = 0; i < nr_heads; i++) {
538 char *private, *name;
539 posn = to_fetch[i];
540 if (posn->status & REF_STATUS_UPTODATE)
541 continue;
542 name = posn->symref ? posn->symref : posn->name;
543 if (data->rs.nr)
544 private = apply_refspecs(&data->rs, name);
545 else
546 private = xstrdup(name);
547 if (private) {
548 if (read_ref(private, &posn->old_oid) < 0)
549 die(_("could not read ref %s"), private);
550 free(private);
553 strbuf_release(&buf);
554 return 0;
557 static int run_connect(struct transport *transport, struct strbuf *cmdbuf)
559 struct helper_data *data = transport->data;
560 int ret = 0;
561 int duped;
562 FILE *input;
563 struct child_process *helper;
565 helper = get_helper(transport);
568 * Yes, dup the pipe another time, as we need unbuffered version
569 * of input pipe as FILE*. fclose() closes the underlying fd and
570 * stream buffering only can be changed before first I/O operation
571 * on it.
573 duped = dup(helper->out);
574 if (duped < 0)
575 die_errno(_("can't dup helper output fd"));
576 input = xfdopen(duped, "r");
577 setvbuf(input, NULL, _IONBF, 0);
579 sendline(data, cmdbuf);
580 if (recvline_fh(input, cmdbuf))
581 exit(128);
583 if (!strcmp(cmdbuf->buf, "")) {
584 data->no_disconnect_req = 1;
585 if (debug)
586 fprintf(stderr, "Debug: Smart transport connection "
587 "ready.\n");
588 ret = 1;
589 } else if (!strcmp(cmdbuf->buf, "fallback")) {
590 if (debug)
591 fprintf(stderr, "Debug: Falling back to dumb "
592 "transport.\n");
593 } else {
594 die(_("unknown response to connect: %s"),
595 cmdbuf->buf);
598 fclose(input);
599 return ret;
602 static int process_connect_service(struct transport *transport,
603 const char *name, const char *exec)
605 struct helper_data *data = transport->data;
606 struct strbuf cmdbuf = STRBUF_INIT;
607 int ret = 0;
610 * Handle --upload-pack and friends. This is fire and forget...
611 * just warn if it fails.
613 if (strcmp(name, exec)) {
614 int r = set_helper_option(transport, "servpath", exec);
615 if (r > 0)
616 warning(_("setting remote service path not supported by protocol"));
617 else if (r < 0)
618 warning(_("invalid remote service path"));
621 if (data->connect) {
622 strbuf_addf(&cmdbuf, "connect %s\n", name);
623 ret = run_connect(transport, &cmdbuf);
624 } else if (data->stateless_connect &&
625 (get_protocol_version_config() == protocol_v2) &&
626 !strcmp("git-upload-pack", name)) {
627 strbuf_addf(&cmdbuf, "stateless-connect %s\n", name);
628 ret = run_connect(transport, &cmdbuf);
629 if (ret)
630 transport->stateless_rpc = 1;
633 strbuf_release(&cmdbuf);
634 return ret;
637 static int process_connect(struct transport *transport,
638 int for_push)
640 struct helper_data *data = transport->data;
641 const char *name;
642 const char *exec;
644 name = for_push ? "git-receive-pack" : "git-upload-pack";
645 if (for_push)
646 exec = data->transport_options.receivepack;
647 else
648 exec = data->transport_options.uploadpack;
650 return process_connect_service(transport, name, exec);
653 static int connect_helper(struct transport *transport, const char *name,
654 const char *exec, int fd[2])
656 struct helper_data *data = transport->data;
658 /* Get_helper so connect is inited. */
659 get_helper(transport);
660 if (!data->connect)
661 die(_("operation not supported by protocol"));
663 if (!process_connect_service(transport, name, exec))
664 die(_("can't connect to subservice %s"), name);
666 fd[0] = data->helper->out;
667 fd[1] = data->helper->in;
668 return 0;
671 static struct ref *get_refs_list_using_list(struct transport *transport,
672 int for_push);
674 static int fetch(struct transport *transport,
675 int nr_heads, struct ref **to_fetch)
677 struct helper_data *data = transport->data;
678 int i, count;
680 get_helper(transport);
682 if (process_connect(transport, 0)) {
683 do_take_over(transport);
684 return transport->vtable->fetch(transport, nr_heads, to_fetch);
687 if (!data->get_refs_list_called)
688 get_refs_list_using_list(transport, 0);
690 count = 0;
691 for (i = 0; i < nr_heads; i++)
692 if (!(to_fetch[i]->status & REF_STATUS_UPTODATE))
693 count++;
695 if (!count)
696 return 0;
698 if (data->check_connectivity &&
699 data->transport_options.check_self_contained_and_connected)
700 set_helper_option(transport, "check-connectivity", "true");
702 if (transport->cloning)
703 set_helper_option(transport, "cloning", "true");
705 if (data->transport_options.update_shallow)
706 set_helper_option(transport, "update-shallow", "true");
708 if (data->transport_options.filter_options.choice) {
709 const char *spec = expand_list_objects_filter_spec(
710 &data->transport_options.filter_options);
711 set_helper_option(transport, "filter", spec);
714 if (data->transport_options.negotiation_tips)
715 warning("Ignoring --negotiation-tip because the protocol does not support it.");
717 if (data->fetch)
718 return fetch_with_fetch(transport, nr_heads, to_fetch);
720 if (data->import)
721 return fetch_with_import(transport, nr_heads, to_fetch);
723 return -1;
726 static int push_update_ref_status(struct strbuf *buf,
727 struct ref **ref,
728 struct ref *remote_refs)
730 char *refname, *msg;
731 int status, forced = 0;
733 if (starts_with(buf->buf, "ok ")) {
734 status = REF_STATUS_OK;
735 refname = buf->buf + 3;
736 } else if (starts_with(buf->buf, "error ")) {
737 status = REF_STATUS_REMOTE_REJECT;
738 refname = buf->buf + 6;
739 } else
740 die(_("expected ok/error, helper said '%s'"), buf->buf);
742 msg = strchr(refname, ' ');
743 if (msg) {
744 struct strbuf msg_buf = STRBUF_INIT;
745 const char *end;
747 *msg++ = '\0';
748 if (!unquote_c_style(&msg_buf, msg, &end))
749 msg = strbuf_detach(&msg_buf, NULL);
750 else
751 msg = xstrdup(msg);
752 strbuf_release(&msg_buf);
754 if (!strcmp(msg, "no match")) {
755 status = REF_STATUS_NONE;
756 FREE_AND_NULL(msg);
758 else if (!strcmp(msg, "up to date")) {
759 status = REF_STATUS_UPTODATE;
760 FREE_AND_NULL(msg);
762 else if (!strcmp(msg, "non-fast forward")) {
763 status = REF_STATUS_REJECT_NONFASTFORWARD;
764 FREE_AND_NULL(msg);
766 else if (!strcmp(msg, "already exists")) {
767 status = REF_STATUS_REJECT_ALREADY_EXISTS;
768 FREE_AND_NULL(msg);
770 else if (!strcmp(msg, "fetch first")) {
771 status = REF_STATUS_REJECT_FETCH_FIRST;
772 FREE_AND_NULL(msg);
774 else if (!strcmp(msg, "needs force")) {
775 status = REF_STATUS_REJECT_NEEDS_FORCE;
776 FREE_AND_NULL(msg);
778 else if (!strcmp(msg, "stale info")) {
779 status = REF_STATUS_REJECT_STALE;
780 FREE_AND_NULL(msg);
782 else if (!strcmp(msg, "forced update")) {
783 forced = 1;
784 FREE_AND_NULL(msg);
788 if (*ref)
789 *ref = find_ref_by_name(*ref, refname);
790 if (!*ref)
791 *ref = find_ref_by_name(remote_refs, refname);
792 if (!*ref) {
793 warning(_("helper reported unexpected status of %s"), refname);
794 return 1;
797 if ((*ref)->status != REF_STATUS_NONE) {
799 * Earlier, the ref was marked not to be pushed, so ignore the ref
800 * status reported by the remote helper if the latter is 'no match'.
802 if (status == REF_STATUS_NONE)
803 return 1;
806 (*ref)->status = status;
807 (*ref)->forced_update |= forced;
808 (*ref)->remote_status = msg;
809 return !(status == REF_STATUS_OK);
812 static int push_update_refs_status(struct helper_data *data,
813 struct ref *remote_refs,
814 int flags)
816 struct strbuf buf = STRBUF_INIT;
817 struct ref *ref = remote_refs;
818 int ret = 0;
820 for (;;) {
821 char *private;
823 if (recvline(data, &buf)) {
824 ret = 1;
825 break;
828 if (!buf.len)
829 break;
831 if (push_update_ref_status(&buf, &ref, remote_refs))
832 continue;
834 if (flags & TRANSPORT_PUSH_DRY_RUN || !data->rs.nr || data->no_private_update)
835 continue;
837 /* propagate back the update to the remote namespace */
838 private = apply_refspecs(&data->rs, ref->name);
839 if (!private)
840 continue;
841 update_ref("update by helper", private, &ref->new_oid, NULL,
842 0, 0);
843 free(private);
845 strbuf_release(&buf);
846 return ret;
849 static void set_common_push_options(struct transport *transport,
850 const char *name, int flags)
852 if (flags & TRANSPORT_PUSH_DRY_RUN) {
853 if (set_helper_option(transport, "dry-run", "true") != 0)
854 die(_("helper %s does not support dry-run"), name);
855 } else if (flags & TRANSPORT_PUSH_CERT_ALWAYS) {
856 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
857 die(_("helper %s does not support --signed"), name);
858 } else if (flags & TRANSPORT_PUSH_CERT_IF_ASKED) {
859 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "if-asked") != 0)
860 die(_("helper %s does not support --signed=if-asked"), name);
863 if (flags & TRANSPORT_PUSH_ATOMIC)
864 if (set_helper_option(transport, TRANS_OPT_ATOMIC, "true") != 0)
865 die(_("helper %s does not support --atomic"), name);
867 if (flags & TRANSPORT_PUSH_OPTIONS) {
868 struct string_list_item *item;
869 for_each_string_list_item(item, transport->push_options)
870 if (set_helper_option(transport, "push-option", item->string) != 0)
871 die(_("helper %s does not support 'push-option'"), name);
875 static int push_refs_with_push(struct transport *transport,
876 struct ref *remote_refs, int flags)
878 int force_all = flags & TRANSPORT_PUSH_FORCE;
879 int mirror = flags & TRANSPORT_PUSH_MIRROR;
880 int atomic = flags & TRANSPORT_PUSH_ATOMIC;
881 struct helper_data *data = transport->data;
882 struct strbuf buf = STRBUF_INIT;
883 struct ref *ref;
884 struct string_list cas_options = STRING_LIST_INIT_DUP;
885 struct string_list_item *cas_option;
887 get_helper(transport);
888 if (!data->push)
889 return 1;
891 for (ref = remote_refs; ref; ref = ref->next) {
892 if (!ref->peer_ref && !mirror)
893 continue;
895 /* Check for statuses set by set_ref_status_for_push() */
896 switch (ref->status) {
897 case REF_STATUS_REJECT_NONFASTFORWARD:
898 case REF_STATUS_REJECT_STALE:
899 case REF_STATUS_REJECT_ALREADY_EXISTS:
900 if (atomic) {
901 reject_atomic_push(remote_refs, mirror);
902 string_list_clear(&cas_options, 0);
903 return 0;
904 } else
905 continue;
906 case REF_STATUS_UPTODATE:
907 continue;
908 default:
909 ; /* do nothing */
912 if (force_all)
913 ref->force = 1;
915 strbuf_addstr(&buf, "push ");
916 if (!ref->deletion) {
917 if (ref->force)
918 strbuf_addch(&buf, '+');
919 if (ref->peer_ref)
920 strbuf_addstr(&buf, ref->peer_ref->name);
921 else
922 strbuf_addstr(&buf, oid_to_hex(&ref->new_oid));
924 strbuf_addch(&buf, ':');
925 strbuf_addstr(&buf, ref->name);
926 strbuf_addch(&buf, '\n');
929 * The "--force-with-lease" options without explicit
930 * values to expect have already been expanded into
931 * the ref->old_oid_expect[] field; we can ignore
932 * transport->smart_options->cas altogether and instead
933 * can enumerate them from the refs.
935 if (ref->expect_old_sha1) {
936 struct strbuf cas = STRBUF_INIT;
937 strbuf_addf(&cas, "%s:%s",
938 ref->name, oid_to_hex(&ref->old_oid_expect));
939 string_list_append_nodup(&cas_options,
940 strbuf_detach(&cas, NULL));
943 if (buf.len == 0) {
944 string_list_clear(&cas_options, 0);
945 return 0;
948 for_each_string_list_item(cas_option, &cas_options)
949 set_helper_option(transport, "cas", cas_option->string);
950 set_common_push_options(transport, data->name, flags);
952 strbuf_addch(&buf, '\n');
953 sendline(data, &buf);
954 strbuf_release(&buf);
955 string_list_clear(&cas_options, 0);
957 return push_update_refs_status(data, remote_refs, flags);
960 static int push_refs_with_export(struct transport *transport,
961 struct ref *remote_refs, int flags)
963 struct ref *ref;
964 struct child_process *helper, exporter;
965 struct helper_data *data = transport->data;
966 struct string_list revlist_args = STRING_LIST_INIT_DUP;
967 struct strbuf buf = STRBUF_INIT;
969 if (!data->rs.nr)
970 die(_("remote-helper doesn't support push; refspec needed"));
972 set_common_push_options(transport, data->name, flags);
973 if (flags & TRANSPORT_PUSH_FORCE) {
974 if (set_helper_option(transport, "force", "true") != 0)
975 warning(_("helper %s does not support 'force'"), data->name);
978 helper = get_helper(transport);
980 write_constant(helper->in, "export\n");
982 for (ref = remote_refs; ref; ref = ref->next) {
983 char *private;
984 struct object_id oid;
986 private = apply_refspecs(&data->rs, ref->name);
987 if (private && !get_oid(private, &oid)) {
988 strbuf_addf(&buf, "^%s", private);
989 string_list_append_nodup(&revlist_args,
990 strbuf_detach(&buf, NULL));
991 oidcpy(&ref->old_oid, &oid);
993 free(private);
995 if (ref->peer_ref) {
996 if (strcmp(ref->name, ref->peer_ref->name)) {
997 if (!ref->deletion) {
998 const char *name;
999 int flag;
1001 /* Follow symbolic refs (mainly for HEAD). */
1002 name = resolve_ref_unsafe(ref->peer_ref->name,
1003 RESOLVE_REF_READING,
1004 &oid, &flag);
1005 if (!name || !(flag & REF_ISSYMREF))
1006 name = ref->peer_ref->name;
1008 strbuf_addf(&buf, "%s:%s", name, ref->name);
1009 } else
1010 strbuf_addf(&buf, ":%s", ref->name);
1012 string_list_append(&revlist_args, "--refspec");
1013 string_list_append(&revlist_args, buf.buf);
1014 strbuf_release(&buf);
1016 if (!ref->deletion)
1017 string_list_append(&revlist_args, ref->peer_ref->name);
1021 if (get_exporter(transport, &exporter, &revlist_args))
1022 die(_("couldn't run fast-export"));
1024 string_list_clear(&revlist_args, 1);
1026 if (finish_command(&exporter))
1027 die(_("error while running fast-export"));
1028 if (push_update_refs_status(data, remote_refs, flags))
1029 return 1;
1031 if (data->export_marks) {
1032 strbuf_addf(&buf, "%s.tmp", data->export_marks);
1033 rename(buf.buf, data->export_marks);
1034 strbuf_release(&buf);
1037 return 0;
1040 static int push_refs(struct transport *transport,
1041 struct ref *remote_refs, int flags)
1043 struct helper_data *data = transport->data;
1045 if (process_connect(transport, 1)) {
1046 do_take_over(transport);
1047 return transport->vtable->push_refs(transport, remote_refs, flags);
1050 if (!remote_refs) {
1051 fprintf(stderr,
1052 _("No refs in common and none specified; doing nothing.\n"
1053 "Perhaps you should specify a branch.\n"));
1054 return 0;
1057 if (data->push)
1058 return push_refs_with_push(transport, remote_refs, flags);
1060 if (data->export)
1061 return push_refs_with_export(transport, remote_refs, flags);
1063 return -1;
1067 static int has_attribute(const char *attrs, const char *attr)
1069 int len;
1070 if (!attrs)
1071 return 0;
1073 len = strlen(attr);
1074 for (;;) {
1075 const char *space = strchrnul(attrs, ' ');
1076 if (len == space - attrs && !strncmp(attrs, attr, len))
1077 return 1;
1078 if (!*space)
1079 return 0;
1080 attrs = space + 1;
1084 static struct ref *get_refs_list(struct transport *transport, int for_push,
1085 const struct argv_array *ref_prefixes)
1087 get_helper(transport);
1089 if (process_connect(transport, for_push)) {
1090 do_take_over(transport);
1091 return transport->vtable->get_refs_list(transport, for_push, ref_prefixes);
1094 return get_refs_list_using_list(transport, for_push);
1097 static struct ref *get_refs_list_using_list(struct transport *transport,
1098 int for_push)
1100 struct helper_data *data = transport->data;
1101 struct child_process *helper;
1102 struct ref *ret = NULL;
1103 struct ref **tail = &ret;
1104 struct ref *posn;
1105 struct strbuf buf = STRBUF_INIT;
1107 data->get_refs_list_called = 1;
1108 helper = get_helper(transport);
1110 if (data->object_format) {
1111 write_str_in_full(helper->in, "option object-format\n");
1112 if (recvline(data, &buf) || strcmp(buf.buf, "ok"))
1113 exit(128);
1116 if (data->push && for_push)
1117 write_str_in_full(helper->in, "list for-push\n");
1118 else
1119 write_str_in_full(helper->in, "list\n");
1121 while (1) {
1122 char *eov, *eon;
1123 if (recvline(data, &buf))
1124 exit(128);
1126 if (!*buf.buf)
1127 break;
1128 else if (buf.buf[0] == ':') {
1129 const char *value;
1130 if (skip_prefix(buf.buf, ":object-format ", &value)) {
1131 int algo = hash_algo_by_name(value);
1132 if (algo == GIT_HASH_UNKNOWN)
1133 die(_("unsupported object format '%s'"),
1134 value);
1135 transport->hash_algo = &hash_algos[algo];
1137 continue;
1140 eov = strchr(buf.buf, ' ');
1141 if (!eov)
1142 die(_("malformed response in ref list: %s"), buf.buf);
1143 eon = strchr(eov + 1, ' ');
1144 *eov = '\0';
1145 if (eon)
1146 *eon = '\0';
1147 *tail = alloc_ref(eov + 1);
1148 if (buf.buf[0] == '@')
1149 (*tail)->symref = xstrdup(buf.buf + 1);
1150 else if (buf.buf[0] != '?')
1151 get_oid_hex_algop(buf.buf, &(*tail)->old_oid, transport->hash_algo);
1152 if (eon) {
1153 if (has_attribute(eon + 1, "unchanged")) {
1154 (*tail)->status |= REF_STATUS_UPTODATE;
1155 if (read_ref((*tail)->name, &(*tail)->old_oid) < 0)
1156 die(_("could not read ref %s"),
1157 (*tail)->name);
1160 tail = &((*tail)->next);
1162 if (debug)
1163 fprintf(stderr, "Debug: Read ref listing.\n");
1164 strbuf_release(&buf);
1166 for (posn = ret; posn; posn = posn->next)
1167 resolve_remote_symref(posn, ret);
1169 return ret;
1172 static struct transport_vtable vtable = {
1173 set_helper_option,
1174 get_refs_list,
1175 fetch,
1176 push_refs,
1177 connect_helper,
1178 release_helper
1181 int transport_helper_init(struct transport *transport, const char *name)
1183 struct helper_data *data = xcalloc(1, sizeof(*data));
1184 data->name = name;
1186 transport_check_allowed(name);
1188 if (getenv("GIT_TRANSPORT_HELPER_DEBUG"))
1189 debug = 1;
1191 transport->data = data;
1192 transport->vtable = &vtable;
1193 transport->smart_options = &(data->transport_options);
1194 return 0;
1198 * Linux pipes can buffer 65536 bytes at once (and most platforms can
1199 * buffer less), so attempt reads and writes with up to that size.
1201 #define BUFFERSIZE 65536
1202 /* This should be enough to hold debugging message. */
1203 #define PBUFFERSIZE 8192
1205 /* Print bidirectional transfer loop debug message. */
1206 __attribute__((format (printf, 1, 2)))
1207 static void transfer_debug(const char *fmt, ...)
1210 * NEEDSWORK: This function is sometimes used from multiple threads, and
1211 * we end up using debug_enabled racily. That "should not matter" since
1212 * we always write the same value, but it's still wrong. This function
1213 * is listed in .tsan-suppressions for the time being.
1216 va_list args;
1217 char msgbuf[PBUFFERSIZE];
1218 static int debug_enabled = -1;
1220 if (debug_enabled < 0)
1221 debug_enabled = getenv("GIT_TRANSLOOP_DEBUG") ? 1 : 0;
1222 if (!debug_enabled)
1223 return;
1225 va_start(args, fmt);
1226 vsnprintf(msgbuf, PBUFFERSIZE, fmt, args);
1227 va_end(args);
1228 fprintf(stderr, "Transfer loop debugging: %s\n", msgbuf);
1231 /* Stream state: More data may be coming in this direction. */
1232 #define SSTATE_TRANSFERRING 0
1234 * Stream state: No more data coming in this direction, flushing rest of
1235 * data.
1237 #define SSTATE_FLUSHING 1
1238 /* Stream state: Transfer in this direction finished. */
1239 #define SSTATE_FINISHED 2
1241 #define STATE_NEEDS_READING(state) ((state) <= SSTATE_TRANSFERRING)
1242 #define STATE_NEEDS_WRITING(state) ((state) <= SSTATE_FLUSHING)
1243 #define STATE_NEEDS_CLOSING(state) ((state) == SSTATE_FLUSHING)
1245 /* Unidirectional transfer. */
1246 struct unidirectional_transfer {
1247 /* Source */
1248 int src;
1249 /* Destination */
1250 int dest;
1251 /* Is source socket? */
1252 int src_is_sock;
1253 /* Is destination socket? */
1254 int dest_is_sock;
1255 /* Transfer state (TRANSFERRING/FLUSHING/FINISHED) */
1256 int state;
1257 /* Buffer. */
1258 char buf[BUFFERSIZE];
1259 /* Buffer used. */
1260 size_t bufuse;
1261 /* Name of source. */
1262 const char *src_name;
1263 /* Name of destination. */
1264 const char *dest_name;
1267 /* Closes the target (for writing) if transfer has finished. */
1268 static void udt_close_if_finished(struct unidirectional_transfer *t)
1270 if (STATE_NEEDS_CLOSING(t->state) && !t->bufuse) {
1271 t->state = SSTATE_FINISHED;
1272 if (t->dest_is_sock)
1273 shutdown(t->dest, SHUT_WR);
1274 else
1275 close(t->dest);
1276 transfer_debug("Closed %s.", t->dest_name);
1281 * Tries to read data from source into buffer. If buffer is full,
1282 * no data is read. Returns 0 on success, -1 on error.
1284 static int udt_do_read(struct unidirectional_transfer *t)
1286 ssize_t bytes;
1288 if (t->bufuse == BUFFERSIZE)
1289 return 0; /* No space for more. */
1291 transfer_debug("%s is readable", t->src_name);
1292 bytes = xread(t->src, t->buf + t->bufuse, BUFFERSIZE - t->bufuse);
1293 if (bytes < 0) {
1294 error_errno(_("read(%s) failed"), t->src_name);
1295 return -1;
1296 } else if (bytes == 0) {
1297 transfer_debug("%s EOF (with %i bytes in buffer)",
1298 t->src_name, (int)t->bufuse);
1299 t->state = SSTATE_FLUSHING;
1300 } else if (bytes > 0) {
1301 t->bufuse += bytes;
1302 transfer_debug("Read %i bytes from %s (buffer now at %i)",
1303 (int)bytes, t->src_name, (int)t->bufuse);
1305 return 0;
1308 /* Tries to write data from buffer into destination. If buffer is empty,
1309 * no data is written. Returns 0 on success, -1 on error.
1311 static int udt_do_write(struct unidirectional_transfer *t)
1313 ssize_t bytes;
1315 if (t->bufuse == 0)
1316 return 0; /* Nothing to write. */
1318 transfer_debug("%s is writable", t->dest_name);
1319 bytes = xwrite(t->dest, t->buf, t->bufuse);
1320 if (bytes < 0) {
1321 error_errno(_("write(%s) failed"), t->dest_name);
1322 return -1;
1323 } else if (bytes > 0) {
1324 t->bufuse -= bytes;
1325 if (t->bufuse)
1326 memmove(t->buf, t->buf + bytes, t->bufuse);
1327 transfer_debug("Wrote %i bytes to %s (buffer now at %i)",
1328 (int)bytes, t->dest_name, (int)t->bufuse);
1330 return 0;
1334 /* State of bidirectional transfer loop. */
1335 struct bidirectional_transfer_state {
1336 /* Direction from program to git. */
1337 struct unidirectional_transfer ptg;
1338 /* Direction from git to program. */
1339 struct unidirectional_transfer gtp;
1342 static void *udt_copy_task_routine(void *udt)
1344 struct unidirectional_transfer *t = (struct unidirectional_transfer *)udt;
1345 while (t->state != SSTATE_FINISHED) {
1346 if (STATE_NEEDS_READING(t->state))
1347 if (udt_do_read(t))
1348 return NULL;
1349 if (STATE_NEEDS_WRITING(t->state))
1350 if (udt_do_write(t))
1351 return NULL;
1352 if (STATE_NEEDS_CLOSING(t->state))
1353 udt_close_if_finished(t);
1355 return udt; /* Just some non-NULL value. */
1358 #ifndef NO_PTHREADS
1361 * Join thread, with appropriate errors on failure. Name is name for the
1362 * thread (for error messages). Returns 0 on success, 1 on failure.
1364 static int tloop_join(pthread_t thread, const char *name)
1366 int err;
1367 void *tret;
1368 err = pthread_join(thread, &tret);
1369 if (!tret) {
1370 error(_("%s thread failed"), name);
1371 return 1;
1373 if (err) {
1374 error(_("%s thread failed to join: %s"), name, strerror(err));
1375 return 1;
1377 return 0;
1381 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1382 * -1 on failure.
1384 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1386 pthread_t gtp_thread;
1387 pthread_t ptg_thread;
1388 int err;
1389 int ret = 0;
1390 err = pthread_create(&gtp_thread, NULL, udt_copy_task_routine,
1391 &s->gtp);
1392 if (err)
1393 die(_("can't start thread for copying data: %s"), strerror(err));
1394 err = pthread_create(&ptg_thread, NULL, udt_copy_task_routine,
1395 &s->ptg);
1396 if (err)
1397 die(_("can't start thread for copying data: %s"), strerror(err));
1399 ret |= tloop_join(gtp_thread, "Git to program copy");
1400 ret |= tloop_join(ptg_thread, "Program to git copy");
1401 return ret;
1403 #else
1405 /* Close the source and target (for writing) for transfer. */
1406 static void udt_kill_transfer(struct unidirectional_transfer *t)
1408 t->state = SSTATE_FINISHED;
1410 * Socket read end left open isn't a disaster if nobody
1411 * attempts to read from it (mingw compat headers do not
1412 * have SHUT_RD)...
1414 * We can't fully close the socket since otherwise gtp
1415 * task would first close the socket it sends data to
1416 * while closing the ptg file descriptors.
1418 if (!t->src_is_sock)
1419 close(t->src);
1420 if (t->dest_is_sock)
1421 shutdown(t->dest, SHUT_WR);
1422 else
1423 close(t->dest);
1427 * Join process, with appropriate errors on failure. Name is name for the
1428 * process (for error messages). Returns 0 on success, 1 on failure.
1430 static int tloop_join(pid_t pid, const char *name)
1432 int tret;
1433 if (waitpid(pid, &tret, 0) < 0) {
1434 error_errno(_("%s process failed to wait"), name);
1435 return 1;
1437 if (!WIFEXITED(tret) || WEXITSTATUS(tret)) {
1438 error(_("%s process failed"), name);
1439 return 1;
1441 return 0;
1445 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1446 * -1 on failure.
1448 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1450 pid_t pid1, pid2;
1451 int ret = 0;
1453 /* Fork thread #1: git to program. */
1454 pid1 = fork();
1455 if (pid1 < 0)
1456 die_errno(_("can't start thread for copying data"));
1457 else if (pid1 == 0) {
1458 udt_kill_transfer(&s->ptg);
1459 exit(udt_copy_task_routine(&s->gtp) ? 0 : 1);
1462 /* Fork thread #2: program to git. */
1463 pid2 = fork();
1464 if (pid2 < 0)
1465 die_errno(_("can't start thread for copying data"));
1466 else if (pid2 == 0) {
1467 udt_kill_transfer(&s->gtp);
1468 exit(udt_copy_task_routine(&s->ptg) ? 0 : 1);
1472 * Close both streams in parent as to not interfere with
1473 * end of file detection and wait for both tasks to finish.
1475 udt_kill_transfer(&s->gtp);
1476 udt_kill_transfer(&s->ptg);
1477 ret |= tloop_join(pid1, "Git to program copy");
1478 ret |= tloop_join(pid2, "Program to git copy");
1479 return ret;
1481 #endif
1484 * Copies data from stdin to output and from input to stdout simultaneously.
1485 * Additionally filtering through given filter. If filter is NULL, uses
1486 * identity filter.
1488 int bidirectional_transfer_loop(int input, int output)
1490 struct bidirectional_transfer_state state;
1492 /* Fill the state fields. */
1493 state.ptg.src = input;
1494 state.ptg.dest = 1;
1495 state.ptg.src_is_sock = (input == output);
1496 state.ptg.dest_is_sock = 0;
1497 state.ptg.state = SSTATE_TRANSFERRING;
1498 state.ptg.bufuse = 0;
1499 state.ptg.src_name = "remote input";
1500 state.ptg.dest_name = "stdout";
1502 state.gtp.src = 0;
1503 state.gtp.dest = output;
1504 state.gtp.src_is_sock = 0;
1505 state.gtp.dest_is_sock = (input == output);
1506 state.gtp.state = SSTATE_TRANSFERRING;
1507 state.gtp.bufuse = 0;
1508 state.gtp.src_name = "stdin";
1509 state.gtp.dest_name = "remote output";
1511 return tloop_spawnwait_tasks(&state);
1514 void reject_atomic_push(struct ref *remote_refs, int mirror_mode)
1516 struct ref *ref;
1518 /* Mark other refs as failed */
1519 for (ref = remote_refs; ref; ref = ref->next) {
1520 if (!ref->peer_ref && !mirror_mode)
1521 continue;
1523 switch (ref->status) {
1524 case REF_STATUS_NONE:
1525 case REF_STATUS_OK:
1526 case REF_STATUS_EXPECTING_REPORT:
1527 ref->status = REF_STATUS_ATOMIC_PUSH_FAILED;
1528 continue;
1529 default:
1530 break; /* do nothing */
1533 return;