fast-import: introduce mem_pool type
[git] / transport.h
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
3
4 #include "cache.h"
5 #include "run-command.h"
6 #include "remote.h"
7 #include "list-objects-filter-options.h"
8
9 struct string_list;
10
11 struct git_transport_options {
12         unsigned thin : 1;
13         unsigned keep : 1;
14         unsigned followtags : 1;
15         unsigned check_self_contained_and_connected : 1;
16         unsigned self_contained_and_connected : 1;
17         unsigned update_shallow : 1;
18         unsigned deepen_relative : 1;
19         unsigned from_promisor : 1;
20         unsigned no_dependents : 1;
21         int depth;
22         const char *deepen_since;
23         const struct string_list *deepen_not;
24         const char *uploadpack;
25         const char *receivepack;
26         struct push_cas_option *cas;
27         struct list_objects_filter_options filter_options;
28 };
29
30 enum transport_family {
31         TRANSPORT_FAMILY_ALL = 0,
32         TRANSPORT_FAMILY_IPV4,
33         TRANSPORT_FAMILY_IPV6
34 };
35
36 struct transport {
37         const struct transport_vtable *vtable;
38
39         struct remote *remote;
40         const char *url;
41         void *data;
42         const struct ref *remote_refs;
43
44         /**
45          * Indicates whether we already called get_refs_list(); set by
46          * transport.c::transport_get_remote_refs().
47          */
48         unsigned got_remote_refs : 1;
49
50         /*
51          * Transports that call take-over destroys the data specific to
52          * the transport type while doing so, and cannot be reused.
53          */
54         unsigned cannot_reuse : 1;
55
56         /*
57          * A hint from caller that it will be performing a clone, not
58          * normal fetch. IOW the repository is guaranteed empty.
59          */
60         unsigned cloning : 1;
61
62         /*
63          * These strings will be passed to the {pre, post}-receive hook,
64          * on the remote side, if both sides support the push options capability.
65          */
66         const struct string_list *push_options;
67
68         char *pack_lockfile;
69         signed verbose : 3;
70         /**
71          * Transports should not set this directly, and should use this
72          * value without having to check isatty(2), -q/--quiet
73          * (transport->verbose < 0), etc. - checking has already been done
74          * in transport_set_verbosity().
75          **/
76         unsigned progress : 1;
77         /*
78          * If transport is at least potentially smart, this points to
79          * git_transport_options structure to use in case transport
80          * actually turns out to be smart.
81          */
82         struct git_transport_options *smart_options;
83
84         enum transport_family family;
85 };
86
87 #define TRANSPORT_PUSH_ALL                      (1<<0)
88 #define TRANSPORT_PUSH_FORCE                    (1<<1)
89 #define TRANSPORT_PUSH_DRY_RUN                  (1<<2)
90 #define TRANSPORT_PUSH_MIRROR                   (1<<3)
91 #define TRANSPORT_PUSH_PORCELAIN                (1<<4)
92 #define TRANSPORT_PUSH_SET_UPSTREAM             (1<<5)
93 #define TRANSPORT_RECURSE_SUBMODULES_CHECK      (1<<6)
94 #define TRANSPORT_PUSH_PRUNE                    (1<<7)
95 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND  (1<<8)
96 #define TRANSPORT_PUSH_NO_HOOK                  (1<<9)
97 #define TRANSPORT_PUSH_FOLLOW_TAGS              (1<<10)
98 #define TRANSPORT_PUSH_CERT_ALWAYS              (1<<11)
99 #define TRANSPORT_PUSH_CERT_IF_ASKED            (1<<12)
100 #define TRANSPORT_PUSH_ATOMIC                   (1<<13)
101 #define TRANSPORT_PUSH_OPTIONS                  (1<<14)
102 #define TRANSPORT_RECURSE_SUBMODULES_ONLY       (1<<15)
103
104 extern int transport_summary_width(const struct ref *refs);
105
106 /* Returns a transport suitable for the url */
107 struct transport *transport_get(struct remote *, const char *);
108
109 /*
110  * Check whether a transport is allowed by the environment.
111  *
112  * Type should generally be the URL scheme, as described in
113  * Documentation/git.txt
114  *
115  * from_user specifies if the transport was given by the user.  If unknown pass
116  * a -1 to read from the environment to determine if the transport was given by
117  * the user.
118  *
119  */
120 int is_transport_allowed(const char *type, int from_user);
121
122 /*
123  * Check whether a transport is allowed by the environment,
124  * and die otherwise.
125  */
126 void transport_check_allowed(const char *type);
127
128 /* Transport options which apply to git:// and scp-style URLs */
129
130 /* The program to use on the remote side to send a pack */
131 #define TRANS_OPT_UPLOADPACK "uploadpack"
132
133 /* The program to use on the remote side to receive a pack */
134 #define TRANS_OPT_RECEIVEPACK "receivepack"
135
136 /* Transfer the data as a thin pack if not null */
137 #define TRANS_OPT_THIN "thin"
138
139 /* Check the current value of the remote ref */
140 #define TRANS_OPT_CAS "cas"
141
142 /* Keep the pack that was transferred if not null */
143 #define TRANS_OPT_KEEP "keep"
144
145 /* Limit the depth of the fetch if not null */
146 #define TRANS_OPT_DEPTH "depth"
147
148 /* Limit the depth of the fetch based on time if not null */
149 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
150
151 /* Limit the depth of the fetch based on revs if not null */
152 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
153
154 /* Limit the deepen of the fetch if not null */
155 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
156
157 /* Aggressively fetch annotated tags if possible */
158 #define TRANS_OPT_FOLLOWTAGS "followtags"
159
160 /* Accept refs that may update .git/shallow without --depth */
161 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
162
163 /* Send push certificates */
164 #define TRANS_OPT_PUSH_CERT "pushcert"
165
166 /* Indicate that these objects are being fetched by a promisor */
167 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
168
169 /*
170  * Indicate that only the objects wanted need to be fetched, not their
171  * dependents
172  */
173 #define TRANS_OPT_NO_DEPENDENTS "no-dependents"
174
175 /* Filter objects for partial clone and fetch */
176 #define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
177
178 /**
179  * Returns 0 if the option was used, non-zero otherwise. Prints a
180  * message to stderr if the option is not used.
181  **/
182 int transport_set_option(struct transport *transport, const char *name,
183                          const char *value);
184 void transport_set_verbosity(struct transport *transport, int verbosity,
185         int force_progress);
186
187 #define REJECT_NON_FF_HEAD     0x01
188 #define REJECT_NON_FF_OTHER    0x02
189 #define REJECT_ALREADY_EXISTS  0x04
190 #define REJECT_FETCH_FIRST     0x08
191 #define REJECT_NEEDS_FORCE     0x10
192
193 int transport_push(struct transport *connection,
194                    int refspec_nr, const char **refspec, int flags,
195                    unsigned int * reject_reasons);
196
197 const struct ref *transport_get_remote_refs(struct transport *transport);
198
199 int transport_fetch_refs(struct transport *transport, struct ref *refs);
200 void transport_unlock_pack(struct transport *transport);
201 int transport_disconnect(struct transport *transport);
202 char *transport_anonymize_url(const char *url);
203 void transport_take_over(struct transport *transport,
204                          struct child_process *child);
205
206 int transport_connect(struct transport *transport, const char *name,
207                       const char *exec, int fd[2]);
208
209 /* Transport methods defined outside transport.c */
210 int transport_helper_init(struct transport *transport, const char *name);
211 int bidirectional_transfer_loop(int input, int output);
212
213 /* common methods used by transport.c and builtin/send-pack.c */
214 void transport_verify_remote_names(int nr_heads, const char **heads);
215
216 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
217
218 int transport_refs_pushed(struct ref *ref);
219
220 void transport_print_push_status(const char *dest, struct ref *refs,
221                   int verbose, int porcelain, unsigned int *reject_reasons);
222
223 typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
224 extern void for_each_alternate_ref(alternate_ref_fn, void *);
225 #endif