upload-pack: add object filtering for partial clone
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
47a59185 5#include "run-command.h"
9b288516
DB
6#include "remote.h"
7
a45a2600
NTND
8struct string_list;
9
aa5af974
IL
10struct git_transport_options {
11 unsigned thin : 1;
12 unsigned keep : 1;
13 unsigned followtags : 1;
c6807a40
NTND
14 unsigned check_self_contained_and_connected : 1;
15 unsigned self_contained_and_connected : 1;
48d25cae 16 unsigned update_shallow : 1;
cccf74e2 17 unsigned deepen_relative : 1;
88e2f9ed
JT
18 unsigned from_promisor : 1;
19 unsigned no_dependents : 1;
aa5af974 20 int depth;
508ea882 21 const char *deepen_since;
a45a2600 22 const struct string_list *deepen_not;
aa5af974
IL
23 const char *uploadpack;
24 const char *receivepack;
91048a95 25 struct push_cas_option *cas;
aa5af974
IL
26};
27
c915f11e
EW
28enum transport_family {
29 TRANSPORT_FAMILY_ALL = 0,
30 TRANSPORT_FAMILY_IPV4,
31 TRANSPORT_FAMILY_IPV6
32};
33
9b288516 34struct transport {
9b288516
DB
35 struct remote *remote;
36 const char *url;
9b288516 37 void *data;
4577370e 38 const struct ref *remote_refs;
9b288516 39
b0d66e15
TRC
40 /**
41 * Indicates whether we already called get_refs_list(); set by
42 * transport.c::transport_get_remote_refs().
43 */
44 unsigned got_remote_refs : 1;
45
b26ed430
JH
46 /*
47 * Transports that call take-over destroys the data specific to
48 * the transport type while doing so, and cannot be reused.
49 */
50 unsigned cannot_reuse : 1;
51
beea4152
NTND
52 /*
53 * A hint from caller that it will be performing a clone, not
54 * normal fetch. IOW the repository is guaranteed empty.
55 */
56 unsigned cloning : 1;
57
f6a4e61f
SB
58 /*
59 * These strings will be passed to the {pre, post}-receive hook,
60 * on the remote side, if both sides support the push options capability.
61 */
62 const struct string_list *push_options;
63
9b288516
DB
64 /**
65 * Returns 0 if successful, positive if the option is not
66 * recognized or is inapplicable, and negative if the option
67 * is applicable but the value is invalid.
68 **/
69 int (*set_option)(struct transport *connection, const char *name,
70 const char *value);
71
37148311
DB
72 /**
73 * Returns a list of the remote side's refs. In order to allow
74 * the transport to try to share connections, for_push is a
75 * hint as to whether the ultimate operation is a push or a fetch.
76 *
77 * If the transport is able to determine the remote hash for
78 * the ref without a huge amount of effort, it should store it
79 * in the ref's old_sha1 field; otherwise it should be all 0.
80 **/
64fcef2d 81 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
82
83 /**
84 * Fetch the objects for the given refs. Note that this gets
85 * an array, and should ignore the list structure.
86 *
87 * If the transport did not get hashes for refs in
88 * get_refs_list(), it should set the old_sha1 fields in the
89 * provided refs now.
90 **/
91 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
92
93 /**
94 * Push the objects and refs. Send the necessary objects, and
95 * then, for any refs where peer_ref is set and
f4e54d02 96 * peer_ref->new_oid is different from old_oid, tell the
97 * remote side to update each ref in the list from old_oid to
98 * peer_ref->new_oid.
37148311
DB
99 *
100 * Where possible, set the status for each ref appropriately.
101 *
102 * The transport must modify new_sha1 in the ref to the new
103 * value if the remote accepted the change. Note that this
f4e54d02 104 * could be a different value from peer_ref->new_oid if the
37148311
DB
105 * process involved generating new commits.
106 **/
64fcef2d 107 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 108 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
109 int (*connect)(struct transport *connection, const char *name,
110 const char *executable, int fd[2]);
9b288516 111
37148311 112 /** get_refs_list(), fetch(), and push_refs() can keep
41ccfdd9 113 * resources (such as a connection) reserved for further
37148311
DB
114 * use. disconnect() releases these resources.
115 **/
9b288516 116 int (*disconnect)(struct transport *connection);
824d5776 117 char *pack_lockfile;
cff7123c 118 signed verbose : 3;
d01b3c02
TRC
119 /**
120 * Transports should not set this directly, and should use this
121 * value without having to check isatty(2), -q/--quiet
122 * (transport->verbose < 0), etc. - checking has already been done
123 * in transport_set_verbosity().
124 **/
21188b1e 125 unsigned progress : 1;
aa5af974
IL
126 /*
127 * If transport is at least potentially smart, this points to
128 * git_transport_options structure to use in case transport
129 * actually turns out to be smart.
130 */
131 struct git_transport_options *smart_options;
c915f11e
EW
132
133 enum transport_family family;
9b288516
DB
134};
135
14c01bdb
BW
136#define TRANSPORT_PUSH_ALL (1<<0)
137#define TRANSPORT_PUSH_FORCE (1<<1)
138#define TRANSPORT_PUSH_DRY_RUN (1<<2)
139#define TRANSPORT_PUSH_MIRROR (1<<3)
140#define TRANSPORT_PUSH_PORCELAIN (1<<4)
141#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
142#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
143#define TRANSPORT_PUSH_PRUNE (1<<7)
144#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
145#define TRANSPORT_PUSH_NO_HOOK (1<<9)
146#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
147#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
148#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
149#define TRANSPORT_PUSH_ATOMIC (1<<13)
150#define TRANSPORT_PUSH_OPTIONS (1<<14)
225e8bf7 151#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
824d5776 152
11fd66de 153extern int transport_summary_width(const struct ref *refs);
824d5776 154
9b288516 155/* Returns a transport suitable for the url */
e5f4e214 156struct transport *transport_get(struct remote *, const char *);
9b288516 157
5088d3b3 158/*
a768a022
BW
159 * Check whether a transport is allowed by the environment.
160 *
161 * Type should generally be the URL scheme, as described in
162 * Documentation/git.txt
163 *
164 * from_user specifies if the transport was given by the user. If unknown pass
165 * a -1 to read from the environment to determine if the transport was given by
166 * the user.
167 *
5088d3b3 168 */
a768a022 169int is_transport_allowed(const char *type, int from_user);
5088d3b3 170
a5adaced
JK
171/*
172 * Check whether a transport is allowed by the environment,
5088d3b3 173 * and die otherwise.
a5adaced
JK
174 */
175void transport_check_allowed(const char *type);
176
9b288516
DB
177/* Transport options which apply to git:// and scp-style URLs */
178
c29727d5
DB
179/* The program to use on the remote side to send a pack */
180#define TRANS_OPT_UPLOADPACK "uploadpack"
181
9b288516
DB
182/* The program to use on the remote side to receive a pack */
183#define TRANS_OPT_RECEIVEPACK "receivepack"
184
185/* Transfer the data as a thin pack if not null */
186#define TRANS_OPT_THIN "thin"
187
91048a95
JH
188/* Check the current value of the remote ref */
189#define TRANS_OPT_CAS "cas"
190
c29727d5
DB
191/* Keep the pack that was transferred if not null */
192#define TRANS_OPT_KEEP "keep"
193
c29727d5
DB
194/* Limit the depth of the fetch if not null */
195#define TRANS_OPT_DEPTH "depth"
196
508ea882
NTND
197/* Limit the depth of the fetch based on time if not null */
198#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
199
a45a2600
NTND
200/* Limit the depth of the fetch based on revs if not null */
201#define TRANS_OPT_DEEPEN_NOT "deepen-not"
202
cccf74e2
NTND
203/* Limit the deepen of the fetch if not null */
204#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
205
41fa7d2e
SP
206/* Aggressively fetch annotated tags if possible */
207#define TRANS_OPT_FOLLOWTAGS "followtags"
208
48d25cae
NTND
209/* Accept refs that may update .git/shallow without --depth */
210#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
211
a85b377d
JH
212/* Send push certificates */
213#define TRANS_OPT_PUSH_CERT "pushcert"
214
88e2f9ed
JT
215/* Indicate that these objects are being fetched by a promisor */
216#define TRANS_OPT_FROM_PROMISOR "from-promisor"
217
218/*
219 * Indicate that only the objects wanted need to be fetched, not their
220 * dependents
221 */
222#define TRANS_OPT_NO_DEPENDENTS "no-dependents"
223
9b288516
DB
224/**
225 * Returns 0 if the option was used, non-zero otherwise. Prints a
226 * message to stderr if the option is not used.
227 **/
228int transport_set_option(struct transport *transport, const char *name,
229 const char *value);
d01b3c02
TRC
230void transport_set_verbosity(struct transport *transport, int verbosity,
231 int force_progress);
9b288516 232
10643d4e
CR
233#define REJECT_NON_FF_HEAD 0x01
234#define REJECT_NON_FF_OTHER 0x02
b24e6047 235#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
236#define REJECT_FETCH_FIRST 0x08
237#define REJECT_NEEDS_FORCE 0x10
10643d4e 238
9b288516 239int transport_push(struct transport *connection,
07436e43 240 int refspec_nr, const char **refspec, int flags,
10643d4e 241 unsigned int * reject_reasons);
9b288516 242
4577370e 243const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 244
37148311 245int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 246void transport_unlock_pack(struct transport *transport);
9b288516 247int transport_disconnect(struct transport *transport);
47abd85b 248char *transport_anonymize_url(const char *url);
61b075bd
IL
249void transport_take_over(struct transport *transport,
250 struct child_process *child);
9b288516 251
b236752a
IL
252int transport_connect(struct transport *transport, const char *name,
253 const char *exec, int fd[2]);
254
6eb996b5 255/* Transport methods defined outside transport.c */
c9e388bb 256int transport_helper_init(struct transport *transport, const char *name);
419f37db 257int bidirectional_transfer_loop(int input, int output);
6eb996b5 258
09b7e220 259/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
260void transport_verify_remote_names(int nr_heads, const char **heads);
261
262void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
263
264int transport_refs_pushed(struct ref *ref);
265
266void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 267 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 268
2429d63a 269typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
114a6a88 270extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 271#endif