Documentation/notes: simplify treatment of default notes ref
[git/wpalmer.git] / upload-pack.c
blobdc464d78b35659705ffb0cd233b80ab27e24e8bc
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;
42 static int advertise_refs;
43 static int stateless_rpc;
45 static void reset_timeout(void)
47 alarm(timeout);
50 static int strip(char *line, int len)
52 if (len && line[len-1] == '\n')
53 line[--len] = 0;
54 return len;
57 static ssize_t send_client_data(int fd, const char *data, ssize_t sz)
59 if (use_sideband)
60 return send_sideband(1, fd, data, sz, use_sideband);
61 if (fd == 3)
62 /* emergency quit */
63 fd = 2;
64 if (fd == 2) {
65 /* XXX: are we happy to lose stuff here? */
66 xwrite(fd, data, sz);
67 return sz;
69 return safe_write(fd, data, sz);
72 static FILE *pack_pipe = NULL;
73 static void show_commit(struct commit *commit, void *data)
75 if (commit->object.flags & BOUNDARY)
76 fputc('-', pack_pipe);
77 if (fputs(sha1_to_hex(commit->object.sha1), pack_pipe) < 0)
78 die("broken output pipe");
79 fputc('\n', pack_pipe);
80 fflush(pack_pipe);
81 free(commit->buffer);
82 commit->buffer = NULL;
85 static void show_object(struct object *obj, const struct name_path *path, const char *component)
87 /* An object with name "foo\n0000000..." can be used to
88 * confuse downstream git-pack-objects very badly.
90 const char *name = path_name(path, component);
91 const char *ep = strchr(name, '\n');
92 if (ep) {
93 fprintf(pack_pipe, "%s %.*s\n", sha1_to_hex(obj->sha1),
94 (int) (ep - name),
95 name);
97 else
98 fprintf(pack_pipe, "%s %s\n",
99 sha1_to_hex(obj->sha1), name);
100 free((char *)name);
103 static void show_edge(struct commit *commit)
105 fprintf(pack_pipe, "-%s\n", sha1_to_hex(commit->object.sha1));
108 static int do_rev_list(int in, int out, void *create_full_pack)
110 int i;
111 struct rev_info revs;
113 pack_pipe = xfdopen(out, "w");
114 init_revisions(&revs, NULL);
115 revs.tag_objects = 1;
116 revs.tree_objects = 1;
117 revs.blob_objects = 1;
118 if (use_thin_pack)
119 revs.edge_hint = 1;
121 if (create_full_pack) {
122 const char *args[] = {"rev-list", "--all", NULL};
123 setup_revisions(2, args, &revs, NULL);
124 } else {
125 for (i = 0; i < want_obj.nr; i++) {
126 struct object *o = want_obj.objects[i].item;
127 /* why??? */
128 o->flags &= ~UNINTERESTING;
129 add_pending_object(&revs, o, NULL);
131 for (i = 0; i < have_obj.nr; i++) {
132 struct object *o = have_obj.objects[i].item;
133 o->flags |= UNINTERESTING;
134 add_pending_object(&revs, o, NULL);
136 setup_revisions(0, NULL, &revs, NULL);
138 if (prepare_revision_walk(&revs))
139 die("revision walk setup failed");
140 mark_edges_uninteresting(revs.commits, &revs, show_edge);
141 if (use_thin_pack)
142 for (i = 0; i < extra_edge_obj.nr; i++)
143 fprintf(pack_pipe, "-%s\n", sha1_to_hex(
144 extra_edge_obj.objects[i].item->sha1));
145 traverse_commit_list(&revs, show_commit, show_object, NULL);
146 fflush(pack_pipe);
147 fclose(pack_pipe);
148 return 0;
151 static void create_pack_file(void)
153 struct async rev_list;
154 struct child_process pack_objects;
155 int create_full_pack = (nr_our_refs == want_obj.nr && !have_obj.nr);
156 char data[8193], progress[128];
157 char abort_msg[] = "aborting due to possible repository "
158 "corruption on the remote side.";
159 int buffered = -1;
160 ssize_t sz;
161 const char *argv[10];
162 int arg = 0;
164 if (shallow_nr) {
165 memset(&rev_list, 0, sizeof(rev_list));
166 rev_list.proc = do_rev_list;
167 rev_list.out = -1;
168 if (start_async(&rev_list))
169 die("git upload-pack: unable to fork git-rev-list");
170 argv[arg++] = "pack-objects";
171 } else {
172 argv[arg++] = "pack-objects";
173 argv[arg++] = "--revs";
174 if (create_full_pack)
175 argv[arg++] = "--all";
176 else if (use_thin_pack)
177 argv[arg++] = "--thin";
180 argv[arg++] = "--stdout";
181 if (!no_progress)
182 argv[arg++] = "--progress";
183 if (use_ofs_delta)
184 argv[arg++] = "--delta-base-offset";
185 if (use_include_tag)
186 argv[arg++] = "--include-tag";
187 argv[arg++] = NULL;
189 memset(&pack_objects, 0, sizeof(pack_objects));
190 pack_objects.in = shallow_nr ? rev_list.out : -1;
191 pack_objects.out = -1;
192 pack_objects.err = -1;
193 pack_objects.git_cmd = 1;
194 pack_objects.argv = argv;
196 if (start_command(&pack_objects))
197 die("git upload-pack: unable to fork git-pack-objects");
199 /* pass on revisions we (don't) want */
200 if (!shallow_nr) {
201 FILE *pipe_fd = xfdopen(pack_objects.in, "w");
202 if (!create_full_pack) {
203 int i;
204 for (i = 0; i < want_obj.nr; i++)
205 fprintf(pipe_fd, "%s\n", sha1_to_hex(want_obj.objects[i].item->sha1));
206 fprintf(pipe_fd, "--not\n");
207 for (i = 0; i < have_obj.nr; i++)
208 fprintf(pipe_fd, "%s\n", sha1_to_hex(have_obj.objects[i].item->sha1));
211 fprintf(pipe_fd, "\n");
212 fflush(pipe_fd);
213 fclose(pipe_fd);
217 /* We read from pack_objects.err to capture stderr output for
218 * progress bar, and pack_objects.out to capture the pack data.
221 while (1) {
222 struct pollfd pfd[2];
223 int pe, pu, pollsize;
225 reset_timeout();
227 pollsize = 0;
228 pe = pu = -1;
230 if (0 <= pack_objects.out) {
231 pfd[pollsize].fd = pack_objects.out;
232 pfd[pollsize].events = POLLIN;
233 pu = pollsize;
234 pollsize++;
236 if (0 <= pack_objects.err) {
237 pfd[pollsize].fd = pack_objects.err;
238 pfd[pollsize].events = POLLIN;
239 pe = pollsize;
240 pollsize++;
243 if (!pollsize)
244 break;
246 if (poll(pfd, pollsize, -1) < 0) {
247 if (errno != EINTR) {
248 error("poll failed, resuming: %s",
249 strerror(errno));
250 sleep(1);
252 continue;
254 if (0 <= pe && (pfd[pe].revents & (POLLIN|POLLHUP))) {
255 /* Status ready; we ship that in the side-band
256 * or dump to the standard error.
258 sz = xread(pack_objects.err, progress,
259 sizeof(progress));
260 if (0 < sz)
261 send_client_data(2, progress, sz);
262 else if (sz == 0) {
263 close(pack_objects.err);
264 pack_objects.err = -1;
266 else
267 goto fail;
268 /* give priority to status messages */
269 continue;
271 if (0 <= pu && (pfd[pu].revents & (POLLIN|POLLHUP))) {
272 /* Data ready; we keep the last byte to ourselves
273 * in case we detect broken rev-list, so that we
274 * can leave the stream corrupted. This is
275 * unfortunate -- unpack-objects would happily
276 * accept a valid packdata with trailing garbage,
277 * so appending garbage after we pass all the
278 * pack data is not good enough to signal
279 * breakage to downstream.
281 char *cp = data;
282 ssize_t outsz = 0;
283 if (0 <= buffered) {
284 *cp++ = buffered;
285 outsz++;
287 sz = xread(pack_objects.out, cp,
288 sizeof(data) - outsz);
289 if (0 < sz)
291 else if (sz == 0) {
292 close(pack_objects.out);
293 pack_objects.out = -1;
295 else
296 goto fail;
297 sz += outsz;
298 if (1 < sz) {
299 buffered = data[sz-1] & 0xFF;
300 sz--;
302 else
303 buffered = -1;
304 sz = send_client_data(1, data, sz);
305 if (sz < 0)
306 goto fail;
310 if (finish_command(&pack_objects)) {
311 error("git upload-pack: git-pack-objects died with error.");
312 goto fail;
314 if (shallow_nr && finish_async(&rev_list))
315 goto fail; /* error was already reported */
317 /* flush the data */
318 if (0 <= buffered) {
319 data[0] = buffered;
320 sz = send_client_data(1, data, 1);
321 if (sz < 0)
322 goto fail;
323 fprintf(stderr, "flushed.\n");
325 if (use_sideband)
326 packet_flush(1);
327 return;
329 fail:
330 send_client_data(3, abort_msg, sizeof(abort_msg));
331 die("git upload-pack: %s", abort_msg);
334 static int got_sha1(char *hex, unsigned char *sha1)
336 struct object *o;
337 int we_knew_they_have = 0;
339 if (get_sha1_hex(hex, sha1))
340 die("git upload-pack: expected SHA1 object, got '%s'", hex);
341 if (!has_sha1_file(sha1))
342 return -1;
344 o = lookup_object(sha1);
345 if (!(o && o->parsed))
346 o = parse_object(sha1);
347 if (!o)
348 die("oops (%s)", sha1_to_hex(sha1));
349 if (o->type == OBJ_COMMIT) {
350 struct commit_list *parents;
351 struct commit *commit = (struct commit *)o;
352 if (o->flags & THEY_HAVE)
353 we_knew_they_have = 1;
354 else
355 o->flags |= THEY_HAVE;
356 if (!oldest_have || (commit->date < oldest_have))
357 oldest_have = commit->date;
358 for (parents = commit->parents;
359 parents;
360 parents = parents->next)
361 parents->item->object.flags |= THEY_HAVE;
363 if (!we_knew_they_have) {
364 add_object_array(o, NULL, &have_obj);
365 return 1;
367 return 0;
370 static int reachable(struct commit *want)
372 struct commit_list *work = NULL;
374 insert_by_date(want, &work);
375 while (work) {
376 struct commit_list *list = work->next;
377 struct commit *commit = work->item;
378 free(work);
379 work = list;
381 if (commit->object.flags & THEY_HAVE) {
382 want->object.flags |= COMMON_KNOWN;
383 break;
385 if (!commit->object.parsed)
386 parse_object(commit->object.sha1);
387 if (commit->object.flags & REACHABLE)
388 continue;
389 commit->object.flags |= REACHABLE;
390 if (commit->date < oldest_have)
391 continue;
392 for (list = commit->parents; list; list = list->next) {
393 struct commit *parent = list->item;
394 if (!(parent->object.flags & REACHABLE))
395 insert_by_date(parent, &work);
398 want->object.flags |= REACHABLE;
399 clear_commit_marks(want, REACHABLE);
400 free_commit_list(work);
401 return (want->object.flags & COMMON_KNOWN);
404 static int ok_to_give_up(void)
406 int i;
408 if (!have_obj.nr)
409 return 0;
411 for (i = 0; i < want_obj.nr; i++) {
412 struct object *want = want_obj.objects[i].item;
414 if (want->flags & COMMON_KNOWN)
415 continue;
416 want = deref_tag(want, "a want line", 0);
417 if (!want || want->type != OBJ_COMMIT) {
418 /* no way to tell if this is reachable by
419 * looking at the ancestry chain alone, so
420 * leave a note to ourselves not to worry about
421 * this object anymore.
423 want_obj.objects[i].item->flags |= COMMON_KNOWN;
424 continue;
426 if (!reachable((struct commit *)want))
427 return 0;
429 return 1;
432 static int get_common_commits(void)
434 static char line[1000];
435 unsigned char sha1[20];
436 char last_hex[41];
438 save_commit_buffer = 0;
440 for (;;) {
441 int len = packet_read_line(0, line, sizeof(line));
442 reset_timeout();
444 if (!len) {
445 if (have_obj.nr == 0 || multi_ack)
446 packet_write(1, "NAK\n");
447 if (stateless_rpc)
448 exit(0);
449 continue;
451 strip(line, len);
452 if (!prefixcmp(line, "have ")) {
453 switch (got_sha1(line+5, sha1)) {
454 case -1: /* they have what we do not */
455 if (multi_ack && ok_to_give_up()) {
456 const char *hex = sha1_to_hex(sha1);
457 if (multi_ack == 2)
458 packet_write(1, "ACK %s ready\n", hex);
459 else
460 packet_write(1, "ACK %s continue\n", hex);
462 break;
463 default:
464 memcpy(last_hex, sha1_to_hex(sha1), 41);
465 if (multi_ack == 2)
466 packet_write(1, "ACK %s common\n", last_hex);
467 else if (multi_ack)
468 packet_write(1, "ACK %s continue\n", last_hex);
469 else if (have_obj.nr == 1)
470 packet_write(1, "ACK %s\n", last_hex);
471 break;
473 continue;
475 if (!strcmp(line, "done")) {
476 if (have_obj.nr > 0) {
477 if (multi_ack)
478 packet_write(1, "ACK %s\n", last_hex);
479 return 0;
481 packet_write(1, "NAK\n");
482 return -1;
484 die("git upload-pack: expected SHA1 list, got '%s'", line);
488 static void receive_needs(void)
490 struct object_array shallows = {0, 0, NULL};
491 static char line[1000];
492 int len, depth = 0;
494 shallow_nr = 0;
495 if (debug_fd)
496 write_str_in_full(debug_fd, "#S\n");
497 for (;;) {
498 struct object *o;
499 unsigned char sha1_buf[20];
500 len = packet_read_line(0, line, sizeof(line));
501 reset_timeout();
502 if (!len)
503 break;
504 if (debug_fd)
505 write_in_full(debug_fd, line, len);
507 if (!prefixcmp(line, "shallow ")) {
508 unsigned char sha1[20];
509 struct object *object;
510 if (get_sha1(line + 8, sha1))
511 die("invalid shallow line: %s", line);
512 object = parse_object(sha1);
513 if (!object)
514 die("did not find object for %s", line);
515 object->flags |= CLIENT_SHALLOW;
516 add_object_array(object, NULL, &shallows);
517 continue;
519 if (!prefixcmp(line, "deepen ")) {
520 char *end;
521 depth = strtol(line + 7, &end, 0);
522 if (end == line + 7 || depth <= 0)
523 die("Invalid deepen: %s", line);
524 continue;
526 if (prefixcmp(line, "want ") ||
527 get_sha1_hex(line+5, sha1_buf))
528 die("git upload-pack: protocol error, "
529 "expected to get sha, not '%s'", line);
530 if (strstr(line+45, "multi_ack_detailed"))
531 multi_ack = 2;
532 else if (strstr(line+45, "multi_ack"))
533 multi_ack = 1;
534 if (strstr(line+45, "thin-pack"))
535 use_thin_pack = 1;
536 if (strstr(line+45, "ofs-delta"))
537 use_ofs_delta = 1;
538 if (strstr(line+45, "side-band-64k"))
539 use_sideband = LARGE_PACKET_MAX;
540 else if (strstr(line+45, "side-band"))
541 use_sideband = DEFAULT_PACKET_MAX;
542 if (strstr(line+45, "no-progress"))
543 no_progress = 1;
544 if (strstr(line+45, "include-tag"))
545 use_include_tag = 1;
547 /* We have sent all our refs already, and the other end
548 * should have chosen out of them; otherwise they are
549 * asking for nonsense.
551 * Hmph. We may later want to allow "want" line that
552 * asks for something like "master~10" (symbolic)...
553 * would it make sense? I don't know.
555 o = lookup_object(sha1_buf);
556 if (!o || !(o->flags & OUR_REF))
557 die("git upload-pack: not our ref %s", line+5);
558 if (!(o->flags & WANTED)) {
559 o->flags |= WANTED;
560 add_object_array(o, NULL, &want_obj);
563 if (debug_fd)
564 write_str_in_full(debug_fd, "#E\n");
566 if (!use_sideband && daemon_mode)
567 no_progress = 1;
569 if (depth == 0 && shallows.nr == 0)
570 return;
571 if (depth > 0) {
572 struct commit_list *result, *backup;
573 int i;
574 backup = result = get_shallow_commits(&want_obj, depth,
575 SHALLOW, NOT_SHALLOW);
576 while (result) {
577 struct object *object = &result->item->object;
578 if (!(object->flags & (CLIENT_SHALLOW|NOT_SHALLOW))) {
579 packet_write(1, "shallow %s",
580 sha1_to_hex(object->sha1));
581 register_shallow(object->sha1);
582 shallow_nr++;
584 result = result->next;
586 free_commit_list(backup);
587 for (i = 0; i < shallows.nr; i++) {
588 struct object *object = shallows.objects[i].item;
589 if (object->flags & NOT_SHALLOW) {
590 struct commit_list *parents;
591 packet_write(1, "unshallow %s",
592 sha1_to_hex(object->sha1));
593 object->flags &= ~CLIENT_SHALLOW;
594 /* make sure the real parents are parsed */
595 unregister_shallow(object->sha1);
596 object->parsed = 0;
597 if (parse_commit((struct commit *)object))
598 die("invalid commit");
599 parents = ((struct commit *)object)->parents;
600 while (parents) {
601 add_object_array(&parents->item->object,
602 NULL, &want_obj);
603 parents = parents->next;
605 add_object_array(object, NULL, &extra_edge_obj);
607 /* make sure commit traversal conforms to client */
608 register_shallow(object->sha1);
610 packet_flush(1);
611 } else
612 if (shallows.nr > 0) {
613 int i;
614 for (i = 0; i < shallows.nr; i++)
615 register_shallow(shallows.objects[i].item->sha1);
618 shallow_nr += shallows.nr;
619 free(shallows.objects);
622 static int send_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
624 static const char *capabilities = "multi_ack thin-pack side-band"
625 " side-band-64k ofs-delta shallow no-progress"
626 " include-tag multi_ack_detailed";
627 struct object *o = parse_object(sha1);
629 if (!o)
630 die("git upload-pack: cannot find object %s:", sha1_to_hex(sha1));
632 if (capabilities)
633 packet_write(1, "%s %s%c%s\n", sha1_to_hex(sha1), refname,
634 0, capabilities);
635 else
636 packet_write(1, "%s %s\n", sha1_to_hex(sha1), refname);
637 capabilities = NULL;
638 if (!(o->flags & OUR_REF)) {
639 o->flags |= OUR_REF;
640 nr_our_refs++;
642 if (o->type == OBJ_TAG) {
643 o = deref_tag(o, refname, 0);
644 if (o)
645 packet_write(1, "%s %s^{}\n", sha1_to_hex(o->sha1), refname);
647 return 0;
650 static int mark_our_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
652 struct object *o = parse_object(sha1);
653 if (!o)
654 die("git upload-pack: cannot find object %s:", sha1_to_hex(sha1));
655 if (!(o->flags & OUR_REF)) {
656 o->flags |= OUR_REF;
657 nr_our_refs++;
659 return 0;
662 static void upload_pack(void)
664 if (advertise_refs || !stateless_rpc) {
665 reset_timeout();
666 head_ref(send_ref, NULL);
667 for_each_ref(send_ref, NULL);
668 packet_flush(1);
669 } else {
670 head_ref(mark_our_ref, NULL);
671 for_each_ref(mark_our_ref, NULL);
673 if (advertise_refs)
674 return;
676 receive_needs();
677 if (want_obj.nr) {
678 get_common_commits();
679 create_pack_file();
683 int main(int argc, char **argv)
685 char *dir;
686 int i;
687 int strict = 0;
689 git_extract_argv0_path(argv[0]);
690 read_replace_refs = 0;
692 for (i = 1; i < argc; i++) {
693 char *arg = argv[i];
695 if (arg[0] != '-')
696 break;
697 if (!strcmp(arg, "--advertise-refs")) {
698 advertise_refs = 1;
699 continue;
701 if (!strcmp(arg, "--stateless-rpc")) {
702 stateless_rpc = 1;
703 continue;
705 if (!strcmp(arg, "--strict")) {
706 strict = 1;
707 continue;
709 if (!prefixcmp(arg, "--timeout=")) {
710 timeout = atoi(arg+10);
711 daemon_mode = 1;
712 continue;
714 if (!strcmp(arg, "--")) {
715 i++;
716 break;
720 if (i != argc-1)
721 usage(upload_pack_usage);
723 setup_path();
725 dir = argv[i];
727 if (!enter_repo(dir, strict))
728 die("'%s' does not appear to be a git repository", dir);
729 if (is_repository_shallow())
730 die("attempt to fetch/clone from a shallow repository");
731 if (getenv("GIT_DEBUG_SEND_PACK"))
732 debug_fd = atoi(getenv("GIT_DEBUG_SEND_PACK"));
733 upload_pack();
734 return 0;