Merge branch 'rg/doc-workflow' into maint
[git/mingw.git] / upload-pack.c
blob953ebe1a6030d8476fbebd0b060d3651cfde8f2f
1 #include "cache.h"
2 #include "refs.h"
3 #include "pkt-line.h"
4 #include "sideband.h"
5 #include "tag.h"
6 #include "object.h"
7 #include "commit.h"
8 #include "exec_cmd.h"
9 #include "diff.h"
10 #include "revision.h"
11 #include "list-objects.h"
12 #include "run-command.h"
14 static const char upload_pack_usage[] = "git upload-pack [--strict] [--timeout=nn] <dir>";
16 /* bits #0..7 in revision.h, #8..10 in commit.c */
17 #define THEY_HAVE (1u << 11)
18 #define OUR_REF (1u << 12)
19 #define WANTED (1u << 13)
20 #define COMMON_KNOWN (1u << 14)
21 #define REACHABLE (1u << 15)
23 #define SHALLOW (1u << 16)
24 #define NOT_SHALLOW (1u << 17)
25 #define CLIENT_SHALLOW (1u << 18)
27 static unsigned long oldest_have;
29 static int multi_ack, nr_our_refs;
30 static int use_thin_pack, use_ofs_delta, use_include_tag;
31 static int no_progress, daemon_mode;
32 static int shallow_nr;
33 static struct object_array have_obj;
34 static struct object_array want_obj;
35 static struct object_array extra_edge_obj;
36 static unsigned int timeout;
37 /* 0 for no sideband,
38 * otherwise maximum packet size (up to 65520 bytes).
40 static int use_sideband;
41 static int debug_fd;
43 static void reset_timeout(void)
45 alarm(timeout);
48 static int strip(char *line, int len)
50 if (len && line[len-1] == '\n')
51 line[--len] = 0;
52 return len;
55 static ssize_t send_client_data(int fd, const char *data, ssize_t sz)
57 if (use_sideband)
58 return send_sideband(1, fd, data, sz, use_sideband);
59 if (fd == 3)
60 /* emergency quit */
61 fd = 2;
62 if (fd == 2) {
63 /* XXX: are we happy to lose stuff here? */
64 xwrite(fd, data, sz);
65 return sz;
67 return safe_write(fd, data, sz);
70 static FILE *pack_pipe = NULL;
71 static void show_commit(struct commit *commit, void *data)
73 if (commit->object.flags & BOUNDARY)
74 fputc('-', pack_pipe);
75 if (fputs(sha1_to_hex(commit->object.sha1), pack_pipe) < 0)
76 die("broken output pipe");
77 fputc('\n', pack_pipe);
78 fflush(pack_pipe);
79 free(commit->buffer);
80 commit->buffer = NULL;
83 static void show_object(struct object *obj, const struct name_path *path, const char *component)
85 /* An object with name "foo\n0000000..." can be used to
86 * confuse downstream git-pack-objects very badly.
88 const char *name = path_name(path, component);
89 const char *ep = strchr(name, '\n');
90 if (ep) {
91 fprintf(pack_pipe, "%s %.*s\n", sha1_to_hex(obj->sha1),
92 (int) (ep - name),
93 name);
95 else
96 fprintf(pack_pipe, "%s %s\n",
97 sha1_to_hex(obj->sha1), name);
98 free((char *)name);
101 static void show_edge(struct commit *commit)
103 fprintf(pack_pipe, "-%s\n", sha1_to_hex(commit->object.sha1));
106 static int do_rev_list(int fd, void *create_full_pack)
108 int i;
109 struct rev_info revs;
111 pack_pipe = xfdopen(fd, "w");
112 init_revisions(&revs, NULL);
113 revs.tag_objects = 1;
114 revs.tree_objects = 1;
115 revs.blob_objects = 1;
116 if (use_thin_pack)
117 revs.edge_hint = 1;
119 if (create_full_pack) {
120 const char *args[] = {"rev-list", "--all", NULL};
121 setup_revisions(2, args, &revs, NULL);
122 } else {
123 for (i = 0; i < want_obj.nr; i++) {
124 struct object *o = want_obj.objects[i].item;
125 /* why??? */
126 o->flags &= ~UNINTERESTING;
127 add_pending_object(&revs, o, NULL);
129 for (i = 0; i < have_obj.nr; i++) {
130 struct object *o = have_obj.objects[i].item;
131 o->flags |= UNINTERESTING;
132 add_pending_object(&revs, o, NULL);
134 setup_revisions(0, NULL, &revs, NULL);
136 if (prepare_revision_walk(&revs))
137 die("revision walk setup failed");
138 mark_edges_uninteresting(revs.commits, &revs, show_edge);
139 if (use_thin_pack)
140 for (i = 0; i < extra_edge_obj.nr; i++)
141 fprintf(pack_pipe, "-%s\n", sha1_to_hex(
142 extra_edge_obj.objects[i].item->sha1));
143 traverse_commit_list(&revs, show_commit, show_object, NULL);
144 fflush(pack_pipe);
145 fclose(pack_pipe);
146 return 0;
149 static int feed_msg_to_hook(int fd, const char *fmt, ...)
151 int cnt;
152 char buf[1024];
153 va_list params;
155 va_start(params, fmt);
156 cnt = vsprintf(buf, fmt, params);
157 va_end(params);
158 return write_in_full(fd, buf, cnt) != cnt;
161 static int feed_obj_to_hook(const char *label, struct object_array *oa, int i, int fd)
163 return feed_msg_to_hook(fd, "%s %s\n", label,
164 sha1_to_hex(oa->objects[i].item->sha1));
167 static int run_post_upload_pack_hook(size_t total, struct timeval *tv)
169 const char *argv[2];
170 struct child_process proc;
171 int err, i;
173 argv[0] = "hooks/post-upload-pack";
174 argv[1] = NULL;
176 if (access(argv[0], X_OK) < 0)
177 return 0;
179 memset(&proc, 0, sizeof(proc));
180 proc.argv = argv;
181 proc.in = -1;
182 proc.stdout_to_stderr = 1;
183 err = start_command(&proc);
184 if (err)
185 return err;
186 for (i = 0; !err && i < want_obj.nr; i++)
187 err |= feed_obj_to_hook("want", &want_obj, i, proc.in);
188 for (i = 0; !err && i < have_obj.nr; i++)
189 err |= feed_obj_to_hook("have", &have_obj, i, proc.in);
190 if (!err)
191 err |= feed_msg_to_hook(proc.in, "time %ld.%06ld\n",
192 (long)tv->tv_sec, (long)tv->tv_usec);
193 if (!err)
194 err |= feed_msg_to_hook(proc.in, "size %ld\n", (long)total);
195 if (!err)
196 err |= feed_msg_to_hook(proc.in, "kind %s\n",
197 (nr_our_refs == want_obj.nr && !have_obj.nr)
198 ? "clone" : "fetch");
199 if (close(proc.in))
200 err = 1;
201 if (finish_command(&proc))
202 err = 1;
203 return err;
206 static void create_pack_file(void)
208 struct timeval start_tv, tv;
209 struct async rev_list;
210 struct child_process pack_objects;
211 int create_full_pack = (nr_our_refs == want_obj.nr && !have_obj.nr);
212 char data[8193], progress[128];
213 char abort_msg[] = "aborting due to possible repository "
214 "corruption on the remote side.";
215 int buffered = -1;
216 ssize_t sz, total_sz;
217 const char *argv[10];
218 int arg = 0;
220 gettimeofday(&start_tv, NULL);
221 total_sz = 0;
222 if (shallow_nr) {
223 rev_list.proc = do_rev_list;
224 rev_list.data = 0;
225 if (start_async(&rev_list))
226 die("git upload-pack: unable to fork git-rev-list");
227 argv[arg++] = "pack-objects";
228 } else {
229 argv[arg++] = "pack-objects";
230 argv[arg++] = "--revs";
231 if (create_full_pack)
232 argv[arg++] = "--all";
233 else if (use_thin_pack)
234 argv[arg++] = "--thin";
237 argv[arg++] = "--stdout";
238 if (!no_progress)
239 argv[arg++] = "--progress";
240 if (use_ofs_delta)
241 argv[arg++] = "--delta-base-offset";
242 if (use_include_tag)
243 argv[arg++] = "--include-tag";
244 argv[arg++] = NULL;
246 memset(&pack_objects, 0, sizeof(pack_objects));
247 pack_objects.in = shallow_nr ? rev_list.out : -1;
248 pack_objects.out = -1;
249 pack_objects.err = -1;
250 pack_objects.git_cmd = 1;
251 pack_objects.argv = argv;
253 if (start_command(&pack_objects))
254 die("git upload-pack: unable to fork git-pack-objects");
256 /* pass on revisions we (don't) want */
257 if (!shallow_nr) {
258 FILE *pipe_fd = xfdopen(pack_objects.in, "w");
259 if (!create_full_pack) {
260 int i;
261 for (i = 0; i < want_obj.nr; i++)
262 fprintf(pipe_fd, "%s\n", sha1_to_hex(want_obj.objects[i].item->sha1));
263 fprintf(pipe_fd, "--not\n");
264 for (i = 0; i < have_obj.nr; i++)
265 fprintf(pipe_fd, "%s\n", sha1_to_hex(have_obj.objects[i].item->sha1));
268 fprintf(pipe_fd, "\n");
269 fflush(pipe_fd);
270 fclose(pipe_fd);
274 /* We read from pack_objects.err to capture stderr output for
275 * progress bar, and pack_objects.out to capture the pack data.
278 while (1) {
279 struct pollfd pfd[2];
280 int pe, pu, pollsize;
282 reset_timeout();
284 pollsize = 0;
285 pe = pu = -1;
287 if (0 <= pack_objects.out) {
288 pfd[pollsize].fd = pack_objects.out;
289 pfd[pollsize].events = POLLIN;
290 pu = pollsize;
291 pollsize++;
293 if (0 <= pack_objects.err) {
294 pfd[pollsize].fd = pack_objects.err;
295 pfd[pollsize].events = POLLIN;
296 pe = pollsize;
297 pollsize++;
300 if (!pollsize)
301 break;
303 if (poll(pfd, pollsize, -1) < 0) {
304 if (errno != EINTR) {
305 error("poll failed, resuming: %s",
306 strerror(errno));
307 sleep(1);
309 continue;
311 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
312 /* Status ready; we ship that in the side-band
313 * or dump to the standard error.
315 sz = xread(pack_objects.err, progress,
316 sizeof(progress));
317 if (0 < sz)
318 send_client_data(2, progress, sz);
319 else if (sz == 0) {
320 close(pack_objects.err);
321 pack_objects.err = -1;
323 else
324 goto fail;
325 /* give priority to status messages */
326 continue;
328 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
329 /* Data ready; we keep the last byte to ourselves
330 * in case we detect broken rev-list, so that we
331 * can leave the stream corrupted. This is
332 * unfortunate -- unpack-objects would happily
333 * accept a valid packdata with trailing garbage,
334 * so appending garbage after we pass all the
335 * pack data is not good enough to signal
336 * breakage to downstream.
338 char *cp = data;
339 ssize_t outsz = 0;
340 if (0 <= buffered) {
341 *cp++ = buffered;
342 outsz++;
344 sz = xread(pack_objects.out, cp,
345 sizeof(data) - outsz);
346 if (0 < sz)
347 total_sz += sz;
348 else if (sz == 0) {
349 close(pack_objects.out);
350 pack_objects.out = -1;
352 else
353 goto fail;
354 sz += outsz;
355 if (1 < sz) {
356 buffered = data[sz-1] & 0xFF;
357 sz--;
359 else
360 buffered = -1;
361 sz = send_client_data(1, data, sz);
362 if (sz < 0)
363 goto fail;
367 if (finish_command(&pack_objects)) {
368 error("git upload-pack: git-pack-objects died with error.");
369 goto fail;
371 if (shallow_nr && finish_async(&rev_list))
372 goto fail; /* error was already reported */
374 /* flush the data */
375 if (0 <= buffered) {
376 data[0] = buffered;
377 sz = send_client_data(1, data, 1);
378 if (sz < 0)
379 goto fail;
380 fprintf(stderr, "flushed.\n");
382 if (use_sideband)
383 packet_flush(1);
385 gettimeofday(&tv, NULL);
386 tv.tv_sec -= start_tv.tv_sec;
387 if (tv.tv_usec < start_tv.tv_usec) {
388 tv.tv_sec--;
389 tv.tv_usec += 1000000;
391 tv.tv_usec -= start_tv.tv_usec;
392 if (run_post_upload_pack_hook(total_sz, &tv))
393 warning("post-upload-hook failed");
394 return;
396 fail:
397 send_client_data(3, abort_msg, sizeof(abort_msg));
398 die("git upload-pack: %s", abort_msg);
401 static int got_sha1(char *hex, unsigned char *sha1)
403 struct object *o;
404 int we_knew_they_have = 0;
406 if (get_sha1_hex(hex, sha1))
407 die("git upload-pack: expected SHA1 object, got '%s'", hex);
408 if (!has_sha1_file(sha1))
409 return -1;
411 o = lookup_object(sha1);
412 if (!(o && o->parsed))
413 o = parse_object(sha1);
414 if (!o)
415 die("oops (%s)", sha1_to_hex(sha1));
416 if (o->type == OBJ_COMMIT) {
417 struct commit_list *parents;
418 struct commit *commit = (struct commit *)o;
419 if (o->flags & THEY_HAVE)
420 we_knew_they_have = 1;
421 else
422 o->flags |= THEY_HAVE;
423 if (!oldest_have || (commit->date < oldest_have))
424 oldest_have = commit->date;
425 for (parents = commit->parents;
426 parents;
427 parents = parents->next)
428 parents->item->object.flags |= THEY_HAVE;
430 if (!we_knew_they_have) {
431 add_object_array(o, NULL, &have_obj);
432 return 1;
434 return 0;
437 static int reachable(struct commit *want)
439 struct commit_list *work = NULL;
441 insert_by_date(want, &work);
442 while (work) {
443 struct commit_list *list = work->next;
444 struct commit *commit = work->item;
445 free(work);
446 work = list;
448 if (commit->object.flags & THEY_HAVE) {
449 want->object.flags |= COMMON_KNOWN;
450 break;
452 if (!commit->object.parsed)
453 parse_object(commit->object.sha1);
454 if (commit->object.flags & REACHABLE)
455 continue;
456 commit->object.flags |= REACHABLE;
457 if (commit->date < oldest_have)
458 continue;
459 for (list = commit->parents; list; list = list->next) {
460 struct commit *parent = list->item;
461 if (!(parent->object.flags & REACHABLE))
462 insert_by_date(parent, &work);
465 want->object.flags |= REACHABLE;
466 clear_commit_marks(want, REACHABLE);
467 free_commit_list(work);
468 return (want->object.flags & COMMON_KNOWN);
471 static int ok_to_give_up(void)
473 int i;
475 if (!have_obj.nr)
476 return 0;
478 for (i = 0; i < want_obj.nr; i++) {
479 struct object *want = want_obj.objects[i].item;
481 if (want->flags & COMMON_KNOWN)
482 continue;
483 want = deref_tag(want, "a want line", 0);
484 if (!want || want->type != OBJ_COMMIT) {
485 /* no way to tell if this is reachable by
486 * looking at the ancestry chain alone, so
487 * leave a note to ourselves not to worry about
488 * this object anymore.
490 want_obj.objects[i].item->flags |= COMMON_KNOWN;
491 continue;
493 if (!reachable((struct commit *)want))
494 return 0;
496 return 1;
499 static int get_common_commits(void)
501 static char line[1000];
502 unsigned char sha1[20];
503 char hex[41], last_hex[41];
505 save_commit_buffer = 0;
507 for (;;) {
508 int len = packet_read_line(0, line, sizeof(line));
509 reset_timeout();
511 if (!len) {
512 if (have_obj.nr == 0 || multi_ack)
513 packet_write(1, "NAK\n");
514 continue;
516 strip(line, len);
517 if (!prefixcmp(line, "have ")) {
518 switch (got_sha1(line+5, sha1)) {
519 case -1: /* they have what we do not */
520 if (multi_ack && ok_to_give_up())
521 packet_write(1, "ACK %s continue\n",
522 sha1_to_hex(sha1));
523 break;
524 default:
525 memcpy(hex, sha1_to_hex(sha1), 41);
526 if (multi_ack) {
527 const char *msg = "ACK %s continue\n";
528 packet_write(1, msg, hex);
529 memcpy(last_hex, hex, 41);
531 else if (have_obj.nr == 1)
532 packet_write(1, "ACK %s\n", hex);
533 break;
535 continue;
537 if (!strcmp(line, "done")) {
538 if (have_obj.nr > 0) {
539 if (multi_ack)
540 packet_write(1, "ACK %s\n", last_hex);
541 return 0;
543 packet_write(1, "NAK\n");
544 return -1;
546 die("git upload-pack: expected SHA1 list, got '%s'", line);
550 static void receive_needs(void)
552 struct object_array shallows = {0, 0, NULL};
553 static char line[1000];
554 int len, depth = 0;
556 shallow_nr = 0;
557 if (debug_fd)
558 write_str_in_full(debug_fd, "#S\n");
559 for (;;) {
560 struct object *o;
561 unsigned char sha1_buf[20];
562 len = packet_read_line(0, line, sizeof(line));
563 reset_timeout();
564 if (!len)
565 break;
566 if (debug_fd)
567 write_in_full(debug_fd, line, len);
569 if (!prefixcmp(line, "shallow ")) {
570 unsigned char sha1[20];
571 struct object *object;
572 if (get_sha1(line + 8, sha1))
573 die("invalid shallow line: %s", line);
574 object = parse_object(sha1);
575 if (!object)
576 die("did not find object for %s", line);
577 object->flags |= CLIENT_SHALLOW;
578 add_object_array(object, NULL, &shallows);
579 continue;
581 if (!prefixcmp(line, "deepen ")) {
582 char *end;
583 depth = strtol(line + 7, &end, 0);
584 if (end == line + 7 || depth <= 0)
585 die("Invalid deepen: %s", line);
586 continue;
588 if (prefixcmp(line, "want ") ||
589 get_sha1_hex(line+5, sha1_buf))
590 die("git upload-pack: protocol error, "
591 "expected to get sha, not '%s'", line);
592 if (strstr(line+45, "multi_ack"))
593 multi_ack = 1;
594 if (strstr(line+45, "thin-pack"))
595 use_thin_pack = 1;
596 if (strstr(line+45, "ofs-delta"))
597 use_ofs_delta = 1;
598 if (strstr(line+45, "side-band-64k"))
599 use_sideband = LARGE_PACKET_MAX;
600 else if (strstr(line+45, "side-band"))
601 use_sideband = DEFAULT_PACKET_MAX;
602 if (strstr(line+45, "no-progress"))
603 no_progress = 1;
604 if (strstr(line+45, "include-tag"))
605 use_include_tag = 1;
607 /* We have sent all our refs already, and the other end
608 * should have chosen out of them; otherwise they are
609 * asking for nonsense.
611 * Hmph. We may later want to allow "want" line that
612 * asks for something like "master~10" (symbolic)...
613 * would it make sense? I don't know.
615 o = lookup_object(sha1_buf);
616 if (!o || !(o->flags & OUR_REF))
617 die("git upload-pack: not our ref %s", line+5);
618 if (!(o->flags & WANTED)) {
619 o->flags |= WANTED;
620 add_object_array(o, NULL, &want_obj);
623 if (debug_fd)
624 write_str_in_full(debug_fd, "#E\n");
626 if (!use_sideband && daemon_mode)
627 no_progress = 1;
629 if (depth == 0 && shallows.nr == 0)
630 return;
631 if (depth > 0) {
632 struct commit_list *result, *backup;
633 int i;
634 backup = result = get_shallow_commits(&want_obj, depth,
635 SHALLOW, NOT_SHALLOW);
636 while (result) {
637 struct object *object = &result->item->object;
638 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
639 packet_write(1, "shallow %s",
640 sha1_to_hex(object->sha1));
641 register_shallow(object->sha1);
642 shallow_nr++;
644 result = result->next;
646 free_commit_list(backup);
647 for (i = 0; i < shallows.nr; i++) {
648 struct object *object = shallows.objects[i].item;
649 if (object->flags & NOT_SHALLOW) {
650 struct commit_list *parents;
651 packet_write(1, "unshallow %s",
652 sha1_to_hex(object->sha1));
653 object->flags &= ~CLIENT_SHALLOW;
654 /* make sure the real parents are parsed */
655 unregister_shallow(object->sha1);
656 object->parsed = 0;
657 if (parse_commit((struct commit *)object))
658 die("invalid commit");
659 parents = ((struct commit *)object)->parents;
660 while (parents) {
661 add_object_array(&parents->item->object,
662 NULL, &want_obj);
663 parents = parents->next;
665 add_object_array(object, NULL, &extra_edge_obj);
667 /* make sure commit traversal conforms to client */
668 register_shallow(object->sha1);
670 packet_flush(1);
671 } else
672 if (shallows.nr > 0) {
673 int i;
674 for (i = 0; i < shallows.nr; i++)
675 register_shallow(shallows.objects[i].item->sha1);
678 shallow_nr += shallows.nr;
679 free(shallows.objects);
682 static int send_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
684 static const char *capabilities = "multi_ack thin-pack side-band"
685 " side-band-64k ofs-delta shallow no-progress"
686 " include-tag";
687 struct object *o = parse_object(sha1);
689 if (!o)
690 die("git upload-pack: cannot find object %s:", sha1_to_hex(sha1));
692 if (capabilities)
693 packet_write(1, "%s %s%c%s\n", sha1_to_hex(sha1), refname,
694 0, capabilities);
695 else
696 packet_write(1, "%s %s\n", sha1_to_hex(sha1), refname);
697 capabilities = NULL;
698 if (!(o->flags & OUR_REF)) {
699 o->flags |= OUR_REF;
700 nr_our_refs++;
702 if (o->type == OBJ_TAG) {
703 o = deref_tag(o, refname, 0);
704 if (o)
705 packet_write(1, "%s %s^{}\n", sha1_to_hex(o->sha1), refname);
707 return 0;
710 static void upload_pack(void)
712 reset_timeout();
713 head_ref(send_ref, NULL);
714 for_each_ref(send_ref, NULL);
715 packet_flush(1);
716 receive_needs();
717 if (want_obj.nr) {
718 get_common_commits();
719 create_pack_file();
723 int main(int argc, char **argv)
725 char *dir;
726 int i;
727 int strict = 0;
729 git_extract_argv0_path(argv[0]);
730 read_replace_refs = 0;
732 for (i = 1; i < argc; i++) {
733 char *arg = argv[i];
735 if (arg[0] != '-')
736 break;
737 if (!strcmp(arg, "--strict")) {
738 strict = 1;
739 continue;
741 if (!prefixcmp(arg, "--timeout=")) {
742 timeout = atoi(arg+10);
743 daemon_mode = 1;
744 continue;
746 if (!strcmp(arg, "--")) {
747 i++;
748 break;
752 if (i != argc-1)
753 usage(upload_pack_usage);
755 setup_path();
757 dir = argv[i];
759 if (!enter_repo(dir, strict))
760 die("'%s' does not appear to be a git repository", dir);
761 if (is_repository_shallow())
762 die("attempt to fetch/clone from a shallow repository");
763 if (getenv("GIT_DEBUG_SEND_PACK"))
764 debug_fd = atoi(getenv("GIT_DEBUG_SEND_PACK"));
765 upload_pack();
766 return 0;