Imported Upstream version 2.8.0
[platform/upstream/git.git] / refs.h
1 #ifndef REFS_H
2 #define REFS_H
3
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
55 extern const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
56                                       unsigned char *sha1, int *flags);
57
58 extern char *resolve_refdup(const char *refname, int resolve_flags,
59                             unsigned char *sha1, int *flags);
60
61 extern int read_ref_full(const char *refname, int resolve_flags,
62                          unsigned char *sha1, int *flags);
63 extern int read_ref(const char *refname, unsigned char *sha1);
64
65 extern int ref_exists(const char *refname);
66
67 extern 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  */
77 extern 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  */
84 extern 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  */
91 extern int refname_match(const char *abbrev_name, const char *full_name);
92
93 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
94 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
95
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  *
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  *
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.
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.
139  */
140 struct ref_transaction;
141
142 /*
143  * Bit values set in the flags argument passed to each_ref_fn():
144  */
145
146 /* Reference is a symbolic reference. */
147 #define REF_ISSYMREF 0x01
148
149 /* Reference is a packed reference. */
150 #define REF_ISPACKED 0x02
151
152 /*
153  * Reference cannot be resolved to an object name: dangling symbolic
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.
157  */
158 #define REF_ISBROKEN 0x04
159
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
167 /*
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  */
173 typedef int each_ref_fn(const char *refname,
174                         const struct object_id *oid, int flags, void *cb_data);
175
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.
184  */
185 extern int head_ref(each_ref_fn fn, void *cb_data);
186 extern int for_each_ref(each_ref_fn fn, void *cb_data);
187 extern int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
188 extern int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken);
189 extern int for_each_tag_ref(each_ref_fn fn, void *cb_data);
190 extern int for_each_branch_ref(each_ref_fn fn, void *cb_data);
191 extern int for_each_remote_ref(each_ref_fn fn, void *cb_data);
192 extern int for_each_replace_ref(each_ref_fn fn, void *cb_data);
193 extern int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
194 extern int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, const char *prefix, void *cb_data);
195
196 extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
197 extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
198 extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
199                 each_ref_fn fn, void *cb_data);
200 extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
201 extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
202 extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
203
204 extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
205 extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
206
207 /* can be used to learn about broken ref and symref */
208 extern int for_each_rawref(each_ref_fn fn, void *cb_data);
209
210 static inline const char *has_glob_specials(const char *pattern)
211 {
212         return strpbrk(pattern, "?*[");
213 }
214
215 extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
216 extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames);
217
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  */
230 int pack_refs(unsigned int flags);
231
232 /*
233  * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
234  * REF_NODEREF: act on the ref directly, instead of dereferencing
235  *              symbolic references.
236  *
237  * Other flags are reserved for internal use.
238  */
239 #define REF_NODEREF     0x01
240 #define REF_FORCE_CREATE_REFLOG 0x40
241
242 /*
243  * Setup reflog before using. Fill in err and return -1 on failure.
244  */
245 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
246
247 /** Reads log for the value of ref during at_time. **/
248 extern int read_ref_at(const char *refname, unsigned int flags,
249                        unsigned long at_time, int cnt,
250                        unsigned char *sha1, char **msg,
251                        unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
252
253 /** Check if a particular reflog exists */
254 extern int reflog_exists(const char *refname);
255
256 /*
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().
262  */
263 extern int delete_ref(const char *refname, const unsigned char *old_sha1,
264                       unsigned int flags);
265
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  */
271 extern int delete_refs(struct string_list *refnames);
272
273 /** Delete a reflog */
274 extern int delete_reflog(const char *refname);
275
276 /* iterate over reflog entries */
277 typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
278 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
279 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
280
281 /*
282  * Calls the specified function for each reflog file until it returns nonzero,
283  * and returns the value
284  */
285 extern int for_each_reflog(each_ref_fn, void *);
286
287 #define REFNAME_ALLOW_ONELEVEL 1
288 #define REFNAME_REFSPEC_PATTERN 2
289
290 /*
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
294  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
295  * allow a single "*" wildcard character in the refspec. No leading or
296  * repeated slashes are accepted.
297  */
298 extern int check_refname_format(const char *refname, int flags);
299
300 extern const char *prettify_refname(const char *refname);
301
302 extern char *shorten_unambiguous_ref(const char *refname, int strict);
303
304 /** rename ref, return 0 on success **/
305 extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
306
307 extern int create_symref(const char *refname, const char *target, const char *logmsg);
308
309 enum action_on_err {
310         UPDATE_REFS_MSG_ON_ERR,
311         UPDATE_REFS_DIE_ON_ERR,
312         UPDATE_REFS_QUIET_ON_ERR
313 };
314
315 /*
316  * Begin a reference transaction.  The reference transaction must
317  * be freed by calling ref_transaction_free().
318  */
319 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
320
321 /*
322  * Reference transaction updates
323  *
324  * The following four functions add a reference check or update to a
325  * ref_transaction.  They have some common similar parameters:
326  *
327  *     transaction -- a pointer to an open ref_transaction, obtained
328  *         from ref_transaction_begin().
329  *
330  *     refname -- the name of the reference to be affected.
331  *
332  *     flags -- flags affecting the update, passed to
333  *         update_ref_lock(). Can be REF_NODEREF, which means that
334  *         symbolic references should not be followed.
335  *
336  *     msg -- a message describing the change (for the reflog).
337  *
338  *     err -- a strbuf for receiving a description of any error that
339  *         might have occured.
340  *
341  * The functions make internal copies of refname and msg, so the
342  * caller retains ownership of these parameters.
343  *
344  * The functions return 0 on success and non-zero on failure. A
345  * failure means that the transaction as a whole has failed and needs
346  * to be rolled back.
347  */
348
349 /*
350  * Add a reference update to transaction. new_sha1 is the value that
351  * the reference should have after the update, or null_sha1 if it
352  * should be deleted. If new_sha1 is NULL, then the reference is not
353  * changed at all. old_sha1 is the value that the reference must have
354  * before the update, or null_sha1 if it must not have existed
355  * beforehand. The old value is checked after the lock is taken to
356  * prevent races. If the old value doesn't agree with old_sha1, the
357  * whole transaction fails. If old_sha1 is NULL, then the previous
358  * value is not checked.
359  *
360  * See the above comment "Reference transaction updates" for more
361  * information.
362  */
363 int ref_transaction_update(struct ref_transaction *transaction,
364                            const char *refname,
365                            const unsigned char *new_sha1,
366                            const unsigned char *old_sha1,
367                            unsigned int flags, const char *msg,
368                            struct strbuf *err);
369
370 /*
371  * Add a reference creation to transaction. new_sha1 is the value that
372  * the reference should have after the update; it must not be
373  * null_sha1. It is verified that the reference does not exist
374  * already.
375  *
376  * See the above comment "Reference transaction updates" for more
377  * information.
378  */
379 int ref_transaction_create(struct ref_transaction *transaction,
380                            const char *refname,
381                            const unsigned char *new_sha1,
382                            unsigned int flags, const char *msg,
383                            struct strbuf *err);
384
385 /*
386  * Add a reference deletion to transaction. If old_sha1 is non-NULL,
387  * then it holds the value that the reference should have had before
388  * the update (which must not be null_sha1).
389  *
390  * See the above comment "Reference transaction updates" for more
391  * information.
392  */
393 int ref_transaction_delete(struct ref_transaction *transaction,
394                            const char *refname,
395                            const unsigned char *old_sha1,
396                            unsigned int flags, const char *msg,
397                            struct strbuf *err);
398
399 /*
400  * Verify, within a transaction, that refname has the value old_sha1,
401  * or, if old_sha1 is null_sha1, then verify that the reference
402  * doesn't exist. old_sha1 must be non-NULL.
403  *
404  * See the above comment "Reference transaction updates" for more
405  * information.
406  */
407 int ref_transaction_verify(struct ref_transaction *transaction,
408                            const char *refname,
409                            const unsigned char *old_sha1,
410                            unsigned int flags,
411                            struct strbuf *err);
412
413 /*
414  * Commit all of the changes that have been queued in transaction, as
415  * atomically as possible.
416  *
417  * Returns 0 for success, or one of the below error codes for errors.
418  */
419 /* Naming conflict (for example, the ref names A and A/B conflict). */
420 #define TRANSACTION_NAME_CONFLICT -1
421 /* All other errors. */
422 #define TRANSACTION_GENERIC_ERROR -2
423 int ref_transaction_commit(struct ref_transaction *transaction,
424                            struct strbuf *err);
425
426 /*
427  * Like ref_transaction_commit(), but optimized for creating
428  * references when originally initializing a repository (e.g., by "git
429  * clone"). It writes the new references directly to packed-refs
430  * without locking the individual references.
431  *
432  * It is a bug to call this function when there might be other
433  * processes accessing the repository or if there are existing
434  * references that might conflict with the ones being created. All
435  * old_sha1 values must either be absent or NULL_SHA1.
436  */
437 int initial_ref_transaction_commit(struct ref_transaction *transaction,
438                                    struct strbuf *err);
439
440 /*
441  * Free an existing transaction and all associated data.
442  */
443 void ref_transaction_free(struct ref_transaction *transaction);
444
445 /**
446  * Lock, update, and unlock a single reference. This function
447  * basically does a transaction containing a single call to
448  * ref_transaction_update(). The parameters to this function have the
449  * same meaning as the corresponding parameters to
450  * ref_transaction_update(). Handle errors as requested by the `onerr`
451  * argument.
452  */
453 int update_ref(const char *msg, const char *refname,
454                const unsigned char *new_sha1, const unsigned char *old_sha1,
455                unsigned int flags, enum action_on_err onerr);
456
457 extern int parse_hide_refs_config(const char *var, const char *value, const char *);
458
459 /*
460  * Check whether a ref is hidden. If no namespace is set, both the first and
461  * the second parameter point to the full ref name. If a namespace is set and
462  * the ref is inside that namespace, the first parameter is a pointer to the
463  * name of the ref with the namespace prefix removed. If a namespace is set and
464  * the ref is outside that namespace, the first parameter is NULL. The second
465  * parameter always points to the full ref name.
466  */
467 extern int ref_is_hidden(const char *, const char *);
468
469 enum ref_type {
470         REF_TYPE_PER_WORKTREE,
471         REF_TYPE_PSEUDOREF,
472         REF_TYPE_NORMAL,
473 };
474
475 enum ref_type ref_type(const char *refname);
476
477 enum expire_reflog_flags {
478         EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
479         EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
480         EXPIRE_REFLOGS_VERBOSE = 1 << 2,
481         EXPIRE_REFLOGS_REWRITE = 1 << 3
482 };
483
484 /*
485  * The following interface is used for reflog expiration. The caller
486  * calls reflog_expire(), supplying it with three callback functions,
487  * of the following types. The callback functions define the
488  * expiration policy that is desired.
489  *
490  * reflog_expiry_prepare_fn -- Called once after the reference is
491  *     locked.
492  *
493  * reflog_expiry_should_prune_fn -- Called once for each entry in the
494  *     existing reflog. It should return true iff that entry should be
495  *     pruned.
496  *
497  * reflog_expiry_cleanup_fn -- Called once before the reference is
498  *     unlocked again.
499  */
500 typedef void reflog_expiry_prepare_fn(const char *refname,
501                                       const unsigned char *sha1,
502                                       void *cb_data);
503 typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
504                                           unsigned char *nsha1,
505                                           const char *email,
506                                           unsigned long timestamp, int tz,
507                                           const char *message, void *cb_data);
508 typedef void reflog_expiry_cleanup_fn(void *cb_data);
509
510 /*
511  * Expire reflog entries for the specified reference. sha1 is the old
512  * value of the reference. flags is a combination of the constants in
513  * enum expire_reflog_flags. The three function pointers are described
514  * above. On success, return zero.
515  */
516 extern int reflog_expire(const char *refname, const unsigned char *sha1,
517                          unsigned int flags,
518                          reflog_expiry_prepare_fn prepare_fn,
519                          reflog_expiry_should_prune_fn should_prune_fn,
520                          reflog_expiry_cleanup_fn cleanup_fn,
521                          void *policy_cb_data);
522
523 #endif /* REFS_H */