]> git.ipfire.org Git - thirdparty/git.git/blob - remote.h
config.mak.uname: remove unused the NO_R_TO_GCC_LINKER flag
[thirdparty/git.git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "cache.h"
5 #include "parse-options.h"
6 #include "hashmap.h"
7 #include "refspec.h"
8
9 /**
10 * The API gives access to the configuration related to remotes. It handles
11 * all three configuration mechanisms historically and currently used by Git,
12 * and presents the information in a uniform fashion. Note that the code also
13 * handles plain URLs without any configuration, giving them just the default
14 * information.
15 */
16
17 enum {
18 REMOTE_UNCONFIGURED = 0,
19 REMOTE_CONFIG,
20 REMOTE_REMOTES,
21 REMOTE_BRANCHES
22 };
23
24 struct remote {
25 struct hashmap_entry ent;
26
27 /* The user's nickname for the remote */
28 const char *name;
29
30 int origin, configured_in_repo;
31
32 const char *foreign_vcs;
33
34 /* An array of all of the url_nr URLs configured for the remote */
35 const char **url;
36
37 int url_nr;
38 int url_alloc;
39
40 /* An array of all of the pushurl_nr push URLs configured for the remote */
41 const char **pushurl;
42
43 int pushurl_nr;
44 int pushurl_alloc;
45
46 struct refspec push;
47
48 struct refspec fetch;
49
50 /*
51 * The setting for whether to fetch tags (as a separate rule from the
52 * configured refspecs);
53 * -1 to never fetch tags
54 * 0 to auto-follow tags on heuristic (default)
55 * 1 to always auto-follow tags
56 * 2 to always fetch tags
57 */
58 int fetch_tags;
59
60 int skip_default_update;
61 int mirror;
62 int prune;
63 int prune_tags;
64
65 /**
66 * The configured helper programs to run on the remote side, for
67 * Git-native protocols.
68 */
69 const char *receivepack;
70 const char *uploadpack;
71
72 /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
73 char *http_proxy;
74
75 /* The method used for authenticating against `http_proxy`. */
76 char *http_proxy_authmethod;
77 };
78
79 /**
80 * struct remotes can be found by name with remote_get().
81 * remote_get(NULL) will return the default remote, given the current branch
82 * and configuration.
83 */
84 struct remote *remote_get(const char *name);
85
86 struct remote *pushremote_get(const char *name);
87 int remote_is_configured(struct remote *remote, int in_repo);
88
89 typedef int each_remote_fn(struct remote *remote, void *priv);
90
91 /* iterate through struct remotes */
92 int for_each_remote(each_remote_fn fn, void *priv);
93
94 int remote_has_url(struct remote *remote, const char *url);
95
96 struct ref_push_report {
97 const char *ref_name;
98 struct object_id *old_oid;
99 struct object_id *new_oid;
100 unsigned int forced_update:1;
101 struct ref_push_report *next;
102 };
103
104 struct ref {
105 struct ref *next;
106 struct object_id old_oid;
107 struct object_id new_oid;
108 struct object_id old_oid_expect; /* used by expect-old */
109 char *symref;
110 unsigned int
111 force:1,
112 forced_update:1,
113 expect_old_sha1:1,
114 exact_oid:1,
115 deletion:1;
116
117 enum {
118 REF_NOT_MATCHED = 0, /* initial value */
119 REF_MATCHED,
120 REF_UNADVERTISED_NOT_ALLOWED
121 } match_status;
122
123 /*
124 * Order is important here, as we write to FETCH_HEAD
125 * in numeric order. And the default NOT_FOR_MERGE
126 * should be 0, so that xcalloc'd structures get it
127 * by default.
128 */
129 enum {
130 FETCH_HEAD_MERGE = -1,
131 FETCH_HEAD_NOT_FOR_MERGE = 0,
132 FETCH_HEAD_IGNORE = 1
133 } fetch_head_status;
134
135 enum {
136 REF_STATUS_NONE = 0,
137 REF_STATUS_OK,
138 REF_STATUS_REJECT_NONFASTFORWARD,
139 REF_STATUS_REJECT_ALREADY_EXISTS,
140 REF_STATUS_REJECT_NODELETE,
141 REF_STATUS_REJECT_FETCH_FIRST,
142 REF_STATUS_REJECT_NEEDS_FORCE,
143 REF_STATUS_REJECT_STALE,
144 REF_STATUS_REJECT_SHALLOW,
145 REF_STATUS_UPTODATE,
146 REF_STATUS_REMOTE_REJECT,
147 REF_STATUS_EXPECTING_REPORT,
148 REF_STATUS_ATOMIC_PUSH_FAILED
149 } status;
150 char *remote_status;
151 struct ref_push_report *report;
152 struct ref *peer_ref; /* when renaming */
153 char name[FLEX_ARRAY]; /* more */
154 };
155
156 #define REF_NORMAL (1u << 0)
157 #define REF_HEADS (1u << 1)
158 #define REF_TAGS (1u << 2)
159
160 struct ref *find_ref_by_name(const struct ref *list, const char *name);
161
162 struct ref *alloc_ref(const char *name);
163 struct ref *copy_ref(const struct ref *ref);
164 struct ref *copy_ref_list(const struct ref *ref);
165 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
166 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
167 int ref_compare_name(const void *, const void *);
168
169 int check_ref_type(const struct ref *ref, int flags);
170
171 /*
172 * Free a single ref and its peer, or an entire list of refs and their peers,
173 * respectively.
174 */
175 void free_one_ref(struct ref *ref);
176 void free_refs(struct ref *ref);
177
178 struct oid_array;
179 struct packet_reader;
180 struct strvec;
181 struct string_list;
182 struct ref **get_remote_heads(struct packet_reader *reader,
183 struct ref **list, unsigned int flags,
184 struct oid_array *extra_have,
185 struct oid_array *shallow_points);
186
187 /* Used for protocol v2 in order to retrieve refs from a remote */
188 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
189 struct ref **list, int for_push,
190 const struct strvec *ref_prefixes,
191 const struct string_list *server_options,
192 int stateless_rpc);
193
194 int resolve_remote_symref(struct ref *ref, struct ref *list);
195
196 /*
197 * Remove and free all but the first of any entries in the input list
198 * that map the same remote reference to the same local reference. If
199 * there are two entries that map different remote references to the
200 * same local reference, emit an error message and die. Return a
201 * pointer to the head of the resulting list.
202 */
203 struct ref *ref_remove_duplicates(struct ref *ref_map);
204
205 /*
206 * Remove all entries in the input list which match any negative refspec in
207 * the refspec list.
208 */
209 struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
210
211 int query_refspecs(struct refspec *rs, struct refspec_item *query);
212 char *apply_refspecs(struct refspec *rs, const char *name);
213
214 int check_push_refs(struct ref *src, struct refspec *rs);
215 int match_push_refs(struct ref *src, struct ref **dst,
216 struct refspec *rs, int flags);
217 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
218 int force_update);
219
220 /*
221 * Given a list of the remote refs and the specification of things to
222 * fetch, makes a (separate) list of the refs to fetch and the local
223 * refs to store into. Note that negative refspecs are ignored here, and
224 * should be handled separately.
225 *
226 * *tail is the pointer to the tail pointer of the list of results
227 * beforehand, and will be set to the tail pointer of the list of
228 * results afterward.
229 *
230 * missing_ok is usually false, but when we are adding branch.$name.merge
231 * it is Ok if the branch is not at the remote anymore.
232 */
233 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
234 struct ref ***tail, int missing_ok);
235
236 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
237
238 /*
239 * For the given remote, reads the refspec's src and sets the other fields.
240 */
241 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
242
243 /**
244 * struct branch holds the configuration for a branch. It can be looked up with
245 * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
246 */
247 struct branch {
248
249 /* The short name of the branch. */
250 const char *name;
251
252 /* The full path for the branch ref. */
253 const char *refname;
254
255 /* The name of the remote listed in the configuration. */
256 const char *remote_name;
257
258 const char *pushremote_name;
259
260 /* An array of the "merge" lines in the configuration. */
261 const char **merge_name;
262
263 /**
264 * An array of the struct refspecs used for the merge lines. That is,
265 * merge[i]->dst is a local tracking ref which should be merged into this
266 * branch by default.
267 */
268 struct refspec_item **merge;
269
270 /* The number of merge configurations */
271 int merge_nr;
272
273 int merge_alloc;
274
275 const char *push_tracking_ref;
276 };
277
278 struct branch *branch_get(const char *name);
279 const char *remote_for_branch(struct branch *branch, int *explicit);
280 const char *pushremote_for_branch(struct branch *branch, int *explicit);
281 const char *remote_ref_for_branch(struct branch *branch, int for_push);
282
283 /* returns true if the given branch has merge configuration given. */
284 int branch_has_merge_config(struct branch *branch);
285
286 int branch_merge_matches(struct branch *, int n, const char *);
287
288 /**
289 * Return the fully-qualified refname of the tracking branch for `branch`.
290 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
291 * upstream is defined.
292 *
293 * If `err` is not NULL and no upstream is defined, a more specific error
294 * message is recorded there (if the function does not return NULL, then
295 * `err` is not touched).
296 */
297 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
298
299 /**
300 * Return the tracking branch that corresponds to the ref we would push to
301 * given a bare `git push` while `branch` is checked out.
302 *
303 * The return value and `err` conventions match those of `branch_get_upstream`.
304 */
305 const char *branch_get_push(struct branch *branch, struct strbuf *err);
306
307 /* Flags to match_refs. */
308 enum match_refs_flags {
309 MATCH_REFS_NONE = 0,
310 MATCH_REFS_ALL = (1 << 0),
311 MATCH_REFS_MIRROR = (1 << 1),
312 MATCH_REFS_PRUNE = (1 << 2),
313 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
314 };
315
316 /* Flags for --ahead-behind option. */
317 enum ahead_behind_flags {
318 AHEAD_BEHIND_UNSPECIFIED = -1,
319 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
320 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
321 };
322
323 /* Reporting of tracking info */
324 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
325 const char **upstream_name, int for_push,
326 enum ahead_behind_flags abf);
327 int format_tracking_info(struct branch *branch, struct strbuf *sb,
328 enum ahead_behind_flags abf);
329
330 struct ref *get_local_heads(void);
331 /*
332 * Find refs from a list which are likely to be pointed to by the given HEAD
333 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
334 * list of all candidate refs. If no match is found (or 'head' is NULL),
335 * returns NULL. All returns are newly allocated and should be freed.
336 */
337 struct ref *guess_remote_head(const struct ref *head,
338 const struct ref *refs,
339 int all);
340
341 /* Return refs which no longer exist on remote */
342 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
343
344 /*
345 * Compare-and-swap
346 */
347 #define CAS_OPT_NAME "force-with-lease"
348
349 struct push_cas_option {
350 unsigned use_tracking_for_rest:1;
351 struct push_cas {
352 struct object_id expect;
353 unsigned use_tracking:1;
354 char *refname;
355 } *entry;
356 int nr;
357 int alloc;
358 };
359
360 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
361
362 int is_empty_cas(const struct push_cas_option *);
363 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
364
365 #endif