]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
504c4d42 | 4 | struct object_id; |
077be78d | 5 | struct ref_store; |
504c4d42 NTND |
6 | struct strbuf; |
7 | struct string_list; | |
17eff96b | 8 | struct worktree; |
504c4d42 | 9 | |
fb58c8d5 MH |
10 | /* |
11 | * Resolve a reference, recursively following symbolic refererences. | |
12 | * | |
13 | * Store the referred-to object's name in sha1 and return the name of | |
14 | * the non-symbolic reference that ultimately pointed at it. The | |
15 | * return value, if not NULL, is a pointer into either a static buffer | |
16 | * or the input ref. | |
17 | * | |
18 | * If the reference cannot be resolved to an object, the behavior | |
19 | * depends on the RESOLVE_REF_READING flag: | |
20 | * | |
21 | * - If RESOLVE_REF_READING is set, return NULL. | |
22 | * | |
23 | * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of | |
24 | * the last reference name in the chain, which will either be a non-symbolic | |
25 | * reference or an undefined reference. If this is a prelude to | |
26 | * "writing" to the ref, the return value is the name of the ref | |
27 | * that will actually be created or changed. | |
28 | * | |
29 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one | |
30 | * level of symbolic reference. The value stored in sha1 for a symbolic | |
31 | * reference will always be null_sha1 in this case, and the return | |
32 | * value is the reference that the symref refers to directly. | |
33 | * | |
34 | * If flags is non-NULL, set the value that it points to the | |
35 | * combination of REF_ISPACKED (if the reference was found among the | |
36 | * packed references), REF_ISSYMREF (if the initial reference was a | |
37 | * symbolic reference), REF_BAD_NAME (if the reference name is ill | |
38 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
39 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
40 | * on each flag. | |
41 | * | |
42 | * If ref is not a properly-formatted, normalized reference, return | |
43 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
44 | * give up and return NULL. | |
45 | * | |
46 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their | |
47 | * name is invalid according to git-check-ref-format(1). If the name | |
48 | * is bad then the value stored in sha1 will be null_sha1 and the two | |
49 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. | |
50 | * | |
51 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
52 | * directory and do not consist of all caps and underscores cannot be | |
53 | * resolved. The function returns NULL for such ref names. | |
54 | * Caps and underscores refers to the special refs, such as HEAD, | |
55 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
56 | */ | |
57 | #define RESOLVE_REF_READING 0x01 | |
58 | #define RESOLVE_REF_NO_RECURSE 0x02 | |
59 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 | |
60 | ||
7d2df051 NTND |
61 | const char *refs_resolve_ref_unsafe(struct ref_store *refs, |
62 | const char *refname, | |
63 | int resolve_flags, | |
64 | unsigned char *sha1, | |
65 | int *flags); | |
1354c9b2 MH |
66 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, |
67 | unsigned char *sha1, int *flags); | |
fb58c8d5 | 68 | |
7d2df051 NTND |
69 | char *refs_resolve_refdup(struct ref_store *refs, |
70 | const char *refname, int resolve_flags, | |
71 | unsigned char *sha1, int *flags); | |
1354c9b2 MH |
72 | char *resolve_refdup(const char *refname, int resolve_flags, |
73 | unsigned char *sha1, int *flags); | |
fb58c8d5 | 74 | |
7d2df051 NTND |
75 | int refs_read_ref_full(struct ref_store *refs, const char *refname, |
76 | int resolve_flags, unsigned char *sha1, int *flags); | |
1354c9b2 MH |
77 | int read_ref_full(const char *refname, int resolve_flags, |
78 | unsigned char *sha1, int *flags); | |
79 | int read_ref(const char *refname, unsigned char *sha1); | |
fb58c8d5 | 80 | |
7d2df051 NTND |
81 | /* |
82 | * Return 0 if a reference named refname could be created without | |
83 | * conflicting with the name of an existing reference. Otherwise, | |
84 | * return a negative value and write an explanation to err. If extras | |
85 | * is non-NULL, it is a list of additional refnames with which refname | |
86 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
87 | * conflicts with refs in skip (e.g., because they are scheduled for | |
88 | * deletion in the same operation). Behavior is undefined if the same | |
89 | * name is listed in both extras and skip. | |
90 | * | |
91 | * Two reference names conflict if one of them exactly matches the | |
92 | * leading components of the other; e.g., "foo/bar" conflicts with | |
93 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
94 | * "foo/barbados". | |
95 | * | |
96 | * extras and skip must be sorted. | |
97 | */ | |
98 | ||
99 | int refs_verify_refname_available(struct ref_store *refs, | |
100 | const char *refname, | |
b05855b5 | 101 | const struct string_list *extras, |
7d2df051 NTND |
102 | const struct string_list *skip, |
103 | struct strbuf *err); | |
104 | ||
1354c9b2 | 105 | int ref_exists(const char *refname); |
fb58c8d5 | 106 | |
341fb286 CW |
107 | int should_autocreate_reflog(const char *refname); |
108 | ||
1354c9b2 | 109 | int is_branch(const char *refname); |
fb58c8d5 | 110 | |
6fb5acfd DT |
111 | extern int refs_init_db(struct strbuf *err); |
112 | ||
fb58c8d5 MH |
113 | /* |
114 | * If refname is a non-symbolic reference that refers to a tag object, | |
115 | * and the tag can be (recursively) dereferenced to a non-tag object, | |
116 | * store the SHA1 of the referred-to object to sha1 and return 0. If | |
117 | * any of these conditions are not met, return a non-zero value. | |
118 | * Symbolic references are considered unpeelable, even if they | |
119 | * ultimately resolve to a peelable tag. | |
120 | */ | |
7d2df051 NTND |
121 | int refs_peel_ref(struct ref_store *refs, const char *refname, |
122 | unsigned char *sha1); | |
1354c9b2 | 123 | int peel_ref(const char *refname, unsigned char *sha1); |
fb58c8d5 MH |
124 | |
125 | /** | |
a8355bb7 MH |
126 | * Resolve refname in the nested "gitlink" repository in the specified |
127 | * submodule (which must be non-NULL). If the resolution is | |
128 | * successful, return 0 and set sha1 to the name of the object; | |
129 | * otherwise, return a non-zero value. | |
fb58c8d5 | 130 | */ |
a8355bb7 | 131 | int resolve_gitlink_ref(const char *submodule, const char *refname, |
1354c9b2 | 132 | unsigned char *sha1); |
fb58c8d5 MH |
133 | |
134 | /* | |
135 | * Return true iff abbrev_name is a possible abbreviation for | |
136 | * full_name according to the rules defined by ref_rev_parse_rules in | |
137 | * refs.c. | |
138 | */ | |
1354c9b2 | 139 | int refname_match(const char *abbrev_name, const char *full_name); |
fb58c8d5 | 140 | |
a460ea4a | 141 | int expand_ref(const char *str, int len, unsigned char *sha1, char **ref); |
1354c9b2 MH |
142 | int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref); |
143 | int dwim_log(const char *str, int len, unsigned char *sha1, char **ref); | |
fb58c8d5 | 144 | |
b416af5b | 145 | /* |
30173b88 MH |
146 | * A ref_transaction represents a collection of reference updates that |
147 | * should succeed or fail together. | |
b416af5b RS |
148 | * |
149 | * Calling sequence | |
150 | * ---------------- | |
30173b88 | 151 | * |
b416af5b RS |
152 | * - Allocate and initialize a `struct ref_transaction` by calling |
153 | * `ref_transaction_begin()`. | |
154 | * | |
30173b88 MH |
155 | * - Specify the intended ref updates by calling one or more of the |
156 | * following functions: | |
157 | * - `ref_transaction_update()` | |
158 | * - `ref_transaction_create()` | |
159 | * - `ref_transaction_delete()` | |
160 | * - `ref_transaction_verify()` | |
161 | * | |
162 | * - Then either: | |
163 | * | |
164 | * - Optionally call `ref_transaction_prepare()` to prepare the | |
165 | * transaction. This locks all references, checks preconditions, | |
166 | * etc. but doesn't finalize anything. If this step fails, the | |
167 | * transaction has been closed and can only be freed. If this step | |
168 | * succeeds, then `ref_transaction_commit()` is almost certain to | |
169 | * succeed. However, you can still call `ref_transaction_abort()` | |
170 | * if you decide not to commit the transaction after all. | |
171 | * | |
172 | * - Call `ref_transaction_commit()` to execute the transaction, | |
173 | * make the changes permanent, and release all locks. If you | |
174 | * haven't already called `ref_transaction_prepare()`, then | |
175 | * `ref_transaction_commit()` calls it for you. | |
176 | * | |
177 | * Or | |
178 | * | |
179 | * - Call `initial_ref_transaction_commit()` if the ref database is | |
180 | * known to be empty and have no other writers (e.g. during | |
181 | * clone). This is likely to be much faster than | |
182 | * `ref_transaction_commit()`. `ref_transaction_prepare()` should | |
183 | * *not* be called before `initial_ref_transaction_commit()`. | |
184 | * | |
185 | * - Then finally, call `ref_transaction_free()` to free the | |
186 | * `ref_transaction` data structure. | |
187 | * | |
188 | * At any time before calling `ref_transaction_commit()`, you can call | |
189 | * `ref_transaction_abort()` to abort the transaction, rollback any | |
190 | * locks, and free any associated resources (including the | |
191 | * `ref_transaction` data structure). | |
192 | * | |
193 | * Putting it all together, a complete reference update looks like | |
194 | * | |
195 | * struct ref_transaction *transaction; | |
196 | * struct strbuf err = STRBUF_INIT; | |
197 | * int ret = 0; | |
198 | * | |
199 | * transaction = ref_store_transaction_begin(refs, &err); | |
200 | * if (!transaction || | |
201 | * ref_transaction_update(...) || | |
202 | * ref_transaction_create(...) || | |
203 | * ...etc... || | |
204 | * ref_transaction_commit(transaction, &err)) { | |
205 | * error("%s", err.buf); | |
206 | * ret = -1; | |
207 | * } | |
208 | * ref_transaction_free(transaction); | |
209 | * strbuf_release(&err); | |
210 | * return ret; | |
b416af5b RS |
211 | * |
212 | * Error handling | |
213 | * -------------- | |
214 | * | |
215 | * On error, transaction functions append a message about what | |
216 | * went wrong to the 'err' argument. The message mentions what | |
217 | * ref was being updated (if any) when the error occurred so it | |
218 | * can be passed to 'die' or 'error' as-is. | |
219 | * | |
220 | * The message is appended to err without first clearing err. | |
221 | * err will not be '\n' terminated. | |
49386868 DT |
222 | * |
223 | * Caveats | |
224 | * ------- | |
225 | * | |
226 | * Note that no locks are taken, and no refs are read, until | |
30173b88 MH |
227 | * `ref_transaction_prepare()` or `ref_transaction_commit()` is |
228 | * called. So, for example, `ref_transaction_verify()` won't report a | |
229 | * verification failure until the commit is attempted. | |
b416af5b | 230 | */ |
caa4046c MH |
231 | struct ref_transaction; |
232 | ||
89df9c84 | 233 | /* |
3bc581b9 MH |
234 | * Bit values set in the flags argument passed to each_ref_fn() and |
235 | * stored in ref_iterator::flags. Other bits are for internal use | |
236 | * only: | |
89df9c84 MH |
237 | */ |
238 | ||
239 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 240 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
241 | |
242 | /* Reference is a packed reference. */ | |
98ac34b2 | 243 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
244 | |
245 | /* | |
246 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
247 | * reference (directly or indirectly), corrupt reference file, |
248 | * reference exists but name is bad, or symbolic reference refers to | |
249 | * ill-formatted reference name. | |
89df9c84 | 250 | */ |
98ac34b2 | 251 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 252 | |
d0f810f0 RS |
253 | /* |
254 | * Reference name is not well formed. | |
255 | * | |
256 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
257 | */ | |
258 | #define REF_BAD_NAME 0x08 | |
259 | ||
8a65ff76 | 260 | /* |
4f78c24c MH |
261 | * The signature for the callback function for the for_each_*() |
262 | * functions below. The memory pointed to by the refname and sha1 | |
263 | * arguments is only guaranteed to be valid for the duration of a | |
264 | * single callback invocation. | |
265 | */ | |
266 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
267 | const struct object_id *oid, int flags, void *cb_data); |
268 | ||
4f78c24c MH |
269 | /* |
270 | * The following functions invoke the specified callback function for | |
271 | * each reference indicated. If the function ever returns a nonzero | |
272 | * value, stop the iteration and return that value. Please note that | |
273 | * it is not safe to modify references while an iteration is in | |
274 | * progress, unless the same callback function invocation that | |
275 | * modifies the reference also returns a nonzero value to immediately | |
adac8115 | 276 | * stop the iteration. Returned references are sorted. |
8a65ff76 | 277 | */ |
7d2df051 NTND |
278 | int refs_for_each_ref(struct ref_store *refs, |
279 | each_ref_fn fn, void *cb_data); | |
280 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
281 | each_ref_fn fn, void *cb_data); | |
282 | int refs_for_each_tag_ref(struct ref_store *refs, | |
283 | each_ref_fn fn, void *cb_data); | |
284 | int refs_for_each_branch_ref(struct ref_store *refs, | |
285 | each_ref_fn fn, void *cb_data); | |
286 | int refs_for_each_remote_ref(struct ref_store *refs, | |
287 | each_ref_fn fn, void *cb_data); | |
288 | ||
1354c9b2 MH |
289 | int head_ref(each_ref_fn fn, void *cb_data); |
290 | int for_each_ref(each_ref_fn fn, void *cb_data); | |
291 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); | |
292 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, | |
293 | unsigned int broken); | |
294 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); | |
295 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
296 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
297 | int for_each_replace_ref(each_ref_fn fn, void *cb_data); | |
298 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); | |
299 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, | |
300 | const char *prefix, void *cb_data); | |
301 | ||
302 | int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
303 | int for_each_ref_submodule(const char *submodule, | |
304 | each_ref_fn fn, void *cb_data); | |
305 | int for_each_ref_in_submodule(const char *submodule, const char *prefix, | |
9ef6aeb0 | 306 | each_ref_fn fn, void *cb_data); |
1354c9b2 MH |
307 | int for_each_tag_ref_submodule(const char *submodule, |
308 | each_ref_fn fn, void *cb_data); | |
309 | int for_each_branch_ref_submodule(const char *submodule, | |
310 | each_ref_fn fn, void *cb_data); | |
311 | int for_each_remote_ref_submodule(const char *submodule, | |
312 | each_ref_fn fn, void *cb_data); | |
9ef6aeb0 | 313 | |
1354c9b2 MH |
314 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
315 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
a1bea2c1 | 316 | |
fb58c8d5 | 317 | /* can be used to learn about broken ref and symref */ |
7d2df051 | 318 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 319 | int for_each_rawref(each_ref_fn fn, void *cb_data); |
fb58c8d5 | 320 | |
894a9d33 TR |
321 | static inline const char *has_glob_specials(const char *pattern) |
322 | { | |
323 | return strpbrk(pattern, "?*["); | |
324 | } | |
325 | ||
1354c9b2 MH |
326 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
327 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
328 | const struct string_list *refnames); | |
f8948e2f | 329 | |
32d462ce MH |
330 | /* |
331 | * Flags for controlling behaviour of pack_refs() | |
332 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
333 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
334 | */ | |
335 | #define PACK_REFS_PRUNE 0x0001 | |
336 | #define PACK_REFS_ALL 0x0002 | |
337 | ||
338 | /* | |
339 | * Write a packed-refs file for the current repository. | |
340 | * flags: Combination of the above PACK_REFS_* flags. | |
341 | */ | |
7d2df051 | 342 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); |
32d462ce | 343 | |
835e3c99 | 344 | /* |
31e07f76 | 345 | * Flags controlling ref_transaction_update(), ref_transaction_create(), etc. |
029cdb4a RS |
346 | * REF_NODEREF: act on the ref directly, instead of dereferencing |
347 | * symbolic references. | |
348 | * | |
581d4e0c | 349 | * Other flags are reserved for internal use. |
835e3c99 | 350 | */ |
68db31cc | 351 | #define REF_NODEREF 0x01 |
0f2a71d9 | 352 | #define REF_FORCE_CREATE_REFLOG 0x40 |
95fc7512 | 353 | |
bd3b02da | 354 | /* |
a4c653df | 355 | * Setup reflog before using. Fill in err and return -1 on failure. |
bd3b02da | 356 | */ |
7d2df051 NTND |
357 | int refs_create_reflog(struct ref_store *refs, const char *refname, |
358 | int force_create, struct strbuf *err); | |
abd0cd3a | 359 | int safe_create_reflog(const char *refname, int force_create, struct strbuf *err); |
859c3017 | 360 | |
d556fae2 | 361 | /** Reads log for the value of ref during at_time. **/ |
1354c9b2 | 362 | int read_ref_at(const char *refname, unsigned int flags, |
dddbad72 | 363 | timestamp_t at_time, int cnt, |
1354c9b2 | 364 | unsigned char *sha1, char **msg, |
dddbad72 | 365 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); |
d556fae2 | 366 | |
4da58835 | 367 | /** Check if a particular reflog exists */ |
7d2df051 | 368 | int refs_reflog_exists(struct ref_store *refs, const char *refname); |
1354c9b2 | 369 | int reflog_exists(const char *refname); |
4da58835 | 370 | |
fc1c2168 | 371 | /* |
1c03c4d3 MH |
372 | * Delete the specified reference. If old_sha1 is non-NULL, then |
373 | * verify that the current value of the reference is old_sha1 before | |
374 | * deleting it. If old_sha1 is NULL, delete the reference if it | |
375 | * exists, regardless of its old value. It is an error for old_sha1 to | |
64da4199 MH |
376 | * be NULL_SHA1. msg and flags are passed through to |
377 | * ref_transaction_delete(). | |
fc1c2168 | 378 | */ |
c0fe4e8b NTND |
379 | int refs_delete_ref(struct ref_store *refs, const char *msg, |
380 | const char *refname, | |
381 | const unsigned char *old_sha1, | |
382 | unsigned int flags); | |
755b49ae KM |
383 | int delete_ref(const char *msg, const char *refname, |
384 | const unsigned char *old_sha1, unsigned int flags); | |
fc1c2168 | 385 | |
98ffd5ff MH |
386 | /* |
387 | * Delete the specified references. If there are any problems, emit | |
388 | * errors but attempt to keep going (i.e., the deletes are not done in | |
64da4199 | 389 | * an all-or-nothing transaction). msg and flags are passed through to |
c5f04ddd | 390 | * ref_transaction_delete(). |
98ffd5ff | 391 | */ |
64da4199 MH |
392 | int refs_delete_refs(struct ref_store *refs, const char *msg, |
393 | struct string_list *refnames, unsigned int flags); | |
394 | int delete_refs(const char *msg, struct string_list *refnames, | |
395 | unsigned int flags); | |
98ffd5ff | 396 | |
4da58835 | 397 | /** Delete a reflog */ |
7d2df051 | 398 | int refs_delete_reflog(struct ref_store *refs, const char *refname); |
1354c9b2 | 399 | int delete_reflog(const char *refname); |
4da58835 | 400 | |
2ff81662 | 401 | /* iterate over reflog entries */ |
1354c9b2 | 402 | typedef int each_reflog_ent_fn( |
9461d272 | 403 | struct object_id *old_oid, struct object_id *new_oid, |
dddbad72 | 404 | const char *committer, timestamp_t timestamp, |
1354c9b2 MH |
405 | int tz, const char *msg, void *cb_data); |
406 | ||
7d2df051 NTND |
407 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, |
408 | each_reflog_ent_fn fn, void *cb_data); | |
409 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, | |
410 | const char *refname, | |
411 | each_reflog_ent_fn fn, | |
412 | void *cb_data); | |
dfefa935 | 413 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
98f85ff4 | 414 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 415 | |
eb8381c8 NP |
416 | /* |
417 | * Calls the specified function for each reflog file until it returns nonzero, | |
adac8115 | 418 | * and returns the value. Reflog file order is unspecified. |
eb8381c8 | 419 | */ |
7d2df051 | 420 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 421 | int for_each_reflog(each_ref_fn fn, void *cb_data); |
eb8381c8 | 422 | |
8d9c5010 MH |
423 | #define REFNAME_ALLOW_ONELEVEL 1 |
424 | #define REFNAME_REFSPEC_PATTERN 2 | |
425 | ||
426 | /* | |
dfefa935 MH |
427 | * Return 0 iff refname has the correct format for a refname according |
428 | * to the rules described in Documentation/git-check-ref-format.txt. | |
429 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 | 430 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
cd377f45 JK |
431 | * allow a single "*" wildcard character in the refspec. No leading or |
432 | * repeated slashes are accepted. | |
8d9c5010 | 433 | */ |
1354c9b2 | 434 | int check_refname_format(const char *refname, int flags); |
95fc7512 | 435 | |
1354c9b2 | 436 | const char *prettify_refname(const char *refname); |
fb58c8d5 | 437 | |
1354c9b2 | 438 | char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 439 | |
c976d415 | 440 | /** rename ref, return 0 on success **/ |
7d2df051 NTND |
441 | int refs_rename_ref(struct ref_store *refs, const char *oldref, |
442 | const char *newref, const char *logmsg); | |
1354c9b2 | 443 | int rename_ref(const char *oldref, const char *newref, const char *logmsg); |
c976d415 | 444 | |
7d2df051 NTND |
445 | int refs_create_symref(struct ref_store *refs, const char *refname, |
446 | const char *target, const char *logmsg); | |
1354c9b2 | 447 | int create_symref(const char *refname, const char *target, const char *logmsg); |
0ebde32c | 448 | |
f4124112 MH |
449 | enum action_on_err { |
450 | UPDATE_REFS_MSG_ON_ERR, | |
451 | UPDATE_REFS_DIE_ON_ERR, | |
452 | UPDATE_REFS_QUIET_ON_ERR | |
453 | }; | |
454 | ||
caa4046c MH |
455 | /* |
456 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 457 | * be freed by calling ref_transaction_free(). |
caa4046c | 458 | */ |
c0fe4e8b NTND |
459 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, |
460 | struct strbuf *err); | |
93a644ea | 461 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 462 | |
caa4046c | 463 | /* |
d1dd721f MH |
464 | * Reference transaction updates |
465 | * | |
466 | * The following four functions add a reference check or update to a | |
467 | * ref_transaction. They have some common similar parameters: | |
468 | * | |
469 | * transaction -- a pointer to an open ref_transaction, obtained | |
470 | * from ref_transaction_begin(). | |
471 | * | |
472 | * refname -- the name of the reference to be affected. | |
473 | * | |
fd2ce9c0 MH |
474 | * new_sha1 -- the SHA-1 that should be set to be the new value of |
475 | * the reference. Some functions allow this parameter to be | |
476 | * NULL, meaning that the reference is not changed, or | |
477 | * null_sha1, meaning that the reference should be deleted. A | |
478 | * copy of this value is made in the transaction. | |
479 | * | |
480 | * old_sha1 -- the SHA-1 value that the reference must have before | |
481 | * the update. Some functions allow this parameter to be NULL, | |
482 | * meaning that the old value of the reference is not checked, | |
483 | * or null_sha1, meaning that the reference must not exist | |
484 | * before the update. A copy of this value is made in the | |
485 | * transaction. | |
486 | * | |
d1dd721f MH |
487 | * flags -- flags affecting the update, passed to |
488 | * update_ref_lock(). Can be REF_NODEREF, which means that | |
489 | * symbolic references should not be followed. | |
490 | * | |
491 | * msg -- a message describing the change (for the reflog). | |
492 | * | |
493 | * err -- a strbuf for receiving a description of any error that | |
dc72b500 | 494 | * might have occurred. |
d1dd721f MH |
495 | * |
496 | * The functions make internal copies of refname and msg, so the | |
497 | * caller retains ownership of these parameters. | |
498 | * | |
499 | * The functions return 0 on success and non-zero on failure. A | |
500 | * failure means that the transaction as a whole has failed and needs | |
501 | * to be rolled back. | |
caa4046c MH |
502 | */ |
503 | ||
caa4046c | 504 | /* |
16180334 MH |
505 | * Add a reference update to transaction. new_sha1 is the value that |
506 | * the reference should have after the update, or null_sha1 if it | |
507 | * should be deleted. If new_sha1 is NULL, then the reference is not | |
508 | * changed at all. old_sha1 is the value that the reference must have | |
509 | * before the update, or null_sha1 if it must not have existed | |
510 | * beforehand. The old value is checked after the lock is taken to | |
511 | * prevent races. If the old value doesn't agree with old_sha1, the | |
512 | * whole transaction fails. If old_sha1 is NULL, then the previous | |
513 | * value is not checked. | |
514 | * | |
d1dd721f MH |
515 | * See the above comment "Reference transaction updates" for more |
516 | * information. | |
caa4046c | 517 | */ |
8e34800e RS |
518 | int ref_transaction_update(struct ref_transaction *transaction, |
519 | const char *refname, | |
520 | const unsigned char *new_sha1, | |
521 | const unsigned char *old_sha1, | |
1d147bdf | 522 | unsigned int flags, const char *msg, |
8e34800e | 523 | struct strbuf *err); |
caa4046c MH |
524 | |
525 | /* | |
d1dd721f MH |
526 | * Add a reference creation to transaction. new_sha1 is the value that |
527 | * the reference should have after the update; it must not be | |
528 | * null_sha1. It is verified that the reference does not exist | |
caa4046c | 529 | * already. |
d1dd721f MH |
530 | * |
531 | * See the above comment "Reference transaction updates" for more | |
532 | * information. | |
caa4046c | 533 | */ |
b416af5b RS |
534 | int ref_transaction_create(struct ref_transaction *transaction, |
535 | const char *refname, | |
536 | const unsigned char *new_sha1, | |
fec14ec3 | 537 | unsigned int flags, const char *msg, |
b416af5b | 538 | struct strbuf *err); |
caa4046c MH |
539 | |
540 | /* | |
d1dd721f MH |
541 | * Add a reference deletion to transaction. If old_sha1 is non-NULL, |
542 | * then it holds the value that the reference should have had before | |
543 | * the update (which must not be null_sha1). | |
544 | * | |
545 | * See the above comment "Reference transaction updates" for more | |
546 | * information. | |
caa4046c | 547 | */ |
8c8bdc0d RS |
548 | int ref_transaction_delete(struct ref_transaction *transaction, |
549 | const char *refname, | |
550 | const unsigned char *old_sha1, | |
fb5a6bb6 | 551 | unsigned int flags, const char *msg, |
8c8bdc0d | 552 | struct strbuf *err); |
caa4046c | 553 | |
16180334 MH |
554 | /* |
555 | * Verify, within a transaction, that refname has the value old_sha1, | |
556 | * or, if old_sha1 is null_sha1, then verify that the reference | |
d1dd721f MH |
557 | * doesn't exist. old_sha1 must be non-NULL. |
558 | * | |
559 | * See the above comment "Reference transaction updates" for more | |
560 | * information. | |
16180334 MH |
561 | */ |
562 | int ref_transaction_verify(struct ref_transaction *transaction, | |
563 | const char *refname, | |
564 | const unsigned char *old_sha1, | |
565 | unsigned int flags, | |
566 | struct strbuf *err); | |
567 | ||
28e6a97e RS |
568 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
569 | #define TRANSACTION_NAME_CONFLICT -1 | |
570 | /* All other errors. */ | |
571 | #define TRANSACTION_GENERIC_ERROR -2 | |
30173b88 MH |
572 | |
573 | /* | |
574 | * Perform the preparatory stages of commiting `transaction`. Acquire | |
575 | * any needed locks, check preconditions, etc.; basically, do as much | |
576 | * as possible to ensure that the transaction will be able to go | |
577 | * through, stopping just short of making any irrevocable or | |
578 | * user-visible changes. The updates that this function prepares can | |
579 | * be finished up by calling `ref_transaction_commit()` or rolled back | |
580 | * by calling `ref_transaction_abort()`. | |
581 | * | |
582 | * On success, return 0 and leave the transaction in "prepared" state. | |
583 | * On failure, abort the transaction, write an error message to `err`, | |
584 | * and return one of the `TRANSACTION_*` constants. | |
585 | * | |
586 | * Callers who don't need such fine-grained control over commiting | |
587 | * reference transactions should just call `ref_transaction_commit()`. | |
588 | */ | |
589 | int ref_transaction_prepare(struct ref_transaction *transaction, | |
590 | struct strbuf *err); | |
591 | ||
592 | /* | |
593 | * Commit all of the changes that have been queued in transaction, as | |
594 | * atomically as possible. On success, return 0 and leave the | |
595 | * transaction in "closed" state. On failure, roll back the | |
596 | * transaction, write an error message to `err`, and return one of the | |
597 | * `TRANSACTION_*` constants | |
598 | */ | |
caa4046c | 599 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 600 | struct strbuf *err); |
caa4046c | 601 | |
30173b88 MH |
602 | /* |
603 | * Abort `transaction`, which has been begun and possibly prepared, | |
604 | * but not yet committed. | |
605 | */ | |
606 | int ref_transaction_abort(struct ref_transaction *transaction, | |
607 | struct strbuf *err); | |
608 | ||
58f233ce MH |
609 | /* |
610 | * Like ref_transaction_commit(), but optimized for creating | |
611 | * references when originally initializing a repository (e.g., by "git | |
612 | * clone"). It writes the new references directly to packed-refs | |
613 | * without locking the individual references. | |
614 | * | |
615 | * It is a bug to call this function when there might be other | |
616 | * processes accessing the repository or if there are existing | |
617 | * references that might conflict with the ones being created. All | |
618 | * old_sha1 values must either be absent or NULL_SHA1. | |
619 | */ | |
620 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
621 | struct strbuf *err); | |
622 | ||
026bd1d3 | 623 | /* |
30173b88 | 624 | * Free `*transaction` and all associated data. |
026bd1d3 RS |
625 | */ |
626 | void ref_transaction_free(struct ref_transaction *transaction); | |
627 | ||
4b7b520b MH |
628 | /** |
629 | * Lock, update, and unlock a single reference. This function | |
630 | * basically does a transaction containing a single call to | |
631 | * ref_transaction_update(). The parameters to this function have the | |
632 | * same meaning as the corresponding parameters to | |
633 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
634 | * argument. | |
635 | */ | |
c0fe4e8b NTND |
636 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, |
637 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
638 | unsigned int flags, enum action_on_err onerr); | |
4b7b520b MH |
639 | int update_ref(const char *msg, const char *refname, |
640 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
fec14ec3 | 641 | unsigned int flags, enum action_on_err onerr); |
8f6dc7e3 | 642 | int update_ref_oid(const char *msg, const char *refname, |
643 | const struct object_id *new_oid, const struct object_id *old_oid, | |
644 | unsigned int flags, enum action_on_err onerr); | |
3d9f037c | 645 | |
1354c9b2 | 646 | int parse_hide_refs_config(const char *var, const char *value, const char *); |
fb58c8d5 | 647 | |
78a766ab LF |
648 | /* |
649 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
650 | * the second parameter point to the full ref name. If a namespace is set and | |
651 | * the ref is inside that namespace, the first parameter is a pointer to the | |
652 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
653 | * the ref is outside that namespace, the first parameter is NULL. The second | |
654 | * parameter always points to the full ref name. | |
655 | */ | |
1354c9b2 | 656 | int ref_is_hidden(const char *, const char *); |
daebaa78 | 657 | |
266b1827 DT |
658 | enum ref_type { |
659 | REF_TYPE_PER_WORKTREE, | |
660 | REF_TYPE_PSEUDOREF, | |
661 | REF_TYPE_NORMAL, | |
662 | }; | |
663 | ||
664 | enum ref_type ref_type(const char *refname); | |
665 | ||
fa5b1830 MH |
666 | enum expire_reflog_flags { |
667 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
668 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
669 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
670 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
671 | }; | |
672 | ||
673 | /* | |
674 | * The following interface is used for reflog expiration. The caller | |
675 | * calls reflog_expire(), supplying it with three callback functions, | |
676 | * of the following types. The callback functions define the | |
677 | * expiration policy that is desired. | |
678 | * | |
679 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
680 | * locked. | |
681 | * | |
682 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
683 | * existing reflog. It should return true iff that entry should be | |
684 | * pruned. | |
685 | * | |
686 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
687 | * unlocked again. | |
688 | */ | |
689 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
4322478a | 690 | const struct object_id *oid, |
fa5b1830 | 691 | void *cb_data); |
4322478a | 692 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, |
693 | struct object_id *noid, | |
fa5b1830 | 694 | const char *email, |
dddbad72 | 695 | timestamp_t timestamp, int tz, |
fa5b1830 MH |
696 | const char *message, void *cb_data); |
697 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
698 | ||
699 | /* | |
700 | * Expire reflog entries for the specified reference. sha1 is the old | |
701 | * value of the reference. flags is a combination of the constants in | |
702 | * enum expire_reflog_flags. The three function pointers are described | |
703 | * above. On success, return zero. | |
704 | */ | |
7d2df051 NTND |
705 | int refs_reflog_expire(struct ref_store *refs, |
706 | const char *refname, | |
707 | const unsigned char *sha1, | |
708 | unsigned int flags, | |
709 | reflog_expiry_prepare_fn prepare_fn, | |
710 | reflog_expiry_should_prune_fn should_prune_fn, | |
711 | reflog_expiry_cleanup_fn cleanup_fn, | |
712 | void *policy_cb_data); | |
1354c9b2 MH |
713 | int reflog_expire(const char *refname, const unsigned char *sha1, |
714 | unsigned int flags, | |
715 | reflog_expiry_prepare_fn prepare_fn, | |
716 | reflog_expiry_should_prune_fn should_prune_fn, | |
717 | reflog_expiry_cleanup_fn cleanup_fn, | |
718 | void *policy_cb_data); | |
fa5b1830 | 719 | |
3dce444f RS |
720 | int ref_storage_backend_exists(const char *name); |
721 | ||
077be78d | 722 | struct ref_store *get_main_ref_store(void); |
18d0002d NTND |
723 | /* |
724 | * Return the ref_store instance for the specified submodule. For the | |
725 | * main repository, use submodule==NULL; such a call cannot fail. For | |
726 | * a submodule, the submodule must exist and be a nonbare repository, | |
727 | * otherwise return NULL. If the requested reference store has not yet | |
728 | * been initialized, initialize it first. | |
729 | * | |
730 | * For backwards compatibility, submodule=="" is treated the same as | |
731 | * submodule==NULL. | |
732 | */ | |
733 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
17eff96b | 734 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); |
077be78d | 735 | |
95fc7512 | 736 | #endif /* REFS_H */ |