blob: 6393cd9823c01f878000ded305cf621b2b526824 [file] [log] [blame]
Daniel Barkalow9b288512007-09-10 23:03:04 -04001#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
Junio C Hamano47a59182013-07-08 13:56:53 -07004#include "run-command.h"
Daniel Barkalow9b288512007-09-10 23:03:04 -04005#include "remote.h"
Jeff Hostetler640d8b72017-12-08 15:58:40 +00006#include "list-objects-filter-options.h"
Jonathan Tan9da69a62020-06-10 13:57:22 -07007#include "string-list.h"
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +07008
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +02009struct git_transport_options {
10 unsigned thin : 1;
11 unsigned keep : 1;
12 unsigned followtags : 1;
Nguyễn Thái Ngọc Duyc6807a42013-05-26 08:16:17 +070013 unsigned check_self_contained_and_connected : 1;
14 unsigned self_contained_and_connected : 1;
Nguyễn Thái Ngọc Duy48d25ca2013-12-05 20:02:42 +070015 unsigned update_shallow : 1;
Li Linchao4fe788b2021-04-01 10:46:59 +000016 unsigned reject_shallow : 1;
Nguyễn Thái Ngọc Duycccf74e2016-06-12 17:54:09 +070017 unsigned deepen_relative : 1;
Robert Coup3c7bab02022-03-28 14:02:08 +000018 unsigned refetch : 1;
Jonathan Tan42d418d2020-08-17 12:48:18 -070019
20 /* see documentation of corresponding flag in fetch-pack.h */
Jonathan Tan88e2f9e2017-12-05 16:58:49 +000021 unsigned from_promisor : 1;
Jonathan Tan42d418d2020-08-17 12:48:18 -070022
Jonathan Tancf1e7c02018-07-02 15:08:43 -070023 /*
24 * If this transport supports connect or stateless-connect,
25 * the corresponding field in struct fetch_pack_args is copied
26 * here after fetching.
27 *
28 * See the definition of connectivity_checked in struct
29 * fetch_pack_args for more information.
30 */
31 unsigned connectivity_checked:1;
32
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020033 int depth;
Nguyễn Thái Ngọc Duy508ea882016-06-12 17:53:59 +070034 const char *deepen_since;
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +070035 const struct string_list *deepen_not;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020036 const char *uploadpack;
37 const char *receivepack;
Junio C Hamano91048a92013-07-09 11:01:06 -070038 struct push_cas_option *cas;
Jeff Hostetler640d8b72017-12-08 15:58:40 +000039 struct list_objects_filter_options filter_options;
Jonathan Tan3390e422018-07-02 15:39:44 -070040
41 /*
42 * This is only used during fetch. See the documentation of
43 * negotiation_tips in struct fetch_pack_args.
44 *
45 * This field is only supported by transports that support connect or
46 * stateless_connect. Set this field directly instead of using
47 * transport_set_option().
48 */
49 struct oid_array *negotiation_tips;
Jonathan Tan9c1e6572021-05-04 14:16:01 -070050
51 /*
52 * If allocated, whenever transport_fetch_refs() is called, add known
53 * common commits to this oidset instead of fetching any packfiles.
54 */
55 struct oidset *acked_commits;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020056};
57
Eric Wongc915f112016-02-03 04:09:14 +000058enum transport_family {
59 TRANSPORT_FAMILY_ALL = 0,
60 TRANSPORT_FAMILY_IPV4,
61 TRANSPORT_FAMILY_IPV6
62};
63
Ævar Arnfjörð Bjarmason0cfde742022-12-22 15:14:09 +000064struct bundle_list;
Daniel Barkalow9b288512007-09-10 23:03:04 -040065struct transport {
Jonathan Tane967ca32017-12-14 13:44:45 -080066 const struct transport_vtable *vtable;
67
Daniel Barkalow9b288512007-09-10 23:03:04 -040068 struct remote *remote;
69 const char *url;
Daniel Barkalow9b288512007-09-10 23:03:04 -040070 void *data;
Daniel Barkalow45773702007-10-29 21:05:40 -040071 const struct ref *remote_refs;
Daniel Barkalow9b288512007-09-10 23:03:04 -040072
Daniel Barkalow9b288512007-09-10 23:03:04 -040073 /**
Tay Ray Chuanb0d66e12010-02-16 15:18:21 +080074 * Indicates whether we already called get_refs_list(); set by
75 * transport.c::transport_get_remote_refs().
76 */
77 unsigned got_remote_refs : 1;
78
Ævar Arnfjörð Bjarmason0cfde742022-12-22 15:14:09 +000079 /**
80 * Indicates whether we already called get_bundle_uri_list(); set by
81 * transport.c::transport_get_remote_bundle_uri().
82 */
83 unsigned got_remote_bundle_uri : 1;
84
85 /*
86 * The results of "command=bundle-uri", if both sides support
87 * the "bundle-uri" capability.
88 */
89 struct bundle_list *bundles;
90
Junio C Hamanob26ed432013-08-07 15:47:18 -070091 /*
92 * Transports that call take-over destroys the data specific to
93 * the transport type while doing so, and cannot be reused.
94 */
95 unsigned cannot_reuse : 1;
96
Nguyễn Thái Ngọc Duybeea4152013-12-05 20:02:39 +070097 /*
98 * A hint from caller that it will be performing a clone, not
99 * normal fetch. IOW the repository is guaranteed empty.
100 */
101 unsigned cloning : 1;
102
Stefan Bellerf6a4e612016-07-14 14:49:47 -0700103 /*
Brandon Williamsedc9caf2018-03-15 10:31:34 -0700104 * Indicates that the transport is connected via a half-duplex
105 * connection and should operate in stateless-rpc mode.
106 */
107 unsigned stateless_rpc : 1;
108
109 /*
Stefan Bellerf6a4e612016-07-14 14:49:47 -0700110 * These strings will be passed to the {pre, post}-receive hook,
111 * on the remote side, if both sides support the push options capability.
112 */
113 const struct string_list *push_options;
114
Brandon Williamsff473222018-04-23 15:46:23 -0700115 /*
116 * These strings will be passed to the remote side on each command
117 * request, if both sides support the server-option capability.
118 */
119 const struct string_list *server_options;
120
Jonathan Tan9da69a62020-06-10 13:57:22 -0700121 struct string_list pack_lockfiles;
122
Shawn O. Pearcecff71232009-10-30 17:47:27 -0700123 signed verbose : 3;
Tay Ray Chuand01b3c02010-02-24 20:50:26 +0800124 /**
125 * Transports should not set this directly, and should use this
126 * value without having to check isatty(2), -q/--quiet
127 * (transport->verbose < 0), etc. - checking has already been done
128 * in transport_set_verbosity().
129 **/
Miklos Vajna21188b12008-10-09 01:40:32 +0200130 unsigned progress : 1;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +0200131 /*
132 * If transport is at least potentially smart, this points to
133 * git_transport_options structure to use in case transport
134 * actually turns out to be smart.
135 */
136 struct git_transport_options *smart_options;
Eric Wongc915f112016-02-03 04:09:14 +0000137
138 enum transport_family family;
brian m. carlson7c97af42020-05-25 19:58:55 +0000139
140 const struct git_hash_algo *hash_algo;
Daniel Barkalow9b288512007-09-10 23:03:04 -0400141};
142
Brandon Williams14c01bd2016-12-19 10:25:31 -0800143#define TRANSPORT_PUSH_ALL (1<<0)
144#define TRANSPORT_PUSH_FORCE (1<<1)
145#define TRANSPORT_PUSH_DRY_RUN (1<<2)
146#define TRANSPORT_PUSH_MIRROR (1<<3)
147#define TRANSPORT_PUSH_PORCELAIN (1<<4)
148#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
149#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
150#define TRANSPORT_PUSH_PRUNE (1<<7)
151#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
152#define TRANSPORT_PUSH_NO_HOOK (1<<9)
153#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
154#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
155#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
156#define TRANSPORT_PUSH_ATOMIC (1<<13)
157#define TRANSPORT_PUSH_OPTIONS (1<<14)
Brandon Williams225e8bf2016-12-19 10:25:33 -0800158#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
Srinidhi Kaushik3b990aa2020-10-03 17:40:45 +0530159#define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16)
Tao Klerks05d57752022-04-29 09:56:46 +0000160#define TRANSPORT_PUSH_AUTO_UPSTREAM (1<<17)
Shawn O. Pearce824d5772007-09-19 00:49:31 -0400161
Denton Liu55454422019-04-29 04:28:14 -0400162int transport_summary_width(const struct ref *refs);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400163
164/* Returns a transport suitable for the url */
165struct transport *transport_get(struct remote *, const char *);
166
Jeff Kinga5adace2015-09-16 13:12:52 -0400167/*
Brandon Williamsa768a022016-12-14 14:39:54 -0800168 * Check whether a transport is allowed by the environment.
169 *
170 * Type should generally be the URL scheme, as described in
171 * Documentation/git.txt
172 *
173 * from_user specifies if the transport was given by the user. If unknown pass
174 * a -1 to read from the environment to determine if the transport was given by
175 * the user.
176 *
Jeff King5088d3b2015-09-22 18:03:49 -0400177 */
Brandon Williamsa768a022016-12-14 14:39:54 -0800178int is_transport_allowed(const char *type, int from_user);
Jeff King5088d3b2015-09-22 18:03:49 -0400179
180/*
Jeff Kinga5adace2015-09-16 13:12:52 -0400181 * Check whether a transport is allowed by the environment,
Jeff King5088d3b2015-09-22 18:03:49 -0400182 * and die otherwise.
Jeff Kinga5adace2015-09-16 13:12:52 -0400183 */
184void transport_check_allowed(const char *type);
185
Daniel Barkalow9b288512007-09-10 23:03:04 -0400186/* Transport options which apply to git:// and scp-style URLs */
187
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400188/* The program to use on the remote side to send a pack */
189#define TRANS_OPT_UPLOADPACK "uploadpack"
190
Daniel Barkalow9b288512007-09-10 23:03:04 -0400191/* The program to use on the remote side to receive a pack */
192#define TRANS_OPT_RECEIVEPACK "receivepack"
193
194/* Transfer the data as a thin pack if not null */
195#define TRANS_OPT_THIN "thin"
196
Junio C Hamano91048a92013-07-09 11:01:06 -0700197/* Check the current value of the remote ref */
198#define TRANS_OPT_CAS "cas"
199
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400200/* Keep the pack that was transferred if not null */
201#define TRANS_OPT_KEEP "keep"
202
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400203/* Limit the depth of the fetch if not null */
204#define TRANS_OPT_DEPTH "depth"
205
Nguyễn Thái Ngọc Duy508ea882016-06-12 17:53:59 +0700206/* Limit the depth of the fetch based on time if not null */
207#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
208
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +0700209/* Limit the depth of the fetch based on revs if not null */
210#define TRANS_OPT_DEEPEN_NOT "deepen-not"
211
Nguyễn Thái Ngọc Duycccf74e2016-06-12 17:54:09 +0700212/* Limit the deepen of the fetch if not null */
213#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
214
Shawn O. Pearce41fa7d22008-03-03 22:27:40 -0500215/* Aggressively fetch annotated tags if possible */
216#define TRANS_OPT_FOLLOWTAGS "followtags"
217
Li Linchao4fe788b2021-04-01 10:46:59 +0000218/* Reject shallow repo transport */
219#define TRANS_OPT_REJECT_SHALLOW "rejectshallow"
220
Nguyễn Thái Ngọc Duy48d25ca2013-12-05 20:02:42 +0700221/* Accept refs that may update .git/shallow without --depth */
222#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
223
Junio C Hamanoa85b3772014-09-12 11:17:07 -0700224/* Send push certificates */
225#define TRANS_OPT_PUSH_CERT "pushcert"
226
Jonathan Tan88e2f9e2017-12-05 16:58:49 +0000227/* Indicate that these objects are being fetched by a promisor */
228#define TRANS_OPT_FROM_PROMISOR "from-promisor"
229
Jeff Hostetler640d8b72017-12-08 15:58:40 +0000230/* Filter objects for partial clone and fetch */
231#define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
232
Robert Coup3c7bab02022-03-28 14:02:08 +0000233/* Refetch all objects without negotiating */
234#define TRANS_OPT_REFETCH "refetch"
235
brian m. carlson6f119422019-10-16 23:45:34 +0000236/* Request atomic (all-or-nothing) updates when pushing */
237#define TRANS_OPT_ATOMIC "atomic"
238
Srinidhi Kaushik3b990aa2020-10-03 17:40:45 +0530239/* Require remote changes to be integrated locally. */
240#define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes"
241
Daniel Barkalow9b288512007-09-10 23:03:04 -0400242/**
243 * Returns 0 if the option was used, non-zero otherwise. Prints a
244 * message to stderr if the option is not used.
245 **/
246int transport_set_option(struct transport *transport, const char *name,
247 const char *value);
Tay Ray Chuand01b3c02010-02-24 20:50:26 +0800248void transport_set_verbosity(struct transport *transport, int verbosity,
249 int force_progress);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400250
Srinidhi Kaushik3b990aa2020-10-03 17:40:45 +0530251#define REJECT_NON_FF_HEAD 0x01
252#define REJECT_NON_FF_OTHER 0x02
253#define REJECT_ALREADY_EXISTS 0x04
254#define REJECT_FETCH_FIRST 0x08
255#define REJECT_NEEDS_FORCE 0x10
256#define REJECT_REF_NEEDS_UPDATE 0x20
Chris Rorvick10643d42012-11-29 19:41:33 -0600257
Nguyễn Thái Ngọc Duy6c6d5d02018-11-10 06:48:55 +0100258int transport_push(struct repository *repo,
259 struct transport *connection,
Brandon Williams306f22d2018-05-16 15:58:17 -0700260 struct refspec *rs, int flags,
Chris Rorvick10643d42012-11-29 19:41:33 -0600261 unsigned int * reject_reasons);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400262
Jonathan Tan39835402021-02-05 12:48:48 -0800263struct transport_ls_refs_options {
264 /*
265 * Optionally, a list of ref prefixes can be provided which can be sent
266 * to the server (when communicating using protocol v2) to enable it to
267 * limit the ref advertisement. Since ref filtering is done on the
268 * server's end (and only when using protocol v2),
269 * transport_get_remote_refs() could return refs which don't match the
270 * provided ref_prefixes.
271 */
272 struct strvec ref_prefixes;
Jonathan Tan4f37d452021-02-05 12:48:49 -0800273
274 /*
275 * If unborn_head_target is not NULL, and the remote reports HEAD as
276 * pointing to an unborn branch, transport_get_remote_refs() stores the
Ævar Arnfjörð Bjarmasonf36d4f82022-02-05 01:08:14 +0100277 * unborn branch in unborn_head_target.
Jonathan Tan4f37d452021-02-05 12:48:49 -0800278 */
Ævar Arnfjörð Bjarmasonf36d4f82022-02-05 01:08:14 +0100279 const char *unborn_head_target;
Jonathan Tan39835402021-02-05 12:48:48 -0800280};
Ævar Arnfjörð Bjarmasonf69a6e42021-09-27 14:54:27 +0200281#define TRANSPORT_LS_REFS_OPTIONS_INIT { \
282 .ref_prefixes = STRVEC_INIT, \
283}
Jonathan Tan39835402021-02-05 12:48:48 -0800284
Ævar Arnfjörð Bjarmasonf36d4f82022-02-05 01:08:14 +0100285/**
286 * Release the "struct transport_ls_refs_options".
287 */
288void transport_ls_refs_options_release(struct transport_ls_refs_options *opts);
289
Brandon Williams1af8ae12018-03-15 10:31:23 -0700290/*
291 * Retrieve refs from a remote.
Brandon Williams1af8ae12018-03-15 10:31:23 -0700292 */
293const struct ref *transport_get_remote_refs(struct transport *transport,
Jonathan Tan39835402021-02-05 12:48:48 -0800294 struct transport_ls_refs_options *transport_options);
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400295
Ævar Arnfjörð Bjarmason0cfde742022-12-22 15:14:09 +0000296/**
297 * Retrieve bundle URI(s) from a remote. Populates "struct
298 * transport"'s "bundle_uri" and "got_remote_bundle_uri".
299 */
300int transport_get_remote_bundle_uri(struct transport *transport);
301
brian m. carlson7c97af42020-05-25 19:58:55 +0000302/*
303 * Fetch the hash algorithm used by a remote.
304 *
305 * This can only be called after fetching the remote refs.
306 */
307const struct git_hash_algo *transport_get_hash_algo(struct transport *transport);
Jonathan Tane2842b32018-08-01 13:13:20 -0700308int transport_fetch_refs(struct transport *transport, struct ref *refs);
Patrick Steinhardt58d4d7f2022-01-07 11:55:47 +0100309
310/*
311 * If this flag is set, unlocking will avoid to call non-async-signal-safe
312 * functions. This will necessarily leave behind some data structures which
313 * cannot be cleaned up.
314 */
315#define TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER (1 << 0)
316
317/*
318 * Unlock all packfiles locked by the transport.
319 */
320void transport_unlock_pack(struct transport *transport, unsigned int flags);
321
Daniel Barkalow9b288512007-09-10 23:03:04 -0400322int transport_disconnect(struct transport *transport);
Andreas Ericsson47abd852009-04-17 10:20:11 +0200323char *transport_anonymize_url(const char *url);
Ilari Liusvaara61b075b2009-12-09 17:26:31 +0200324void transport_take_over(struct transport *transport,
325 struct child_process *child);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400326
Ilari Liusvaarab2367522009-12-09 17:26:33 +0200327int transport_connect(struct transport *transport, const char *name,
328 const char *exec, int fd[2]);
329
Daniel Barkalow6eb996b2009-08-05 01:01:53 -0400330/* Transport methods defined outside transport.c */
Daniel Barkalowc9e388b2009-09-03 22:13:49 -0400331int transport_helper_init(struct transport *transport, const char *name);
Ilari Liusvaara419f37d2010-10-12 19:39:41 +0300332int bidirectional_transfer_loop(int input, int output);
Daniel Barkalow6eb996b2009-08-05 01:01:53 -0400333
Phil Hord09b7e222013-06-18 13:44:58 -0400334/* common methods used by transport.c and builtin/send-pack.c */
Michael Lukashovf1863d02010-02-16 23:42:52 +0000335void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
336
337int transport_refs_pushed(struct ref *ref);
338
339void transport_print_push_status(const char *dest, struct ref *refs,
Chris Rorvick10643d42012-11-29 19:41:33 -0600340 int verbose, int porcelain, unsigned int *reject_reasons);
Michael Lukashovf1863d02010-02-16 23:42:52 +0000341
Jiang Xindfe1b7f2020-04-17 05:45:36 -0400342/* common method used by transport-helper.c and send-pack.c */
343void reject_atomic_push(struct ref *refs, int mirror_mode);
344
Daniel Barkalow9b288512007-09-10 23:03:04 -0400345#endif