upload-pack: make sure deepening preserves shallow roots
[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
aa5af974
IL
8struct git_transport_options {
9 unsigned thin : 1;
10 unsigned keep : 1;
11 unsigned followtags : 1;
c6807a40
NTND
12 unsigned check_self_contained_and_connected : 1;
13 unsigned self_contained_and_connected : 1;
aa5af974
IL
14 int depth;
15 const char *uploadpack;
16 const char *receivepack;
91048a95 17 struct push_cas_option *cas;
aa5af974
IL
18};
19
9b288516 20struct transport {
9b288516
DB
21 struct remote *remote;
22 const char *url;
9b288516 23 void *data;
4577370e 24 const struct ref *remote_refs;
9b288516 25
b0d66e15
TRC
26 /**
27 * Indicates whether we already called get_refs_list(); set by
28 * transport.c::transport_get_remote_refs().
29 */
30 unsigned got_remote_refs : 1;
31
b26ed430
JH
32 /*
33 * Transports that call take-over destroys the data specific to
34 * the transport type while doing so, and cannot be reused.
35 */
36 unsigned cannot_reuse : 1;
37
beea4152
NTND
38 /*
39 * A hint from caller that it will be performing a clone, not
40 * normal fetch. IOW the repository is guaranteed empty.
41 */
42 unsigned cloning : 1;
43
9b288516
DB
44 /**
45 * Returns 0 if successful, positive if the option is not
46 * recognized or is inapplicable, and negative if the option
47 * is applicable but the value is invalid.
48 **/
49 int (*set_option)(struct transport *connection, const char *name,
50 const char *value);
51
37148311
DB
52 /**
53 * Returns a list of the remote side's refs. In order to allow
54 * the transport to try to share connections, for_push is a
55 * hint as to whether the ultimate operation is a push or a fetch.
56 *
57 * If the transport is able to determine the remote hash for
58 * the ref without a huge amount of effort, it should store it
59 * in the ref's old_sha1 field; otherwise it should be all 0.
60 **/
64fcef2d 61 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
62
63 /**
64 * Fetch the objects for the given refs. Note that this gets
65 * an array, and should ignore the list structure.
66 *
67 * If the transport did not get hashes for refs in
68 * get_refs_list(), it should set the old_sha1 fields in the
69 * provided refs now.
70 **/
71 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
72
73 /**
74 * Push the objects and refs. Send the necessary objects, and
75 * then, for any refs where peer_ref is set and
76 * peer_ref->new_sha1 is different from old_sha1, tell the
77 * remote side to update each ref in the list from old_sha1 to
78 * peer_ref->new_sha1.
79 *
80 * Where possible, set the status for each ref appropriately.
81 *
82 * The transport must modify new_sha1 in the ref to the new
83 * value if the remote accepted the change. Note that this
84 * could be a different value from peer_ref->new_sha1 if the
85 * process involved generating new commits.
86 **/
64fcef2d 87 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 88 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
89 int (*connect)(struct transport *connection, const char *name,
90 const char *executable, int fd[2]);
9b288516 91
37148311 92 /** get_refs_list(), fetch(), and push_refs() can keep
41ccfdd9 93 * resources (such as a connection) reserved for further
37148311
DB
94 * use. disconnect() releases these resources.
95 **/
9b288516 96 int (*disconnect)(struct transport *connection);
824d5776 97 char *pack_lockfile;
cff7123c 98 signed verbose : 3;
d01b3c02
TRC
99 /**
100 * Transports should not set this directly, and should use this
101 * value without having to check isatty(2), -q/--quiet
102 * (transport->verbose < 0), etc. - checking has already been done
103 * in transport_set_verbosity().
104 **/
21188b1e 105 unsigned progress : 1;
aa5af974
IL
106 /*
107 * If transport is at least potentially smart, this points to
108 * git_transport_options structure to use in case transport
109 * actually turns out to be smart.
110 */
111 struct git_transport_options *smart_options;
9b288516
DB
112};
113
824d5776
SP
114#define TRANSPORT_PUSH_ALL 1
115#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 116#define TRANSPORT_PUSH_DRY_RUN 4
94c89ba6 117#define TRANSPORT_PUSH_MIRROR 8
212cfe15
TRC
118#define TRANSPORT_PUSH_PORCELAIN 16
119#define TRANSPORT_PUSH_SET_UPSTREAM 32
d2b17b32 120#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
6ddba5e2 121#define TRANSPORT_PUSH_PRUNE 128
eb21c732 122#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
ec55559f 123#define TRANSPORT_PUSH_NO_HOOK 512
c2aba155 124#define TRANSPORT_PUSH_FOLLOW_TAGS 1024
824d5776 125
f1863d0d 126#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
754395d3 127#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
824d5776 128
9b288516 129/* Returns a transport suitable for the url */
e5f4e214 130struct transport *transport_get(struct remote *, const char *);
9b288516
DB
131
132/* Transport options which apply to git:// and scp-style URLs */
133
c29727d5
DB
134/* The program to use on the remote side to send a pack */
135#define TRANS_OPT_UPLOADPACK "uploadpack"
136
9b288516
DB
137/* The program to use on the remote side to receive a pack */
138#define TRANS_OPT_RECEIVEPACK "receivepack"
139
140/* Transfer the data as a thin pack if not null */
141#define TRANS_OPT_THIN "thin"
142
91048a95
JH
143/* Check the current value of the remote ref */
144#define TRANS_OPT_CAS "cas"
145
c29727d5
DB
146/* Keep the pack that was transferred if not null */
147#define TRANS_OPT_KEEP "keep"
148
c29727d5
DB
149/* Limit the depth of the fetch if not null */
150#define TRANS_OPT_DEPTH "depth"
151
41fa7d2e
SP
152/* Aggressively fetch annotated tags if possible */
153#define TRANS_OPT_FOLLOWTAGS "followtags"
154
9b288516
DB
155/**
156 * Returns 0 if the option was used, non-zero otherwise. Prints a
157 * message to stderr if the option is not used.
158 **/
159int transport_set_option(struct transport *transport, const char *name,
160 const char *value);
d01b3c02
TRC
161void transport_set_verbosity(struct transport *transport, int verbosity,
162 int force_progress);
9b288516 163
10643d4e
CR
164#define REJECT_NON_FF_HEAD 0x01
165#define REJECT_NON_FF_OTHER 0x02
b24e6047 166#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
167#define REJECT_FETCH_FIRST 0x08
168#define REJECT_NEEDS_FORCE 0x10
10643d4e 169
9b288516 170int transport_push(struct transport *connection,
07436e43 171 int refspec_nr, const char **refspec, int flags,
10643d4e 172 unsigned int * reject_reasons);
9b288516 173
4577370e 174const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 175
37148311 176int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 177void transport_unlock_pack(struct transport *transport);
9b288516 178int transport_disconnect(struct transport *transport);
47abd85b 179char *transport_anonymize_url(const char *url);
61b075bd
IL
180void transport_take_over(struct transport *transport,
181 struct child_process *child);
9b288516 182
b236752a
IL
183int transport_connect(struct transport *transport, const char *name,
184 const char *exec, int fd[2]);
185
6eb996b5 186/* Transport methods defined outside transport.c */
c9e388bb 187int transport_helper_init(struct transport *transport, const char *name);
419f37db 188int bidirectional_transfer_loop(int input, int output);
6eb996b5 189
09b7e220 190/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
191void transport_verify_remote_names(int nr_heads, const char **heads);
192
193void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
194
195int transport_refs_pushed(struct ref *ref);
196
197void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 198 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 199
36cfda15 200typedef void alternate_ref_fn(const struct ref *, void *);
114a6a88 201extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 202#endif