lock_ref_sha1_basic(): only handle REF_NODEREF mode
[git/git.git] / refs.h
CommitLineData
95fc7512
DB
1#ifndef REFS_H
2#define REFS_H
3
fb58c8d5
MH
4/*
5 * Resolve a reference, recursively following symbolic refererences.
6 *
7 * Store the referred-to object's name in sha1 and return the name of
8 * the non-symbolic reference that ultimately pointed at it. The
9 * return value, if not NULL, is a pointer into either a static buffer
10 * or the input ref.
11 *
12 * If the reference cannot be resolved to an object, the behavior
13 * depends on the RESOLVE_REF_READING flag:
14 *
15 * - If RESOLVE_REF_READING is set, return NULL.
16 *
17 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
18 * the last reference name in the chain, which will either be a non-symbolic
19 * reference or an undefined reference. If this is a prelude to
20 * "writing" to the ref, the return value is the name of the ref
21 * that will actually be created or changed.
22 *
23 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
24 * level of symbolic reference. The value stored in sha1 for a symbolic
25 * reference will always be null_sha1 in this case, and the return
26 * value is the reference that the symref refers to directly.
27 *
28 * If flags is non-NULL, set the value that it points to the
29 * combination of REF_ISPACKED (if the reference was found among the
30 * packed references), REF_ISSYMREF (if the initial reference was a
31 * symbolic reference), REF_BAD_NAME (if the reference name is ill
32 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
33 * (if the ref is malformed or has a bad name). See refs.h for more detail
34 * on each flag.
35 *
36 * If ref is not a properly-formatted, normalized reference, return
37 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
38 * give up and return NULL.
39 *
40 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
41 * name is invalid according to git-check-ref-format(1). If the name
42 * is bad then the value stored in sha1 will be null_sha1 and the two
43 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
44 *
45 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
46 * directory and do not consist of all caps and underscores cannot be
47 * resolved. The function returns NULL for such ref names.
48 * Caps and underscores refers to the special refs, such as HEAD,
49 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
50 */
51#define RESOLVE_REF_READING 0x01
52#define RESOLVE_REF_NO_RECURSE 0x02
53#define RESOLVE_REF_ALLOW_BAD_NAME 0x04
54
55extern const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
56 unsigned char *sha1, int *flags);
57
58extern char *resolve_refdup(const char *refname, int resolve_flags,
59 unsigned char *sha1, int *flags);
60
61extern int read_ref_full(const char *refname, int resolve_flags,
62 unsigned char *sha1, int *flags);
63extern int read_ref(const char *refname, unsigned char *sha1);
64
24337102 65extern int ref_exists(const char *refname);
fb58c8d5
MH
66
67extern int is_branch(const char *refname);
68
69/*
70 * If refname is a non-symbolic reference that refers to a tag object,
71 * and the tag can be (recursively) dereferenced to a non-tag object,
72 * store the SHA1 of the referred-to object to sha1 and return 0. If
73 * any of these conditions are not met, return a non-zero value.
74 * Symbolic references are considered unpeelable, even if they
75 * ultimately resolve to a peelable tag.
76 */
77extern int peel_ref(const char *refname, unsigned char *sha1);
78
79/**
80 * Resolve refname in the nested "gitlink" repository that is located
81 * at path. If the resolution is successful, return 0 and set sha1 to
82 * the name of the object; otherwise, return a non-zero value.
83 */
84extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
85
86/*
87 * Return true iff abbrev_name is a possible abbreviation for
88 * full_name according to the rules defined by ref_rev_parse_rules in
89 * refs.c.
90 */
91extern int refname_match(const char *abbrev_name, const char *full_name);
92
93extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
94extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
95
b416af5b
RS
96/*
97 * A ref_transaction represents a collection of ref updates
98 * that should succeed or fail together.
99 *
100 * Calling sequence
101 * ----------------
102 * - Allocate and initialize a `struct ref_transaction` by calling
103 * `ref_transaction_begin()`.
104 *
105 * - List intended ref updates by calling functions like
106 * `ref_transaction_update()` and `ref_transaction_create()`.
107 *
108 * - Call `ref_transaction_commit()` to execute the transaction.
109 * If this succeeds, the ref updates will have taken place and
110 * the transaction cannot be rolled back.
111 *
49386868
DT
112 * - Instead of `ref_transaction_commit`, use
113 * `initial_ref_transaction_commit()` if the ref database is known
114 * to be empty (e.g. during clone). This is likely to be much
115 * faster.
116 *
b416af5b
RS
117 * - At any time call `ref_transaction_free()` to discard the
118 * transaction and free associated resources. In particular,
119 * this rolls back the transaction if it has not been
120 * successfully committed.
121 *
122 * Error handling
123 * --------------
124 *
125 * On error, transaction functions append a message about what
126 * went wrong to the 'err' argument. The message mentions what
127 * ref was being updated (if any) when the error occurred so it
128 * can be passed to 'die' or 'error' as-is.
129 *
130 * The message is appended to err without first clearing err.
131 * err will not be '\n' terminated.
49386868
DT
132 *
133 * Caveats
134 * -------
135 *
136 * Note that no locks are taken, and no refs are read, until
137 * `ref_transaction_commit` is called. So `ref_transaction_verify`
138 * won't report a verification failure until the commit is attempted.
b416af5b 139 */
caa4046c
MH
140struct ref_transaction;
141
89df9c84
MH
142/*
143 * Bit values set in the flags argument passed to each_ref_fn():
144 */
145
146/* Reference is a symbolic reference. */
98ac34b2 147#define REF_ISSYMREF 0x01
89df9c84
MH
148
149/* Reference is a packed reference. */
98ac34b2 150#define REF_ISPACKED 0x02
89df9c84
MH
151
152/*
153 * Reference cannot be resolved to an object name: dangling symbolic
d0f810f0
RS
154 * reference (directly or indirectly), corrupt reference file,
155 * reference exists but name is bad, or symbolic reference refers to
156 * ill-formatted reference name.
89df9c84 157 */
98ac34b2 158#define REF_ISBROKEN 0x04
f4204ab9 159
d0f810f0
RS
160/*
161 * Reference name is not well formed.
162 *
163 * See git-check-ref-format(1) for the definition of well formed ref names.
164 */
165#define REF_BAD_NAME 0x08
166
8a65ff76 167/*
4f78c24c
MH
168 * The signature for the callback function for the for_each_*()
169 * functions below. The memory pointed to by the refname and sha1
170 * arguments is only guaranteed to be valid for the duration of a
171 * single callback invocation.
172 */
173typedef int each_ref_fn(const char *refname,
2b2a5be3
MH
174 const struct object_id *oid, int flags, void *cb_data);
175
4f78c24c
MH
176/*
177 * The following functions invoke the specified callback function for
178 * each reference indicated. If the function ever returns a nonzero
179 * value, stop the iteration and return that value. Please note that
180 * it is not safe to modify references while an iteration is in
181 * progress, unless the same callback function invocation that
182 * modifies the reference also returns a nonzero value to immediately
183 * stop the iteration.
8a65ff76 184 */
24337102
MH
185extern int head_ref(each_ref_fn fn, void *cb_data);
186extern int for_each_ref(each_ref_fn fn, void *cb_data);
187extern int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
5b4f2851 188extern int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken);
24337102
MH
189extern int for_each_tag_ref(each_ref_fn fn, void *cb_data);
190extern int for_each_branch_ref(each_ref_fn fn, void *cb_data);
191extern int for_each_remote_ref(each_ref_fn fn, void *cb_data);
192extern int for_each_replace_ref(each_ref_fn fn, void *cb_data);
193extern int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
194extern int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, const char *prefix, void *cb_data);
8a65ff76 195
9ef6aeb0
HV
196extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
197extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
198extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
199 each_ref_fn fn, void *cb_data);
200extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
201extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
202extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
203
a1bea2c1
JT
204extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
205extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
206
fb58c8d5 207/* can be used to learn about broken ref and symref */
24337102 208extern int for_each_rawref(each_ref_fn fn, void *cb_data);
fb58c8d5 209
894a9d33
TR
210static inline const char *has_glob_specials(const char *pattern)
211{
212 return strpbrk(pattern, "?*[");
213}
214
3cf6134a 215extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
24d36f14 216extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames);
f8948e2f 217
32d462ce
MH
218/*
219 * Flags for controlling behaviour of pack_refs()
220 * PACK_REFS_PRUNE: Prune loose refs after packing
221 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
222 */
223#define PACK_REFS_PRUNE 0x0001
224#define PACK_REFS_ALL 0x0002
225
226/*
227 * Write a packed-refs file for the current repository.
228 * flags: Combination of the above PACK_REFS_* flags.
229 */
230int pack_refs(unsigned int flags);
231
835e3c99 232/*
31e07f76 233 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
029cdb4a
RS
234 * REF_NODEREF: act on the ref directly, instead of dereferencing
235 * symbolic references.
236 *
581d4e0c 237 * Other flags are reserved for internal use.
835e3c99 238 */
68db31cc 239#define REF_NODEREF 0x01
0f2a71d9 240#define REF_FORCE_CREATE_REFLOG 0x40
95fc7512 241
bd3b02da 242/*
a4c653df 243 * Setup reflog before using. Fill in err and return -1 on failure.
bd3b02da 244 */
abd0cd3a 245int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
859c3017 246
d556fae2 247/** Reads log for the value of ref during at_time. **/
c41a87dd
DA
248extern int read_ref_at(const char *refname, unsigned int flags,
249 unsigned long at_time, int cnt,
dfefa935
MH
250 unsigned char *sha1, char **msg,
251 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 252
4da58835
RS
253/** Check if a particular reflog exists */
254extern int reflog_exists(const char *refname);
255
fc1c2168 256/*
1c03c4d3
MH
257 * Delete the specified reference. If old_sha1 is non-NULL, then
258 * verify that the current value of the reference is old_sha1 before
259 * deleting it. If old_sha1 is NULL, delete the reference if it
260 * exists, regardless of its old value. It is an error for old_sha1 to
261 * be NULL_SHA1. flags is passed through to ref_transaction_delete().
fc1c2168
MH
262 */
263extern int delete_ref(const char *refname, const unsigned char *old_sha1,
264 unsigned int flags);
265
98ffd5ff
MH
266/*
267 * Delete the specified references. If there are any problems, emit
268 * errors but attempt to keep going (i.e., the deletes are not done in
269 * an all-or-nothing transaction).
270 */
271extern int delete_refs(struct string_list *refnames);
272
4da58835
RS
273/** Delete a reflog */
274extern int delete_reflog(const char *refname);
275
2ff81662 276/* iterate over reflog entries */
883d60fa 277typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 278int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 279int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 280
eb8381c8
NP
281/*
282 * Calls the specified function for each reflog file until it returns nonzero,
283 * and returns the value
284 */
285extern int for_each_reflog(each_ref_fn, void *);
286
8d9c5010
MH
287#define REFNAME_ALLOW_ONELEVEL 1
288#define REFNAME_REFSPEC_PATTERN 2
289
290/*
dfefa935
MH
291 * Return 0 iff refname has the correct format for a refname according
292 * to the rules described in Documentation/git-check-ref-format.txt.
293 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010 294 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
cd377f45
JK
295 * allow a single "*" wildcard character in the refspec. No leading or
296 * repeated slashes are accepted.
8d9c5010 297 */
dfefa935 298extern int check_refname_format(const char *refname, int flags);
95fc7512 299
4577e483 300extern const char *prettify_refname(const char *refname);
fb58c8d5 301
dfefa935 302extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 303
c976d415 304/** rename ref, return 0 on success **/
678d0f4c 305extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 306
b9badadd 307extern int create_symref(const char *refname, const char *target, const char *logmsg);
0ebde32c 308
2233066e
KY
309/*
310 * Update HEAD of the specified gitdir.
311 * Similar to create_symref("relative-git-dir/HEAD", target, NULL), but
312 * this can update the main working tree's HEAD regardless of where
313 * $GIT_DIR points to.
314 * Return 0 if successful, non-zero otherwise.
315 * */
316extern int set_worktree_head_symref(const char *gitdir, const char *target);
317
f4124112
MH
318enum action_on_err {
319 UPDATE_REFS_MSG_ON_ERR,
320 UPDATE_REFS_DIE_ON_ERR,
321 UPDATE_REFS_QUIET_ON_ERR
322};
323
caa4046c
MH
324/*
325 * Begin a reference transaction. The reference transaction must
33f9fc59 326 * be freed by calling ref_transaction_free().
caa4046c 327 */
93a644ea 328struct ref_transaction *ref_transaction_begin(struct strbuf *err);
caa4046c 329
caa4046c 330/*
d1dd721f
MH
331 * Reference transaction updates
332 *
333 * The following four functions add a reference check or update to a
334 * ref_transaction. They have some common similar parameters:
335 *
336 * transaction -- a pointer to an open ref_transaction, obtained
337 * from ref_transaction_begin().
338 *
339 * refname -- the name of the reference to be affected.
340 *
341 * flags -- flags affecting the update, passed to
342 * update_ref_lock(). Can be REF_NODEREF, which means that
343 * symbolic references should not be followed.
344 *
345 * msg -- a message describing the change (for the reflog).
346 *
347 * err -- a strbuf for receiving a description of any error that
348 * might have occured.
349 *
350 * The functions make internal copies of refname and msg, so the
351 * caller retains ownership of these parameters.
352 *
353 * The functions return 0 on success and non-zero on failure. A
354 * failure means that the transaction as a whole has failed and needs
355 * to be rolled back.
caa4046c
MH
356 */
357
caa4046c 358/*
16180334
MH
359 * Add a reference update to transaction. new_sha1 is the value that
360 * the reference should have after the update, or null_sha1 if it
361 * should be deleted. If new_sha1 is NULL, then the reference is not
362 * changed at all. old_sha1 is the value that the reference must have
363 * before the update, or null_sha1 if it must not have existed
364 * beforehand. The old value is checked after the lock is taken to
365 * prevent races. If the old value doesn't agree with old_sha1, the
366 * whole transaction fails. If old_sha1 is NULL, then the previous
367 * value is not checked.
368 *
d1dd721f
MH
369 * See the above comment "Reference transaction updates" for more
370 * information.
caa4046c 371 */
8e34800e
RS
372int ref_transaction_update(struct ref_transaction *transaction,
373 const char *refname,
374 const unsigned char *new_sha1,
375 const unsigned char *old_sha1,
1d147bdf 376 unsigned int flags, const char *msg,
8e34800e 377 struct strbuf *err);
caa4046c
MH
378
379/*
d1dd721f
MH
380 * Add a reference creation to transaction. new_sha1 is the value that
381 * the reference should have after the update; it must not be
382 * null_sha1. It is verified that the reference does not exist
caa4046c 383 * already.
d1dd721f
MH
384 *
385 * See the above comment "Reference transaction updates" for more
386 * information.
caa4046c 387 */
b416af5b
RS
388int ref_transaction_create(struct ref_transaction *transaction,
389 const char *refname,
390 const unsigned char *new_sha1,
fec14ec3 391 unsigned int flags, const char *msg,
b416af5b 392 struct strbuf *err);
caa4046c
MH
393
394/*
d1dd721f
MH
395 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
396 * then it holds the value that the reference should have had before
397 * the update (which must not be null_sha1).
398 *
399 * See the above comment "Reference transaction updates" for more
400 * information.
caa4046c 401 */
8c8bdc0d
RS
402int ref_transaction_delete(struct ref_transaction *transaction,
403 const char *refname,
404 const unsigned char *old_sha1,
fb5a6bb6 405 unsigned int flags, const char *msg,
8c8bdc0d 406 struct strbuf *err);
caa4046c 407
16180334
MH
408/*
409 * Verify, within a transaction, that refname has the value old_sha1,
410 * or, if old_sha1 is null_sha1, then verify that the reference
d1dd721f
MH
411 * doesn't exist. old_sha1 must be non-NULL.
412 *
413 * See the above comment "Reference transaction updates" for more
414 * information.
16180334
MH
415 */
416int ref_transaction_verify(struct ref_transaction *transaction,
417 const char *refname,
418 const unsigned char *old_sha1,
419 unsigned int flags,
420 struct strbuf *err);
421
caa4046c
MH
422/*
423 * Commit all of the changes that have been queued in transaction, as
28e6a97e
RS
424 * atomically as possible.
425 *
426 * Returns 0 for success, or one of the below error codes for errors.
caa4046c 427 */
28e6a97e
RS
428/* Naming conflict (for example, the ref names A and A/B conflict). */
429#define TRANSACTION_NAME_CONFLICT -1
430/* All other errors. */
431#define TRANSACTION_GENERIC_ERROR -2
caa4046c 432int ref_transaction_commit(struct ref_transaction *transaction,
db7516ab 433 struct strbuf *err);
caa4046c 434
58f233ce
MH
435/*
436 * Like ref_transaction_commit(), but optimized for creating
437 * references when originally initializing a repository (e.g., by "git
438 * clone"). It writes the new references directly to packed-refs
439 * without locking the individual references.
440 *
441 * It is a bug to call this function when there might be other
442 * processes accessing the repository or if there are existing
443 * references that might conflict with the ones being created. All
444 * old_sha1 values must either be absent or NULL_SHA1.
445 */
446int initial_ref_transaction_commit(struct ref_transaction *transaction,
447 struct strbuf *err);
448
026bd1d3
RS
449/*
450 * Free an existing transaction and all associated data.
451 */
452void ref_transaction_free(struct ref_transaction *transaction);
453
4b7b520b
MH
454/**
455 * Lock, update, and unlock a single reference. This function
456 * basically does a transaction containing a single call to
457 * ref_transaction_update(). The parameters to this function have the
458 * same meaning as the corresponding parameters to
459 * ref_transaction_update(). Handle errors as requested by the `onerr`
460 * argument.
461 */
462int update_ref(const char *msg, const char *refname,
463 const unsigned char *new_sha1, const unsigned char *old_sha1,
fec14ec3 464 unsigned int flags, enum action_on_err onerr);
3d9f037c 465
daebaa78 466extern int parse_hide_refs_config(const char *var, const char *value, const char *);
fb58c8d5 467
78a766ab
LF
468/*
469 * Check whether a ref is hidden. If no namespace is set, both the first and
470 * the second parameter point to the full ref name. If a namespace is set and
471 * the ref is inside that namespace, the first parameter is a pointer to the
472 * name of the ref with the namespace prefix removed. If a namespace is set and
473 * the ref is outside that namespace, the first parameter is NULL. The second
474 * parameter always points to the full ref name.
475 */
476extern int ref_is_hidden(const char *, const char *);
daebaa78 477
266b1827
DT
478enum ref_type {
479 REF_TYPE_PER_WORKTREE,
480 REF_TYPE_PSEUDOREF,
481 REF_TYPE_NORMAL,
482};
483
484enum ref_type ref_type(const char *refname);
485
fa5b1830
MH
486enum expire_reflog_flags {
487 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
488 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
489 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
490 EXPIRE_REFLOGS_REWRITE = 1 << 3
491};
492
493/*
494 * The following interface is used for reflog expiration. The caller
495 * calls reflog_expire(), supplying it with three callback functions,
496 * of the following types. The callback functions define the
497 * expiration policy that is desired.
498 *
499 * reflog_expiry_prepare_fn -- Called once after the reference is
500 * locked.
501 *
502 * reflog_expiry_should_prune_fn -- Called once for each entry in the
503 * existing reflog. It should return true iff that entry should be
504 * pruned.
505 *
506 * reflog_expiry_cleanup_fn -- Called once before the reference is
507 * unlocked again.
508 */
509typedef void reflog_expiry_prepare_fn(const char *refname,
510 const unsigned char *sha1,
511 void *cb_data);
512typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
513 unsigned char *nsha1,
514 const char *email,
515 unsigned long timestamp, int tz,
516 const char *message, void *cb_data);
517typedef void reflog_expiry_cleanup_fn(void *cb_data);
518
519/*
520 * Expire reflog entries for the specified reference. sha1 is the old
521 * value of the reference. flags is a combination of the constants in
522 * enum expire_reflog_flags. The three function pointers are described
523 * above. On success, return zero.
524 */
525extern int reflog_expire(const char *refname, const unsigned char *sha1,
526 unsigned int flags,
527 reflog_expiry_prepare_fn prepare_fn,
528 reflog_expiry_should_prune_fn should_prune_fn,
529 reflog_expiry_cleanup_fn cleanup_fn,
530 void *policy_cb_data);
531
95fc7512 532#endif /* REFS_H */