Documentation/Makefile: add *.pdf to `clean' target
[git/jrn.git] / upload-pack.c
blobce5cbbea6be45a6dfa79bcc8c8244ae0b99c7ca3
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=<n>] <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 no_done;
31 static int use_thin_pack, use_ofs_delta, use_include_tag;
32 static int no_progress, daemon_mode;
33 static int shallow_nr;
34 static struct object_array have_obj;
35 static struct object_array want_obj;
36 static struct object_array extra_edge_obj;
37 static unsigned int timeout;
38 /* 0 for no sideband,
39 * otherwise maximum packet size (up to 65520 bytes).
41 static int use_sideband;
42 static int debug_fd;
43 static int advertise_refs;
44 static int stateless_rpc;
46 static void reset_timeout(void)
48 alarm(timeout);
51 static int strip(char *line, int len)
53 if (len && line[len-1] == '\n')
54 line[--len] = 0;
55 return len;
58 static ssize_t send_client_data(int fd, const char *data, ssize_t sz)
60 if (use_sideband)
61 return send_sideband(1, fd, data, sz, use_sideband);
62 if (fd == 3)
63 /* emergency quit */
64 fd = 2;
65 if (fd == 2) {
66 /* XXX: are we happy to lose stuff here? */
67 xwrite(fd, data, sz);
68 return sz;
70 return safe_write(fd, data, sz);
73 static FILE *pack_pipe = NULL;
74 static void show_commit(struct commit *commit, void *data)
76 if (commit->object.flags & BOUNDARY)
77 fputc('-', pack_pipe);
78 if (fputs(sha1_to_hex(commit->object.sha1), pack_pipe) < 0)
79 die("broken output pipe");
80 fputc('\n', pack_pipe);
81 fflush(pack_pipe);
82 free(commit->buffer);
83 commit->buffer = NULL;
86 static void show_object(struct object *obj, const struct name_path *path, const char *component)
88 /* An object with name "foo\n0000000..." can be used to
89 * confuse downstream git-pack-objects very badly.
91 const char *name = path_name(path, component);
92 const char *ep = strchr(name, '\n');
93 if (ep) {
94 fprintf(pack_pipe, "%s %.*s\n", sha1_to_hex(obj->sha1),
95 (int) (ep - name),
96 name);
98 else
99 fprintf(pack_pipe, "%s %s\n",
100 sha1_to_hex(obj->sha1), name);
101 free((char *)name);
104 static void show_edge(struct commit *commit)
106 fprintf(pack_pipe, "-%s\n", sha1_to_hex(commit->object.sha1));
109 static int do_rev_list(int in, int out, void *user_data)
111 int i;
112 struct rev_info revs;
114 pack_pipe = xfdopen(out, "w");
115 init_revisions(&revs, NULL);
116 revs.tag_objects = 1;
117 revs.tree_objects = 1;
118 revs.blob_objects = 1;
119 if (use_thin_pack)
120 revs.edge_hint = 1;
122 for (i = 0; i < want_obj.nr; i++) {
123 struct object *o = want_obj.objects[i].item;
124 /* why??? */
125 o->flags &= ~UNINTERESTING;
126 add_pending_object(&revs, o, NULL);
128 for (i = 0; i < have_obj.nr; i++) {
129 struct object *o = have_obj.objects[i].item;
130 o->flags |= UNINTERESTING;
131 add_pending_object(&revs, o, NULL);
133 setup_revisions(0, NULL, &revs, NULL);
134 if (prepare_revision_walk(&revs))
135 die("revision walk setup failed");
136 mark_edges_uninteresting(revs.commits, &revs, show_edge);
137 if (use_thin_pack)
138 for (i = 0; i < extra_edge_obj.nr; i++)
139 fprintf(pack_pipe, "-%s\n", sha1_to_hex(
140 extra_edge_obj.objects[i].item->sha1));
141 traverse_commit_list(&revs, show_commit, show_object, NULL);
142 fflush(pack_pipe);
143 fclose(pack_pipe);
144 return 0;
147 static void create_pack_file(void)
149 struct async rev_list;
150 struct child_process pack_objects;
151 int create_full_pack = (nr_our_refs == want_obj.nr && !have_obj.nr);
152 char data[8193], progress[128];
153 char abort_msg[] = "aborting due to possible repository "
154 "corruption on the remote side.";
155 int buffered = -1;
156 ssize_t sz;
157 const char *argv[10];
158 int arg = 0;
160 argv[arg++] = "pack-objects";
161 if (!shallow_nr) {
162 argv[arg++] = "--revs";
163 if (create_full_pack)
164 argv[arg++] = "--all";
165 else if (use_thin_pack)
166 argv[arg++] = "--thin";
169 argv[arg++] = "--stdout";
170 if (!no_progress)
171 argv[arg++] = "--progress";
172 if (use_ofs_delta)
173 argv[arg++] = "--delta-base-offset";
174 if (use_include_tag)
175 argv[arg++] = "--include-tag";
176 argv[arg++] = NULL;
178 memset(&pack_objects, 0, sizeof(pack_objects));
179 pack_objects.in = -1;
180 pack_objects.out = -1;
181 pack_objects.err = -1;
182 pack_objects.git_cmd = 1;
183 pack_objects.argv = argv;
185 if (start_command(&pack_objects))
186 die("git upload-pack: unable to fork git-pack-objects");
188 if (shallow_nr) {
189 memset(&rev_list, 0, sizeof(rev_list));
190 rev_list.proc = do_rev_list;
191 rev_list.out = pack_objects.in;
192 if (start_async(&rev_list))
193 die("git upload-pack: unable to fork git-rev-list");
195 else {
196 FILE *pipe_fd = xfdopen(pack_objects.in, "w");
197 if (!create_full_pack) {
198 int i;
199 for (i = 0; i < want_obj.nr; i++)
200 fprintf(pipe_fd, "%s\n", sha1_to_hex(want_obj.objects[i].item->sha1));
201 fprintf(pipe_fd, "--not\n");
202 for (i = 0; i < have_obj.nr; i++)
203 fprintf(pipe_fd, "%s\n", sha1_to_hex(have_obj.objects[i].item->sha1));
206 fprintf(pipe_fd, "\n");
207 fflush(pipe_fd);
208 fclose(pipe_fd);
212 /* We read from pack_objects.err to capture stderr output for
213 * progress bar, and pack_objects.out to capture the pack data.
216 while (1) {
217 struct pollfd pfd[2];
218 int pe, pu, pollsize;
220 reset_timeout();
222 pollsize = 0;
223 pe = pu = -1;
225 if (0 <= pack_objects.out) {
226 pfd[pollsize].fd = pack_objects.out;
227 pfd[pollsize].events = POLLIN;
228 pu = pollsize;
229 pollsize++;
231 if (0 <= pack_objects.err) {
232 pfd[pollsize].fd = pack_objects.err;
233 pfd[pollsize].events = POLLIN;
234 pe = pollsize;
235 pollsize++;
238 if (!pollsize)
239 break;
241 if (poll(pfd, pollsize, -1) < 0) {
242 if (errno != EINTR) {
243 error("poll failed, resuming: %s",
244 strerror(errno));
245 sleep(1);
247 continue;
249 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
250 /* Status ready; we ship that in the side-band
251 * or dump to the standard error.
253 sz = xread(pack_objects.err, progress,
254 sizeof(progress));
255 if (0 < sz)
256 send_client_data(2, progress, sz);
257 else if (sz == 0) {
258 close(pack_objects.err);
259 pack_objects.err = -1;
261 else
262 goto fail;
263 /* give priority to status messages */
264 continue;
266 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
267 /* Data ready; we keep the last byte to ourselves
268 * in case we detect broken rev-list, so that we
269 * can leave the stream corrupted. This is
270 * unfortunate -- unpack-objects would happily
271 * accept a valid packdata with trailing garbage,
272 * so appending garbage after we pass all the
273 * pack data is not good enough to signal
274 * breakage to downstream.
276 char *cp = data;
277 ssize_t outsz = 0;
278 if (0 <= buffered) {
279 *cp++ = buffered;
280 outsz++;
282 sz = xread(pack_objects.out, cp,
283 sizeof(data) - outsz);
284 if (0 < sz)
286 else if (sz == 0) {
287 close(pack_objects.out);
288 pack_objects.out = -1;
290 else
291 goto fail;
292 sz += outsz;
293 if (1 < sz) {
294 buffered = data[sz-1] & 0xFF;
295 sz--;
297 else
298 buffered = -1;
299 sz = send_client_data(1, data, sz);
300 if (sz < 0)
301 goto fail;
305 if (finish_command(&pack_objects)) {
306 error("git upload-pack: git-pack-objects died with error.");
307 goto fail;
309 if (shallow_nr && finish_async(&rev_list))
310 goto fail; /* error was already reported */
312 /* flush the data */
313 if (0 <= buffered) {
314 data[0] = buffered;
315 sz = send_client_data(1, data, 1);
316 if (sz < 0)
317 goto fail;
318 fprintf(stderr, "flushed.\n");
320 if (use_sideband)
321 packet_flush(1);
322 return;
324 fail:
325 send_client_data(3, abort_msg, sizeof(abort_msg));
326 die("git upload-pack: %s", abort_msg);
329 static int got_sha1(char *hex, unsigned char *sha1)
331 struct object *o;
332 int we_knew_they_have = 0;
334 if (get_sha1_hex(hex, sha1))
335 die("git upload-pack: expected SHA1 object, got '%s'", hex);
336 if (!has_sha1_file(sha1))
337 return -1;
339 o = lookup_object(sha1);
340 if (!(o && o->parsed))
341 o = parse_object(sha1);
342 if (!o)
343 die("oops (%s)", sha1_to_hex(sha1));
344 if (o->type == OBJ_COMMIT) {
345 struct commit_list *parents;
346 struct commit *commit = (struct commit *)o;
347 if (o->flags & THEY_HAVE)
348 we_knew_they_have = 1;
349 else
350 o->flags |= THEY_HAVE;
351 if (!oldest_have || (commit->date < oldest_have))
352 oldest_have = commit->date;
353 for (parents = commit->parents;
354 parents;
355 parents = parents->next)
356 parents->item->object.flags |= THEY_HAVE;
358 if (!we_knew_they_have) {
359 add_object_array(o, NULL, &have_obj);
360 return 1;
362 return 0;
365 static int reachable(struct commit *want)
367 struct commit_list *work = NULL;
369 commit_list_insert_by_date(want, &work);
370 while (work) {
371 struct commit_list *list = work->next;
372 struct commit *commit = work->item;
373 free(work);
374 work = list;
376 if (commit->object.flags & THEY_HAVE) {
377 want->object.flags |= COMMON_KNOWN;
378 break;
380 if (!commit->object.parsed)
381 parse_object(commit->object.sha1);
382 if (commit->object.flags & REACHABLE)
383 continue;
384 commit->object.flags |= REACHABLE;
385 if (commit->date < oldest_have)
386 continue;
387 for (list = commit->parents; list; list = list->next) {
388 struct commit *parent = list->item;
389 if (!(parent->object.flags & REACHABLE))
390 commit_list_insert_by_date(parent, &work);
393 want->object.flags |= REACHABLE;
394 clear_commit_marks(want, REACHABLE);
395 free_commit_list(work);
396 return (want->object.flags & COMMON_KNOWN);
399 static int ok_to_give_up(void)
401 int i;
403 if (!have_obj.nr)
404 return 0;
406 for (i = 0; i < want_obj.nr; i++) {
407 struct object *want = want_obj.objects[i].item;
409 if (want->flags & COMMON_KNOWN)
410 continue;
411 want = deref_tag(want, "a want line", 0);
412 if (!want || want->type != OBJ_COMMIT) {
413 /* no way to tell if this is reachable by
414 * looking at the ancestry chain alone, so
415 * leave a note to ourselves not to worry about
416 * this object anymore.
418 want_obj.objects[i].item->flags |= COMMON_KNOWN;
419 continue;
421 if (!reachable((struct commit *)want))
422 return 0;
424 return 1;
427 static int get_common_commits(void)
429 static char line[1000];
430 unsigned char sha1[20];
431 char last_hex[41];
432 int got_common = 0;
433 int got_other = 0;
434 int sent_ready = 0;
436 save_commit_buffer = 0;
438 for (;;) {
439 int len = packet_read_line(0, line, sizeof(line));
440 reset_timeout();
442 if (!len) {
443 if (multi_ack == 2 && got_common
444 && !got_other && ok_to_give_up()) {
445 sent_ready = 1;
446 packet_write(1, "ACK %s ready\n", last_hex);
448 if (have_obj.nr == 0 || multi_ack)
449 packet_write(1, "NAK\n");
451 if (no_done && sent_ready) {
452 packet_write(1, "ACK %s\n", last_hex);
453 return 0;
455 if (stateless_rpc)
456 exit(0);
457 got_common = 0;
458 got_other = 0;
459 continue;
461 strip(line, len);
462 if (!prefixcmp(line, "have ")) {
463 switch (got_sha1(line+5, sha1)) {
464 case -1: /* they have what we do not */
465 got_other = 1;
466 if (multi_ack && ok_to_give_up()) {
467 const char *hex = sha1_to_hex(sha1);
468 if (multi_ack == 2) {
469 sent_ready = 1;
470 packet_write(1, "ACK %s ready\n", hex);
471 } else
472 packet_write(1, "ACK %s continue\n", hex);
474 break;
475 default:
476 got_common = 1;
477 memcpy(last_hex, sha1_to_hex(sha1), 41);
478 if (multi_ack == 2)
479 packet_write(1, "ACK %s common\n", last_hex);
480 else if (multi_ack)
481 packet_write(1, "ACK %s continue\n", last_hex);
482 else if (have_obj.nr == 1)
483 packet_write(1, "ACK %s\n", last_hex);
484 break;
486 continue;
488 if (!strcmp(line, "done")) {
489 if (have_obj.nr > 0) {
490 if (multi_ack)
491 packet_write(1, "ACK %s\n", last_hex);
492 return 0;
494 packet_write(1, "NAK\n");
495 return -1;
497 die("git upload-pack: expected SHA1 list, got '%s'", line);
501 static void receive_needs(void)
503 struct object_array shallows = OBJECT_ARRAY_INIT;
504 static char line[1000];
505 int len, depth = 0;
507 shallow_nr = 0;
508 if (debug_fd)
509 write_str_in_full(debug_fd, "#S\n");
510 for (;;) {
511 struct object *o;
512 unsigned char sha1_buf[20];
513 len = packet_read_line(0, line, sizeof(line));
514 reset_timeout();
515 if (!len)
516 break;
517 if (debug_fd)
518 write_in_full(debug_fd, line, len);
520 if (!prefixcmp(line, "shallow ")) {
521 unsigned char sha1[20];
522 struct object *object;
523 if (get_sha1(line + 8, sha1))
524 die("invalid shallow line: %s", line);
525 object = parse_object(sha1);
526 if (!object)
527 die("did not find object for %s", line);
528 object->flags |= CLIENT_SHALLOW;
529 add_object_array(object, NULL, &shallows);
530 continue;
532 if (!prefixcmp(line, "deepen ")) {
533 char *end;
534 depth = strtol(line + 7, &end, 0);
535 if (end == line + 7 || depth <= 0)
536 die("Invalid deepen: %s", line);
537 continue;
539 if (prefixcmp(line, "want ") ||
540 get_sha1_hex(line+5, sha1_buf))
541 die("git upload-pack: protocol error, "
542 "expected to get sha, not '%s'", line);
543 if (strstr(line+45, "multi_ack_detailed"))
544 multi_ack = 2;
545 else if (strstr(line+45, "multi_ack"))
546 multi_ack = 1;
547 if (strstr(line+45, "no-done"))
548 no_done = 1;
549 if (strstr(line+45, "thin-pack"))
550 use_thin_pack = 1;
551 if (strstr(line+45, "ofs-delta"))
552 use_ofs_delta = 1;
553 if (strstr(line+45, "side-band-64k"))
554 use_sideband = LARGE_PACKET_MAX;
555 else if (strstr(line+45, "side-band"))
556 use_sideband = DEFAULT_PACKET_MAX;
557 if (strstr(line+45, "no-progress"))
558 no_progress = 1;
559 if (strstr(line+45, "include-tag"))
560 use_include_tag = 1;
562 /* We have sent all our refs already, and the other end
563 * should have chosen out of them; otherwise they are
564 * asking for nonsense.
566 * Hmph. We may later want to allow "want" line that
567 * asks for something like "master~10" (symbolic)...
568 * would it make sense? I don't know.
570 o = lookup_object(sha1_buf);
571 if (!o || !(o->flags & OUR_REF))
572 die("git upload-pack: not our ref %s",
573 sha1_to_hex(sha1_buf));
574 if (!(o->flags & WANTED)) {
575 o->flags |= WANTED;
576 add_object_array(o, NULL, &want_obj);
579 if (debug_fd)
580 write_str_in_full(debug_fd, "#E\n");
582 if (!use_sideband && daemon_mode)
583 no_progress = 1;
585 if (depth == 0 && shallows.nr == 0)
586 return;
587 if (depth > 0) {
588 struct commit_list *result, *backup;
589 int i;
590 backup = result = get_shallow_commits(&want_obj, depth,
591 SHALLOW, NOT_SHALLOW);
592 while (result) {
593 struct object *object = &result->item->object;
594 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
595 packet_write(1, "shallow %s",
596 sha1_to_hex(object->sha1));
597 register_shallow(object->sha1);
598 shallow_nr++;
600 result = result->next;
602 free_commit_list(backup);
603 for (i = 0; i < shallows.nr; i++) {
604 struct object *object = shallows.objects[i].item;
605 if (object->flags & NOT_SHALLOW) {
606 struct commit_list *parents;
607 packet_write(1, "unshallow %s",
608 sha1_to_hex(object->sha1));
609 object->flags &= ~CLIENT_SHALLOW;
610 /* make sure the real parents are parsed */
611 unregister_shallow(object->sha1);
612 object->parsed = 0;
613 if (parse_commit((struct commit *)object))
614 die("invalid commit");
615 parents = ((struct commit *)object)->parents;
616 while (parents) {
617 add_object_array(&parents->item->object,
618 NULL, &want_obj);
619 parents = parents->next;
621 add_object_array(object, NULL, &extra_edge_obj);
623 /* make sure commit traversal conforms to client */
624 register_shallow(object->sha1);
626 packet_flush(1);
627 } else
628 if (shallows.nr > 0) {
629 int i;
630 for (i = 0; i < shallows.nr; i++)
631 register_shallow(shallows.objects[i].item->sha1);
634 shallow_nr += shallows.nr;
635 free(shallows.objects);
638 static int send_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
640 static const char *capabilities = "multi_ack thin-pack side-band"
641 " side-band-64k ofs-delta shallow no-progress"
642 " include-tag multi_ack_detailed";
643 struct object *o = parse_object(sha1);
645 if (!o)
646 die("git upload-pack: cannot find object %s:", sha1_to_hex(sha1));
648 if (capabilities)
649 packet_write(1, "%s %s%c%s%s\n", sha1_to_hex(sha1), refname,
650 0, capabilities,
651 stateless_rpc ? " no-done" : "");
652 else
653 packet_write(1, "%s %s\n", sha1_to_hex(sha1), refname);
654 capabilities = NULL;
655 if (!(o->flags & OUR_REF)) {
656 o->flags |= OUR_REF;
657 nr_our_refs++;
659 if (o->type == OBJ_TAG) {
660 o = deref_tag(o, refname, 0);
661 if (o)
662 packet_write(1, "%s %s^{}\n", sha1_to_hex(o->sha1), refname);
664 return 0;
667 static int mark_our_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
669 struct object *o = parse_object(sha1);
670 if (!o)
671 die("git upload-pack: cannot find object %s:", sha1_to_hex(sha1));
672 if (!(o->flags & OUR_REF)) {
673 o->flags |= OUR_REF;
674 nr_our_refs++;
676 return 0;
679 static void upload_pack(void)
681 if (advertise_refs || !stateless_rpc) {
682 reset_timeout();
683 head_ref(send_ref, NULL);
684 for_each_ref(send_ref, NULL);
685 packet_flush(1);
686 } else {
687 head_ref(mark_our_ref, NULL);
688 for_each_ref(mark_our_ref, NULL);
690 if (advertise_refs)
691 return;
693 receive_needs();
694 if (want_obj.nr) {
695 get_common_commits();
696 create_pack_file();
700 int main(int argc, char **argv)
702 char *dir;
703 int i;
704 int strict = 0;
706 packet_trace_identity("upload-pack");
707 git_extract_argv0_path(argv[0]);
708 read_replace_refs = 0;
710 for (i = 1; i < argc; i++) {
711 char *arg = argv[i];
713 if (arg[0] != '-')
714 break;
715 if (!strcmp(arg, "--advertise-refs")) {
716 advertise_refs = 1;
717 continue;
719 if (!strcmp(arg, "--stateless-rpc")) {
720 stateless_rpc = 1;
721 continue;
723 if (!strcmp(arg, "--strict")) {
724 strict = 1;
725 continue;
727 if (!prefixcmp(arg, "--timeout=")) {
728 timeout = atoi(arg+10);
729 daemon_mode = 1;
730 continue;
732 if (!strcmp(arg, "--")) {
733 i++;
734 break;
738 if (i != argc-1)
739 usage(upload_pack_usage);
741 setup_path();
743 dir = argv[i];
745 if (!enter_repo(dir, strict))
746 die("'%s' does not appear to be a git repository", dir);
747 if (is_repository_shallow())
748 die("attempt to fetch/clone from a shallow repository");
749 if (getenv("GIT_DEBUG_SEND_PACK"))
750 debug_fd = atoi(getenv("GIT_DEBUG_SEND_PACK"));
751 upload_pack();
752 return 0;