Merge branch 'jc/how-to-document-api'
[git] / connected.c
1 #include "cache.h"
2 #include "run-command.h"
3 #include "sigchain.h"
4 #include "connected.h"
5 #include "transport.h"
6 #include "packfile.h"
7
8 /*
9  * If we feed all the commits we want to verify to this command
10  *
11  *  $ git rev-list --objects --stdin --not --all
12  *
13  * and if it does not error out, that means everything reachable from
14  * these commits locally exists and is connected to our existing refs.
15  * Note that this does _not_ validate the individual objects.
16  *
17  * Returns 0 if everything is connected, non-zero otherwise.
18  */
19 int check_connected(oid_iterate_fn fn, void *cb_data,
20                     struct check_connected_options *opt)
21 {
22         struct child_process rev_list = CHILD_PROCESS_INIT;
23         struct check_connected_options defaults = CHECK_CONNECTED_INIT;
24         char commit[GIT_MAX_HEXSZ + 1];
25         struct object_id oid;
26         int err = 0;
27         struct packed_git *new_pack = NULL;
28         struct transport *transport;
29         size_t base_len;
30
31         if (!opt)
32                 opt = &defaults;
33         transport = opt->transport;
34
35         if (fn(cb_data, &oid)) {
36                 if (opt->err_fd)
37                         close(opt->err_fd);
38                 return err;
39         }
40
41         if (transport && transport->smart_options &&
42             transport->smart_options->self_contained_and_connected &&
43             transport->pack_lockfile &&
44             strip_suffix(transport->pack_lockfile, ".keep", &base_len)) {
45                 struct strbuf idx_file = STRBUF_INIT;
46                 strbuf_add(&idx_file, transport->pack_lockfile, base_len);
47                 strbuf_addstr(&idx_file, ".idx");
48                 new_pack = add_packed_git(idx_file.buf, idx_file.len, 1);
49                 strbuf_release(&idx_file);
50         }
51
52         if (opt->shallow_file) {
53                 argv_array_push(&rev_list.args, "--shallow-file");
54                 argv_array_push(&rev_list.args, opt->shallow_file);
55         }
56         argv_array_push(&rev_list.args,"rev-list");
57         argv_array_push(&rev_list.args, "--objects");
58         argv_array_push(&rev_list.args, "--stdin");
59         if (repository_format_partial_clone)
60                 argv_array_push(&rev_list.args, "--exclude-promisor-objects");
61         if (!opt->is_deepening_fetch) {
62                 argv_array_push(&rev_list.args, "--not");
63                 argv_array_push(&rev_list.args, "--all");
64         }
65         argv_array_push(&rev_list.args, "--quiet");
66         if (opt->progress)
67                 argv_array_pushf(&rev_list.args, "--progress=%s",
68                                  _("Checking connectivity"));
69
70         rev_list.git_cmd = 1;
71         rev_list.env = opt->env;
72         rev_list.in = -1;
73         rev_list.no_stdout = 1;
74         if (opt->err_fd)
75                 rev_list.err = opt->err_fd;
76         else
77                 rev_list.no_stderr = opt->quiet;
78
79         if (start_command(&rev_list))
80                 return error(_("Could not run 'git rev-list'"));
81
82         sigchain_push(SIGPIPE, SIG_IGN);
83
84         commit[GIT_SHA1_HEXSZ] = '\n';
85         do {
86                 /*
87                  * If index-pack already checked that:
88                  * - there are no dangling pointers in the new pack
89                  * - the pack is self contained
90                  * Then if the updated ref is in the new pack, then we
91                  * are sure the ref is good and not sending it to
92                  * rev-list for verification.
93                  */
94                 if (new_pack && find_pack_entry_one(oid.hash, new_pack))
95                         continue;
96
97                 memcpy(commit, oid_to_hex(&oid), GIT_SHA1_HEXSZ);
98                 if (write_in_full(rev_list.in, commit, GIT_SHA1_HEXSZ + 1) < 0) {
99                         if (errno != EPIPE && errno != EINVAL)
100                                 error_errno(_("failed write to rev-list"));
101                         err = -1;
102                         break;
103                 }
104         } while (!fn(cb_data, &oid));
105
106         if (close(rev_list.in))
107                 err = error_errno(_("failed to close rev-list's stdin"));
108
109         sigchain_pop(SIGPIPE);
110         return finish_command(&rev_list) || err;
111 }