11 struct string_list_item
;
14 unsigned int ref_storage_format_by_name(const char *name
);
15 const char *ref_storage_format_to_name(unsigned int ref_storage_format
);
18 * Resolve a reference, recursively following symbolic refererences.
20 * Return the name of the non-symbolic reference that ultimately pointed
21 * at the resolved object name. The return value, if not NULL, is a
22 * pointer into either a static buffer or the input ref.
24 * If oid is non-NULL, store the referred-to object's name in it.
26 * If the reference cannot be resolved to an object, the behavior
27 * depends on the RESOLVE_REF_READING flag:
29 * - If RESOLVE_REF_READING is set, return NULL.
31 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
32 * the last reference name in the chain, which will either be a non-symbolic
33 * reference or an undefined reference. If this is a prelude to
34 * "writing" to the ref, the return value is the name of the ref
35 * that will actually be created or changed.
37 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
38 * level of symbolic reference. The value stored in oid for a symbolic
39 * reference will always be null_oid in this case, and the return
40 * value is the reference that the symref refers to directly.
42 * If flags is non-NULL, set the value that it points to the
43 * combination of REF_ISPACKED (if the reference was found among the
44 * packed references), REF_ISSYMREF (if the initial reference was a
45 * symbolic reference), REF_BAD_NAME (if the reference name is ill
46 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
47 * (if the ref is malformed or has a bad name). See refs.h for more detail
50 * If ref is not a properly-formatted, normalized reference, return
51 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
52 * give up and return NULL.
54 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
55 * name is invalid according to git-check-ref-format(1). If the name
56 * is bad then the value stored in oid will be null_oid and the two
57 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
59 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
60 * directory and do not consist of all caps and underscores cannot be
61 * resolved. The function returns NULL for such ref names.
62 * Caps and underscores refers to the pseudorefs, such as HEAD,
63 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
65 #define RESOLVE_REF_READING 0x01
66 #define RESOLVE_REF_NO_RECURSE 0x02
67 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
69 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
72 struct object_id
*oid
,
75 char *refs_resolve_refdup(struct ref_store
*refs
,
76 const char *refname
, int resolve_flags
,
77 struct object_id
*oid
, int *flags
);
79 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
80 int resolve_flags
, struct object_id
*oid
, int *flags
);
82 int refs_read_ref(struct ref_store
*refs
, const char *refname
, struct object_id
*oid
);
84 int refs_read_symbolic_ref(struct ref_store
*ref_store
, const char *refname
,
85 struct strbuf
*referent
);
88 * Return 0 if a reference named refname could be created without
89 * conflicting with the name of an existing reference. Otherwise,
90 * return a negative value and write an explanation to err. If extras
91 * is non-NULL, it is a list of additional refnames with which refname
92 * is not allowed to conflict. If skip is non-NULL, ignore potential
93 * conflicts with refs in skip (e.g., because they are scheduled for
94 * deletion in the same operation). Behavior is undefined if the same
95 * name is listed in both extras and skip.
97 * Two reference names conflict if one of them exactly matches the
98 * leading components of the other; e.g., "foo/bar" conflicts with
99 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
102 * extras and skip must be sorted.
105 int refs_verify_refname_available(struct ref_store
*refs
,
107 const struct string_list
*extras
,
108 const struct string_list
*skip
,
111 int refs_ref_exists(struct ref_store
*refs
, const char *refname
);
113 int should_autocreate_reflog(const char *refname
);
115 int is_branch(const char *refname
);
117 #define REF_STORE_CREATE_ON_DISK_IS_WORKTREE (1 << 0)
119 int ref_store_create_on_disk(struct ref_store
*refs
, int flags
, struct strbuf
*err
);
122 * Release all memory and resources associated with the ref store.
124 void ref_store_release(struct ref_store
*ref_store
);
127 * Return the peeled value of the oid currently being iterated via
128 * for_each_ref(), etc. This is equivalent to calling:
130 * peel_object(r, oid, &peeled);
132 * with the "oid" value given to the each_ref_fn callback, except
133 * that some ref storage may be able to answer the query without
134 * actually loading the object in memory.
136 int peel_iterated_oid(struct repository
*r
,
137 const struct object_id
*base
, struct object_id
*peeled
);
140 * Resolve refname in the nested "gitlink" repository in the specified
141 * submodule (which must be non-NULL). If the resolution is
142 * successful, return 0 and set oid to the name of the object;
143 * otherwise, return a non-zero value.
145 int repo_resolve_gitlink_ref(struct repository
*r
,
146 const char *submodule
, const char *refname
,
147 struct object_id
*oid
);
150 * Return true iff abbrev_name is a possible abbreviation for
151 * full_name according to the rules defined by ref_rev_parse_rules in
154 int refname_match(const char *abbrev_name
, const char *full_name
);
157 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
158 * the results to 'prefixes'
161 void expand_ref_prefix(struct strvec
*prefixes
, const char *prefix
);
163 int expand_ref(struct repository
*r
, const char *str
, int len
, struct object_id
*oid
, char **ref
);
164 int repo_dwim_ref(struct repository
*r
, const char *str
, int len
,
165 struct object_id
*oid
, char **ref
, int nonfatal_dangling_mark
);
166 int repo_dwim_log(struct repository
*r
, const char *str
, int len
, struct object_id
*oid
, char **ref
);
169 * Retrieves the default branch name for newly-initialized repositories.
171 * The return value is an allocated string.
173 char *repo_default_branch_name(struct repository
*r
, int quiet
);
176 * A ref_transaction represents a collection of reference updates that
177 * should succeed or fail together.
182 * - Allocate and initialize a `struct ref_transaction` by calling
183 * `ref_transaction_begin()`.
185 * - Specify the intended ref updates by calling one or more of the
186 * following functions:
187 * - `ref_transaction_update()`
188 * - `ref_transaction_create()`
189 * - `ref_transaction_delete()`
190 * - `ref_transaction_verify()`
194 * - Optionally call `ref_transaction_prepare()` to prepare the
195 * transaction. This locks all references, checks preconditions,
196 * etc. but doesn't finalize anything. If this step fails, the
197 * transaction has been closed and can only be freed. If this step
198 * succeeds, then `ref_transaction_commit()` is almost certain to
199 * succeed. However, you can still call `ref_transaction_abort()`
200 * if you decide not to commit the transaction after all.
202 * - Call `ref_transaction_commit()` to execute the transaction,
203 * make the changes permanent, and release all locks. If you
204 * haven't already called `ref_transaction_prepare()`, then
205 * `ref_transaction_commit()` calls it for you.
209 * - Call `initial_ref_transaction_commit()` if the ref database is
210 * known to be empty and have no other writers (e.g. during
211 * clone). This is likely to be much faster than
212 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
213 * *not* be called before `initial_ref_transaction_commit()`.
215 * - Then finally, call `ref_transaction_free()` to free the
216 * `ref_transaction` data structure.
218 * At any time before calling `ref_transaction_commit()`, you can call
219 * `ref_transaction_abort()` to abort the transaction, rollback any
220 * locks, and free any associated resources (including the
221 * `ref_transaction` data structure).
223 * Putting it all together, a complete reference update looks like
225 * struct ref_transaction *transaction;
226 * struct strbuf err = STRBUF_INIT;
229 * transaction = ref_store_transaction_begin(refs, &err);
230 * if (!transaction ||
231 * ref_transaction_update(...) ||
232 * ref_transaction_create(...) ||
234 * ref_transaction_commit(transaction, &err)) {
235 * error("%s", err.buf);
238 * ref_transaction_free(transaction);
239 * strbuf_release(&err);
245 * On error, transaction functions append a message about what
246 * went wrong to the 'err' argument. The message mentions what
247 * ref was being updated (if any) when the error occurred so it
248 * can be passed to 'die' or 'error' as-is.
250 * The message is appended to err without first clearing err.
251 * err will not be '\n' terminated.
256 * Note that no locks are taken, and no refs are read, until
257 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
258 * called. So, for example, `ref_transaction_verify()` won't report a
259 * verification failure until the commit is attempted.
261 struct ref_transaction
;
264 * Bit values set in the flags argument passed to each_ref_fn() and
265 * stored in ref_iterator::flags. Other bits are for internal use
269 /* Reference is a symbolic reference. */
270 #define REF_ISSYMREF 0x01
272 /* Reference is a packed reference. */
273 #define REF_ISPACKED 0x02
276 * Reference cannot be resolved to an object name: dangling symbolic
277 * reference (directly or indirectly), corrupt reference file,
278 * reference exists but name is bad, or symbolic reference refers to
279 * ill-formatted reference name.
281 #define REF_ISBROKEN 0x04
284 * Reference name is not well formed.
286 * See git-check-ref-format(1) for the definition of well formed ref names.
288 #define REF_BAD_NAME 0x08
291 * The signature for the callback function for the for_each_*()
292 * functions below. The memory pointed to by the refname and oid
293 * arguments is only guaranteed to be valid for the duration of a
294 * single callback invocation.
296 typedef int each_ref_fn(const char *refname
,
297 const struct object_id
*oid
, int flags
, void *cb_data
);
300 * The following functions invoke the specified callback function for
301 * each reference indicated. If the function ever returns a nonzero
302 * value, stop the iteration and return that value. Please note that
303 * it is not safe to modify references while an iteration is in
304 * progress, unless the same callback function invocation that
305 * modifies the reference also returns a nonzero value to immediately
306 * stop the iteration. Returned references are sorted.
308 int refs_head_ref(struct ref_store
*refs
,
309 each_ref_fn fn
, void *cb_data
);
310 int refs_for_each_ref(struct ref_store
*refs
,
311 each_ref_fn fn
, void *cb_data
);
312 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
313 each_ref_fn fn
, void *cb_data
);
314 int refs_for_each_tag_ref(struct ref_store
*refs
,
315 each_ref_fn fn
, void *cb_data
);
316 int refs_for_each_branch_ref(struct ref_store
*refs
,
317 each_ref_fn fn
, void *cb_data
);
318 int refs_for_each_remote_ref(struct ref_store
*refs
,
319 each_ref_fn fn
, void *cb_data
);
320 int refs_for_each_replace_ref(struct ref_store
*refs
,
321 each_ref_fn fn
, void *cb_data
);
324 * references matching any pattern in "exclude_patterns" are omitted from the
325 * result set on a best-effort basis.
327 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
328 const char **exclude_patterns
,
329 each_ref_fn fn
, void *cb_data
);
332 * iterate all refs in "patterns" by partitioning patterns into disjoint sets
333 * and iterating the longest-common prefix of each set.
335 * references matching any pattern in "exclude_patterns" are omitted from the
336 * result set on a best-effort basis.
338 * callers should be prepared to ignore references that they did not ask for.
340 int refs_for_each_fullref_in_prefixes(struct ref_store
*refs
,
341 const char *namespace,
342 const char **patterns
,
343 const char **exclude_patterns
,
344 each_ref_fn fn
, void *cb_data
);
346 /* iterates all refs that match the specified glob pattern. */
347 int refs_for_each_glob_ref(struct ref_store
*refs
, each_ref_fn fn
,
348 const char *pattern
, void *cb_data
);
350 int refs_for_each_glob_ref_in(struct ref_store
*refs
, each_ref_fn fn
,
351 const char *pattern
, const char *prefix
, void *cb_data
);
353 int refs_head_ref_namespaced(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
356 * references matching any pattern in "exclude_patterns" are omitted from the
357 * result set on a best-effort basis.
359 int refs_for_each_namespaced_ref(struct ref_store
*refs
,
360 const char **exclude_patterns
,
361 each_ref_fn fn
, void *cb_data
);
363 /* can be used to learn about broken ref and symref */
364 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
367 * Iterates over all refs including root refs, i.e. pseudorefs and HEAD.
369 int refs_for_each_include_root_refs(struct ref_store
*refs
, each_ref_fn fn
,
373 * Normalizes partial refs to their fully qualified form.
374 * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'.
375 * <prefix> will default to 'refs/' if NULL.
377 * item.string will be set to the result.
378 * item.util will be set to NULL if <pattern> contains glob characters, or
379 * non-NULL if it doesn't.
381 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
382 const char *pattern
);
384 static inline const char *has_glob_specials(const char *pattern
)
386 return strpbrk(pattern
, "?*[");
389 void refs_warn_dangling_symref(struct ref_store
*refs
, FILE *fp
,
390 const char *msg_fmt
, const char *refname
);
391 void refs_warn_dangling_symrefs(struct ref_store
*refs
, FILE *fp
,
392 const char *msg_fmt
, const struct string_list
*refnames
);
395 * Flags for controlling behaviour of pack_refs()
396 * PACK_REFS_PRUNE: Prune loose refs after packing
397 * PACK_REFS_AUTO: Pack refs on a best effort basis. The heuristics and end
398 * result are decided by the ref backend. Backends may ignore
399 * this flag and fall back to a normal repack.
401 #define PACK_REFS_PRUNE (1 << 0)
402 #define PACK_REFS_AUTO (1 << 1)
404 struct pack_refs_opts
{
406 struct ref_exclusions
*exclusions
;
407 struct string_list
*includes
;
411 * Write a packed-refs file for the current repository.
412 * flags: Combination of the above PACK_REFS_* flags.
414 int refs_pack_refs(struct ref_store
*refs
, struct pack_refs_opts
*opts
);
417 * Setup reflog before using. Fill in err and return -1 on failure.
419 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
423 * Reads log for the value of ref during at_time (in which case "cnt" should be
424 * negative) or the reflog "cnt" entries from the top (in which case "at_time"
427 * If we found the reflog entry in question, returns 0 (and details of the
428 * entry can be found in the out-parameters).
430 * If we ran out of reflog entries, the out-parameters are filled with the
431 * details of the oldest entry we did find, and the function returns 1. Note
432 * that there is one important special case here! If the reflog was empty
433 * and the caller asked for the 0-th cnt, we will return "1" but leave the
434 * "oid" field untouched.
436 int read_ref_at(struct ref_store
*refs
,
437 const char *refname
, unsigned int flags
,
438 timestamp_t at_time
, int cnt
,
439 struct object_id
*oid
, char **msg
,
440 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
442 /** Check if a particular reflog exists */
443 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
);
446 * Delete the specified reference. If old_oid is non-NULL, then
447 * verify that the current value of the reference is old_oid before
448 * deleting it. If old_oid is NULL, delete the reference if it
449 * exists, regardless of its old value. It is an error for old_oid to
450 * be null_oid. msg and flags are passed through to
451 * ref_transaction_delete().
453 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
455 const struct object_id
*old_oid
,
459 * Delete the specified references. If there are any problems, emit
460 * errors but attempt to keep going (i.e., the deletes are not done in
461 * an all-or-nothing transaction). msg and flags are passed through to
462 * ref_transaction_delete().
464 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
465 struct string_list
*refnames
, unsigned int flags
);
467 /** Delete a reflog */
468 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
);
471 * Callback to process a reflog entry found by the iteration functions (see
474 * The committer parameter is a single string, in the form
475 * "$GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" (without double quotes).
477 * The timestamp parameter gives the time when entry was created as the number
478 * of seconds since the UNIX epoch.
480 * The tz parameter gives the timezone offset for the user who created
481 * the reflog entry, and its value gives a positive or negative offset
482 * from UTC. Its absolute value is formed by multiplying the hour
483 * part by 100 and adding the minute part. For example, 1 hour ahead
484 * of UTC, CET == "+0100", is represented as positive one hundred (not
487 * The msg parameter is a single complete line; a reflog message given
488 * to refs_delete_ref, refs_update_ref, etc. is returned to the
489 * callback normalized---each run of whitespaces are squashed into a
490 * single whitespace, trailing whitespace, if exists, is trimmed, and
491 * then a single LF is added at the end.
493 * The cb_data is a caller-supplied pointer given to the iterator
496 typedef int each_reflog_ent_fn(
497 struct object_id
*old_oid
, struct object_id
*new_oid
,
498 const char *committer
, timestamp_t timestamp
,
499 int tz
, const char *msg
, void *cb_data
);
501 /* Iterate over reflog entries in the log for `refname`. */
503 /* oldest entry first */
504 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
505 each_reflog_ent_fn fn
, void *cb_data
);
507 /* youngest entry first */
508 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
510 each_reflog_ent_fn fn
,
514 * The signature for the callback function for the refs_for_each_reflog()
515 * functions below. The memory pointed to by the refname argument is only
516 * guaranteed to be valid for the duration of a single callback invocation.
518 typedef int each_reflog_fn(const char *refname
, void *cb_data
);
521 * Calls the specified function for each reflog file until it returns nonzero,
522 * and returns the value. Reflog file order is unspecified.
524 int refs_for_each_reflog(struct ref_store
*refs
, each_reflog_fn fn
, void *cb_data
);
526 #define REFNAME_ALLOW_ONELEVEL 1
527 #define REFNAME_REFSPEC_PATTERN 2
530 * Return 0 iff refname has the correct format for a refname according
531 * to the rules described in Documentation/git-check-ref-format.txt.
532 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
533 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
534 * allow a single "*" wildcard character in the refspec. No leading or
535 * repeated slashes are accepted.
537 int check_refname_format(const char *refname
, int flags
);
540 * Apply the rules from check_refname_format, but mutate the result until it
541 * is acceptable, and place the result in "out".
543 void sanitize_refname_component(const char *refname
, struct strbuf
*out
);
545 const char *prettify_refname(const char *refname
);
547 char *refs_shorten_unambiguous_ref(struct ref_store
*refs
,
548 const char *refname
, int strict
);
550 /** rename ref, return 0 on success **/
551 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
552 const char *newref
, const char *logmsg
);
554 /** copy ref, return 0 on success **/
555 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
556 const char *newref
, const char *logmsg
);
558 int refs_update_symref(struct ref_store
*refs
, const char *refname
,
559 const char *target
, const char *logmsg
);
562 UPDATE_REFS_MSG_ON_ERR
,
563 UPDATE_REFS_DIE_ON_ERR
,
564 UPDATE_REFS_QUIET_ON_ERR
568 * Begin a reference transaction. The reference transaction must
569 * be freed by calling ref_transaction_free().
571 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
575 * Reference transaction updates
577 * The following four functions add a reference check or update to a
578 * ref_transaction. They have some common similar parameters:
580 * transaction -- a pointer to an open ref_transaction, obtained
581 * from ref_transaction_begin().
583 * refname -- the name of the reference to be affected.
585 * new_oid -- the object ID that should be set to be the new value
586 * of the reference. Some functions allow this parameter to be
587 * NULL, meaning that the reference is not changed, or
588 * null_oid, meaning that the reference should be deleted. A
589 * copy of this value is made in the transaction.
591 * old_oid -- the object ID that the reference must have before
592 * the update. Some functions allow this parameter to be NULL,
593 * meaning that the old value of the reference is not checked,
594 * or null_oid, meaning that the reference must not exist
595 * before the update. A copy of this value is made in the
598 * new_target -- the target reference that the reference will be
599 * updated to point to. If the reference is a regular reference,
600 * it will be converted to a symbolic reference. Cannot be set
601 * together with `new_oid`. A copy of this value is made in the
604 * old_target -- the reference that the reference must be pointing to.
605 * Canont be set together with `old_oid`. A copy of this value is
606 * made in the transaction.
608 * flags -- flags affecting the update, passed to
609 * update_ref_lock(). Possible flags: REF_NO_DEREF,
610 * REF_FORCE_CREATE_REFLOG. See those constants for more
613 * msg -- a message describing the change (for the reflog).
615 * err -- a strbuf for receiving a description of any error that
616 * might have occurred.
618 * The functions make internal copies of refname and msg, so the
619 * caller retains ownership of these parameters.
621 * The functions return 0 on success and non-zero on failure. A
622 * failure means that the transaction as a whole has failed and needs
627 * The following flags can be passed to ref_transaction_update() etc.
628 * Internally, they are stored in `ref_update::flags`, along with some
633 * Act on the ref directly; i.e., without dereferencing symbolic refs.
634 * If this flag is not specified, then symbolic references are
635 * dereferenced and the update is applied to the referent.
637 #define REF_NO_DEREF (1 << 0)
640 * Force the creation of a reflog for this reference, even if it
641 * didn't previously have a reflog.
643 #define REF_FORCE_CREATE_REFLOG (1 << 1)
646 * Blindly write an object_id. This is useful for testing data corruption
649 #define REF_SKIP_OID_VERIFICATION (1 << 10)
652 * Skip verifying refname. This is useful for testing data corruption scenarios.
654 #define REF_SKIP_REFNAME_VERIFICATION (1 << 11)
657 * Bitmask of all of the flags that are allowed to be passed in to
658 * ref_transaction_update() and friends:
660 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
661 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG | REF_SKIP_OID_VERIFICATION | \
662 REF_SKIP_REFNAME_VERIFICATION)
665 * Add a reference update to transaction. `new_oid` is the value that
666 * the reference should have after the update, or `null_oid` if it
667 * should be deleted. If `new_oid` is NULL, then the reference is not
668 * changed at all. `old_oid` is the value that the reference must have
669 * before the update, or `null_oid` if it must not have existed
670 * beforehand. The old value is checked after the lock is taken to
671 * prevent races. If the old value doesn't agree with old_oid, the
672 * whole transaction fails. If old_oid is NULL, then the previous
673 * value is not checked. If `old_target` is not NULL, treat the reference
674 * as a symbolic ref and validate that its target before the update is
675 * `old_target`. If the `new_target` is not NULL, then the reference
676 * will be updated to a symbolic ref which targets `new_target`.
677 * Together, these allow us to update between regular refs and symrefs.
679 * See the above comment "Reference transaction updates" for more
682 int ref_transaction_update(struct ref_transaction
*transaction
,
684 const struct object_id
*new_oid
,
685 const struct object_id
*old_oid
,
686 const char *new_target
,
687 const char *old_target
,
688 unsigned int flags
, const char *msg
,
692 * Add a reference creation to transaction. new_oid is the value that
693 * the reference should have after the update; it must not be
694 * null_oid. It is verified that the reference does not exist
697 * See the above comment "Reference transaction updates" for more
700 int ref_transaction_create(struct ref_transaction
*transaction
,
702 const struct object_id
*new_oid
,
703 unsigned int flags
, const char *msg
,
707 * Add a reference deletion to transaction. If old_oid is non-NULL,
708 * then it holds the value that the reference should have had before
709 * the update (which must not be null_oid).
711 * See the above comment "Reference transaction updates" for more
714 int ref_transaction_delete(struct ref_transaction
*transaction
,
716 const struct object_id
*old_oid
,
717 unsigned int flags
, const char *msg
,
721 * Verify, within a transaction, that refname has the value old_oid,
722 * or, if old_oid is null_oid, then verify that the reference
723 * doesn't exist. old_oid must be non-NULL.
725 * See the above comment "Reference transaction updates" for more
728 int ref_transaction_verify(struct ref_transaction
*transaction
,
730 const struct object_id
*old_oid
,
734 /* Naming conflict (for example, the ref names A and A/B conflict). */
735 #define TRANSACTION_NAME_CONFLICT -1
736 /* All other errors. */
737 #define TRANSACTION_GENERIC_ERROR -2
740 * Perform the preparatory stages of committing `transaction`. Acquire
741 * any needed locks, check preconditions, etc.; basically, do as much
742 * as possible to ensure that the transaction will be able to go
743 * through, stopping just short of making any irrevocable or
744 * user-visible changes. The updates that this function prepares can
745 * be finished up by calling `ref_transaction_commit()` or rolled back
746 * by calling `ref_transaction_abort()`.
748 * On success, return 0 and leave the transaction in "prepared" state.
749 * On failure, abort the transaction, write an error message to `err`,
750 * and return one of the `TRANSACTION_*` constants.
752 * Callers who don't need such fine-grained control over committing
753 * reference transactions should just call `ref_transaction_commit()`.
755 int ref_transaction_prepare(struct ref_transaction
*transaction
,
759 * Commit all of the changes that have been queued in transaction, as
760 * atomically as possible. On success, return 0 and leave the
761 * transaction in "closed" state. On failure, roll back the
762 * transaction, write an error message to `err`, and return one of the
763 * `TRANSACTION_*` constants
765 int ref_transaction_commit(struct ref_transaction
*transaction
,
769 * Abort `transaction`, which has been begun and possibly prepared,
770 * but not yet committed.
772 int ref_transaction_abort(struct ref_transaction
*transaction
,
776 * Like ref_transaction_commit(), but optimized for creating
777 * references when originally initializing a repository (e.g., by "git
778 * clone"). It writes the new references directly to packed-refs
779 * without locking the individual references.
781 * It is a bug to call this function when there might be other
782 * processes accessing the repository or if there are existing
783 * references that might conflict with the ones being created. All
784 * old_oid values must either be absent or null_oid.
786 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
790 * Execute the given callback function for each of the reference updates which
791 * have been queued in the given transaction. `old_oid` and `new_oid` may be
792 * `NULL` pointers depending on whether the update has these object IDs set or
795 typedef void ref_transaction_for_each_queued_update_fn(const char *refname
,
796 const struct object_id
*old_oid
,
797 const struct object_id
*new_oid
,
799 void ref_transaction_for_each_queued_update(struct ref_transaction
*transaction
,
800 ref_transaction_for_each_queued_update_fn cb
,
804 * Free `*transaction` and all associated data.
806 void ref_transaction_free(struct ref_transaction
*transaction
);
809 * Lock, update, and unlock a single reference. This function
810 * basically does a transaction containing a single call to
811 * ref_transaction_update(). The parameters to this function have the
812 * same meaning as the corresponding parameters to
813 * ref_transaction_update(). Handle errors as requested by the `onerr`
816 int refs_update_ref(struct ref_store
*refs
, const char *msg
, const char *refname
,
817 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
818 unsigned int flags
, enum action_on_err onerr
);
820 int parse_hide_refs_config(const char *var
, const char *value
, const char *,
824 * Check whether a ref is hidden. If no namespace is set, both the first and
825 * the second parameter point to the full ref name. If a namespace is set and
826 * the ref is inside that namespace, the first parameter is a pointer to the
827 * name of the ref with the namespace prefix removed. If a namespace is set and
828 * the ref is outside that namespace, the first parameter is NULL. The second
829 * parameter always points to the full ref name.
831 int ref_is_hidden(const char *, const char *, const struct strvec
*);
834 * Returns an array of patterns to use as excluded_patterns, if none of the
835 * hidden references use the token '!' or '^'.
837 const char **hidden_refs_to_excludes(const struct strvec
*hide_refs
);
839 /* Is this a per-worktree ref living in the refs/ namespace? */
840 int is_per_worktree_ref(const char *refname
);
842 /* Describes how a refname relates to worktrees */
843 enum ref_worktree_type
{
844 REF_WORKTREE_CURRENT
, /* implicitly per worktree, eg. HEAD or
845 refs/bisect/SOMETHING */
846 REF_WORKTREE_MAIN
, /* explicitly in main worktree, eg.
847 main-worktree/HEAD */
848 REF_WORKTREE_OTHER
, /* explicitly in named worktree, eg.
849 worktrees/bla/HEAD */
850 REF_WORKTREE_SHARED
, /* the default, eg. refs/heads/main */
854 * Parse a `maybe_worktree_ref` as a ref that possibly refers to a worktree ref
855 * (ie. either REFNAME, main-worktree/REFNAME or worktree/WORKTREE/REFNAME). It
856 * returns what kind of ref was found, and in case of REF_WORKTREE_OTHER, the
857 * worktree name is returned in `worktree_name` (pointing into
858 * `maybe_worktree_ref`) and `worktree_name_length`. The bare refname (the
859 * refname stripped of prefixes) is returned in `bare_refname`. The
860 * `worktree_name`, `worktree_name_length` and `bare_refname` arguments may be
863 enum ref_worktree_type
parse_worktree_ref(const char *maybe_worktree_ref
,
864 const char **worktree_name
,
865 int *worktree_name_length
,
866 const char **bare_refname
);
868 enum expire_reflog_flags
{
869 EXPIRE_REFLOGS_DRY_RUN
= 1 << 0,
870 EXPIRE_REFLOGS_UPDATE_REF
= 1 << 1,
871 EXPIRE_REFLOGS_REWRITE
= 1 << 2,
875 * The following interface is used for reflog expiration. The caller
876 * calls refs_reflog_expire(), supplying it with three callback functions,
877 * of the following types. The callback functions define the
878 * expiration policy that is desired.
880 * reflog_expiry_prepare_fn -- Called once after the reference is
881 * locked. Called with the OID of the locked reference.
883 * reflog_expiry_should_prune_fn -- Called once for each entry in the
884 * existing reflog. It should return true iff that entry should be
887 * reflog_expiry_cleanup_fn -- Called once before the reference is
890 typedef void reflog_expiry_prepare_fn(const char *refname
,
891 const struct object_id
*oid
,
893 typedef int reflog_expiry_should_prune_fn(struct object_id
*ooid
,
894 struct object_id
*noid
,
896 timestamp_t timestamp
, int tz
,
897 const char *message
, void *cb_data
);
898 typedef void reflog_expiry_cleanup_fn(void *cb_data
);
901 * Expire reflog entries for the specified reference.
902 * flags is a combination of the constants in
903 * enum expire_reflog_flags. The three function pointers are described
904 * above. On success, return zero.
906 int refs_reflog_expire(struct ref_store
*refs
,
909 reflog_expiry_prepare_fn prepare_fn
,
910 reflog_expiry_should_prune_fn should_prune_fn
,
911 reflog_expiry_cleanup_fn cleanup_fn
,
912 void *policy_cb_data
);
914 struct ref_store
*get_main_ref_store(struct repository
*r
);
920 * If you want to iterate the refs of a submodule you first need to add the
921 * submodules object database. You can do this by a code-snippet like
924 * const char *path = "path/to/submodule"
925 * if (add_submodule_odb(path))
926 * die("Error submodule '%s' not populated.", path);
928 * `add_submodule_odb()` will return zero on success. If you
929 * do not do this you will get an error for each ref that it does not point
932 * Note: As a side-effect of this you cannot safely assume that all
933 * objects you lookup are available in superproject. All submodule objects
934 * will be available the same way as the superprojects objects.
940 * static int handle_remote_ref(const char *refname,
941 * const unsigned char *sha1, int flags, void *cb_data)
943 * struct strbuf *output = cb_data;
944 * strbuf_addf(output, "%s\n", refname);
951 * Return the ref_store instance for the specified submodule. For the
952 * main repository, use submodule==NULL; such a call cannot fail. For
953 * a submodule, the submodule must exist and be a nonbare repository,
954 * otherwise return NULL. If the requested reference store has not yet
955 * been initialized, initialize it first.
957 * For backwards compatibility, submodule=="" is treated the same as
960 struct ref_store
*repo_get_submodule_ref_store(struct repository
*repo
,
961 const char *submodule
);
962 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
);
965 * Some of the names specified by refs have special meaning to Git.
966 * Organize these namespaces in a comon 'ref_namespace' array for
967 * reference from multiple places in the codebase.
970 struct ref_namespace_info
{
972 enum decoration_type decoration
;
975 * If 'exact' is true, then we must match the 'ref' exactly.
976 * Otherwise, use a prefix match.
978 * 'ref_updated' is for internal use. It represents whether the
979 * 'ref' value was replaced from its original literal version.
989 NAMESPACE_REMOTE_REFS
,
1000 /* See refs.c for the contents of this array. */
1001 extern struct ref_namespace_info ref_namespace
[NAMESPACE__COUNT
];
1004 * Some ref namespaces can be modified by config values or environment
1005 * variables. Modify a namespace as specified by its ref_namespace key.
1007 void update_ref_namespace(enum ref_namespace
namespace, char *ref
);
1010 * Check whether the provided name names a root reference. This function only
1011 * performs a syntactic check.
1013 * A root ref is a reference that lives in the root of the reference hierarchy.
1014 * These references must conform to special syntax:
1016 * - Their name must be all-uppercase or underscores ("_").
1018 * - Their name must end with "_HEAD". As a special rule, "HEAD" is a root
1021 * - Their name may not contain a slash.
1023 * There is a special set of irregular root refs that exist due to historic
1024 * reasons, only. This list shall not be expanded in the future:
1028 * - BISECT_EXPECTED_REV
1030 * - NOTES_MERGE_PARTIAL
1036 int is_root_ref(const char *refname
);
1039 * Pseudorefs are refs that have different semantics compared to
1040 * "normal" refs. These refs can thus not be stored in the ref backend,
1041 * but must always be accessed via the filesystem. The following refs
1044 * - FETCH_HEAD may contain multiple object IDs, and each one of them
1045 * carries additional metadata like where it came from.
1047 * - MERGE_HEAD may contain multiple object IDs when merging multiple
1050 * Reading, writing or deleting references must consistently go either
1051 * through the filesystem (pseudorefs) or through the reference
1052 * backend (normal ones).
1054 int is_pseudo_ref(const char *refname
);
1057 * The following functions have been removed in Git v2.45 in favor of functions
1058 * that receive a `ref_store` as parameter. The intent of this section is
1059 * merely to help patch authors of in-flight series to have a reference what
1060 * they should be migrating to. The section will be removed in Git v2.46.
1063 static char *resolve_refdup(const char *refname
, int resolve_flags
,
1064 struct object_id
*oid
, int *flags
)
1066 return refs_resolve_refdup(get_main_ref_store(the_repository
),
1067 refname
, resolve_flags
,
1071 static int read_ref_full(const char *refname
, int resolve_flags
,
1072 struct object_id
*oid
, int *flags
)
1074 return refs_read_ref_full(get_main_ref_store(the_repository
), refname
,
1075 resolve_flags
, oid
, flags
);
1078 static int read_ref(const char *refname
, struct object_id
*oid
)
1080 return refs_read_ref(get_main_ref_store(the_repository
), refname
, oid
);
1083 static int ref_exists(const char *refname
)
1085 return refs_ref_exists(get_main_ref_store(the_repository
), refname
);
1088 static int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
1090 return refs_for_each_tag_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1093 static int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
1095 return refs_for_each_branch_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1098 static int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
1100 return refs_for_each_remote_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1103 static int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
1105 return refs_head_ref_namespaced(get_main_ref_store(the_repository
),
1109 static int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
1110 const char *prefix
, void *cb_data
)
1112 return refs_for_each_glob_ref_in(get_main_ref_store(the_repository
),
1113 fn
, pattern
, prefix
, cb_data
);
1116 static int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
1118 return refs_for_each_glob_ref(get_main_ref_store(the_repository
),
1119 fn
, pattern
, cb_data
);
1122 static int delete_ref(const char *msg
, const char *refname
,
1123 const struct object_id
*old_oid
, unsigned int flags
)
1125 return refs_delete_ref(get_main_ref_store(the_repository
), msg
, refname
,
1129 static struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
1131 return ref_store_transaction_begin(get_main_ref_store(the_repository
), err
);
1134 static int update_ref(const char *msg
, const char *refname
,
1135 const struct object_id
*new_oid
,
1136 const struct object_id
*old_oid
,
1137 unsigned int flags
, enum action_on_err onerr
)
1139 return refs_update_ref(get_main_ref_store(the_repository
), msg
, refname
, new_oid
,
1140 old_oid
, flags
, onerr
);
1143 static char *shorten_unambiguous_ref(const char *refname
, int strict
)
1145 return refs_shorten_unambiguous_ref(get_main_ref_store(the_repository
),
1149 static int head_ref(each_ref_fn fn
, void *cb_data
)
1151 return refs_head_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1154 static int for_each_ref(each_ref_fn fn
, void *cb_data
)
1156 return refs_for_each_ref(get_main_ref_store(the_repository
), fn
, cb_data
);
1159 static int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1161 return refs_for_each_ref_in(get_main_ref_store(the_repository
), prefix
, fn
, cb_data
);
1164 static int for_each_fullref_in(const char *prefix
,
1165 const char **exclude_patterns
,
1166 each_ref_fn fn
, void *cb_data
)
1168 return refs_for_each_fullref_in(get_main_ref_store(the_repository
),
1169 prefix
, exclude_patterns
, fn
, cb_data
);
1172 static int for_each_namespaced_ref(const char **exclude_patterns
,
1173 each_ref_fn fn
, void *cb_data
)
1175 return refs_for_each_namespaced_ref(get_main_ref_store(the_repository
),
1176 exclude_patterns
, fn
, cb_data
);
1179 static int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1181 return refs_for_each_rawref(get_main_ref_store(the_repository
), fn
, cb_data
);
1184 static const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1185 struct object_id
*oid
, int *flags
)
1187 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository
), refname
,
1188 resolve_flags
, oid
, flags
);
1191 static int create_symref(const char *ref_target
, const char *refs_heads_master
,
1194 return refs_create_symref(get_main_ref_store(the_repository
), ref_target
,
1195 refs_heads_master
, logmsg
);
1198 static int for_each_reflog(each_reflog_fn fn
, void *cb_data
)
1200 return refs_for_each_reflog(get_main_ref_store(the_repository
), fn
, cb_data
);
1203 static int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
1206 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository
),
1207 refname
, fn
, cb_data
);
1210 static int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
1213 return refs_for_each_reflog_ent(get_main_ref_store(the_repository
), refname
,
1217 static int reflog_exists(const char *refname
)
1219 return refs_reflog_exists(get_main_ref_store(the_repository
), refname
);
1222 static int safe_create_reflog(const char *refname
, struct strbuf
*err
)
1224 return refs_create_reflog(get_main_ref_store(the_repository
), refname
,
1228 static int delete_reflog(const char *refname
)
1230 return refs_delete_reflog(get_main_ref_store(the_repository
), refname
);
1233 static int reflog_expire(const char *refname
,
1235 reflog_expiry_prepare_fn prepare_fn
,
1236 reflog_expiry_should_prune_fn should_prune_fn
,
1237 reflog_expiry_cleanup_fn cleanup_fn
,
1238 void *policy_cb_data
)
1240 return refs_reflog_expire(get_main_ref_store(the_repository
),
1242 prepare_fn
, should_prune_fn
,
1243 cleanup_fn
, policy_cb_data
);
1246 static int delete_refs(const char *msg
, struct string_list
*refnames
,
1249 return refs_delete_refs(get_main_ref_store(the_repository
), msg
, refnames
, flags
);
1252 static int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
1254 return refs_rename_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);
1257 static int copy_existing_ref(const char *oldref
, const char *newref
, const char *logmsg
)
1259 return refs_copy_existing_ref(get_main_ref_store(the_repository
), oldref
, newref
, logmsg
);