]> git.ipfire.org Git - thirdparty/git.git/blob - refs.h
012c0d52132bd303eeec7e3661d6f8792fa5b88b
[thirdparty/git.git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
4 #include "commit.h"
5
6 struct object_id;
7 struct ref_store;
8 struct repository;
9 struct strbuf;
10 struct string_list;
11 struct string_list_item;
12 struct worktree;
13
14 /*
15 * Resolve a reference, recursively following symbolic refererences.
16 *
17 * Return the name of the non-symbolic reference that ultimately pointed
18 * at the resolved object name. The return value, if not NULL, is a
19 * pointer into either a static buffer or the input ref.
20 *
21 * If oid is non-NULL, store the referred-to object's name in it.
22 *
23 * If the reference cannot be resolved to an object, the behavior
24 * depends on the RESOLVE_REF_READING flag:
25 *
26 * - If RESOLVE_REF_READING is set, return NULL.
27 *
28 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
29 * the last reference name in the chain, which will either be a non-symbolic
30 * reference or an undefined reference. If this is a prelude to
31 * "writing" to the ref, the return value is the name of the ref
32 * that will actually be created or changed.
33 *
34 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
35 * level of symbolic reference. The value stored in oid for a symbolic
36 * reference will always be null_oid in this case, and the return
37 * value is the reference that the symref refers to directly.
38 *
39 * If flags is non-NULL, set the value that it points to the
40 * combination of REF_ISPACKED (if the reference was found among the
41 * packed references), REF_ISSYMREF (if the initial reference was a
42 * symbolic reference), REF_BAD_NAME (if the reference name is ill
43 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
44 * (if the ref is malformed or has a bad name). See refs.h for more detail
45 * on each flag.
46 *
47 * If ref is not a properly-formatted, normalized reference, return
48 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
49 * give up and return NULL.
50 *
51 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
52 * name is invalid according to git-check-ref-format(1). If the name
53 * is bad then the value stored in oid will be null_oid and the two
54 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
55 *
56 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
57 * directory and do not consist of all caps and underscores cannot be
58 * resolved. The function returns NULL for such ref names.
59 * Caps and underscores refers to the special refs, such as HEAD,
60 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
61 */
62 #define RESOLVE_REF_READING 0x01
63 #define RESOLVE_REF_NO_RECURSE 0x02
64 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
65
66 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
67 const char *refname,
68 int resolve_flags,
69 struct object_id *oid,
70 int *flags);
71
72 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
73 struct object_id *oid, int *flags);
74
75 char *refs_resolve_refdup(struct ref_store *refs,
76 const char *refname, int resolve_flags,
77 struct object_id *oid, int *flags);
78 char *resolve_refdup(const char *refname, int resolve_flags,
79 struct object_id *oid, int *flags);
80
81 int read_ref_full(const char *refname, int resolve_flags,
82 struct object_id *oid, int *flags);
83 int read_ref(const char *refname, struct object_id *oid);
84
85 int refs_read_symbolic_ref(struct ref_store *ref_store, const char *refname,
86 struct strbuf *referent);
87
88 /*
89 * Return 0 if a reference named refname could be created without
90 * conflicting with the name of an existing reference. Otherwise,
91 * return a negative value and write an explanation to err. If extras
92 * is non-NULL, it is a list of additional refnames with which refname
93 * is not allowed to conflict. If skip is non-NULL, ignore potential
94 * conflicts with refs in skip (e.g., because they are scheduled for
95 * deletion in the same operation). Behavior is undefined if the same
96 * name is listed in both extras and skip.
97 *
98 * Two reference names conflict if one of them exactly matches the
99 * leading components of the other; e.g., "foo/bar" conflicts with
100 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
101 * "foo/barbados".
102 *
103 * extras and skip must be sorted.
104 */
105
106 int refs_verify_refname_available(struct ref_store *refs,
107 const char *refname,
108 const struct string_list *extras,
109 const struct string_list *skip,
110 struct strbuf *err);
111
112 int refs_ref_exists(struct ref_store *refs, const char *refname);
113
114 int ref_exists(const char *refname);
115
116 int should_autocreate_reflog(const char *refname);
117
118 int is_branch(const char *refname);
119
120 int refs_init_db(struct strbuf *err);
121
122 /*
123 * Return the peeled value of the oid currently being iterated via
124 * for_each_ref(), etc. This is equivalent to calling:
125 *
126 * peel_object(oid, &peeled);
127 *
128 * with the "oid" value given to the each_ref_fn callback, except
129 * that some ref storage may be able to answer the query without
130 * actually loading the object in memory.
131 */
132 int peel_iterated_oid(const struct object_id *base, struct object_id *peeled);
133
134 /**
135 * Resolve refname in the nested "gitlink" repository in the specified
136 * submodule (which must be non-NULL). If the resolution is
137 * successful, return 0 and set oid to the name of the object;
138 * otherwise, return a non-zero value.
139 */
140 int resolve_gitlink_ref(const char *submodule, const char *refname,
141 struct object_id *oid);
142
143 /*
144 * Return true iff abbrev_name is a possible abbreviation for
145 * full_name according to the rules defined by ref_rev_parse_rules in
146 * refs.c.
147 */
148 int refname_match(const char *abbrev_name, const char *full_name);
149
150 /*
151 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
152 * the results to 'prefixes'
153 */
154 struct strvec;
155 void expand_ref_prefix(struct strvec *prefixes, const char *prefix);
156
157 int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
158 int repo_dwim_ref(struct repository *r, const char *str, int len,
159 struct object_id *oid, char **ref, int nonfatal_dangling_mark);
160 int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
161 int dwim_log(const char *str, int len, struct object_id *oid, char **ref);
162
163 /*
164 * Retrieves the default branch name for newly-initialized repositories.
165 *
166 * The return value of `repo_default_branch_name()` is an allocated string. The
167 * return value of `git_default_branch_name()` is a singleton.
168 */
169 const char *git_default_branch_name(int quiet);
170 char *repo_default_branch_name(struct repository *r, int quiet);
171
172 /*
173 * A ref_transaction represents a collection of reference updates that
174 * should succeed or fail together.
175 *
176 * Calling sequence
177 * ----------------
178 *
179 * - Allocate and initialize a `struct ref_transaction` by calling
180 * `ref_transaction_begin()`.
181 *
182 * - Specify the intended ref updates by calling one or more of the
183 * following functions:
184 * - `ref_transaction_update()`
185 * - `ref_transaction_create()`
186 * - `ref_transaction_delete()`
187 * - `ref_transaction_verify()`
188 *
189 * - Then either:
190 *
191 * - Optionally call `ref_transaction_prepare()` to prepare the
192 * transaction. This locks all references, checks preconditions,
193 * etc. but doesn't finalize anything. If this step fails, the
194 * transaction has been closed and can only be freed. If this step
195 * succeeds, then `ref_transaction_commit()` is almost certain to
196 * succeed. However, you can still call `ref_transaction_abort()`
197 * if you decide not to commit the transaction after all.
198 *
199 * - Call `ref_transaction_commit()` to execute the transaction,
200 * make the changes permanent, and release all locks. If you
201 * haven't already called `ref_transaction_prepare()`, then
202 * `ref_transaction_commit()` calls it for you.
203 *
204 * Or
205 *
206 * - Call `initial_ref_transaction_commit()` if the ref database is
207 * known to be empty and have no other writers (e.g. during
208 * clone). This is likely to be much faster than
209 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
210 * *not* be called before `initial_ref_transaction_commit()`.
211 *
212 * - Then finally, call `ref_transaction_free()` to free the
213 * `ref_transaction` data structure.
214 *
215 * At any time before calling `ref_transaction_commit()`, you can call
216 * `ref_transaction_abort()` to abort the transaction, rollback any
217 * locks, and free any associated resources (including the
218 * `ref_transaction` data structure).
219 *
220 * Putting it all together, a complete reference update looks like
221 *
222 * struct ref_transaction *transaction;
223 * struct strbuf err = STRBUF_INIT;
224 * int ret = 0;
225 *
226 * transaction = ref_store_transaction_begin(refs, &err);
227 * if (!transaction ||
228 * ref_transaction_update(...) ||
229 * ref_transaction_create(...) ||
230 * ...etc... ||
231 * ref_transaction_commit(transaction, &err)) {
232 * error("%s", err.buf);
233 * ret = -1;
234 * }
235 * ref_transaction_free(transaction);
236 * strbuf_release(&err);
237 * return ret;
238 *
239 * Error handling
240 * --------------
241 *
242 * On error, transaction functions append a message about what
243 * went wrong to the 'err' argument. The message mentions what
244 * ref was being updated (if any) when the error occurred so it
245 * can be passed to 'die' or 'error' as-is.
246 *
247 * The message is appended to err without first clearing err.
248 * err will not be '\n' terminated.
249 *
250 * Caveats
251 * -------
252 *
253 * Note that no locks are taken, and no refs are read, until
254 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
255 * called. So, for example, `ref_transaction_verify()` won't report a
256 * verification failure until the commit is attempted.
257 */
258 struct ref_transaction;
259
260 /*
261 * Bit values set in the flags argument passed to each_ref_fn() and
262 * stored in ref_iterator::flags. Other bits are for internal use
263 * only:
264 */
265
266 /* Reference is a symbolic reference. */
267 #define REF_ISSYMREF 0x01
268
269 /* Reference is a packed reference. */
270 #define REF_ISPACKED 0x02
271
272 /*
273 * Reference cannot be resolved to an object name: dangling symbolic
274 * reference (directly or indirectly), corrupt reference file,
275 * reference exists but name is bad, or symbolic reference refers to
276 * ill-formatted reference name.
277 */
278 #define REF_ISBROKEN 0x04
279
280 /*
281 * Reference name is not well formed.
282 *
283 * See git-check-ref-format(1) for the definition of well formed ref names.
284 */
285 #define REF_BAD_NAME 0x08
286
287 /*
288 * The signature for the callback function for the for_each_*()
289 * functions below. The memory pointed to by the refname and oid
290 * arguments is only guaranteed to be valid for the duration of a
291 * single callback invocation.
292 */
293 typedef int each_ref_fn(const char *refname,
294 const struct object_id *oid, int flags, void *cb_data);
295
296 /*
297 * The same as each_ref_fn, but also with a repository argument that
298 * contains the repository associated with the callback.
299 */
300 typedef int each_repo_ref_fn(struct repository *r,
301 const char *refname,
302 const struct object_id *oid,
303 int flags,
304 void *cb_data);
305
306 /*
307 * The following functions invoke the specified callback function for
308 * each reference indicated. If the function ever returns a nonzero
309 * value, stop the iteration and return that value. Please note that
310 * it is not safe to modify references while an iteration is in
311 * progress, unless the same callback function invocation that
312 * modifies the reference also returns a nonzero value to immediately
313 * stop the iteration. Returned references are sorted.
314 */
315 int refs_head_ref(struct ref_store *refs,
316 each_ref_fn fn, void *cb_data);
317 int refs_for_each_ref(struct ref_store *refs,
318 each_ref_fn fn, void *cb_data);
319 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
320 each_ref_fn fn, void *cb_data);
321 int refs_for_each_tag_ref(struct ref_store *refs,
322 each_ref_fn fn, void *cb_data);
323 int refs_for_each_branch_ref(struct ref_store *refs,
324 each_ref_fn fn, void *cb_data);
325 int refs_for_each_remote_ref(struct ref_store *refs,
326 each_ref_fn fn, void *cb_data);
327
328 /* just iterates the head ref. */
329 int head_ref(each_ref_fn fn, void *cb_data);
330
331 /* iterates all refs. */
332 int for_each_ref(each_ref_fn fn, void *cb_data);
333
334 /**
335 * iterates all refs which have a defined prefix and strips that prefix from
336 * the passed variable refname.
337 */
338 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
339
340 /*
341 * references matching any pattern in "exclude_patterns" are omitted from the
342 * result set on a best-effort basis.
343 */
344 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
345 const char **exclude_patterns,
346 each_ref_fn fn, void *cb_data);
347 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data);
348
349 /**
350 * iterate all refs in "patterns" by partitioning patterns into disjoint sets
351 * and iterating the longest-common prefix of each set.
352 *
353 * references matching any pattern in "exclude_patterns" are omitted from the
354 * result set on a best-effort basis.
355 *
356 * callers should be prepared to ignore references that they did not ask for.
357 */
358 int refs_for_each_fullref_in_prefixes(struct ref_store *refs,
359 const char *namespace,
360 const char **patterns,
361 const char **exclude_patterns,
362 each_ref_fn fn, void *cb_data);
363
364 /**
365 * iterate refs from the respective area.
366 */
367 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
368 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
369 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
370 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data);
371
372 /* iterates all refs that match the specified glob pattern. */
373 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
374
375 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
376 const char *prefix, void *cb_data);
377
378 int head_ref_namespaced(each_ref_fn fn, void *cb_data);
379 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
380
381 /* can be used to learn about broken ref and symref */
382 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);
383 int for_each_rawref(each_ref_fn fn, void *cb_data);
384
385 /*
386 * Normalizes partial refs to their fully qualified form.
387 * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'.
388 * <prefix> will default to 'refs/' if NULL.
389 *
390 * item.string will be set to the result.
391 * item.util will be set to NULL if <pattern> contains glob characters, or
392 * non-NULL if it doesn't.
393 */
394 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
395 const char *pattern);
396
397 static inline const char *has_glob_specials(const char *pattern)
398 {
399 return strpbrk(pattern, "?*[");
400 }
401
402 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
403 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt,
404 const struct string_list *refnames);
405
406 /*
407 * Flags for controlling behaviour of pack_refs()
408 * PACK_REFS_PRUNE: Prune loose refs after packing
409 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
410 */
411 #define PACK_REFS_PRUNE 0x0001
412 #define PACK_REFS_ALL 0x0002
413
414 /*
415 * Write a packed-refs file for the current repository.
416 * flags: Combination of the above PACK_REFS_* flags.
417 */
418 int refs_pack_refs(struct ref_store *refs, unsigned int flags);
419
420 /*
421 * Setup reflog before using. Fill in err and return -1 on failure.
422 */
423 int refs_create_reflog(struct ref_store *refs, const char *refname,
424 struct strbuf *err);
425 int safe_create_reflog(const char *refname, struct strbuf *err);
426
427 /** Reads log for the value of ref during at_time. **/
428 int read_ref_at(struct ref_store *refs,
429 const char *refname, unsigned int flags,
430 timestamp_t at_time, int cnt,
431 struct object_id *oid, char **msg,
432 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
433
434 /** Check if a particular reflog exists */
435 int refs_reflog_exists(struct ref_store *refs, const char *refname);
436 int reflog_exists(const char *refname);
437
438 /*
439 * Delete the specified reference. If old_oid is non-NULL, then
440 * verify that the current value of the reference is old_oid before
441 * deleting it. If old_oid is NULL, delete the reference if it
442 * exists, regardless of its old value. It is an error for old_oid to
443 * be null_oid. msg and flags are passed through to
444 * ref_transaction_delete().
445 */
446 int refs_delete_ref(struct ref_store *refs, const char *msg,
447 const char *refname,
448 const struct object_id *old_oid,
449 unsigned int flags);
450 int delete_ref(const char *msg, const char *refname,
451 const struct object_id *old_oid, unsigned int flags);
452
453 /*
454 * Delete the specified references. If there are any problems, emit
455 * errors but attempt to keep going (i.e., the deletes are not done in
456 * an all-or-nothing transaction). msg and flags are passed through to
457 * ref_transaction_delete().
458 */
459 int refs_delete_refs(struct ref_store *refs, const char *msg,
460 struct string_list *refnames, unsigned int flags);
461 int delete_refs(const char *msg, struct string_list *refnames,
462 unsigned int flags);
463
464 /** Delete a reflog */
465 int refs_delete_reflog(struct ref_store *refs, const char *refname);
466 int delete_reflog(const char *refname);
467
468 /*
469 * Callback to process a reflog entry found by the iteration functions (see
470 * below).
471 *
472 * The committer parameter is a single string, in the form
473 * "$GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" (without double quotes).
474 *
475 * The timestamp parameter gives the time when entry was created as the number
476 * of seconds since the UNIX epoch.
477 *
478 * The tz parameter gives the timezone offset for the user who created
479 * the reflog entry, and its value gives a positive or negative offset
480 * from UTC. Its absolute value is formed by multiplying the hour
481 * part by 100 and adding the minute part. For example, 1 hour ahead
482 * of UTC, CET == "+0100", is represented as positive one hundred (not
483 * postiive sixty).
484 *
485 * The msg parameter is a single complete line; a reflog message given
486 * to refs_delete_ref, refs_update_ref, etc. is returned to the
487 * callback normalized---each run of whitespaces are squashed into a
488 * single whitespace, trailing whitespace, if exists, is trimmed, and
489 * then a single LF is added at the end.
490 *
491 * The cb_data is a caller-supplied pointer given to the iterator
492 * functions.
493 */
494 typedef int each_reflog_ent_fn(
495 struct object_id *old_oid, struct object_id *new_oid,
496 const char *committer, timestamp_t timestamp,
497 int tz, const char *msg, void *cb_data);
498
499 /* Iterate over reflog entries in the log for `refname`. */
500
501 /* oldest entry first */
502 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
503 each_reflog_ent_fn fn, void *cb_data);
504
505 /* youngest entry first */
506 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
507 const char *refname,
508 each_reflog_ent_fn fn,
509 void *cb_data);
510
511 /*
512 * Iterate over reflog entries in the log for `refname` in the main ref store.
513 */
514
515 /* oldest entry first */
516 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
517
518 /* youngest entry first */
519 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
520
521 /*
522 * Calls the specified function for each reflog file until it returns nonzero,
523 * and returns the value. Reflog file order is unspecified.
524 */
525 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data);
526 int for_each_reflog(each_ref_fn fn, void *cb_data);
527
528 #define REFNAME_ALLOW_ONELEVEL 1
529 #define REFNAME_REFSPEC_PATTERN 2
530
531 /*
532 * Return 0 iff refname has the correct format for a refname according
533 * to the rules described in Documentation/git-check-ref-format.txt.
534 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
535 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
536 * allow a single "*" wildcard character in the refspec. No leading or
537 * repeated slashes are accepted.
538 */
539 int check_refname_format(const char *refname, int flags);
540
541 /*
542 * Apply the rules from check_refname_format, but mutate the result until it
543 * is acceptable, and place the result in "out".
544 */
545 void sanitize_refname_component(const char *refname, struct strbuf *out);
546
547 const char *prettify_refname(const char *refname);
548
549 char *refs_shorten_unambiguous_ref(struct ref_store *refs,
550 const char *refname, int strict);
551 char *shorten_unambiguous_ref(const char *refname, int strict);
552
553 /** rename ref, return 0 on success **/
554 int refs_rename_ref(struct ref_store *refs, const char *oldref,
555 const char *newref, const char *logmsg);
556 int rename_ref(const char *oldref, const char *newref,
557 const char *logmsg);
558
559 /** copy ref, return 0 on success **/
560 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
561 const char *newref, const char *logmsg);
562 int copy_existing_ref(const char *oldref, const char *newref,
563 const char *logmsg);
564
565 int refs_create_symref(struct ref_store *refs, const char *refname,
566 const char *target, const char *logmsg);
567 int create_symref(const char *refname, const char *target, const char *logmsg);
568
569 enum action_on_err {
570 UPDATE_REFS_MSG_ON_ERR,
571 UPDATE_REFS_DIE_ON_ERR,
572 UPDATE_REFS_QUIET_ON_ERR
573 };
574
575 /*
576 * Begin a reference transaction. The reference transaction must
577 * be freed by calling ref_transaction_free().
578 */
579 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
580 struct strbuf *err);
581 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
582
583 /*
584 * Reference transaction updates
585 *
586 * The following four functions add a reference check or update to a
587 * ref_transaction. They have some common similar parameters:
588 *
589 * transaction -- a pointer to an open ref_transaction, obtained
590 * from ref_transaction_begin().
591 *
592 * refname -- the name of the reference to be affected.
593 *
594 * new_oid -- the object ID that should be set to be the new value
595 * of the reference. Some functions allow this parameter to be
596 * NULL, meaning that the reference is not changed, or
597 * null_oid, meaning that the reference should be deleted. A
598 * copy of this value is made in the transaction.
599 *
600 * old_oid -- the object ID that the reference must have before
601 * the update. Some functions allow this parameter to be NULL,
602 * meaning that the old value of the reference is not checked,
603 * or null_oid, meaning that the reference must not exist
604 * before the update. A copy of this value is made in the
605 * transaction.
606 *
607 * flags -- flags affecting the update, passed to
608 * update_ref_lock(). Possible flags: REF_NO_DEREF,
609 * REF_FORCE_CREATE_REFLOG. See those constants for more
610 * information.
611 *
612 * msg -- a message describing the change (for the reflog).
613 *
614 * err -- a strbuf for receiving a description of any error that
615 * might have occurred.
616 *
617 * The functions make internal copies of refname and msg, so the
618 * caller retains ownership of these parameters.
619 *
620 * The functions return 0 on success and non-zero on failure. A
621 * failure means that the transaction as a whole has failed and needs
622 * to be rolled back.
623 */
624
625 /*
626 * The following flags can be passed to ref_transaction_update() etc.
627 * Internally, they are stored in `ref_update::flags`, along with some
628 * internal flags.
629 */
630
631 /*
632 * Act on the ref directly; i.e., without dereferencing symbolic refs.
633 * If this flag is not specified, then symbolic references are
634 * dereferenced and the update is applied to the referent.
635 */
636 #define REF_NO_DEREF (1 << 0)
637
638 /*
639 * Force the creation of a reflog for this reference, even if it
640 * didn't previously have a reflog.
641 */
642 #define REF_FORCE_CREATE_REFLOG (1 << 1)
643
644 /*
645 * Blindly write an object_id. This is useful for testing data corruption
646 * scenarios.
647 */
648 #define REF_SKIP_OID_VERIFICATION (1 << 10)
649
650 /*
651 * Skip verifying refname. This is useful for testing data corruption scenarios.
652 */
653 #define REF_SKIP_REFNAME_VERIFICATION (1 << 11)
654
655 /*
656 * Bitmask of all of the flags that are allowed to be passed in to
657 * ref_transaction_update() and friends:
658 */
659 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
660 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG | REF_SKIP_OID_VERIFICATION | \
661 REF_SKIP_REFNAME_VERIFICATION)
662
663 /*
664 * Add a reference update to transaction. `new_oid` is the value that
665 * the reference should have after the update, or `null_oid` if it
666 * should be deleted. If `new_oid` is NULL, then the reference is not
667 * changed at all. `old_oid` is the value that the reference must have
668 * before the update, or `null_oid` if it must not have existed
669 * beforehand. The old value is checked after the lock is taken to
670 * prevent races. If the old value doesn't agree with old_oid, the
671 * whole transaction fails. If old_oid is NULL, then the previous
672 * value is not checked.
673 *
674 * See the above comment "Reference transaction updates" for more
675 * information.
676 */
677 int ref_transaction_update(struct ref_transaction *transaction,
678 const char *refname,
679 const struct object_id *new_oid,
680 const struct object_id *old_oid,
681 unsigned int flags, const char *msg,
682 struct strbuf *err);
683
684 /*
685 * Add a reference creation to transaction. new_oid is the value that
686 * the reference should have after the update; it must not be
687 * null_oid. It is verified that the reference does not exist
688 * already.
689 *
690 * See the above comment "Reference transaction updates" for more
691 * information.
692 */
693 int ref_transaction_create(struct ref_transaction *transaction,
694 const char *refname,
695 const struct object_id *new_oid,
696 unsigned int flags, const char *msg,
697 struct strbuf *err);
698
699 /*
700 * Add a reference deletion to transaction. If old_oid is non-NULL,
701 * then it holds the value that the reference should have had before
702 * the update (which must not be null_oid).
703 *
704 * See the above comment "Reference transaction updates" for more
705 * information.
706 */
707 int ref_transaction_delete(struct ref_transaction *transaction,
708 const char *refname,
709 const struct object_id *old_oid,
710 unsigned int flags, const char *msg,
711 struct strbuf *err);
712
713 /*
714 * Verify, within a transaction, that refname has the value old_oid,
715 * or, if old_oid is null_oid, then verify that the reference
716 * doesn't exist. old_oid must be non-NULL.
717 *
718 * See the above comment "Reference transaction updates" for more
719 * information.
720 */
721 int ref_transaction_verify(struct ref_transaction *transaction,
722 const char *refname,
723 const struct object_id *old_oid,
724 unsigned int flags,
725 struct strbuf *err);
726
727 /* Naming conflict (for example, the ref names A and A/B conflict). */
728 #define TRANSACTION_NAME_CONFLICT -1
729 /* All other errors. */
730 #define TRANSACTION_GENERIC_ERROR -2
731
732 /*
733 * Perform the preparatory stages of committing `transaction`. Acquire
734 * any needed locks, check preconditions, etc.; basically, do as much
735 * as possible to ensure that the transaction will be able to go
736 * through, stopping just short of making any irrevocable or
737 * user-visible changes. The updates that this function prepares can
738 * be finished up by calling `ref_transaction_commit()` or rolled back
739 * by calling `ref_transaction_abort()`.
740 *
741 * On success, return 0 and leave the transaction in "prepared" state.
742 * On failure, abort the transaction, write an error message to `err`,
743 * and return one of the `TRANSACTION_*` constants.
744 *
745 * Callers who don't need such fine-grained control over committing
746 * reference transactions should just call `ref_transaction_commit()`.
747 */
748 int ref_transaction_prepare(struct ref_transaction *transaction,
749 struct strbuf *err);
750
751 /*
752 * Commit all of the changes that have been queued in transaction, as
753 * atomically as possible. On success, return 0 and leave the
754 * transaction in "closed" state. On failure, roll back the
755 * transaction, write an error message to `err`, and return one of the
756 * `TRANSACTION_*` constants
757 */
758 int ref_transaction_commit(struct ref_transaction *transaction,
759 struct strbuf *err);
760
761 /*
762 * Abort `transaction`, which has been begun and possibly prepared,
763 * but not yet committed.
764 */
765 int ref_transaction_abort(struct ref_transaction *transaction,
766 struct strbuf *err);
767
768 /*
769 * Like ref_transaction_commit(), but optimized for creating
770 * references when originally initializing a repository (e.g., by "git
771 * clone"). It writes the new references directly to packed-refs
772 * without locking the individual references.
773 *
774 * It is a bug to call this function when there might be other
775 * processes accessing the repository or if there are existing
776 * references that might conflict with the ones being created. All
777 * old_oid values must either be absent or null_oid.
778 */
779 int initial_ref_transaction_commit(struct ref_transaction *transaction,
780 struct strbuf *err);
781
782 /*
783 * Execute the given callback function for each of the reference updates which
784 * have been queued in the given transaction. `old_oid` and `new_oid` may be
785 * `NULL` pointers depending on whether the update has these object IDs set or
786 * not.
787 */
788 typedef void ref_transaction_for_each_queued_update_fn(const char *refname,
789 const struct object_id *old_oid,
790 const struct object_id *new_oid,
791 void *cb_data);
792 void ref_transaction_for_each_queued_update(struct ref_transaction *transaction,
793 ref_transaction_for_each_queued_update_fn cb,
794 void *cb_data);
795
796 /*
797 * Free `*transaction` and all associated data.
798 */
799 void ref_transaction_free(struct ref_transaction *transaction);
800
801 /**
802 * Lock, update, and unlock a single reference. This function
803 * basically does a transaction containing a single call to
804 * ref_transaction_update(). The parameters to this function have the
805 * same meaning as the corresponding parameters to
806 * ref_transaction_update(). Handle errors as requested by the `onerr`
807 * argument.
808 */
809 int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,
810 const struct object_id *new_oid, const struct object_id *old_oid,
811 unsigned int flags, enum action_on_err onerr);
812 int update_ref(const char *msg, const char *refname,
813 const struct object_id *new_oid, const struct object_id *old_oid,
814 unsigned int flags, enum action_on_err onerr);
815
816 int parse_hide_refs_config(const char *var, const char *value, const char *,
817 struct strvec *);
818
819 /*
820 * Check whether a ref is hidden. If no namespace is set, both the first and
821 * the second parameter point to the full ref name. If a namespace is set and
822 * the ref is inside that namespace, the first parameter is a pointer to the
823 * name of the ref with the namespace prefix removed. If a namespace is set and
824 * the ref is outside that namespace, the first parameter is NULL. The second
825 * parameter always points to the full ref name.
826 */
827 int ref_is_hidden(const char *, const char *, const struct strvec *);
828
829 /* Is this a per-worktree ref living in the refs/ namespace? */
830 int is_per_worktree_ref(const char *refname);
831
832 /* Describes how a refname relates to worktrees */
833 enum ref_worktree_type {
834 REF_WORKTREE_CURRENT, /* implicitly per worktree, eg. HEAD or
835 refs/bisect/SOMETHING */
836 REF_WORKTREE_MAIN, /* explicitly in main worktree, eg.
837 main-worktree/HEAD */
838 REF_WORKTREE_OTHER, /* explicitly in named worktree, eg.
839 worktrees/bla/HEAD */
840 REF_WORKTREE_SHARED, /* the default, eg. refs/heads/main */
841 };
842
843 /*
844 * Parse a `maybe_worktree_ref` as a ref that possibly refers to a worktree ref
845 * (ie. either REFNAME, main-worktree/REFNAME or worktree/WORKTREE/REFNAME). It
846 * returns what kind of ref was found, and in case of REF_WORKTREE_OTHER, the
847 * worktree name is returned in `worktree_name` (pointing into
848 * `maybe_worktree_ref`) and `worktree_name_length`. The bare refname (the
849 * refname stripped of prefixes) is returned in `bare_refname`. The
850 * `worktree_name`, `worktree_name_length` and `bare_refname` arguments may be
851 * NULL.
852 */
853 enum ref_worktree_type parse_worktree_ref(const char *maybe_worktree_ref,
854 const char **worktree_name,
855 int *worktree_name_length,
856 const char **bare_refname);
857
858 enum expire_reflog_flags {
859 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
860 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
861 EXPIRE_REFLOGS_REWRITE = 1 << 2,
862 };
863
864 /*
865 * The following interface is used for reflog expiration. The caller
866 * calls reflog_expire(), supplying it with three callback functions,
867 * of the following types. The callback functions define the
868 * expiration policy that is desired.
869 *
870 * reflog_expiry_prepare_fn -- Called once after the reference is
871 * locked. Called with the OID of the locked reference.
872 *
873 * reflog_expiry_should_prune_fn -- Called once for each entry in the
874 * existing reflog. It should return true iff that entry should be
875 * pruned.
876 *
877 * reflog_expiry_cleanup_fn -- Called once before the reference is
878 * unlocked again.
879 */
880 typedef void reflog_expiry_prepare_fn(const char *refname,
881 const struct object_id *oid,
882 void *cb_data);
883 typedef int reflog_expiry_should_prune_fn(struct object_id *ooid,
884 struct object_id *noid,
885 const char *email,
886 timestamp_t timestamp, int tz,
887 const char *message, void *cb_data);
888 typedef void reflog_expiry_cleanup_fn(void *cb_data);
889
890 /*
891 * Expire reflog entries for the specified reference.
892 * flags is a combination of the constants in
893 * enum expire_reflog_flags. The three function pointers are described
894 * above. On success, return zero.
895 */
896 int refs_reflog_expire(struct ref_store *refs,
897 const char *refname,
898 unsigned int flags,
899 reflog_expiry_prepare_fn prepare_fn,
900 reflog_expiry_should_prune_fn should_prune_fn,
901 reflog_expiry_cleanup_fn cleanup_fn,
902 void *policy_cb_data);
903 int reflog_expire(const char *refname,
904 unsigned int flags,
905 reflog_expiry_prepare_fn prepare_fn,
906 reflog_expiry_should_prune_fn should_prune_fn,
907 reflog_expiry_cleanup_fn cleanup_fn,
908 void *policy_cb_data);
909
910 struct ref_store *get_main_ref_store(struct repository *r);
911
912 /**
913 * Submodules
914 * ----------
915 *
916 * If you want to iterate the refs of a submodule you first need to add the
917 * submodules object database. You can do this by a code-snippet like
918 * this:
919 *
920 * const char *path = "path/to/submodule"
921 * if (add_submodule_odb(path))
922 * die("Error submodule '%s' not populated.", path);
923 *
924 * `add_submodule_odb()` will return zero on success. If you
925 * do not do this you will get an error for each ref that it does not point
926 * to a valid object.
927 *
928 * Note: As a side-effect of this you cannot safely assume that all
929 * objects you lookup are available in superproject. All submodule objects
930 * will be available the same way as the superprojects objects.
931 *
932 * Example:
933 * --------
934 *
935 * ----
936 * static int handle_remote_ref(const char *refname,
937 * const unsigned char *sha1, int flags, void *cb_data)
938 * {
939 * struct strbuf *output = cb_data;
940 * strbuf_addf(output, "%s\n", refname);
941 * return 0;
942 * }
943 *
944 */
945
946 /*
947 * Return the ref_store instance for the specified submodule. For the
948 * main repository, use submodule==NULL; such a call cannot fail. For
949 * a submodule, the submodule must exist and be a nonbare repository,
950 * otherwise return NULL. If the requested reference store has not yet
951 * been initialized, initialize it first.
952 *
953 * For backwards compatibility, submodule=="" is treated the same as
954 * submodule==NULL.
955 */
956 struct ref_store *get_submodule_ref_store(const char *submodule);
957 struct ref_store *get_worktree_ref_store(const struct worktree *wt);
958
959 /*
960 * Some of the names specified by refs have special meaning to Git.
961 * Organize these namespaces in a comon 'ref_namespace' array for
962 * reference from multiple places in the codebase.
963 */
964
965 struct ref_namespace_info {
966 char *ref;
967 enum decoration_type decoration;
968
969 /*
970 * If 'exact' is true, then we must match the 'ref' exactly.
971 * Otherwise, use a prefix match.
972 *
973 * 'ref_updated' is for internal use. It represents whether the
974 * 'ref' value was replaced from its original literal version.
975 */
976 unsigned exact:1,
977 ref_updated:1;
978 };
979
980 enum ref_namespace {
981 NAMESPACE_HEAD,
982 NAMESPACE_BRANCHES,
983 NAMESPACE_TAGS,
984 NAMESPACE_REMOTE_REFS,
985 NAMESPACE_STASH,
986 NAMESPACE_REPLACE,
987 NAMESPACE_NOTES,
988 NAMESPACE_PREFETCH,
989 NAMESPACE_REWRITTEN,
990
991 /* Must be last */
992 NAMESPACE__COUNT
993 };
994
995 /* See refs.c for the contents of this array. */
996 extern struct ref_namespace_info ref_namespace[NAMESPACE__COUNT];
997
998 /*
999 * Some ref namespaces can be modified by config values or environment
1000 * variables. Modify a namespace as specified by its ref_namespace key.
1001 */
1002 void update_ref_namespace(enum ref_namespace namespace, char *ref);
1003
1004 #endif /* REFS_H */