10 * Resolve a reference, recursively following symbolic refererences.
12 * Store the referred-to object's name in sha1 and return the name of
13 * the non-symbolic reference that ultimately pointed at it. The
14 * return value, if not NULL, is a pointer into either a static buffer
17 * If the reference cannot be resolved to an object, the behavior
18 * depends on the RESOLVE_REF_READING flag:
20 * - If RESOLVE_REF_READING is set, return NULL.
22 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
23 * the last reference name in the chain, which will either be a non-symbolic
24 * reference or an undefined reference. If this is a prelude to
25 * "writing" to the ref, the return value is the name of the ref
26 * that will actually be created or changed.
28 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
29 * level of symbolic reference. The value stored in sha1 for a symbolic
30 * reference will always be null_sha1 in this case, and the return
31 * value is the reference that the symref refers to directly.
33 * If flags is non-NULL, set the value that it points to the
34 * combination of REF_ISPACKED (if the reference was found among the
35 * packed references), REF_ISSYMREF (if the initial reference was a
36 * symbolic reference), REF_BAD_NAME (if the reference name is ill
37 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
38 * (if the ref is malformed or has a bad name). See refs.h for more detail
41 * If ref is not a properly-formatted, normalized reference, return
42 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
43 * give up and return NULL.
45 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
46 * name is invalid according to git-check-ref-format(1). If the name
47 * is bad then the value stored in sha1 will be null_sha1 and the two
48 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
50 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
51 * directory and do not consist of all caps and underscores cannot be
52 * resolved. The function returns NULL for such ref names.
53 * Caps and underscores refers to the special refs, such as HEAD,
54 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
56 #define RESOLVE_REF_READING 0x01
57 #define RESOLVE_REF_NO_RECURSE 0x02
58 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
60 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
65 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
66 unsigned char *sha1
, int *flags
);
68 char *refs_resolve_refdup(struct ref_store
*refs
,
69 const char *refname
, int resolve_flags
,
70 unsigned char *sha1
, int *flags
);
71 char *resolve_refdup(const char *refname
, int resolve_flags
,
72 unsigned char *sha1
, int *flags
);
74 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
75 int resolve_flags
, unsigned char *sha1
, int *flags
);
76 int read_ref_full(const char *refname
, int resolve_flags
,
77 unsigned char *sha1
, int *flags
);
78 int read_ref(const char *refname
, unsigned char *sha1
);
81 * Return 0 if a reference named refname could be created without
82 * conflicting with the name of an existing reference. Otherwise,
83 * return a negative value and write an explanation to err. If extras
84 * is non-NULL, it is a list of additional refnames with which refname
85 * is not allowed to conflict. If skip is non-NULL, ignore potential
86 * conflicts with refs in skip (e.g., because they are scheduled for
87 * deletion in the same operation). Behavior is undefined if the same
88 * name is listed in both extras and skip.
90 * Two reference names conflict if one of them exactly matches the
91 * leading components of the other; e.g., "foo/bar" conflicts with
92 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
95 * extras and skip must be sorted.
98 int refs_verify_refname_available(struct ref_store
*refs
,
100 const struct string_list
*extra
,
101 const struct string_list
*skip
,
104 int ref_exists(const char *refname
);
106 int should_autocreate_reflog(const char *refname
);
108 int is_branch(const char *refname
);
110 extern int refs_init_db(struct strbuf
*err
);
113 * If refname is a non-symbolic reference that refers to a tag object,
114 * and the tag can be (recursively) dereferenced to a non-tag object,
115 * store the SHA1 of the referred-to object to sha1 and return 0. If
116 * any of these conditions are not met, return a non-zero value.
117 * Symbolic references are considered unpeelable, even if they
118 * ultimately resolve to a peelable tag.
120 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
121 unsigned char *sha1
);
122 int peel_ref(const char *refname
, unsigned char *sha1
);
125 * Resolve refname in the nested "gitlink" repository in the specified
126 * submodule (which must be non-NULL). If the resolution is
127 * successful, return 0 and set sha1 to the name of the object;
128 * otherwise, return a non-zero value.
130 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
131 unsigned char *sha1
);
134 * Return true iff abbrev_name is a possible abbreviation for
135 * full_name according to the rules defined by ref_rev_parse_rules in
138 int refname_match(const char *abbrev_name
, const char *full_name
);
140 int expand_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
);
141 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
);
142 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **ref
);
145 * A ref_transaction represents a collection of ref updates
146 * that should succeed or fail together.
150 * - Allocate and initialize a `struct ref_transaction` by calling
151 * `ref_transaction_begin()`.
153 * - List intended ref updates by calling functions like
154 * `ref_transaction_update()` and `ref_transaction_create()`.
156 * - Call `ref_transaction_commit()` to execute the transaction.
157 * If this succeeds, the ref updates will have taken place and
158 * the transaction cannot be rolled back.
160 * - Instead of `ref_transaction_commit`, use
161 * `initial_ref_transaction_commit()` if the ref database is known
162 * to be empty (e.g. during clone). This is likely to be much
165 * - At any time call `ref_transaction_free()` to discard the
166 * transaction and free associated resources. In particular,
167 * this rolls back the transaction if it has not been
168 * successfully committed.
173 * On error, transaction functions append a message about what
174 * went wrong to the 'err' argument. The message mentions what
175 * ref was being updated (if any) when the error occurred so it
176 * can be passed to 'die' or 'error' as-is.
178 * The message is appended to err without first clearing err.
179 * err will not be '\n' terminated.
184 * Note that no locks are taken, and no refs are read, until
185 * `ref_transaction_commit` is called. So `ref_transaction_verify`
186 * won't report a verification failure until the commit is attempted.
188 struct ref_transaction
;
191 * Bit values set in the flags argument passed to each_ref_fn() and
192 * stored in ref_iterator::flags. Other bits are for internal use
196 /* Reference is a symbolic reference. */
197 #define REF_ISSYMREF 0x01
199 /* Reference is a packed reference. */
200 #define REF_ISPACKED 0x02
203 * Reference cannot be resolved to an object name: dangling symbolic
204 * reference (directly or indirectly), corrupt reference file,
205 * reference exists but name is bad, or symbolic reference refers to
206 * ill-formatted reference name.
208 #define REF_ISBROKEN 0x04
211 * Reference name is not well formed.
213 * See git-check-ref-format(1) for the definition of well formed ref names.
215 #define REF_BAD_NAME 0x08
218 * The signature for the callback function for the for_each_*()
219 * functions below. The memory pointed to by the refname and sha1
220 * arguments is only guaranteed to be valid for the duration of a
221 * single callback invocation.
223 typedef int each_ref_fn(const char *refname
,
224 const struct object_id
*oid
, int flags
, void *cb_data
);
227 * The following functions invoke the specified callback function for
228 * each reference indicated. If the function ever returns a nonzero
229 * value, stop the iteration and return that value. Please note that
230 * it is not safe to modify references while an iteration is in
231 * progress, unless the same callback function invocation that
232 * modifies the reference also returns a nonzero value to immediately
233 * stop the iteration.
235 int refs_for_each_ref(struct ref_store
*refs
,
236 each_ref_fn fn
, void *cb_data
);
237 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
238 each_ref_fn fn
, void *cb_data
);
239 int refs_for_each_tag_ref(struct ref_store
*refs
,
240 each_ref_fn fn
, void *cb_data
);
241 int refs_for_each_branch_ref(struct ref_store
*refs
,
242 each_ref_fn fn
, void *cb_data
);
243 int refs_for_each_remote_ref(struct ref_store
*refs
,
244 each_ref_fn fn
, void *cb_data
);
246 int head_ref(each_ref_fn fn
, void *cb_data
);
247 int for_each_ref(each_ref_fn fn
, void *cb_data
);
248 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
);
249 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
,
250 unsigned int broken
);
251 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
);
252 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
);
253 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
);
254 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
);
255 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
);
256 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
257 const char *prefix
, void *cb_data
);
259 int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
260 int for_each_ref_submodule(const char *submodule
,
261 each_ref_fn fn
, void *cb_data
);
262 int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
263 each_ref_fn fn
, void *cb_data
);
264 int for_each_tag_ref_submodule(const char *submodule
,
265 each_ref_fn fn
, void *cb_data
);
266 int for_each_branch_ref_submodule(const char *submodule
,
267 each_ref_fn fn
, void *cb_data
);
268 int for_each_remote_ref_submodule(const char *submodule
,
269 each_ref_fn fn
, void *cb_data
);
271 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
);
272 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
);
274 /* can be used to learn about broken ref and symref */
275 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
276 int for_each_rawref(each_ref_fn fn
, void *cb_data
);
278 static inline const char *has_glob_specials(const char *pattern
)
280 return strpbrk(pattern
, "?*[");
283 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
284 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
,
285 const struct string_list
*refnames
);
288 * Flags for controlling behaviour of pack_refs()
289 * PACK_REFS_PRUNE: Prune loose refs after packing
290 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
292 #define PACK_REFS_PRUNE 0x0001
293 #define PACK_REFS_ALL 0x0002
296 * Write a packed-refs file for the current repository.
297 * flags: Combination of the above PACK_REFS_* flags.
299 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
);
300 int pack_refs(unsigned int flags
);
303 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
304 * REF_NODEREF: act on the ref directly, instead of dereferencing
305 * symbolic references.
307 * Other flags are reserved for internal use.
309 #define REF_NODEREF 0x01
310 #define REF_FORCE_CREATE_REFLOG 0x40
313 * Setup reflog before using. Fill in err and return -1 on failure.
315 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
316 int force_create
, struct strbuf
*err
);
317 int safe_create_reflog(const char *refname
, int force_create
, struct strbuf
*err
);
319 /** Reads log for the value of ref during at_time. **/
320 int read_ref_at(const char *refname
, unsigned int flags
,
321 unsigned long at_time
, int cnt
,
322 unsigned char *sha1
, char **msg
,
323 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
325 /** Check if a particular reflog exists */
326 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
);
327 int reflog_exists(const char *refname
);
330 * Delete the specified reference. If old_sha1 is non-NULL, then
331 * verify that the current value of the reference is old_sha1 before
332 * deleting it. If old_sha1 is NULL, delete the reference if it
333 * exists, regardless of its old value. It is an error for old_sha1 to
334 * be NULL_SHA1. flags is passed through to ref_transaction_delete().
336 int delete_ref(const char *msg
, const char *refname
,
337 const unsigned char *old_sha1
, unsigned int flags
);
340 * Delete the specified references. If there are any problems, emit
341 * errors but attempt to keep going (i.e., the deletes are not done in
342 * an all-or-nothing transaction). flags is passed through to
343 * ref_transaction_delete().
345 int refs_delete_refs(struct ref_store
*refs
, struct string_list
*refnames
,
347 int delete_refs(struct string_list
*refnames
, unsigned int flags
);
349 /** Delete a reflog */
350 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
);
351 int delete_reflog(const char *refname
);
353 /* iterate over reflog entries */
354 typedef int each_reflog_ent_fn(
355 struct object_id
*old_oid
, struct object_id
*new_oid
,
356 const char *committer
, unsigned long timestamp
,
357 int tz
, const char *msg
, void *cb_data
);
359 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
360 each_reflog_ent_fn fn
, void *cb_data
);
361 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
363 each_reflog_ent_fn fn
,
365 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
366 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
369 * Calls the specified function for each reflog file until it returns nonzero,
370 * and returns the value
372 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
373 int for_each_reflog(each_ref_fn fn
, void *cb_data
);
375 #define REFNAME_ALLOW_ONELEVEL 1
376 #define REFNAME_REFSPEC_PATTERN 2
379 * Return 0 iff refname has the correct format for a refname according
380 * to the rules described in Documentation/git-check-ref-format.txt.
381 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
382 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
383 * allow a single "*" wildcard character in the refspec. No leading or
384 * repeated slashes are accepted.
386 int check_refname_format(const char *refname
, int flags
);
388 const char *prettify_refname(const char *refname
);
390 char *shorten_unambiguous_ref(const char *refname
, int strict
);
392 /** rename ref, return 0 on success **/
393 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
394 const char *newref
, const char *logmsg
);
395 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
);
397 int refs_create_symref(struct ref_store
*refs
, const char *refname
,
398 const char *target
, const char *logmsg
);
399 int create_symref(const char *refname
, const char *target
, const char *logmsg
);
402 * Update HEAD of the specified gitdir.
403 * Similar to create_symref("relative-git-dir/HEAD", target, NULL), but
404 * this can update the main working tree's HEAD regardless of where
405 * $GIT_DIR points to.
406 * Return 0 if successful, non-zero otherwise.
408 int set_worktree_head_symref(const char *gitdir
, const char *target
,
412 UPDATE_REFS_MSG_ON_ERR
,
413 UPDATE_REFS_DIE_ON_ERR
,
414 UPDATE_REFS_QUIET_ON_ERR
418 * Begin a reference transaction. The reference transaction must
419 * be freed by calling ref_transaction_free().
421 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
);
424 * Reference transaction updates
426 * The following four functions add a reference check or update to a
427 * ref_transaction. They have some common similar parameters:
429 * transaction -- a pointer to an open ref_transaction, obtained
430 * from ref_transaction_begin().
432 * refname -- the name of the reference to be affected.
434 * flags -- flags affecting the update, passed to
435 * update_ref_lock(). Can be REF_NODEREF, which means that
436 * symbolic references should not be followed.
438 * msg -- a message describing the change (for the reflog).
440 * err -- a strbuf for receiving a description of any error that
441 * might have occurred.
443 * The functions make internal copies of refname and msg, so the
444 * caller retains ownership of these parameters.
446 * The functions return 0 on success and non-zero on failure. A
447 * failure means that the transaction as a whole has failed and needs
452 * Add a reference update to transaction. new_sha1 is the value that
453 * the reference should have after the update, or null_sha1 if it
454 * should be deleted. If new_sha1 is NULL, then the reference is not
455 * changed at all. old_sha1 is the value that the reference must have
456 * before the update, or null_sha1 if it must not have existed
457 * beforehand. The old value is checked after the lock is taken to
458 * prevent races. If the old value doesn't agree with old_sha1, the
459 * whole transaction fails. If old_sha1 is NULL, then the previous
460 * value is not checked.
462 * See the above comment "Reference transaction updates" for more
465 int ref_transaction_update(struct ref_transaction
*transaction
,
467 const unsigned char *new_sha1
,
468 const unsigned char *old_sha1
,
469 unsigned int flags
, const char *msg
,
473 * Add a reference creation to transaction. new_sha1 is the value that
474 * the reference should have after the update; it must not be
475 * null_sha1. It is verified that the reference does not exist
478 * See the above comment "Reference transaction updates" for more
481 int ref_transaction_create(struct ref_transaction
*transaction
,
483 const unsigned char *new_sha1
,
484 unsigned int flags
, const char *msg
,
488 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
489 * then it holds the value that the reference should have had before
490 * the update (which must not be null_sha1).
492 * See the above comment "Reference transaction updates" for more
495 int ref_transaction_delete(struct ref_transaction
*transaction
,
497 const unsigned char *old_sha1
,
498 unsigned int flags
, const char *msg
,
502 * Verify, within a transaction, that refname has the value old_sha1,
503 * or, if old_sha1 is null_sha1, then verify that the reference
504 * doesn't exist. old_sha1 must be non-NULL.
506 * See the above comment "Reference transaction updates" for more
509 int ref_transaction_verify(struct ref_transaction
*transaction
,
511 const unsigned char *old_sha1
,
516 * Commit all of the changes that have been queued in transaction, as
517 * atomically as possible.
519 * Returns 0 for success, or one of the below error codes for errors.
521 /* Naming conflict (for example, the ref names A and A/B conflict). */
522 #define TRANSACTION_NAME_CONFLICT -1
523 /* All other errors. */
524 #define TRANSACTION_GENERIC_ERROR -2
525 int ref_transaction_commit(struct ref_transaction
*transaction
,
529 * Like ref_transaction_commit(), but optimized for creating
530 * references when originally initializing a repository (e.g., by "git
531 * clone"). It writes the new references directly to packed-refs
532 * without locking the individual references.
534 * It is a bug to call this function when there might be other
535 * processes accessing the repository or if there are existing
536 * references that might conflict with the ones being created. All
537 * old_sha1 values must either be absent or NULL_SHA1.
539 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
543 * Free an existing transaction and all associated data.
545 void ref_transaction_free(struct ref_transaction
*transaction
);
548 * Lock, update, and unlock a single reference. This function
549 * basically does a transaction containing a single call to
550 * ref_transaction_update(). The parameters to this function have the
551 * same meaning as the corresponding parameters to
552 * ref_transaction_update(). Handle errors as requested by the `onerr`
555 int update_ref(const char *msg
, const char *refname
,
556 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
557 unsigned int flags
, enum action_on_err onerr
);
558 int update_ref_oid(const char *msg
, const char *refname
,
559 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
560 unsigned int flags
, enum action_on_err onerr
);
562 int parse_hide_refs_config(const char *var
, const char *value
, const char *);
565 * Check whether a ref is hidden. If no namespace is set, both the first and
566 * the second parameter point to the full ref name. If a namespace is set and
567 * the ref is inside that namespace, the first parameter is a pointer to the
568 * name of the ref with the namespace prefix removed. If a namespace is set and
569 * the ref is outside that namespace, the first parameter is NULL. The second
570 * parameter always points to the full ref name.
572 int ref_is_hidden(const char *, const char *);
575 REF_TYPE_PER_WORKTREE
,
580 enum ref_type
ref_type(const char *refname
);
582 enum expire_reflog_flags
{
583 EXPIRE_REFLOGS_DRY_RUN
= 1 << 0,
584 EXPIRE_REFLOGS_UPDATE_REF
= 1 << 1,
585 EXPIRE_REFLOGS_VERBOSE
= 1 << 2,
586 EXPIRE_REFLOGS_REWRITE
= 1 << 3
590 * The following interface is used for reflog expiration. The caller
591 * calls reflog_expire(), supplying it with three callback functions,
592 * of the following types. The callback functions define the
593 * expiration policy that is desired.
595 * reflog_expiry_prepare_fn -- Called once after the reference is
598 * reflog_expiry_should_prune_fn -- Called once for each entry in the
599 * existing reflog. It should return true iff that entry should be
602 * reflog_expiry_cleanup_fn -- Called once before the reference is
605 typedef void reflog_expiry_prepare_fn(const char *refname
,
606 const unsigned char *sha1
,
608 typedef int reflog_expiry_should_prune_fn(unsigned char *osha1
,
609 unsigned char *nsha1
,
611 unsigned long timestamp
, int tz
,
612 const char *message
, void *cb_data
);
613 typedef void reflog_expiry_cleanup_fn(void *cb_data
);
616 * Expire reflog entries for the specified reference. sha1 is the old
617 * value of the reference. flags is a combination of the constants in
618 * enum expire_reflog_flags. The three function pointers are described
619 * above. On success, return zero.
621 int refs_reflog_expire(struct ref_store
*refs
,
623 const unsigned char *sha1
,
625 reflog_expiry_prepare_fn prepare_fn
,
626 reflog_expiry_should_prune_fn should_prune_fn
,
627 reflog_expiry_cleanup_fn cleanup_fn
,
628 void *policy_cb_data
);
629 int reflog_expire(const char *refname
, const unsigned char *sha1
,
631 reflog_expiry_prepare_fn prepare_fn
,
632 reflog_expiry_should_prune_fn should_prune_fn
,
633 reflog_expiry_cleanup_fn cleanup_fn
,
634 void *policy_cb_data
);
636 int ref_storage_backend_exists(const char *name
);
638 struct ref_store
*get_main_ref_store(void);
640 * Return the ref_store instance for the specified submodule. For the
641 * main repository, use submodule==NULL; such a call cannot fail. For
642 * a submodule, the submodule must exist and be a nonbare repository,
643 * otherwise return NULL. If the requested reference store has not yet
644 * been initialized, initialize it first.
646 * For backwards compatibility, submodule=="" is treated the same as
649 struct ref_store
*get_submodule_ref_store(const char *submodule
);