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