fetch-pack: restore save_commit_buffer after use
[git] / transport-helper.c
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
15 static int debug;
16
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).
39          */
40         struct git_transport_options transport_options;
41 };
42
43 static void sendline(struct helper_data *helper, struct strbuf *buffer)
44 {
45         if (debug)
46                 fprintf(stderr, "Debug: Remote helper: -> %s", buffer->buf);
47         if (write_in_full(helper->helper->in, buffer->buf, buffer->len) < 0)
48                 die_errno("Full write to remote helper failed");
49 }
50
51 static int recvline_fh(FILE *helper, struct strbuf *buffer, const char *name)
52 {
53         strbuf_reset(buffer);
54         if (debug)
55                 fprintf(stderr, "Debug: Remote helper: Waiting...\n");
56         if (strbuf_getline(buffer, helper) == EOF) {
57                 if (debug)
58                         fprintf(stderr, "Debug: Remote helper quit.\n");
59                 return 1;
60         }
61
62         if (debug)
63                 fprintf(stderr, "Debug: Remote helper: <- %s\n", buffer->buf);
64         return 0;
65 }
66
67 static int recvline(struct helper_data *helper, struct strbuf *buffer)
68 {
69         return recvline_fh(helper->out, buffer, helper->name);
70 }
71
72 static void write_constant(int fd, const char *str)
73 {
74         if (debug)
75                 fprintf(stderr, "Debug: Remote helper: -> %s", str);
76         if (write_in_full(fd, str, strlen(str)) < 0)
77                 die_errno("Full write to remote helper failed");
78 }
79
80 static const char *remove_ext_force(const char *url)
81 {
82         if (url) {
83                 const char *colon = strchr(url, ':');
84                 if (colon && colon[1] == ':')
85                         return colon + 2;
86         }
87         return url;
88 }
89
90 static void do_take_over(struct transport *transport)
91 {
92         struct helper_data *data;
93         data = (struct helper_data *)transport->data;
94         transport_take_over(transport, data->helper);
95         fclose(data->out);
96         free(data);
97 }
98
99 static void standard_options(struct transport *t);
100
101 static struct child_process *get_helper(struct transport *transport)
102 {
103         struct helper_data *data = transport->data;
104         struct strbuf buf = STRBUF_INIT;
105         struct child_process *helper;
106         const char **refspecs = NULL;
107         int refspec_nr = 0;
108         int refspec_alloc = 0;
109         int duped;
110         int code;
111
112         if (data->helper)
113                 return data->helper;
114
115         helper = xmalloc(sizeof(*helper));
116         child_process_init(helper);
117         helper->in = -1;
118         helper->out = -1;
119         helper->err = 0;
120         argv_array_pushf(&helper->args, "git-remote-%s", data->name);
121         argv_array_push(&helper->args, transport->remote->name);
122         argv_array_push(&helper->args, remove_ext_force(transport->url));
123         helper->git_cmd = 0;
124         helper->silent_exec_failure = 1;
125
126         if (have_git_dir())
127                 argv_array_pushf(&helper->env_array, "%s=%s",
128                                  GIT_DIR_ENVIRONMENT, get_git_dir());
129
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);
135
136         data->helper = helper;
137         data->no_disconnect_req = 0;
138
139         /*
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.
144          */
145         duped = dup(helper->out);
146         if (duped < 0)
147                 die_errno("Can't dup helper output fd");
148         data->out = xfdopen(duped, "r");
149
150         write_constant(helper->in, "capabilities\n");
151
152         while (1) {
153                 const char *capname, *arg;
154                 int mandatory = 0;
155                 if (recvline(data, &buf))
156                         exit(128);
157
158                 if (!*buf.buf)
159                         break;
160
161                 if (*buf.buf == '*') {
162                         capname = buf.buf + 1;
163                         mandatory = 1;
164                 } else
165                         capname = buf.buf;
166
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);
202                 }
203         }
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.");
213         }
214         strbuf_release(&buf);
215         if (debug)
216                 fprintf(stderr, "Debug: Capabilities complete.\n");
217         standard_options(transport);
218         return data->helper;
219 }
220
221 static int disconnect_helper(struct transport *transport)
222 {
223         struct helper_data *data = transport->data;
224         int res = 0;
225
226         if (data->helper) {
227                 if (debug)
228                         fprintf(stderr, "Debug: Disconnecting.\n");
229                 if (!data->no_disconnect_req) {
230                         /*
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.
235                          */
236                         sigchain_push(SIGPIPE, SIG_IGN);
237                         xwrite(data->helper->in, "\n", 1);
238                         sigchain_pop(SIGPIPE);
239                 }
240                 close(data->helper->in);
241                 close(data->helper->out);
242                 fclose(data->out);
243                 res = finish_command(data->helper);
244                 FREE_AND_NULL(data->helper);
245         }
246         return res;
247 }
248
249 static const char *unsupported_options[] = {
250         TRANS_OPT_UPLOADPACK,
251         TRANS_OPT_RECEIVEPACK,
252         TRANS_OPT_THIN,
253         TRANS_OPT_KEEP
254         };
255
256 static const char *boolean_options[] = {
257         TRANS_OPT_THIN,
258         TRANS_OPT_KEEP,
259         TRANS_OPT_FOLLOWTAGS,
260         TRANS_OPT_DEEPEN_RELATIVE
261         };
262
263 static int strbuf_set_helper_option(struct helper_data *data,
264                                     struct strbuf *buf)
265 {
266         int ret;
267
268         sendline(data, buf);
269         if (recvline(data, buf))
270                 exit(128);
271
272         if (!strcmp(buf->buf, "ok"))
273                 ret = 0;
274         else if (starts_with(buf->buf, "error"))
275                 ret = -1;
276         else if (!strcmp(buf->buf, "unsupported"))
277                 ret = 1;
278         else {
279                 warning("%s unexpectedly said: '%s'", data->name, buf->buf);
280                 ret = 1;
281         }
282         return ret;
283 }
284
285 static int string_list_set_helper_option(struct helper_data *data,
286                                          const char *name,
287                                          struct string_list *list)
288 {
289         struct strbuf buf = STRBUF_INIT;
290         int i, ret = 0;
291
292         for (i = 0; i < list->nr; i++) {
293                 strbuf_addf(&buf, "option %s ", name);
294                 quote_c_style(list->items[i].string, &buf, NULL, 0);
295                 strbuf_addch(&buf, '\n');
296
297                 if ((ret = strbuf_set_helper_option(data, &buf)))
298                         break;
299                 strbuf_reset(&buf);
300         }
301         strbuf_release(&buf);
302         return ret;
303 }
304
305 static int set_helper_option(struct transport *transport,
306                           const char *name, const char *value)
307 {
308         struct helper_data *data = transport->data;
309         struct strbuf buf = STRBUF_INIT;
310         int i, ret, is_bool = 0;
311
312         get_helper(transport);
313
314         if (!data->option)
315                 return 1;
316
317         if (!strcmp(name, "deepen-not"))
318                 return string_list_set_helper_option(data, name,
319                                                      (struct string_list *)value);
320
321         for (i = 0; i < ARRAY_SIZE(unsupported_options); i++) {
322                 if (!strcmp(name, unsupported_options[i]))
323                         return 1;
324         }
325
326         for (i = 0; i < ARRAY_SIZE(boolean_options); i++) {
327                 if (!strcmp(name, boolean_options[i])) {
328                         is_bool = 1;
329                         break;
330                 }
331         }
332
333         strbuf_addf(&buf, "option %s ", name);
334         if (is_bool)
335                 strbuf_addstr(&buf, value ? "true" : "false");
336         else
337                 quote_c_style(value, &buf, NULL, 0);
338         strbuf_addch(&buf, '\n');
339
340         ret = strbuf_set_helper_option(data, &buf);
341         strbuf_release(&buf);
342         return ret;
343 }
344
345 static void standard_options(struct transport *t)
346 {
347         char buf[16];
348         int v = t->verbose;
349
350         set_helper_option(t, "progress", t->progress ? "true" : "false");
351
352         xsnprintf(buf, sizeof(buf), "%d", v + 1);
353         set_helper_option(t, "verbosity", buf);
354
355         switch (t->family) {
356         case TRANSPORT_FAMILY_ALL:
357                 /*
358                  * this is already the default,
359                  * do not break old remote helpers by setting "all" here
360                  */
361                 break;
362         case TRANSPORT_FAMILY_IPV4:
363                 set_helper_option(t, "family", "ipv4");
364                 break;
365         case TRANSPORT_FAMILY_IPV6:
366                 set_helper_option(t, "family", "ipv6");
367                 break;
368         }
369 }
370
371 static int release_helper(struct transport *transport)
372 {
373         int res = 0;
374         struct helper_data *data = transport->data;
375         free_refspec(data->refspec_nr, data->refspecs);
376         data->refspecs = NULL;
377         res = disconnect_helper(transport);
378         free(transport->data);
379         return res;
380 }
381
382 static int fetch_with_fetch(struct transport *transport,
383                             int nr_heads, struct ref **to_fetch)
384 {
385         struct helper_data *data = transport->data;
386         int i;
387         struct strbuf buf = STRBUF_INIT;
388
389         for (i = 0; i < nr_heads; i++) {
390                 const struct ref *posn = to_fetch[i];
391                 if (posn->status & REF_STATUS_UPTODATE)
392                         continue;
393
394                 strbuf_addf(&buf, "fetch %s %s\n",
395                             oid_to_hex(&posn->old_oid),
396                             posn->symref ? posn->symref : posn->name);
397         }
398
399         strbuf_addch(&buf, '\n');
400         sendline(data, &buf);
401
402         while (1) {
403                 if (recvline(data, &buf))
404                         exit(128);
405
406                 if (starts_with(buf.buf, "lock ")) {
407                         const char *name = buf.buf + 5;
408                         if (transport->pack_lockfile)
409                                 warning("%s also locked %s", data->name, name);
410                         else
411                                 transport->pack_lockfile = xstrdup(name);
412                 }
413                 else if (data->check_connectivity &&
414                          data->transport_options.check_self_contained_and_connected &&
415                          !strcmp(buf.buf, "connectivity-ok"))
416                         data->transport_options.self_contained_and_connected = 1;
417                 else if (!buf.len)
418                         break;
419                 else
420                         warning("%s unexpectedly said: '%s'", data->name, buf.buf);
421         }
422         strbuf_release(&buf);
423         return 0;
424 }
425
426 static int get_importer(struct transport *transport, struct child_process *fastimport)
427 {
428         struct child_process *helper = get_helper(transport);
429         struct helper_data *data = transport->data;
430         int cat_blob_fd, code;
431         child_process_init(fastimport);
432         fastimport->in = helper->out;
433         argv_array_push(&fastimport->args, "fast-import");
434         argv_array_push(&fastimport->args, debug ? "--stats" : "--quiet");
435
436         if (data->bidi_import) {
437                 cat_blob_fd = xdup(helper->in);
438                 argv_array_pushf(&fastimport->args, "--cat-blob-fd=%d", cat_blob_fd);
439         }
440         fastimport->git_cmd = 1;
441
442         code = start_command(fastimport);
443         return code;
444 }
445
446 static int get_exporter(struct transport *transport,
447                         struct child_process *fastexport,
448                         struct string_list *revlist_args)
449 {
450         struct helper_data *data = transport->data;
451         struct child_process *helper = get_helper(transport);
452         int i;
453
454         child_process_init(fastexport);
455
456         /* we need to duplicate helper->in because we want to use it after
457          * fastexport is done with it. */
458         fastexport->out = dup(helper->in);
459         argv_array_push(&fastexport->args, "fast-export");
460         argv_array_push(&fastexport->args, "--use-done-feature");
461         argv_array_push(&fastexport->args, data->signed_tags ?
462                 "--signed-tags=verbatim" : "--signed-tags=warn-strip");
463         if (data->export_marks)
464                 argv_array_pushf(&fastexport->args, "--export-marks=%s.tmp", data->export_marks);
465         if (data->import_marks)
466                 argv_array_pushf(&fastexport->args, "--import-marks=%s", data->import_marks);
467
468         for (i = 0; i < revlist_args->nr; i++)
469                 argv_array_push(&fastexport->args, revlist_args->items[i].string);
470
471         fastexport->git_cmd = 1;
472         return start_command(fastexport);
473 }
474
475 static int fetch_with_import(struct transport *transport,
476                              int nr_heads, struct ref **to_fetch)
477 {
478         struct child_process fastimport;
479         struct helper_data *data = transport->data;
480         int i;
481         struct ref *posn;
482         struct strbuf buf = STRBUF_INIT;
483
484         get_helper(transport);
485
486         if (get_importer(transport, &fastimport))
487                 die("Couldn't run fast-import");
488
489         for (i = 0; i < nr_heads; i++) {
490                 posn = to_fetch[i];
491                 if (posn->status & REF_STATUS_UPTODATE)
492                         continue;
493
494                 strbuf_addf(&buf, "import %s\n",
495                             posn->symref ? posn->symref : posn->name);
496                 sendline(data, &buf);
497                 strbuf_reset(&buf);
498         }
499
500         write_constant(data->helper->in, "\n");
501         /*
502          * remote-helpers that advertise the bidi-import capability are required to
503          * buffer the complete batch of import commands until this newline before
504          * sending data to fast-import.
505          * These helpers read back data from fast-import on their stdin, which could
506          * be mixed with import commands, otherwise.
507          */
508
509         if (finish_command(&fastimport))
510                 die("Error while running fast-import");
511
512         /*
513          * The fast-import stream of a remote helper that advertises
514          * the "refspec" capability writes to the refs named after the
515          * right hand side of the first refspec matching each ref we
516          * were fetching.
517          *
518          * (If no "refspec" capability was specified, for historical
519          * reasons we default to the equivalent of *:*.)
520          *
521          * Store the result in to_fetch[i].old_sha1.  Callers such
522          * as "git fetch" can use the value to write feedback to the
523          * terminal, populate FETCH_HEAD, and determine what new value
524          * should be written to peer_ref if the update is a
525          * fast-forward or this is a forced update.
526          */
527         for (i = 0; i < nr_heads; i++) {
528                 char *private, *name;
529                 posn = to_fetch[i];
530                 if (posn->status & REF_STATUS_UPTODATE)
531                         continue;
532                 name = posn->symref ? posn->symref : posn->name;
533                 if (data->refspecs)
534                         private = apply_refspecs(data->refspecs, data->refspec_nr, name);
535                 else
536                         private = xstrdup(name);
537                 if (private) {
538                         if (read_ref(private, posn->old_oid.hash) < 0)
539                                 die("Could not read ref %s", private);
540                         free(private);
541                 }
542         }
543         strbuf_release(&buf);
544         return 0;
545 }
546
547 static int process_connect_service(struct transport *transport,
548                                    const char *name, const char *exec)
549 {
550         struct helper_data *data = transport->data;
551         struct strbuf cmdbuf = STRBUF_INIT;
552         struct child_process *helper;
553         int r, duped, ret = 0;
554         FILE *input;
555
556         helper = get_helper(transport);
557
558         /*
559          * Yes, dup the pipe another time, as we need unbuffered version
560          * of input pipe as FILE*. fclose() closes the underlying fd and
561          * stream buffering only can be changed before first I/O operation
562          * on it.
563          */
564         duped = dup(helper->out);
565         if (duped < 0)
566                 die_errno("Can't dup helper output fd");
567         input = xfdopen(duped, "r");
568         setvbuf(input, NULL, _IONBF, 0);
569
570         /*
571          * Handle --upload-pack and friends. This is fire and forget...
572          * just warn if it fails.
573          */
574         if (strcmp(name, exec)) {
575                 r = set_helper_option(transport, "servpath", exec);
576                 if (r > 0)
577                         warning("Setting remote service path not supported by protocol.");
578                 else if (r < 0)
579                         warning("Invalid remote service path.");
580         }
581
582         if (data->connect)
583                 strbuf_addf(&cmdbuf, "connect %s\n", name);
584         else
585                 goto exit;
586
587         sendline(data, &cmdbuf);
588         if (recvline_fh(input, &cmdbuf, name))
589                 exit(128);
590
591         if (!strcmp(cmdbuf.buf, "")) {
592                 data->no_disconnect_req = 1;
593                 if (debug)
594                         fprintf(stderr, "Debug: Smart transport connection "
595                                 "ready.\n");
596                 ret = 1;
597         } else if (!strcmp(cmdbuf.buf, "fallback")) {
598                 if (debug)
599                         fprintf(stderr, "Debug: Falling back to dumb "
600                                 "transport.\n");
601         } else
602                 die("Unknown response to connect: %s",
603                         cmdbuf.buf);
604
605 exit:
606         strbuf_release(&cmdbuf);
607         fclose(input);
608         return ret;
609 }
610
611 static int process_connect(struct transport *transport,
612                                      int for_push)
613 {
614         struct helper_data *data = transport->data;
615         const char *name;
616         const char *exec;
617
618         name = for_push ? "git-receive-pack" : "git-upload-pack";
619         if (for_push)
620                 exec = data->transport_options.receivepack;
621         else
622                 exec = data->transport_options.uploadpack;
623
624         return process_connect_service(transport, name, exec);
625 }
626
627 static int connect_helper(struct transport *transport, const char *name,
628                    const char *exec, int fd[2])
629 {
630         struct helper_data *data = transport->data;
631
632         /* Get_helper so connect is inited. */
633         get_helper(transport);
634         if (!data->connect)
635                 die("Operation not supported by protocol.");
636
637         if (!process_connect_service(transport, name, exec))
638                 die("Can't connect to subservice %s.", name);
639
640         fd[0] = data->helper->out;
641         fd[1] = data->helper->in;
642         return 0;
643 }
644
645 static int fetch(struct transport *transport,
646                  int nr_heads, struct ref **to_fetch)
647 {
648         struct helper_data *data = transport->data;
649         int i, count;
650
651         if (process_connect(transport, 0)) {
652                 do_take_over(transport);
653                 return transport->fetch(transport, nr_heads, to_fetch);
654         }
655
656         count = 0;
657         for (i = 0; i < nr_heads; i++)
658                 if (!(to_fetch[i]->status & REF_STATUS_UPTODATE))
659                         count++;
660
661         if (!count)
662                 return 0;
663
664         if (data->check_connectivity &&
665             data->transport_options.check_self_contained_and_connected)
666                 set_helper_option(transport, "check-connectivity", "true");
667
668         if (transport->cloning)
669                 set_helper_option(transport, "cloning", "true");
670
671         if (data->transport_options.update_shallow)
672                 set_helper_option(transport, "update-shallow", "true");
673
674         if (data->transport_options.filter_options.choice)
675                 set_helper_option(
676                         transport, "filter",
677                         data->transport_options.filter_options.filter_spec);
678
679         if (data->fetch)
680                 return fetch_with_fetch(transport, nr_heads, to_fetch);
681
682         if (data->import)
683                 return fetch_with_import(transport, nr_heads, to_fetch);
684
685         return -1;
686 }
687
688 static int push_update_ref_status(struct strbuf *buf,
689                                    struct ref **ref,
690                                    struct ref *remote_refs)
691 {
692         char *refname, *msg;
693         int status, forced = 0;
694
695         if (starts_with(buf->buf, "ok ")) {
696                 status = REF_STATUS_OK;
697                 refname = buf->buf + 3;
698         } else if (starts_with(buf->buf, "error ")) {
699                 status = REF_STATUS_REMOTE_REJECT;
700                 refname = buf->buf + 6;
701         } else
702                 die("expected ok/error, helper said '%s'", buf->buf);
703
704         msg = strchr(refname, ' ');
705         if (msg) {
706                 struct strbuf msg_buf = STRBUF_INIT;
707                 const char *end;
708
709                 *msg++ = '\0';
710                 if (!unquote_c_style(&msg_buf, msg, &end))
711                         msg = strbuf_detach(&msg_buf, NULL);
712                 else
713                         msg = xstrdup(msg);
714                 strbuf_release(&msg_buf);
715
716                 if (!strcmp(msg, "no match")) {
717                         status = REF_STATUS_NONE;
718                         FREE_AND_NULL(msg);
719                 }
720                 else if (!strcmp(msg, "up to date")) {
721                         status = REF_STATUS_UPTODATE;
722                         FREE_AND_NULL(msg);
723                 }
724                 else if (!strcmp(msg, "non-fast forward")) {
725                         status = REF_STATUS_REJECT_NONFASTFORWARD;
726                         FREE_AND_NULL(msg);
727                 }
728                 else if (!strcmp(msg, "already exists")) {
729                         status = REF_STATUS_REJECT_ALREADY_EXISTS;
730                         FREE_AND_NULL(msg);
731                 }
732                 else if (!strcmp(msg, "fetch first")) {
733                         status = REF_STATUS_REJECT_FETCH_FIRST;
734                         FREE_AND_NULL(msg);
735                 }
736                 else if (!strcmp(msg, "needs force")) {
737                         status = REF_STATUS_REJECT_NEEDS_FORCE;
738                         FREE_AND_NULL(msg);
739                 }
740                 else if (!strcmp(msg, "stale info")) {
741                         status = REF_STATUS_REJECT_STALE;
742                         FREE_AND_NULL(msg);
743                 }
744                 else if (!strcmp(msg, "forced update")) {
745                         forced = 1;
746                         FREE_AND_NULL(msg);
747                 }
748         }
749
750         if (*ref)
751                 *ref = find_ref_by_name(*ref, refname);
752         if (!*ref)
753                 *ref = find_ref_by_name(remote_refs, refname);
754         if (!*ref) {
755                 warning("helper reported unexpected status of %s", refname);
756                 return 1;
757         }
758
759         if ((*ref)->status != REF_STATUS_NONE) {
760                 /*
761                  * Earlier, the ref was marked not to be pushed, so ignore the ref
762                  * status reported by the remote helper if the latter is 'no match'.
763                  */
764                 if (status == REF_STATUS_NONE)
765                         return 1;
766         }
767
768         (*ref)->status = status;
769         (*ref)->forced_update |= forced;
770         (*ref)->remote_status = msg;
771         return !(status == REF_STATUS_OK);
772 }
773
774 static int push_update_refs_status(struct helper_data *data,
775                                     struct ref *remote_refs,
776                                     int flags)
777 {
778         struct strbuf buf = STRBUF_INIT;
779         struct ref *ref = remote_refs;
780         int ret = 0;
781
782         for (;;) {
783                 char *private;
784
785                 if (recvline(data, &buf)) {
786                         ret = 1;
787                         break;
788                 }
789
790                 if (!buf.len)
791                         break;
792
793                 if (push_update_ref_status(&buf, &ref, remote_refs))
794                         continue;
795
796                 if (flags & TRANSPORT_PUSH_DRY_RUN || !data->refspecs || data->no_private_update)
797                         continue;
798
799                 /* propagate back the update to the remote namespace */
800                 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
801                 if (!private)
802                         continue;
803                 update_ref("update by helper", private, ref->new_oid.hash, NULL, 0, 0);
804                 free(private);
805         }
806         strbuf_release(&buf);
807         return ret;
808 }
809
810 static void set_common_push_options(struct transport *transport,
811                                    const char *name, int flags)
812 {
813         if (flags & TRANSPORT_PUSH_DRY_RUN) {
814                 if (set_helper_option(transport, "dry-run", "true") != 0)
815                         die("helper %s does not support dry-run", name);
816         } else if (flags & TRANSPORT_PUSH_CERT_ALWAYS) {
817                 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
818                         die("helper %s does not support --signed", name);
819         } else if (flags & TRANSPORT_PUSH_CERT_IF_ASKED) {
820                 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "if-asked") != 0)
821                         die("helper %s does not support --signed=if-asked", name);
822         }
823
824         if (flags & TRANSPORT_PUSH_OPTIONS) {
825                 struct string_list_item *item;
826                 for_each_string_list_item(item, transport->push_options)
827                         if (set_helper_option(transport, "push-option", item->string) != 0)
828                                 die("helper %s does not support 'push-option'", name);
829         }
830 }
831
832 static int push_refs_with_push(struct transport *transport,
833                                struct ref *remote_refs, int flags)
834 {
835         int force_all = flags & TRANSPORT_PUSH_FORCE;
836         int mirror = flags & TRANSPORT_PUSH_MIRROR;
837         struct helper_data *data = transport->data;
838         struct strbuf buf = STRBUF_INIT;
839         struct ref *ref;
840         struct string_list cas_options = STRING_LIST_INIT_DUP;
841         struct string_list_item *cas_option;
842
843         get_helper(transport);
844         if (!data->push)
845                 return 1;
846
847         for (ref = remote_refs; ref; ref = ref->next) {
848                 if (!ref->peer_ref && !mirror)
849                         continue;
850
851                 /* Check for statuses set by set_ref_status_for_push() */
852                 switch (ref->status) {
853                 case REF_STATUS_REJECT_NONFASTFORWARD:
854                 case REF_STATUS_REJECT_STALE:
855                 case REF_STATUS_REJECT_ALREADY_EXISTS:
856                 case REF_STATUS_UPTODATE:
857                         continue;
858                 default:
859                         ; /* do nothing */
860                 }
861
862                 if (force_all)
863                         ref->force = 1;
864
865                 strbuf_addstr(&buf, "push ");
866                 if (!ref->deletion) {
867                         if (ref->force)
868                                 strbuf_addch(&buf, '+');
869                         if (ref->peer_ref)
870                                 strbuf_addstr(&buf, ref->peer_ref->name);
871                         else
872                                 strbuf_addstr(&buf, oid_to_hex(&ref->new_oid));
873                 }
874                 strbuf_addch(&buf, ':');
875                 strbuf_addstr(&buf, ref->name);
876                 strbuf_addch(&buf, '\n');
877
878                 /*
879                  * The "--force-with-lease" options without explicit
880                  * values to expect have already been expanded into
881                  * the ref->old_oid_expect[] field; we can ignore
882                  * transport->smart_options->cas altogether and instead
883                  * can enumerate them from the refs.
884                  */
885                 if (ref->expect_old_sha1) {
886                         struct strbuf cas = STRBUF_INIT;
887                         strbuf_addf(&cas, "%s:%s",
888                                     ref->name, oid_to_hex(&ref->old_oid_expect));
889                         string_list_append(&cas_options, strbuf_detach(&cas, NULL));
890                 }
891         }
892         if (buf.len == 0) {
893                 string_list_clear(&cas_options, 0);
894                 return 0;
895         }
896
897         for_each_string_list_item(cas_option, &cas_options)
898                 set_helper_option(transport, "cas", cas_option->string);
899         set_common_push_options(transport, data->name, flags);
900
901         strbuf_addch(&buf, '\n');
902         sendline(data, &buf);
903         strbuf_release(&buf);
904
905         return push_update_refs_status(data, remote_refs, flags);
906 }
907
908 static int push_refs_with_export(struct transport *transport,
909                 struct ref *remote_refs, int flags)
910 {
911         struct ref *ref;
912         struct child_process *helper, exporter;
913         struct helper_data *data = transport->data;
914         struct string_list revlist_args = STRING_LIST_INIT_DUP;
915         struct strbuf buf = STRBUF_INIT;
916
917         if (!data->refspecs)
918                 die("remote-helper doesn't support push; refspec needed");
919
920         set_common_push_options(transport, data->name, flags);
921         if (flags & TRANSPORT_PUSH_FORCE) {
922                 if (set_helper_option(transport, "force", "true") != 0)
923                         warning("helper %s does not support 'force'", data->name);
924         }
925
926         helper = get_helper(transport);
927
928         write_constant(helper->in, "export\n");
929
930         for (ref = remote_refs; ref; ref = ref->next) {
931                 char *private;
932                 struct object_id oid;
933
934                 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
935                 if (private && !get_oid(private, &oid)) {
936                         strbuf_addf(&buf, "^%s", private);
937                         string_list_append(&revlist_args, strbuf_detach(&buf, NULL));
938                         oidcpy(&ref->old_oid, &oid);
939                 }
940                 free(private);
941
942                 if (ref->peer_ref) {
943                         if (strcmp(ref->name, ref->peer_ref->name)) {
944                                 if (!ref->deletion) {
945                                         const char *name;
946                                         int flag;
947
948                                         /* Follow symbolic refs (mainly for HEAD). */
949                                         name = resolve_ref_unsafe(
950                                                  ref->peer_ref->name,
951                                                  RESOLVE_REF_READING,
952                                                  oid.hash, &flag);
953                                         if (!name || !(flag & REF_ISSYMREF))
954                                                 name = ref->peer_ref->name;
955
956                                         strbuf_addf(&buf, "%s:%s", name, ref->name);
957                                 } else
958                                         strbuf_addf(&buf, ":%s", ref->name);
959
960                                 string_list_append(&revlist_args, "--refspec");
961                                 string_list_append(&revlist_args, buf.buf);
962                                 strbuf_release(&buf);
963                         }
964                         if (!ref->deletion)
965                                 string_list_append(&revlist_args, ref->peer_ref->name);
966                 }
967         }
968
969         if (get_exporter(transport, &exporter, &revlist_args))
970                 die("Couldn't run fast-export");
971
972         string_list_clear(&revlist_args, 1);
973
974         if (finish_command(&exporter))
975                 die("Error while running fast-export");
976         if (push_update_refs_status(data, remote_refs, flags))
977                 return 1;
978
979         if (data->export_marks) {
980                 strbuf_addf(&buf, "%s.tmp", data->export_marks);
981                 rename(buf.buf, data->export_marks);
982                 strbuf_release(&buf);
983         }
984
985         return 0;
986 }
987
988 static int push_refs(struct transport *transport,
989                 struct ref *remote_refs, int flags)
990 {
991         struct helper_data *data = transport->data;
992
993         if (process_connect(transport, 1)) {
994                 do_take_over(transport);
995                 return transport->push_refs(transport, remote_refs, flags);
996         }
997
998         if (!remote_refs) {
999                 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
1000                         "Perhaps you should specify a branch such as 'master'.\n");
1001                 return 0;
1002         }
1003
1004         if (data->push)
1005                 return push_refs_with_push(transport, remote_refs, flags);
1006
1007         if (data->export)
1008                 return push_refs_with_export(transport, remote_refs, flags);
1009
1010         return -1;
1011 }
1012
1013
1014 static int has_attribute(const char *attrs, const char *attr) {
1015         int len;
1016         if (!attrs)
1017                 return 0;
1018
1019         len = strlen(attr);
1020         for (;;) {
1021                 const char *space = strchrnul(attrs, ' ');
1022                 if (len == space - attrs && !strncmp(attrs, attr, len))
1023                         return 1;
1024                 if (!*space)
1025                         return 0;
1026                 attrs = space + 1;
1027         }
1028 }
1029
1030 static struct ref *get_refs_list(struct transport *transport, int for_push)
1031 {
1032         struct helper_data *data = transport->data;
1033         struct child_process *helper;
1034         struct ref *ret = NULL;
1035         struct ref **tail = &ret;
1036         struct ref *posn;
1037         struct strbuf buf = STRBUF_INIT;
1038
1039         helper = get_helper(transport);
1040
1041         if (process_connect(transport, for_push)) {
1042                 do_take_over(transport);
1043                 return transport->get_refs_list(transport, for_push);
1044         }
1045
1046         if (data->push && for_push)
1047                 write_str_in_full(helper->in, "list for-push\n");
1048         else
1049                 write_str_in_full(helper->in, "list\n");
1050
1051         while (1) {
1052                 char *eov, *eon;
1053                 if (recvline(data, &buf))
1054                         exit(128);
1055
1056                 if (!*buf.buf)
1057                         break;
1058
1059                 eov = strchr(buf.buf, ' ');
1060                 if (!eov)
1061                         die("Malformed response in ref list: %s", buf.buf);
1062                 eon = strchr(eov + 1, ' ');
1063                 *eov = '\0';
1064                 if (eon)
1065                         *eon = '\0';
1066                 *tail = alloc_ref(eov + 1);
1067                 if (buf.buf[0] == '@')
1068                         (*tail)->symref = xstrdup(buf.buf + 1);
1069                 else if (buf.buf[0] != '?')
1070                         get_oid_hex(buf.buf, &(*tail)->old_oid);
1071                 if (eon) {
1072                         if (has_attribute(eon + 1, "unchanged")) {
1073                                 (*tail)->status |= REF_STATUS_UPTODATE;
1074                                 if (read_ref((*tail)->name,
1075                                              (*tail)->old_oid.hash) < 0)
1076                                         die(_("Could not read ref %s"),
1077                                             (*tail)->name);
1078                         }
1079                 }
1080                 tail = &((*tail)->next);
1081         }
1082         if (debug)
1083                 fprintf(stderr, "Debug: Read ref listing.\n");
1084         strbuf_release(&buf);
1085
1086         for (posn = ret; posn; posn = posn->next)
1087                 resolve_remote_symref(posn, ret);
1088
1089         return ret;
1090 }
1091
1092 int transport_helper_init(struct transport *transport, const char *name)
1093 {
1094         struct helper_data *data = xcalloc(1, sizeof(*data));
1095         data->name = name;
1096
1097         transport_check_allowed(name);
1098
1099         if (getenv("GIT_TRANSPORT_HELPER_DEBUG"))
1100                 debug = 1;
1101
1102         transport->data = data;
1103         transport->set_option = set_helper_option;
1104         transport->get_refs_list = get_refs_list;
1105         transport->fetch = fetch;
1106         transport->push_refs = push_refs;
1107         transport->disconnect = release_helper;
1108         transport->connect = connect_helper;
1109         transport->smart_options = &(data->transport_options);
1110         return 0;
1111 }
1112
1113 /*
1114  * Linux pipes can buffer 65536 bytes at once (and most platforms can
1115  * buffer less), so attempt reads and writes with up to that size.
1116  */
1117 #define BUFFERSIZE 65536
1118 /* This should be enough to hold debugging message. */
1119 #define PBUFFERSIZE 8192
1120
1121 /* Print bidirectional transfer loop debug message. */
1122 __attribute__((format (printf, 1, 2)))
1123 static void transfer_debug(const char *fmt, ...)
1124 {
1125         /*
1126          * NEEDSWORK: This function is sometimes used from multiple threads, and
1127          * we end up using debug_enabled racily. That "should not matter" since
1128          * we always write the same value, but it's still wrong. This function
1129          * is listed in .tsan-suppressions for the time being.
1130          */
1131
1132         va_list args;
1133         char msgbuf[PBUFFERSIZE];
1134         static int debug_enabled = -1;
1135
1136         if (debug_enabled < 0)
1137                 debug_enabled = getenv("GIT_TRANSLOOP_DEBUG") ? 1 : 0;
1138         if (!debug_enabled)
1139                 return;
1140
1141         va_start(args, fmt);
1142         vsnprintf(msgbuf, PBUFFERSIZE, fmt, args);
1143         va_end(args);
1144         fprintf(stderr, "Transfer loop debugging: %s\n", msgbuf);
1145 }
1146
1147 /* Stream state: More data may be coming in this direction. */
1148 #define SSTATE_TRANSFERRING 0
1149 /*
1150  * Stream state: No more data coming in this direction, flushing rest of
1151  * data.
1152  */
1153 #define SSTATE_FLUSHING 1
1154 /* Stream state: Transfer in this direction finished. */
1155 #define SSTATE_FINISHED 2
1156
1157 #define STATE_NEEDS_READING(state) ((state) <= SSTATE_TRANSFERRING)
1158 #define STATE_NEEDS_WRITING(state) ((state) <= SSTATE_FLUSHING)
1159 #define STATE_NEEDS_CLOSING(state) ((state) == SSTATE_FLUSHING)
1160
1161 /* Unidirectional transfer. */
1162 struct unidirectional_transfer {
1163         /* Source */
1164         int src;
1165         /* Destination */
1166         int dest;
1167         /* Is source socket? */
1168         int src_is_sock;
1169         /* Is destination socket? */
1170         int dest_is_sock;
1171         /* Transfer state (TRANSFERRING/FLUSHING/FINISHED) */
1172         int state;
1173         /* Buffer. */
1174         char buf[BUFFERSIZE];
1175         /* Buffer used. */
1176         size_t bufuse;
1177         /* Name of source. */
1178         const char *src_name;
1179         /* Name of destination. */
1180         const char *dest_name;
1181 };
1182
1183 /* Closes the target (for writing) if transfer has finished. */
1184 static void udt_close_if_finished(struct unidirectional_transfer *t)
1185 {
1186         if (STATE_NEEDS_CLOSING(t->state) && !t->bufuse) {
1187                 t->state = SSTATE_FINISHED;
1188                 if (t->dest_is_sock)
1189                         shutdown(t->dest, SHUT_WR);
1190                 else
1191                         close(t->dest);
1192                 transfer_debug("Closed %s.", t->dest_name);
1193         }
1194 }
1195
1196 /*
1197  * Tries to read data from source into buffer. If buffer is full,
1198  * no data is read. Returns 0 on success, -1 on error.
1199  */
1200 static int udt_do_read(struct unidirectional_transfer *t)
1201 {
1202         ssize_t bytes;
1203
1204         if (t->bufuse == BUFFERSIZE)
1205                 return 0;       /* No space for more. */
1206
1207         transfer_debug("%s is readable", t->src_name);
1208         bytes = read(t->src, t->buf + t->bufuse, BUFFERSIZE - t->bufuse);
1209         if (bytes < 0 && errno != EWOULDBLOCK && errno != EAGAIN &&
1210                 errno != EINTR) {
1211                 error_errno("read(%s) failed", t->src_name);
1212                 return -1;
1213         } else if (bytes == 0) {
1214                 transfer_debug("%s EOF (with %i bytes in buffer)",
1215                         t->src_name, (int)t->bufuse);
1216                 t->state = SSTATE_FLUSHING;
1217         } else if (bytes > 0) {
1218                 t->bufuse += bytes;
1219                 transfer_debug("Read %i bytes from %s (buffer now at %i)",
1220                         (int)bytes, t->src_name, (int)t->bufuse);
1221         }
1222         return 0;
1223 }
1224
1225 /* Tries to write data from buffer into destination. If buffer is empty,
1226  * no data is written. Returns 0 on success, -1 on error.
1227  */
1228 static int udt_do_write(struct unidirectional_transfer *t)
1229 {
1230         ssize_t bytes;
1231
1232         if (t->bufuse == 0)
1233                 return 0;       /* Nothing to write. */
1234
1235         transfer_debug("%s is writable", t->dest_name);
1236         bytes = xwrite(t->dest, t->buf, t->bufuse);
1237         if (bytes < 0 && errno != EWOULDBLOCK) {
1238                 error_errno("write(%s) failed", t->dest_name);
1239                 return -1;
1240         } else if (bytes > 0) {
1241                 t->bufuse -= bytes;
1242                 if (t->bufuse)
1243                         memmove(t->buf, t->buf + bytes, t->bufuse);
1244                 transfer_debug("Wrote %i bytes to %s (buffer now at %i)",
1245                         (int)bytes, t->dest_name, (int)t->bufuse);
1246         }
1247         return 0;
1248 }
1249
1250
1251 /* State of bidirectional transfer loop. */
1252 struct bidirectional_transfer_state {
1253         /* Direction from program to git. */
1254         struct unidirectional_transfer ptg;
1255         /* Direction from git to program. */
1256         struct unidirectional_transfer gtp;
1257 };
1258
1259 static void *udt_copy_task_routine(void *udt)
1260 {
1261         struct unidirectional_transfer *t = (struct unidirectional_transfer *)udt;
1262         while (t->state != SSTATE_FINISHED) {
1263                 if (STATE_NEEDS_READING(t->state))
1264                         if (udt_do_read(t))
1265                                 return NULL;
1266                 if (STATE_NEEDS_WRITING(t->state))
1267                         if (udt_do_write(t))
1268                                 return NULL;
1269                 if (STATE_NEEDS_CLOSING(t->state))
1270                         udt_close_if_finished(t);
1271         }
1272         return udt;     /* Just some non-NULL value. */
1273 }
1274
1275 #ifndef NO_PTHREADS
1276
1277 /*
1278  * Join thread, with appropriate errors on failure. Name is name for the
1279  * thread (for error messages). Returns 0 on success, 1 on failure.
1280  */
1281 static int tloop_join(pthread_t thread, const char *name)
1282 {
1283         int err;
1284         void *tret;
1285         err = pthread_join(thread, &tret);
1286         if (!tret) {
1287                 error("%s thread failed", name);
1288                 return 1;
1289         }
1290         if (err) {
1291                 error("%s thread failed to join: %s", name, strerror(err));
1292                 return 1;
1293         }
1294         return 0;
1295 }
1296
1297 /*
1298  * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1299  * -1 on failure.
1300  */
1301 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1302 {
1303         pthread_t gtp_thread;
1304         pthread_t ptg_thread;
1305         int err;
1306         int ret = 0;
1307         err = pthread_create(&gtp_thread, NULL, udt_copy_task_routine,
1308                 &s->gtp);
1309         if (err)
1310                 die("Can't start thread for copying data: %s", strerror(err));
1311         err = pthread_create(&ptg_thread, NULL, udt_copy_task_routine,
1312                 &s->ptg);
1313         if (err)
1314                 die("Can't start thread for copying data: %s", strerror(err));
1315
1316         ret |= tloop_join(gtp_thread, "Git to program copy");
1317         ret |= tloop_join(ptg_thread, "Program to git copy");
1318         return ret;
1319 }
1320 #else
1321
1322 /* Close the source and target (for writing) for transfer. */
1323 static void udt_kill_transfer(struct unidirectional_transfer *t)
1324 {
1325         t->state = SSTATE_FINISHED;
1326         /*
1327          * Socket read end left open isn't a disaster if nobody
1328          * attempts to read from it (mingw compat headers do not
1329          * have SHUT_RD)...
1330          *
1331          * We can't fully close the socket since otherwise gtp
1332          * task would first close the socket it sends data to
1333          * while closing the ptg file descriptors.
1334          */
1335         if (!t->src_is_sock)
1336                 close(t->src);
1337         if (t->dest_is_sock)
1338                 shutdown(t->dest, SHUT_WR);
1339         else
1340                 close(t->dest);
1341 }
1342
1343 /*
1344  * Join process, with appropriate errors on failure. Name is name for the
1345  * process (for error messages). Returns 0 on success, 1 on failure.
1346  */
1347 static int tloop_join(pid_t pid, const char *name)
1348 {
1349         int tret;
1350         if (waitpid(pid, &tret, 0) < 0) {
1351                 error_errno("%s process failed to wait", name);
1352                 return 1;
1353         }
1354         if (!WIFEXITED(tret) || WEXITSTATUS(tret)) {
1355                 error("%s process failed", name);
1356                 return 1;
1357         }
1358         return 0;
1359 }
1360
1361 /*
1362  * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1363  * -1 on failure.
1364  */
1365 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1366 {
1367         pid_t pid1, pid2;
1368         int ret = 0;
1369
1370         /* Fork thread #1: git to program. */
1371         pid1 = fork();
1372         if (pid1 < 0)
1373                 die_errno("Can't start thread for copying data");
1374         else if (pid1 == 0) {
1375                 udt_kill_transfer(&s->ptg);
1376                 exit(udt_copy_task_routine(&s->gtp) ? 0 : 1);
1377         }
1378
1379         /* Fork thread #2: program to git. */
1380         pid2 = fork();
1381         if (pid2 < 0)
1382                 die_errno("Can't start thread for copying data");
1383         else if (pid2 == 0) {
1384                 udt_kill_transfer(&s->gtp);
1385                 exit(udt_copy_task_routine(&s->ptg) ? 0 : 1);
1386         }
1387
1388         /*
1389          * Close both streams in parent as to not interfere with
1390          * end of file detection and wait for both tasks to finish.
1391          */
1392         udt_kill_transfer(&s->gtp);
1393         udt_kill_transfer(&s->ptg);
1394         ret |= tloop_join(pid1, "Git to program copy");
1395         ret |= tloop_join(pid2, "Program to git copy");
1396         return ret;
1397 }
1398 #endif
1399
1400 /*
1401  * Copies data from stdin to output and from input to stdout simultaneously.
1402  * Additionally filtering through given filter. If filter is NULL, uses
1403  * identity filter.
1404  */
1405 int bidirectional_transfer_loop(int input, int output)
1406 {
1407         struct bidirectional_transfer_state state;
1408
1409         /* Fill the state fields. */
1410         state.ptg.src = input;
1411         state.ptg.dest = 1;
1412         state.ptg.src_is_sock = (input == output);
1413         state.ptg.dest_is_sock = 0;
1414         state.ptg.state = SSTATE_TRANSFERRING;
1415         state.ptg.bufuse = 0;
1416         state.ptg.src_name = "remote input";
1417         state.ptg.dest_name = "stdout";
1418
1419         state.gtp.src = 0;
1420         state.gtp.dest = output;
1421         state.gtp.src_is_sock = 0;
1422         state.gtp.dest_is_sock = (input == output);
1423         state.gtp.state = SSTATE_TRANSFERRING;
1424         state.gtp.bufuse = 0;
1425         state.gtp.src_name = "stdin";
1426         state.gtp.dest_name = "remote output";
1427
1428         return tloop_spawnwait_tasks(&state);
1429 }