5 * A ref_transaction represents a collection of ref updates
6 * that should succeed or fail together.
10 * - Allocate and initialize a `struct ref_transaction` by calling
11 * `ref_transaction_begin()`.
13 * - List intended ref updates by calling functions like
14 * `ref_transaction_update()` and `ref_transaction_create()`.
16 * - Call `ref_transaction_commit()` to execute the transaction.
17 * If this succeeds, the ref updates will have taken place and
18 * the transaction cannot be rolled back.
20 * - At any time call `ref_transaction_free()` to discard the
21 * transaction and free associated resources. In particular,
22 * this rolls back the transaction if it has not been
23 * successfully committed.
28 * On error, transaction functions append a message about what
29 * went wrong to the 'err' argument. The message mentions what
30 * ref was being updated (if any) when the error occurred so it
31 * can be passed to 'die' or 'error' as-is.
33 * The message is appended to err without first clearing err.
34 * err will not be '\n' terminated.
36 struct ref_transaction
;
39 * Bit values set in the flags argument passed to each_ref_fn():
42 /* Reference is a symbolic reference. */
43 #define REF_ISSYMREF 0x01
45 /* Reference is a packed reference. */
46 #define REF_ISPACKED 0x02
49 * Reference cannot be resolved to an object name: dangling symbolic
50 * reference (directly or indirectly), corrupt reference file,
51 * reference exists but name is bad, or symbolic reference refers to
52 * ill-formatted reference name.
54 #define REF_ISBROKEN 0x04
57 * Reference name is not well formed.
59 * See git-check-ref-format(1) for the definition of well formed ref names.
61 #define REF_BAD_NAME 0x08
64 * The signature for the callback function for the for_each_*()
65 * functions below. The memory pointed to by the refname and sha1
66 * arguments is only guaranteed to be valid for the duration of a
67 * single callback invocation.
69 typedef int each_ref_fn(const char *refname
,
70 const struct object_id
*oid
, int flags
, void *cb_data
);
73 * The following functions invoke the specified callback function for
74 * each reference indicated. If the function ever returns a nonzero
75 * value, stop the iteration and return that value. Please note that
76 * it is not safe to modify references while an iteration is in
77 * progress, unless the same callback function invocation that
78 * modifies the reference also returns a nonzero value to immediately
81 extern int head_ref(each_ref_fn
, void *);
82 extern int for_each_ref(each_ref_fn
, void *);
83 extern int for_each_ref_in(const char *, each_ref_fn
, void *);
84 extern int for_each_tag_ref(each_ref_fn
, void *);
85 extern int for_each_branch_ref(each_ref_fn
, void *);
86 extern int for_each_remote_ref(each_ref_fn
, void *);
87 extern int for_each_replace_ref(each_ref_fn
, void *);
88 extern int for_each_glob_ref(each_ref_fn
, const char *pattern
, void *);
89 extern int for_each_glob_ref_in(each_ref_fn
, const char *pattern
, const char* prefix
, void *);
91 extern int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
92 extern int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
93 extern int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
94 each_ref_fn fn
, void *cb_data
);
95 extern int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
96 extern int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
97 extern int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
99 extern int head_ref_namespaced(each_ref_fn fn
, void *cb_data
);
100 extern int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
);
102 static inline const char *has_glob_specials(const char *pattern
)
104 return strpbrk(pattern
, "?*[");
107 /* can be used to learn about broken ref and symref */
108 extern int for_each_rawref(each_ref_fn
, void *);
110 extern void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
111 extern void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
);
114 * Lock the packed-refs file for writing. Flags is passed to
115 * hold_lock_file_for_update(). Return 0 on success.
116 * Errno is set to something meaningful on error.
118 extern int lock_packed_refs(int flags
);
121 * Add a reference to the in-memory packed reference cache. This may
122 * only be called while the packed-refs file is locked (see
123 * lock_packed_refs()). To actually write the packed-refs file, call
124 * commit_packed_refs().
126 extern void add_packed_ref(const char *refname
, const unsigned char *sha1
);
129 * Write the current version of the packed refs cache from memory to
130 * disk. The packed-refs file must already be locked for writing (see
131 * lock_packed_refs()). Return zero on success.
132 * Sets errno to something meaningful on error.
134 extern int commit_packed_refs(void);
137 * Rollback the lockfile for the packed-refs file, and discard the
138 * in-memory packed reference cache. (The packed-refs file will be
139 * read anew if it is needed again after this function is called.)
141 extern void rollback_packed_refs(void);
144 * Flags for controlling behaviour of pack_refs()
145 * PACK_REFS_PRUNE: Prune loose refs after packing
146 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
148 #define PACK_REFS_PRUNE 0x0001
149 #define PACK_REFS_ALL 0x0002
152 * Write a packed-refs file for the current repository.
153 * flags: Combination of the above PACK_REFS_* flags.
155 int pack_refs(unsigned int flags
);
157 extern int ref_exists(const char *);
159 extern int is_branch(const char *refname
);
162 * If refname is a non-symbolic reference that refers to a tag object,
163 * and the tag can be (recursively) dereferenced to a non-tag object,
164 * store the SHA1 of the referred-to object to sha1 and return 0. If
165 * any of these conditions are not met, return a non-zero value.
166 * Symbolic references are considered unpeelable, even if they
167 * ultimately resolve to a peelable tag.
169 extern int peel_ref(const char *refname
, unsigned char *sha1
);
172 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
173 * REF_NODEREF: act on the ref directly, instead of dereferencing
174 * symbolic references.
176 * Other flags are reserved for internal use.
178 #define REF_NODEREF 0x01
181 * Setup reflog before using. Set errno to something meaningful on failure.
183 int log_ref_setup(const char *refname
, struct strbuf
*logfile
);
185 /** Reads log for the value of ref during at_time. **/
186 extern int read_ref_at(const char *refname
, unsigned int flags
,
187 unsigned long at_time
, int cnt
,
188 unsigned char *sha1
, char **msg
,
189 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
191 /** Check if a particular reflog exists */
192 extern int reflog_exists(const char *refname
);
195 * Delete the specified reference. If old_sha1 is non-NULL and not
196 * NULL_SHA1, then verify that the current value of the reference is
197 * old_sha1 before deleting it. If old_sha1 is NULL or NULL_SHA1,
198 * delete the reference if it exists, regardless of its old value.
199 * flags is passed through to ref_transaction_delete().
201 extern int delete_ref(const char *refname
, const unsigned char *old_sha1
,
205 * Delete the specified references. If there are any problems, emit
206 * errors but attempt to keep going (i.e., the deletes are not done in
207 * an all-or-nothing transaction).
209 extern int delete_refs(struct string_list
*refnames
);
211 /** Delete a reflog */
212 extern int delete_reflog(const char *refname
);
214 /* iterate over reflog entries */
215 typedef int each_reflog_ent_fn(unsigned char *osha1
, unsigned char *nsha1
, const char *, unsigned long, int, const char *, void *);
216 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
217 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
220 * Calls the specified function for each reflog file until it returns nonzero,
221 * and returns the value
223 extern int for_each_reflog(each_ref_fn
, void *);
225 #define REFNAME_ALLOW_ONELEVEL 1
226 #define REFNAME_REFSPEC_PATTERN 2
229 * Return 0 iff refname has the correct format for a refname according
230 * to the rules described in Documentation/git-check-ref-format.txt.
231 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
232 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
233 * allow a "*" wildcard character in place of one of the name
234 * components. No leading or repeated slashes are accepted.
236 extern int check_refname_format(const char *refname
, int flags
);
238 extern const char *prettify_refname(const char *refname
);
239 extern char *shorten_unambiguous_ref(const char *refname
, int strict
);
241 /** rename ref, return 0 on success **/
242 extern int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
);
245 * Resolve refname in the nested "gitlink" repository that is located
246 * at path. If the resolution is successful, return 0 and set sha1 to
247 * the name of the object; otherwise, return a non-zero value.
249 extern int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
);
252 UPDATE_REFS_MSG_ON_ERR
,
253 UPDATE_REFS_DIE_ON_ERR
,
254 UPDATE_REFS_QUIET_ON_ERR
258 * Begin a reference transaction. The reference transaction must
259 * be freed by calling ref_transaction_free().
261 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
);
264 * Reference transaction updates
266 * The following four functions add a reference check or update to a
267 * ref_transaction. They have some common similar parameters:
269 * transaction -- a pointer to an open ref_transaction, obtained
270 * from ref_transaction_begin().
272 * refname -- the name of the reference to be affected.
274 * flags -- flags affecting the update, passed to
275 * update_ref_lock(). Can be REF_NODEREF, which means that
276 * symbolic references should not be followed.
278 * msg -- a message describing the change (for the reflog).
280 * err -- a strbuf for receiving a description of any error that
281 * might have occured.
283 * The functions make internal copies of refname and msg, so the
284 * caller retains ownership of these parameters.
286 * The functions return 0 on success and non-zero on failure. A
287 * failure means that the transaction as a whole has failed and needs
292 * Add a reference update to transaction. new_sha1 is the value that
293 * the reference should have after the update, or null_sha1 if it
294 * should be deleted. If new_sha1 is NULL, then the reference is not
295 * changed at all. old_sha1 is the value that the reference must have
296 * before the update, or null_sha1 if it must not have existed
297 * beforehand. The old value is checked after the lock is taken to
298 * prevent races. If the old value doesn't agree with old_sha1, the
299 * whole transaction fails. If old_sha1 is NULL, then the previous
300 * value is not checked.
302 * See the above comment "Reference transaction updates" for more
305 int ref_transaction_update(struct ref_transaction
*transaction
,
307 const unsigned char *new_sha1
,
308 const unsigned char *old_sha1
,
309 unsigned int flags
, const char *msg
,
313 * Add a reference creation to transaction. new_sha1 is the value that
314 * the reference should have after the update; it must not be
315 * null_sha1. It is verified that the reference does not exist
318 * See the above comment "Reference transaction updates" for more
321 int ref_transaction_create(struct ref_transaction
*transaction
,
323 const unsigned char *new_sha1
,
324 unsigned int flags
, const char *msg
,
328 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
329 * then it holds the value that the reference should have had before
330 * the update (which must not be null_sha1).
332 * See the above comment "Reference transaction updates" for more
335 int ref_transaction_delete(struct ref_transaction
*transaction
,
337 const unsigned char *old_sha1
,
338 unsigned int flags
, const char *msg
,
342 * Verify, within a transaction, that refname has the value old_sha1,
343 * or, if old_sha1 is null_sha1, then verify that the reference
344 * doesn't exist. old_sha1 must be non-NULL.
346 * See the above comment "Reference transaction updates" for more
349 int ref_transaction_verify(struct ref_transaction
*transaction
,
351 const unsigned char *old_sha1
,
356 * Commit all of the changes that have been queued in transaction, as
357 * atomically as possible.
359 * Returns 0 for success, or one of the below error codes for errors.
361 /* Naming conflict (for example, the ref names A and A/B conflict). */
362 #define TRANSACTION_NAME_CONFLICT -1
363 /* All other errors. */
364 #define TRANSACTION_GENERIC_ERROR -2
365 int ref_transaction_commit(struct ref_transaction
*transaction
,
369 * Free an existing transaction and all associated data.
371 void ref_transaction_free(struct ref_transaction
*transaction
);
374 * Lock, update, and unlock a single reference. This function
375 * basically does a transaction containing a single call to
376 * ref_transaction_update(). The parameters to this function have the
377 * same meaning as the corresponding parameters to
378 * ref_transaction_update(). Handle errors as requested by the `onerr`
381 int update_ref(const char *msg
, const char *refname
,
382 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
383 unsigned int flags
, enum action_on_err onerr
);
385 extern int parse_hide_refs_config(const char *var
, const char *value
, const char *);
386 extern int ref_is_hidden(const char *);
388 enum expire_reflog_flags
{
389 EXPIRE_REFLOGS_DRY_RUN
= 1 << 0,
390 EXPIRE_REFLOGS_UPDATE_REF
= 1 << 1,
391 EXPIRE_REFLOGS_VERBOSE
= 1 << 2,
392 EXPIRE_REFLOGS_REWRITE
= 1 << 3
396 * The following interface is used for reflog expiration. The caller
397 * calls reflog_expire(), supplying it with three callback functions,
398 * of the following types. The callback functions define the
399 * expiration policy that is desired.
401 * reflog_expiry_prepare_fn -- Called once after the reference is
404 * reflog_expiry_should_prune_fn -- Called once for each entry in the
405 * existing reflog. It should return true iff that entry should be
408 * reflog_expiry_cleanup_fn -- Called once before the reference is
411 typedef void reflog_expiry_prepare_fn(const char *refname
,
412 const unsigned char *sha1
,
414 typedef int reflog_expiry_should_prune_fn(unsigned char *osha1
,
415 unsigned char *nsha1
,
417 unsigned long timestamp
, int tz
,
418 const char *message
, void *cb_data
);
419 typedef void reflog_expiry_cleanup_fn(void *cb_data
);
422 * Expire reflog entries for the specified reference. sha1 is the old
423 * value of the reference. flags is a combination of the constants in
424 * enum expire_reflog_flags. The three function pointers are described
425 * above. On success, return zero.
427 extern int reflog_expire(const char *refname
, const unsigned char *sha1
,
429 reflog_expiry_prepare_fn prepare_fn
,
430 reflog_expiry_should_prune_fn should_prune_fn
,
431 reflog_expiry_cleanup_fn cleanup_fn
,
432 void *policy_cb_data
);