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