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