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