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