Merge branch 'rs/plug-leak-in-pack-bitmaps' into maint
[git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "parse-options.h"
5 #include "hashmap.h"
6
7 enum {
8         REMOTE_CONFIG,
9         REMOTE_REMOTES,
10         REMOTE_BRANCHES
11 };
12
13 struct remote {
14         struct hashmap_entry ent;  /* must be first */
15
16         const char *name;
17         int origin;
18
19         const char *foreign_vcs;
20
21         const char **url;
22         int url_nr;
23         int url_alloc;
24
25         const char **pushurl;
26         int pushurl_nr;
27         int pushurl_alloc;
28
29         const char **push_refspec;
30         struct refspec *push;
31         int push_refspec_nr;
32         int push_refspec_alloc;
33
34         const char **fetch_refspec;
35         struct refspec *fetch;
36         int fetch_refspec_nr;
37         int fetch_refspec_alloc;
38
39         /*
40          * -1 to never fetch tags
41          * 0 to auto-follow tags on heuristic (default)
42          * 1 to always auto-follow tags
43          * 2 to always fetch tags
44          */
45         int fetch_tags;
46         int skip_default_update;
47         int mirror;
48         int prune;
49
50         const char *receivepack;
51         const char *uploadpack;
52
53         /*
54          * for curl remotes only
55          */
56         char *http_proxy;
57 };
58
59 struct remote *remote_get(const char *name);
60 struct remote *pushremote_get(const char *name);
61 int remote_is_configured(const char *name);
62
63 typedef int each_remote_fn(struct remote *remote, void *priv);
64 int for_each_remote(each_remote_fn fn, void *priv);
65
66 int remote_has_url(struct remote *remote, const char *url);
67
68 struct refspec {
69         unsigned force : 1;
70         unsigned pattern : 1;
71         unsigned matching : 1;
72         unsigned exact_sha1 : 1;
73
74         char *src;
75         char *dst;
76 };
77
78 extern const struct refspec *tag_refspec;
79
80 struct ref {
81         struct ref *next;
82         unsigned char old_sha1[20];
83         unsigned char new_sha1[20];
84         unsigned char old_sha1_expect[20]; /* used by expect-old */
85         char *symref;
86         unsigned int
87                 force:1,
88                 forced_update:1,
89                 expect_old_sha1:1,
90                 expect_old_no_trackback:1,
91                 deletion:1,
92                 matched:1;
93
94         /*
95          * Order is important here, as we write to FETCH_HEAD
96          * in numeric order. And the default NOT_FOR_MERGE
97          * should be 0, so that xcalloc'd structures get it
98          * by default.
99          */
100         enum {
101                 FETCH_HEAD_MERGE = -1,
102                 FETCH_HEAD_NOT_FOR_MERGE = 0,
103                 FETCH_HEAD_IGNORE = 1
104         } fetch_head_status;
105
106         enum {
107                 REF_STATUS_NONE = 0,
108                 REF_STATUS_OK,
109                 REF_STATUS_REJECT_NONFASTFORWARD,
110                 REF_STATUS_REJECT_ALREADY_EXISTS,
111                 REF_STATUS_REJECT_NODELETE,
112                 REF_STATUS_REJECT_FETCH_FIRST,
113                 REF_STATUS_REJECT_NEEDS_FORCE,
114                 REF_STATUS_REJECT_STALE,
115                 REF_STATUS_REJECT_SHALLOW,
116                 REF_STATUS_UPTODATE,
117                 REF_STATUS_REMOTE_REJECT,
118                 REF_STATUS_EXPECTING_REPORT,
119                 REF_STATUS_ATOMIC_PUSH_FAILED
120         } status;
121         char *remote_status;
122         struct ref *peer_ref; /* when renaming */
123         char name[FLEX_ARRAY]; /* more */
124 };
125
126 #define REF_NORMAL      (1u << 0)
127 #define REF_HEADS       (1u << 1)
128 #define REF_TAGS        (1u << 2)
129
130 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
131
132 struct ref *alloc_ref(const char *name);
133 struct ref *copy_ref(const struct ref *ref);
134 struct ref *copy_ref_list(const struct ref *ref);
135 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
136 extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
137 int ref_compare_name(const void *, const void *);
138
139 int check_ref_type(const struct ref *ref, int flags);
140
141 /*
142  * Frees the entire list and peers of elements.
143  */
144 void free_refs(struct ref *ref);
145
146 struct sha1_array;
147 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
148                                      struct ref **list, unsigned int flags,
149                                      struct sha1_array *extra_have,
150                                      struct sha1_array *shallow);
151
152 int resolve_remote_symref(struct ref *ref, struct ref *list);
153 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
154
155 /*
156  * Remove and free all but the first of any entries in the input list
157  * that map the same remote reference to the same local reference.  If
158  * there are two entries that map different remote references to the
159  * same local reference, emit an error message and die.  Return a
160  * pointer to the head of the resulting list.
161  */
162 struct ref *ref_remove_duplicates(struct ref *ref_map);
163
164 int valid_fetch_refspec(const char *refspec);
165 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
166
167 void free_refspec(int nr_refspec, struct refspec *refspec);
168
169 extern int query_refspecs(struct refspec *specs, int nr, struct refspec *query);
170 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
171                      const char *name);
172
173 int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
174 int match_push_refs(struct ref *src, struct ref **dst,
175                     int nr_refspec, const char **refspec, int all);
176 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
177         int force_update);
178
179 /*
180  * Given a list of the remote refs and the specification of things to
181  * fetch, makes a (separate) list of the refs to fetch and the local
182  * refs to store into.
183  *
184  * *tail is the pointer to the tail pointer of the list of results
185  * beforehand, and will be set to the tail pointer of the list of
186  * results afterward.
187  *
188  * missing_ok is usually false, but when we are adding branch.$name.merge
189  * it is Ok if the branch is not at the remote anymore.
190  */
191 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
192                   struct ref ***tail, int missing_ok);
193
194 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
195
196 /*
197  * For the given remote, reads the refspec's src and sets the other fields.
198  */
199 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
200
201 struct branch {
202         const char *name;
203         const char *refname;
204
205         const char *remote_name;
206         struct remote *remote;
207
208         const char **merge_name;
209         struct refspec **merge;
210         int merge_nr;
211         int merge_alloc;
212 };
213
214 struct branch *branch_get(const char *name);
215
216 int branch_has_merge_config(struct branch *branch);
217 int branch_merge_matches(struct branch *, int n, const char *);
218
219 /* Flags to match_refs. */
220 enum match_refs_flags {
221         MATCH_REFS_NONE         = 0,
222         MATCH_REFS_ALL          = (1 << 0),
223         MATCH_REFS_MIRROR       = (1 << 1),
224         MATCH_REFS_PRUNE        = (1 << 2),
225         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
226 };
227
228 /* Reporting of tracking info */
229 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
230 int format_tracking_info(struct branch *branch, struct strbuf *sb);
231
232 struct ref *get_local_heads(void);
233 /*
234  * Find refs from a list which are likely to be pointed to by the given HEAD
235  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
236  * list of all candidate refs. If no match is found (or 'head' is NULL),
237  * returns NULL. All returns are newly allocated and should be freed.
238  */
239 struct ref *guess_remote_head(const struct ref *head,
240                               const struct ref *refs,
241                               int all);
242
243 /* Return refs which no longer exist on remote */
244 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
245
246 /*
247  * Compare-and-swap
248  */
249 #define CAS_OPT_NAME "force-with-lease"
250
251 struct push_cas_option {
252         unsigned use_tracking_for_rest:1;
253         struct push_cas {
254                 unsigned char expect[20];
255                 unsigned use_tracking:1;
256                 char *refname;
257         } *entry;
258         int nr;
259         int alloc;
260 };
261
262 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
263 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
264
265 extern int is_empty_cas(const struct push_cas_option *);
266 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
267
268 #endif