blob: 2727405b61c4e26538c3e76b528df37078337376 [file] [log] [blame]
Daniel Barkalow95fc7512005-06-06 16:31:29 -04001#ifndef REFS_H
2#define REFS_H
3
Nguyễn Thái Ngọc Duy504c4d42017-03-18 09:03:11 +07004struct object_id;
Nguyễn Thái Ngọc Duy077be782017-03-26 09:42:29 +07005struct ref_store;
Elijah Newrenef3ca952018-08-15 10:54:05 -07006struct repository;
Nguyễn Thái Ngọc Duy504c4d42017-03-18 09:03:11 +07007struct strbuf;
8struct string_list;
Elijah Newrenef3ca952018-08-15 10:54:05 -07009struct string_list_item;
Nguyễn Thái Ngọc Duy17eff962017-04-24 17:01:22 +070010struct worktree;
Nguyễn Thái Ngọc Duy504c4d42017-03-18 09:03:11 +070011
Ronnie Sahlbergb416af52014-04-16 15:26:44 -070012/*
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020013 * Resolve a reference, recursively following symbolic refererences.
14 *
René Scharfe54fad662017-09-23 11:41:45 +020015 * 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 *
brian m. carlson49e61472017-10-15 22:07:09 +000019 * If oid is non-NULL, store the referred-to object's name in it.
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020020 *
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 *
brian m. carlson49e61472017-10-15 22:07:09 +000026 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020027 * 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
brian m. carlson49e61472017-10-15 22:07:09 +000033 * 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
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020035 * 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
brian m. carlson49e61472017-10-15 22:07:09 +000051 * is bad then the value stored in oid will be null_oid and the two
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020052 * 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
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +070064const char *refs_resolve_ref_unsafe(struct ref_store *refs,
65 const char *refname,
66 int resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +000067 struct object_id *oid,
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +070068 int *flags);
Michael Haggerty1354c9b2016-03-31 06:19:22 +020069const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +000070 struct object_id *oid, int *flags);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020071
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +070072char *refs_resolve_refdup(struct ref_store *refs,
73 const char *refname, int resolve_flags,
brian m. carlson0f2dc722017-10-15 22:06:55 +000074 struct object_id *oid, int *flags);
Michael Haggerty1354c9b2016-03-31 06:19:22 +020075char *resolve_refdup(const char *refname, int resolve_flags,
brian m. carlson0f2dc722017-10-15 22:06:55 +000076 struct object_id *oid, int *flags);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020077
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +070078int refs_read_ref_full(struct ref_store *refs, const char *refname,
brian m. carlson34c290a2017-10-15 22:06:56 +000079 int resolve_flags, struct object_id *oid, int *flags);
Michael Haggerty1354c9b2016-03-31 06:19:22 +020080int read_ref_full(const char *refname, int resolve_flags,
brian m. carlson34c290a2017-10-15 22:06:56 +000081 struct object_id *oid, int *flags);
82int read_ref(const char *refname, struct object_id *oid);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +020083
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +070084/*
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,
Michael Haggertyb05855b2017-04-16 08:41:26 +0200104 const struct string_list *extras,
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700105 const struct string_list *skip,
106 struct strbuf *err);
107
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200108int ref_exists(const char *refname);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200109
Cornelius Weig341fb282017-01-27 11:09:47 +0100110int should_autocreate_reflog(const char *refname);
111
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200112int is_branch(const char *refname);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200113
Denton Liu55454422019-04-29 04:28:14 -0400114int refs_init_db(struct strbuf *err);
David Turner6fb5acf2016-09-04 18:08:41 +0200115
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200116/*
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,
brian m. carlsonb420d902017-10-15 22:07:02 +0000119 * 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.
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200121 * Symbolic references are considered unpeelable, even if they
122 * ultimately resolve to a peelable tag.
123 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700124int refs_peel_ref(struct ref_store *refs, const char *refname,
brian m. carlsonb420d902017-10-15 22:07:02 +0000125 struct object_id *oid);
126int peel_ref(const char *refname, struct object_id *oid);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200127
128/**
Michael Haggertya8355bb2016-09-04 18:08:24 +0200129 * Resolve refname in the nested "gitlink" repository in the specified
130 * submodule (which must be non-NULL). If the resolution is
Michael Haggerty78fb4572017-11-05 09:42:09 +0100131 * successful, return 0 and set oid to the name of the object;
Michael Haggertya8355bb2016-09-04 18:08:24 +0200132 * otherwise, return a non-zero value.
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200133 */
Michael Haggertya8355bb2016-09-04 18:08:24 +0200134int resolve_gitlink_ref(const char *submodule, const char *refname,
brian m. carlsona98e6102017-10-15 22:07:07 +0000135 struct object_id *oid);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200136
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 */
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200142int refname_match(const char *abbrev_name, const char *full_name);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200143
Brandon Williamsb4be7412018-03-15 10:31:24 -0700144/*
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
Nguyễn Thái Ngọc Duy0b1dbf52019-04-06 18:34:27 +0700151int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
Nguyễn Thái Ngọc Duyd8984c52019-04-06 18:34:28 +0700152int repo_dwim_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
Nguyễn Thái Ngọc Duy56700902019-04-06 18:34:29 +0700153int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
brian m. carlsoncca5fa62017-10-15 22:06:57 +0000154int dwim_ref(const char *str, int len, struct object_id *oid, char **ref);
brian m. carlson334dc522017-10-15 22:06:59 +0000155int dwim_log(const char *str, int len, struct object_id *oid, char **ref);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200156
157/*
Michael Haggerty30173b82017-05-22 16:17:44 +0200158 * A ref_transaction represents a collection of reference updates that
159 * should succeed or fail together.
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700160 *
161 * Calling sequence
162 * ----------------
Michael Haggerty30173b82017-05-22 16:17:44 +0200163 *
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700164 * - Allocate and initialize a `struct ref_transaction` by calling
165 * `ref_transaction_begin()`.
166 *
Michael Haggerty30173b82017-05-22 16:17:44 +0200167 * - 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()`
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700173 *
Michael Haggerty30173b82017-05-22 16:17:44 +0200174 * - Then either:
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700175 *
Michael Haggerty30173b82017-05-22 16:17:44 +0200176 * - 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.
David Turner49386862016-02-25 15:05:46 -0500183 *
Michael Haggerty30173b82017-05-22 16:17:44 +0200184 * - 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;
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700223 *
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.
David Turner49386862016-02-25 15:05:46 -0500234 *
235 * Caveats
236 * -------
237 *
238 * Note that no locks are taken, and no refs are read, until
Michael Haggerty30173b82017-05-22 16:17:44 +0200239 * `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.
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700242 */
Michael Haggertycaa40462014-04-07 15:48:10 +0200243struct ref_transaction;
244
Michael Haggerty89df9c82013-04-14 14:54:16 +0200245/*
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200246 * 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:
Michael Haggerty89df9c82013-04-14 14:54:16 +0200249 */
250
251/* Reference is a symbolic reference. */
Junio C Hamano98ac34b2011-10-19 13:45:50 -0700252#define REF_ISSYMREF 0x01
Michael Haggerty89df9c82013-04-14 14:54:16 +0200253
254/* Reference is a packed reference. */
Junio C Hamano98ac34b2011-10-19 13:45:50 -0700255#define REF_ISPACKED 0x02
Michael Haggerty89df9c82013-04-14 14:54:16 +0200256
257/*
258 * Reference cannot be resolved to an object name: dangling symbolic
Ronnie Sahlbergd0f810f2014-09-03 11:45:43 -0700259 * reference (directly or indirectly), corrupt reference file,
260 * reference exists but name is bad, or symbolic reference refers to
261 * ill-formatted reference name.
Michael Haggerty89df9c82013-04-14 14:54:16 +0200262 */
Junio C Hamano98ac34b2011-10-19 13:45:50 -0700263#define REF_ISBROKEN 0x04
Junio C Hamanof4204ab2006-11-21 23:36:35 -0800264
Linus Torvalds8a65ff72005-07-02 20:23:36 -0700265/*
Ronnie Sahlbergd0f810f2014-09-03 11:45:43 -0700266 * 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
272/*
Michael Haggerty4f78c242013-05-25 11:08:24 +0200273 * The signature for the callback function for the for_each_*()
Michael Haggerty78fb4572017-11-05 09:42:09 +0100274 * functions below. The memory pointed to by the refname and oid
Michael Haggerty4f78c242013-05-25 11:08:24 +0200275 * arguments is only guaranteed to be valid for the duration of a
276 * single callback invocation.
Linus Torvalds8a65ff72005-07-02 20:23:36 -0700277 */
Michael Haggerty4f78c242013-05-25 11:08:24 +0200278typedef int each_ref_fn(const char *refname,
Michael Haggerty2b2a5be2015-05-25 18:38:28 +0000279 const struct object_id *oid, int flags, void *cb_data);
280
Michael Haggerty4f78c242013-05-25 11:08:24 +0200281/*
Stefan Beller4a6067c2018-08-20 18:24:16 +0000282 * 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
291/*
Michael Haggerty4f78c242013-05-25 11:08:24 +0200292 * 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
Nguyễn Thái Ngọc Duyadac8112017-03-26 09:42:41 +0700298 * stop the iteration. Returned references are sorted.
Michael Haggerty4f78c242013-05-25 11:08:24 +0200299 */
Nguyễn Thái Ngọc Duy62f0b392017-08-23 19:36:55 +0700300int refs_head_ref(struct ref_store *refs,
301 each_ref_fn fn, void *cb_data);
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700302int 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
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200313int 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);
Nguyễn Thái Ngọc Duy073cf632017-08-23 19:36:56 +0700316int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
317 each_ref_fn fn, void *cb_data,
318 unsigned int broken);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200319int 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);
Stefan Beller212e0f72018-08-20 18:24:19 +0000324int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200325int 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);
Linus Torvalds8a65ff72005-07-02 20:23:36 -0700328
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200329int head_ref_namespaced(each_ref_fn fn, void *cb_data);
330int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
Josh Tripletta1bea2c2011-07-05 10:54:44 -0700331
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200332/* can be used to learn about broken ref and symref */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700333int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200334int for_each_rawref(each_ref_fn fn, void *cb_data);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200335
Rafael Ascensão65516f52017-11-21 21:33:41 +0000336/*
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
Thomas Rast894a9d32010-03-12 18:04:26 +0100360static inline const char *has_glob_specials(const char *pattern)
361{
362 return strpbrk(pattern, "?*[");
363}
364
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200365void 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);
Junio C Hamanof8948e22009-02-08 23:27:10 -0800368
Daniel Barkalowe142a3c2008-04-27 13:39:24 -0400369/*
Michael Haggerty32d462c2013-04-22 21:52:32 +0200370 * 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 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700381int refs_pack_refs(struct ref_store *refs, unsigned int flags);
Michael Haggerty32d462c2013-04-22 21:52:32 +0200382
Ronnie Sahlberg835e3c92014-06-20 07:42:51 -0700383/*
David Turnera4c653d2015-07-21 17:04:50 -0400384 * Setup reflog before using. Fill in err and return -1 on failure.
Ronnie Sahlbergbd3b02d2014-06-20 07:42:50 -0700385 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700386int refs_create_reflog(struct ref_store *refs, const char *refname,
387 int force_create, struct strbuf *err);
David Turnerabd0cd32015-07-21 17:04:52 -0400388int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
Erick Mattos859c3012010-05-21 21:28:36 -0300389
Shawn Pearced556fae2006-05-17 05:56:09 -0400390/** Reads log for the value of ref during at_time. **/
Nguyễn Thái Ngọc Duy7fdff472019-04-06 18:34:30 +0700391int read_ref_at(struct ref_store *refs,
392 const char *refname, unsigned int flags,
Johannes Schindelindddbad72017-04-26 21:29:31 +0200393 timestamp_t at_time, int cnt,
brian m. carlson8eb36d92017-10-15 22:07:03 +0000394 struct object_id *oid, char **msg,
Johannes Schindelindddbad72017-04-26 21:29:31 +0200395 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
Shawn Pearced556fae2006-05-17 05:56:09 -0400396
Ronnie Sahlberg4da58832014-05-06 15:45:52 -0700397/** Check if a particular reflog exists */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700398int refs_reflog_exists(struct ref_store *refs, const char *refname);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200399int reflog_exists(const char *refname);
Ronnie Sahlberg4da58832014-05-06 15:45:52 -0700400
Michael Haggertyfc1c2162015-06-22 16:02:52 +0200401/*
brian m. carlson2616a5e2017-10-15 22:06:50 +0000402 * Delete the specified reference. If old_oid is non-NULL, then
Michael Haggerty78fb4572017-11-05 09:42:09 +0100403 * verify that the current value of the reference is old_oid before
brian m. carlson2616a5e2017-10-15 22:06:50 +0000404 * 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
Michael Haggerty64da4192017-05-22 16:17:38 +0200407 * ref_transaction_delete().
Michael Haggertyfc1c2162015-06-22 16:02:52 +0200408 */
Nguyễn Thái Ngọc Duyc0fe4e82017-03-26 09:42:35 +0700409int refs_delete_ref(struct ref_store *refs, const char *msg,
410 const char *refname,
brian m. carlson2616a5e2017-10-15 22:06:50 +0000411 const struct object_id *old_oid,
Nguyễn Thái Ngọc Duyc0fe4e82017-03-26 09:42:35 +0700412 unsigned int flags);
Kyle Meyer755b49a2017-02-20 20:10:32 -0500413int delete_ref(const char *msg, const char *refname,
brian m. carlson2616a5e2017-10-15 22:06:50 +0000414 const struct object_id *old_oid, unsigned int flags);
Michael Haggertyfc1c2162015-06-22 16:02:52 +0200415
Michael Haggerty98ffd5f2015-06-22 16:02:55 +0200416/*
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
Michael Haggerty64da4192017-05-22 16:17:38 +0200419 * an all-or-nothing transaction). msg and flags are passed through to
Michael Haggertyc5f04dd2016-06-18 06:15:10 +0200420 * ref_transaction_delete().
Michael Haggerty98ffd5f2015-06-22 16:02:55 +0200421 */
Michael Haggerty64da4192017-05-22 16:17:38 +0200422int 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);
Michael Haggerty98ffd5f2015-06-22 16:02:55 +0200426
Ronnie Sahlberg4da58832014-05-06 15:45:52 -0700427/** Delete a reflog */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700428int refs_delete_reflog(struct ref_store *refs, const char *refname);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200429int delete_reflog(const char *refname);
Ronnie Sahlberg4da58832014-05-06 15:45:52 -0700430
Junio C Hamano2ff81662006-12-18 01:18:16 -0800431/* iterate over reflog entries */
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200432typedef int each_reflog_ent_fn(
brian m. carlson9461d272017-02-21 23:47:32 +0000433 struct object_id *old_oid, struct object_id *new_oid,
Johannes Schindelindddbad72017-04-26 21:29:31 +0200434 const char *committer, timestamp_t timestamp,
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200435 int tz, const char *msg, void *cb_data);
436
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700437int 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);
Michael Haggertydfefa932011-12-12 06:38:09 +0100443int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
Junio C Hamano98f85ff2013-03-08 13:27:37 -0800444int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
Junio C Hamano2ff81662006-12-18 01:18:16 -0800445
Nicolas Pitreeb8381c2007-02-03 13:25:43 -0500446/*
447 * Calls the specified function for each reflog file until it returns nonzero,
Nguyễn Thái Ngọc Duyadac8112017-03-26 09:42:41 +0700448 * and returns the value. Reflog file order is unspecified.
Nicolas Pitreeb8381c2007-02-03 13:25:43 -0500449 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700450int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200451int for_each_reflog(each_ref_fn fn, void *cb_data);
Nicolas Pitreeb8381c2007-02-03 13:25:43 -0500452
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200453#define REFNAME_ALLOW_ONELEVEL 1
454#define REFNAME_REFSPEC_PATTERN 2
455
456/*
Michael Haggertydfefa932011-12-12 06:38:09 +0100457 * 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
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200460 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
Jacob Kellercd377f42015-07-22 14:05:33 -0700461 * allow a single "*" wildcard character in the refspec. No leading or
462 * repeated slashes are accepted.
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200463 */
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200464int check_refname_format(const char *refname, int flags);
Daniel Barkalow95fc7512005-06-06 16:31:29 -0400465
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200466const char *prettify_refname(const char *refname);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200467
Nguyễn Thái Ngọc Duy546edf32019-04-06 18:34:25 +0700468char *refs_shorten_unambiguous_ref(struct ref_store *refs,
469 const char *refname, int strict);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200470char *shorten_unambiguous_ref(const char *refname, int strict);
Daniel Barkalowa9c37a72009-03-08 21:06:05 -0400471
Lars Hjemlic976d412006-11-28 15:47:40 +0100472/** rename ref, return 0 on success **/
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700473int refs_rename_ref(struct ref_store *refs, const char *oldref,
474 const char *newref, const char *logmsg);
Sahil Dua52d59cc2017-06-18 23:19:16 +0200475int rename_ref(const char *oldref, const char *newref,
476 const char *logmsg);
477
478/** copy ref, return 0 on success **/
479int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
480 const char *newref, const char *logmsg);
481int copy_existing_ref(const char *oldref, const char *newref,
482 const char *logmsg);
Lars Hjemlic976d412006-11-28 15:47:40 +0100483
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700484int refs_create_symref(struct ref_store *refs, const char *refname,
485 const char *target, const char *logmsg);
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200486int create_symref(const char *refname, const char *target, const char *logmsg);
Linus Torvalds0ebde322007-04-09 21:14:26 -0700487
Michael Haggertyf4124112014-04-07 15:47:56 +0200488enum action_on_err {
489 UPDATE_REFS_MSG_ON_ERR,
490 UPDATE_REFS_DIE_ON_ERR,
491 UPDATE_REFS_QUIET_ON_ERR
492};
493
Michael Haggertycaa40462014-04-07 15:48:10 +0200494/*
495 * Begin a reference transaction. The reference transaction must
Ronnie Sahlberg33f9fc52014-06-20 07:42:43 -0700496 * be freed by calling ref_transaction_free().
Michael Haggertycaa40462014-04-07 15:48:10 +0200497 */
Nguyễn Thái Ngọc Duyc0fe4e82017-03-26 09:42:35 +0700498struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
499 struct strbuf *err);
Ronnie Sahlberg93a644e2014-05-19 10:42:34 -0700500struct ref_transaction *ref_transaction_begin(struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200501
502/*
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100503 * Reference transaction updates
504 *
505 * The following four functions add a reference check or update to a
506 * ref_transaction. They have some common similar parameters:
507 *
508 * transaction -- a pointer to an open ref_transaction, obtained
509 * from ref_transaction_begin().
510 *
511 * refname -- the name of the reference to be affected.
512 *
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100513 * new_oid -- the object ID that should be set to be the new value
514 * of the reference. Some functions allow this parameter to be
Michael Haggertyfd2ce9c2017-05-22 16:17:32 +0200515 * NULL, meaning that the reference is not changed, or
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100516 * null_oid, meaning that the reference should be deleted. A
Michael Haggertyfd2ce9c2017-05-22 16:17:32 +0200517 * copy of this value is made in the transaction.
518 *
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100519 * old_oid -- the object ID that the reference must have before
Michael Haggertyfd2ce9c2017-05-22 16:17:32 +0200520 * the update. Some functions allow this parameter to be NULL,
521 * meaning that the old value of the reference is not checked,
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100522 * or null_oid, meaning that the reference must not exist
Michael Haggertyfd2ce9c2017-05-22 16:17:32 +0200523 * before the update. A copy of this value is made in the
524 * transaction.
525 *
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100526 * flags -- flags affecting the update, passed to
Michael Haggerty91774af2017-11-05 09:42:06 +0100527 * update_ref_lock(). Possible flags: REF_NO_DEREF,
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100528 * REF_FORCE_CREATE_REFLOG. See those constants for more
529 * information.
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100530 *
531 * msg -- a message describing the change (for the reflog).
532 *
533 * err -- a strbuf for receiving a description of any error that
Peter Colbergdc72b502016-06-10 15:05:26 -0400534 * might have occurred.
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100535 *
536 * The functions make internal copies of refname and msg, so the
537 * caller retains ownership of these parameters.
538 *
539 * The functions return 0 on success and non-zero on failure. A
540 * failure means that the transaction as a whole has failed and needs
541 * to be rolled back.
Michael Haggertycaa40462014-04-07 15:48:10 +0200542 */
543
Michael Haggertycaa40462014-04-07 15:48:10 +0200544/*
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100545 * The following flags can be passed to ref_transaction_update() etc.
546 * Internally, they are stored in `ref_update::flags`, along with some
547 * internal flags.
548 */
549
550/*
551 * Act on the ref directly; i.e., without dereferencing symbolic refs.
552 * If this flag is not specified, then symbolic references are
553 * dereferenced and the update is applied to the referent.
554 */
Michael Haggerty91774af2017-11-05 09:42:06 +0100555#define REF_NO_DEREF (1 << 0)
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100556
557/*
558 * Force the creation of a reflog for this reference, even if it
559 * didn't previously have a reflog.
560 */
561#define REF_FORCE_CREATE_REFLOG (1 << 1)
562
563/*
564 * Bitmask of all of the flags that are allowed to be passed in to
565 * ref_transaction_update() and friends:
566 */
567#define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
Michael Haggerty91774af2017-11-05 09:42:06 +0100568 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG)
Michael Haggerty5ac95fe2017-11-05 09:42:05 +0100569
570/*
571 * Add a reference update to transaction. `new_oid` is the value that
572 * the reference should have after the update, or `null_oid` if it
573 * should be deleted. If `new_oid` is NULL, then the reference is not
574 * changed at all. `old_oid` is the value that the reference must have
575 * before the update, or `null_oid` if it must not have existed
Michael Haggerty16180332015-02-17 18:00:21 +0100576 * beforehand. The old value is checked after the lock is taken to
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000577 * prevent races. If the old value doesn't agree with old_oid, the
578 * whole transaction fails. If old_oid is NULL, then the previous
Michael Haggerty16180332015-02-17 18:00:21 +0100579 * value is not checked.
580 *
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100581 * See the above comment "Reference transaction updates" for more
582 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200583 */
Ronnie Sahlberg8e348002014-06-20 07:43:00 -0700584int ref_transaction_update(struct ref_transaction *transaction,
585 const char *refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000586 const struct object_id *new_oid,
587 const struct object_id *old_oid,
Michael Haggerty1d147bd2015-02-17 18:00:15 +0100588 unsigned int flags, const char *msg,
Ronnie Sahlberg8e348002014-06-20 07:43:00 -0700589 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200590
591/*
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000592 * Add a reference creation to transaction. new_oid is the value that
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100593 * the reference should have after the update; it must not be
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000594 * null_oid. It is verified that the reference does not exist
Michael Haggertycaa40462014-04-07 15:48:10 +0200595 * already.
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100596 *
597 * See the above comment "Reference transaction updates" for more
598 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200599 */
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700600int ref_transaction_create(struct ref_transaction *transaction,
601 const char *refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000602 const struct object_id *new_oid,
Michael Haggertyfec14ec2015-02-17 18:00:13 +0100603 unsigned int flags, const char *msg,
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700604 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200605
606/*
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000607 * Add a reference deletion to transaction. If old_oid is non-NULL,
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100608 * then it holds the value that the reference should have had before
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000609 * the update (which must not be null_oid).
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100610 *
611 * See the above comment "Reference transaction updates" for more
612 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200613 */
Ronnie Sahlberg8c8bdc02014-04-16 15:27:45 -0700614int ref_transaction_delete(struct ref_transaction *transaction,
615 const char *refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000616 const struct object_id *old_oid,
Michael Haggertyfb5a6bb2015-02-17 18:00:16 +0100617 unsigned int flags, const char *msg,
Ronnie Sahlberg8c8bdc02014-04-16 15:27:45 -0700618 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200619
620/*
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000621 * Verify, within a transaction, that refname has the value old_oid,
622 * or, if old_oid is null_oid, then verify that the reference
623 * doesn't exist. old_oid must be non-NULL.
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100624 *
625 * See the above comment "Reference transaction updates" for more
626 * information.
Michael Haggerty16180332015-02-17 18:00:21 +0100627 */
628int ref_transaction_verify(struct ref_transaction *transaction,
629 const char *refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000630 const struct object_id *old_oid,
Michael Haggerty16180332015-02-17 18:00:21 +0100631 unsigned int flags,
632 struct strbuf *err);
633
Ronnie Sahlberg28e6a972014-05-16 14:14:38 -0700634/* Naming conflict (for example, the ref names A and A/B conflict). */
635#define TRANSACTION_NAME_CONFLICT -1
636/* All other errors. */
637#define TRANSACTION_GENERIC_ERROR -2
Michael Haggerty30173b82017-05-22 16:17:44 +0200638
639/*
Ville Skyttä64127572017-06-25 13:20:41 +0300640 * Perform the preparatory stages of committing `transaction`. Acquire
Michael Haggerty30173b82017-05-22 16:17:44 +0200641 * any needed locks, check preconditions, etc.; basically, do as much
642 * as possible to ensure that the transaction will be able to go
643 * through, stopping just short of making any irrevocable or
644 * user-visible changes. The updates that this function prepares can
645 * be finished up by calling `ref_transaction_commit()` or rolled back
646 * by calling `ref_transaction_abort()`.
647 *
648 * On success, return 0 and leave the transaction in "prepared" state.
649 * On failure, abort the transaction, write an error message to `err`,
650 * and return one of the `TRANSACTION_*` constants.
651 *
Ville Skyttä64127572017-06-25 13:20:41 +0300652 * Callers who don't need such fine-grained control over committing
Michael Haggerty30173b82017-05-22 16:17:44 +0200653 * reference transactions should just call `ref_transaction_commit()`.
654 */
655int ref_transaction_prepare(struct ref_transaction *transaction,
656 struct strbuf *err);
657
658/*
659 * Commit all of the changes that have been queued in transaction, as
660 * atomically as possible. On success, return 0 and leave the
661 * transaction in "closed" state. On failure, roll back the
662 * transaction, write an error message to `err`, and return one of the
663 * `TRANSACTION_*` constants
664 */
Michael Haggertycaa40462014-04-07 15:48:10 +0200665int ref_transaction_commit(struct ref_transaction *transaction,
Ronnie Sahlbergdb7516a2014-04-30 12:22:42 -0700666 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200667
Ronnie Sahlberg026bd1d2014-06-20 07:42:42 -0700668/*
Michael Haggerty30173b82017-05-22 16:17:44 +0200669 * Abort `transaction`, which has been begun and possibly prepared,
670 * but not yet committed.
671 */
672int ref_transaction_abort(struct ref_transaction *transaction,
673 struct strbuf *err);
674
675/*
Michael Haggerty58f233c2015-06-22 16:03:01 +0200676 * Like ref_transaction_commit(), but optimized for creating
677 * references when originally initializing a repository (e.g., by "git
678 * clone"). It writes the new references directly to packed-refs
679 * without locking the individual references.
680 *
681 * It is a bug to call this function when there might be other
682 * processes accessing the repository or if there are existing
683 * references that might conflict with the ones being created. All
Michael Haggerty78fb4572017-11-05 09:42:09 +0100684 * old_oid values must either be absent or null_oid.
Michael Haggerty58f233c2015-06-22 16:03:01 +0200685 */
686int initial_ref_transaction_commit(struct ref_transaction *transaction,
687 struct strbuf *err);
688
689/*
Michael Haggerty30173b82017-05-22 16:17:44 +0200690 * Free `*transaction` and all associated data.
Ronnie Sahlberg026bd1d2014-06-20 07:42:42 -0700691 */
692void ref_transaction_free(struct ref_transaction *transaction);
693
Michael Haggerty4b7b5202015-02-17 18:00:22 +0100694/**
695 * Lock, update, and unlock a single reference. This function
696 * basically does a transaction containing a single call to
697 * ref_transaction_update(). The parameters to this function have the
698 * same meaning as the corresponding parameters to
699 * ref_transaction_update(). Handle errors as requested by the `onerr`
700 * argument.
701 */
Nguyễn Thái Ngọc Duyc0fe4e82017-03-26 09:42:35 +0700702int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,
brian m. carlsonae077772017-10-15 22:06:51 +0000703 const struct object_id *new_oid, const struct object_id *old_oid,
Nguyễn Thái Ngọc Duyc0fe4e82017-03-26 09:42:35 +0700704 unsigned int flags, enum action_on_err onerr);
Michael Haggerty4b7b5202015-02-17 18:00:22 +0100705int update_ref(const char *msg, const char *refname,
brian m. carlson8f6dc7e2016-09-05 20:08:08 +0000706 const struct object_id *new_oid, const struct object_id *old_oid,
707 unsigned int flags, enum action_on_err onerr);
Carlos Rica3d9f0372007-09-05 03:38:24 +0200708
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200709int parse_hide_refs_config(const char *var, const char *value, const char *);
Michael Haggertyfb58c8d2015-06-22 16:03:05 +0200710
Lukas Fleischer78a766a2015-11-03 08:58:16 +0100711/*
712 * Check whether a ref is hidden. If no namespace is set, both the first and
713 * the second parameter point to the full ref name. If a namespace is set and
714 * the ref is inside that namespace, the first parameter is a pointer to the
715 * name of the ref with the namespace prefix removed. If a namespace is set and
716 * the ref is outside that namespace, the first parameter is NULL. The second
717 * parameter always points to the full ref name.
718 */
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200719int ref_is_hidden(const char *, const char *);
Junio C Hamanodaebaa72013-01-18 16:08:30 -0800720
David Turner266b1822015-07-31 02:06:18 -0400721enum ref_type {
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200722 REF_TYPE_PER_WORKTREE, /* refs inside refs/ but not shared */
723 REF_TYPE_PSEUDOREF, /* refs outside refs/ in current worktree */
724 REF_TYPE_MAIN_PSEUDOREF, /* pseudo refs from the main worktree */
725 REF_TYPE_OTHER_PSEUDOREF, /* pseudo refs from other worktrees */
726 REF_TYPE_NORMAL, /* normal/shared refs inside refs/ */
David Turner266b1822015-07-31 02:06:18 -0400727};
728
729enum ref_type ref_type(const char *refname);
730
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100731enum expire_reflog_flags {
732 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
733 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
734 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
735 EXPIRE_REFLOGS_REWRITE = 1 << 3
736};
737
738/*
739 * The following interface is used for reflog expiration. The caller
740 * calls reflog_expire(), supplying it with three callback functions,
741 * of the following types. The callback functions define the
742 * expiration policy that is desired.
743 *
744 * reflog_expiry_prepare_fn -- Called once after the reference is
745 * locked.
746 *
747 * reflog_expiry_should_prune_fn -- Called once for each entry in the
748 * existing reflog. It should return true iff that entry should be
749 * pruned.
750 *
751 * reflog_expiry_cleanup_fn -- Called once before the reference is
752 * unlocked again.
753 */
754typedef void reflog_expiry_prepare_fn(const char *refname,
brian m. carlson43224782017-05-06 22:10:00 +0000755 const struct object_id *oid,
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100756 void *cb_data);
brian m. carlson43224782017-05-06 22:10:00 +0000757typedef int reflog_expiry_should_prune_fn(struct object_id *ooid,
758 struct object_id *noid,
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100759 const char *email,
Johannes Schindelindddbad72017-04-26 21:29:31 +0200760 timestamp_t timestamp, int tz,
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100761 const char *message, void *cb_data);
762typedef void reflog_expiry_cleanup_fn(void *cb_data);
763
764/*
brian m. carlson0155f712017-10-15 22:07:04 +0000765 * Expire reflog entries for the specified reference. oid is the old
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100766 * value of the reference. flags is a combination of the constants in
767 * enum expire_reflog_flags. The three function pointers are described
768 * above. On success, return zero.
769 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700770int refs_reflog_expire(struct ref_store *refs,
771 const char *refname,
brian m. carlson0155f712017-10-15 22:07:04 +0000772 const struct object_id *oid,
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700773 unsigned int flags,
774 reflog_expiry_prepare_fn prepare_fn,
775 reflog_expiry_should_prune_fn should_prune_fn,
776 reflog_expiry_cleanup_fn cleanup_fn,
777 void *policy_cb_data);
brian m. carlson0155f712017-10-15 22:07:04 +0000778int reflog_expire(const char *refname, const struct object_id *oid,
Michael Haggerty1354c9b2016-03-31 06:19:22 +0200779 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);
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100784
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +0200785int ref_storage_backend_exists(const char *name);
786
Stefan Beller64a74162018-04-11 17:21:14 -0700787struct ref_store *get_main_ref_store(struct repository *r);
Nguyễn Thái Ngọc Duy18d00022017-03-26 09:42:33 +0700788/*
789 * Return the ref_store instance for the specified submodule. For the
790 * main repository, use submodule==NULL; such a call cannot fail. For
791 * a submodule, the submodule must exist and be a nonbare repository,
792 * otherwise return NULL. If the requested reference store has not yet
793 * been initialized, initialize it first.
794 *
795 * For backwards compatibility, submodule=="" is treated the same as
796 * submodule==NULL.
797 */
798struct ref_store *get_submodule_ref_store(const char *submodule);
Nguyễn Thái Ngọc Duy17eff962017-04-24 17:01:22 +0700799struct ref_store *get_worktree_ref_store(const struct worktree *wt);
Nguyễn Thái Ngọc Duy077be782017-03-26 09:42:29 +0700800
Daniel Barkalow95fc7512005-06-06 16:31:29 -0400801#endif /* REFS_H */