]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
b416af5b RS |
4 | /* |
5 | * A ref_transaction represents a collection of ref updates | |
6 | * that should succeed or fail together. | |
7 | * | |
8 | * Calling sequence | |
9 | * ---------------- | |
10 | * - Allocate and initialize a `struct ref_transaction` by calling | |
11 | * `ref_transaction_begin()`. | |
12 | * | |
13 | * - List intended ref updates by calling functions like | |
14 | * `ref_transaction_update()` and `ref_transaction_create()`. | |
15 | * | |
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. | |
19 | * | |
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. | |
24 | * | |
25 | * Error handling | |
26 | * -------------- | |
27 | * | |
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. | |
32 | * | |
33 | * The message is appended to err without first clearing err. | |
34 | * err will not be '\n' terminated. | |
35 | */ | |
caa4046c MH |
36 | struct ref_transaction; |
37 | ||
89df9c84 MH |
38 | /* |
39 | * Bit values set in the flags argument passed to each_ref_fn(): | |
40 | */ | |
41 | ||
42 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 43 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
44 | |
45 | /* Reference is a packed reference. */ | |
98ac34b2 | 46 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
47 | |
48 | /* | |
49 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
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. | |
89df9c84 | 53 | */ |
98ac34b2 | 54 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 55 | |
d0f810f0 RS |
56 | /* |
57 | * Reference name is not well formed. | |
58 | * | |
59 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
60 | */ | |
61 | #define REF_BAD_NAME 0x08 | |
62 | ||
8a65ff76 | 63 | /* |
4f78c24c MH |
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. | |
68 | */ | |
69 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
70 | const struct object_id *oid, int flags, void *cb_data); |
71 | ||
72 | typedef int each_ref_sha1_fn(const char *refname, | |
73 | const unsigned char *sha1, int flags, void *cb_data); | |
74 | ||
75 | struct each_ref_fn_sha1_adapter { | |
76 | each_ref_sha1_fn *original_fn; | |
77 | void *original_cb_data; | |
78 | }; | |
79 | ||
80 | extern int each_ref_fn_adapter(const char *refname, | |
81 | const struct object_id *oid, int flags, void *cb_data); | |
4f78c24c MH |
82 | |
83 | /* | |
84 | * The following functions invoke the specified callback function for | |
85 | * each reference indicated. If the function ever returns a nonzero | |
86 | * value, stop the iteration and return that value. Please note that | |
87 | * it is not safe to modify references while an iteration is in | |
88 | * progress, unless the same callback function invocation that | |
89 | * modifies the reference also returns a nonzero value to immediately | |
90 | * stop the iteration. | |
8a65ff76 | 91 | */ |
cb5d709f JH |
92 | extern int head_ref(each_ref_fn, void *); |
93 | extern int for_each_ref(each_ref_fn, void *); | |
2a8177b6 | 94 | extern int for_each_ref_in(const char *, each_ref_fn, void *); |
cb5d709f JH |
95 | extern int for_each_tag_ref(each_ref_fn, void *); |
96 | extern int for_each_branch_ref(each_ref_fn, void *); | |
97 | extern int for_each_remote_ref(each_ref_fn, void *); | |
29268700 | 98 | extern int for_each_replace_ref(each_ref_fn, void *); |
d08bae7e | 99 | extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *); |
b09fe971 | 100 | extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *); |
8a65ff76 | 101 | |
9ef6aeb0 HV |
102 | extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); |
103 | extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
104 | extern int for_each_ref_in_submodule(const char *submodule, const char *prefix, | |
105 | each_ref_fn fn, void *cb_data); | |
106 | extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
107 | extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
108 | extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
109 | ||
a1bea2c1 JT |
110 | extern int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
111 | extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
112 | ||
894a9d33 TR |
113 | static inline const char *has_glob_specials(const char *pattern) |
114 | { | |
115 | return strpbrk(pattern, "?*["); | |
116 | } | |
117 | ||
f8948e2f JH |
118 | /* can be used to learn about broken ref and symref */ |
119 | extern int for_each_rawref(each_ref_fn, void *); | |
120 | ||
3cf6134a | 121 | extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
24d36f14 | 122 | extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames); |
f8948e2f | 123 | |
30249ee6 | 124 | /* |
9f69d297 MH |
125 | * Lock the packed-refs file for writing. Flags is passed to |
126 | * hold_lock_file_for_update(). Return 0 on success. | |
447ff1bf | 127 | * Errno is set to something meaningful on error. |
9f69d297 MH |
128 | */ |
129 | extern int lock_packed_refs(int flags); | |
130 | ||
131 | /* | |
132 | * Add a reference to the in-memory packed reference cache. This may | |
133 | * only be called while the packed-refs file is locked (see | |
134 | * lock_packed_refs()). To actually write the packed-refs file, call | |
135 | * commit_packed_refs(). | |
30249ee6 MH |
136 | */ |
137 | extern void add_packed_ref(const char *refname, const unsigned char *sha1); | |
138 | ||
9f69d297 MH |
139 | /* |
140 | * Write the current version of the packed refs cache from memory to | |
141 | * disk. The packed-refs file must already be locked for writing (see | |
142 | * lock_packed_refs()). Return zero on success. | |
d3f66555 | 143 | * Sets errno to something meaningful on error. |
9f69d297 MH |
144 | */ |
145 | extern int commit_packed_refs(void); | |
146 | ||
147 | /* | |
148 | * Rollback the lockfile for the packed-refs file, and discard the | |
149 | * in-memory packed reference cache. (The packed-refs file will be | |
150 | * read anew if it is needed again after this function is called.) | |
151 | */ | |
152 | extern void rollback_packed_refs(void); | |
153 | ||
32d462ce MH |
154 | /* |
155 | * Flags for controlling behaviour of pack_refs() | |
156 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
157 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
158 | */ | |
159 | #define PACK_REFS_PRUNE 0x0001 | |
160 | #define PACK_REFS_ALL 0x0002 | |
161 | ||
162 | /* | |
163 | * Write a packed-refs file for the current repository. | |
164 | * flags: Combination of the above PACK_REFS_* flags. | |
165 | */ | |
166 | int pack_refs(unsigned int flags); | |
167 | ||
4a45b2f3 MH |
168 | /* |
169 | * Rewrite the packed-refs file, omitting any refs listed in | |
170 | * 'refnames'. On error, packed-refs will be unchanged, the return | |
171 | * value is nonzero, and a message about the error is written to the | |
172 | * 'err' strbuf. | |
173 | * | |
174 | * The refs in 'refnames' needn't be sorted. `err` must not be NULL. | |
175 | */ | |
176 | extern int repack_without_refs(struct string_list *refnames, | |
60bca085 | 177 | struct strbuf *err); |
c9e768bb | 178 | |
2c5c66be | 179 | extern int ref_exists(const char *); |
e142a3c6 | 180 | |
e7e0f26e RS |
181 | extern int is_branch(const char *refname); |
182 | ||
2312a793 MH |
183 | /* |
184 | * If refname is a non-symbolic reference that refers to a tag object, | |
185 | * and the tag can be (recursively) dereferenced to a non-tag object, | |
186 | * store the SHA1 of the referred-to object to sha1 and return 0. If | |
187 | * any of these conditions are not met, return a non-zero value. | |
188 | * Symbolic references are considered unpeelable, even if they | |
189 | * ultimately resolve to a peelable tag. | |
190 | */ | |
dfefa935 | 191 | extern int peel_ref(const char *refname, unsigned char *sha1); |
cf0adba7 | 192 | |
835e3c99 | 193 | /* |
31e07f76 | 194 | * Flags controlling ref_transaction_update(), ref_transaction_create(), etc. |
029cdb4a RS |
195 | * REF_NODEREF: act on the ref directly, instead of dereferencing |
196 | * symbolic references. | |
197 | * | |
581d4e0c | 198 | * Other flags are reserved for internal use. |
835e3c99 | 199 | */ |
68db31cc | 200 | #define REF_NODEREF 0x01 |
95fc7512 | 201 | |
bd3b02da RS |
202 | /* |
203 | * Setup reflog before using. Set errno to something meaningful on failure. | |
204 | */ | |
1a83c240 | 205 | int log_ref_setup(const char *refname, struct strbuf *logfile); |
859c3017 | 206 | |
d556fae2 | 207 | /** Reads log for the value of ref during at_time. **/ |
c41a87dd DA |
208 | extern int read_ref_at(const char *refname, unsigned int flags, |
209 | unsigned long at_time, int cnt, | |
dfefa935 MH |
210 | unsigned char *sha1, char **msg, |
211 | unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt); | |
d556fae2 | 212 | |
4da58835 RS |
213 | /** Check if a particular reflog exists */ |
214 | extern int reflog_exists(const char *refname); | |
215 | ||
216 | /** Delete a reflog */ | |
217 | extern int delete_reflog(const char *refname); | |
218 | ||
2ff81662 | 219 | /* iterate over reflog entries */ |
883d60fa | 220 | typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *); |
dfefa935 | 221 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
98f85ff4 | 222 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 223 | |
eb8381c8 NP |
224 | /* |
225 | * Calls the specified function for each reflog file until it returns nonzero, | |
226 | * and returns the value | |
227 | */ | |
228 | extern int for_each_reflog(each_ref_fn, void *); | |
229 | ||
8d9c5010 MH |
230 | #define REFNAME_ALLOW_ONELEVEL 1 |
231 | #define REFNAME_REFSPEC_PATTERN 2 | |
232 | ||
233 | /* | |
dfefa935 MH |
234 | * Return 0 iff refname has the correct format for a refname according |
235 | * to the rules described in Documentation/git-check-ref-format.txt. | |
236 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 MH |
237 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
238 | * allow a "*" wildcard character in place of one of the name | |
f3cc52d8 | 239 | * components. No leading or repeated slashes are accepted. |
8d9c5010 | 240 | */ |
dfefa935 | 241 | extern int check_refname_format(const char *refname, int flags); |
95fc7512 | 242 | |
4577e483 | 243 | extern const char *prettify_refname(const char *refname); |
dfefa935 | 244 | extern char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 245 | |
c976d415 | 246 | /** rename ref, return 0 on success **/ |
678d0f4c | 247 | extern int rename_ref(const char *oldref, const char *newref, const char *logmsg); |
c976d415 | 248 | |
7f820bd9 MH |
249 | /** |
250 | * Resolve refname in the nested "gitlink" repository that is located | |
251 | * at path. If the resolution is successful, return 0 and set sha1 to | |
252 | * the name of the object; otherwise, return a non-zero value. | |
253 | */ | |
254 | extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1); | |
0ebde32c | 255 | |
f4124112 MH |
256 | enum action_on_err { |
257 | UPDATE_REFS_MSG_ON_ERR, | |
258 | UPDATE_REFS_DIE_ON_ERR, | |
259 | UPDATE_REFS_QUIET_ON_ERR | |
260 | }; | |
261 | ||
caa4046c MH |
262 | /* |
263 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 264 | * be freed by calling ref_transaction_free(). |
caa4046c | 265 | */ |
93a644ea | 266 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 267 | |
caa4046c | 268 | /* |
d1dd721f MH |
269 | * Reference transaction updates |
270 | * | |
271 | * The following four functions add a reference check or update to a | |
272 | * ref_transaction. They have some common similar parameters: | |
273 | * | |
274 | * transaction -- a pointer to an open ref_transaction, obtained | |
275 | * from ref_transaction_begin(). | |
276 | * | |
277 | * refname -- the name of the reference to be affected. | |
278 | * | |
279 | * flags -- flags affecting the update, passed to | |
280 | * update_ref_lock(). Can be REF_NODEREF, which means that | |
281 | * symbolic references should not be followed. | |
282 | * | |
283 | * msg -- a message describing the change (for the reflog). | |
284 | * | |
285 | * err -- a strbuf for receiving a description of any error that | |
286 | * might have occured. | |
287 | * | |
288 | * The functions make internal copies of refname and msg, so the | |
289 | * caller retains ownership of these parameters. | |
290 | * | |
291 | * The functions return 0 on success and non-zero on failure. A | |
292 | * failure means that the transaction as a whole has failed and needs | |
293 | * to be rolled back. | |
caa4046c MH |
294 | */ |
295 | ||
caa4046c | 296 | /* |
16180334 MH |
297 | * Add a reference update to transaction. new_sha1 is the value that |
298 | * the reference should have after the update, or null_sha1 if it | |
299 | * should be deleted. If new_sha1 is NULL, then the reference is not | |
300 | * changed at all. old_sha1 is the value that the reference must have | |
301 | * before the update, or null_sha1 if it must not have existed | |
302 | * beforehand. The old value is checked after the lock is taken to | |
303 | * prevent races. If the old value doesn't agree with old_sha1, the | |
304 | * whole transaction fails. If old_sha1 is NULL, then the previous | |
305 | * value is not checked. | |
306 | * | |
d1dd721f MH |
307 | * See the above comment "Reference transaction updates" for more |
308 | * information. | |
caa4046c | 309 | */ |
8e34800e RS |
310 | int ref_transaction_update(struct ref_transaction *transaction, |
311 | const char *refname, | |
312 | const unsigned char *new_sha1, | |
313 | const unsigned char *old_sha1, | |
1d147bdf | 314 | unsigned int flags, const char *msg, |
8e34800e | 315 | struct strbuf *err); |
caa4046c MH |
316 | |
317 | /* | |
d1dd721f MH |
318 | * Add a reference creation to transaction. new_sha1 is the value that |
319 | * the reference should have after the update; it must not be | |
320 | * null_sha1. It is verified that the reference does not exist | |
caa4046c | 321 | * already. |
d1dd721f MH |
322 | * |
323 | * See the above comment "Reference transaction updates" for more | |
324 | * information. | |
caa4046c | 325 | */ |
b416af5b RS |
326 | int ref_transaction_create(struct ref_transaction *transaction, |
327 | const char *refname, | |
328 | const unsigned char *new_sha1, | |
fec14ec3 | 329 | unsigned int flags, const char *msg, |
b416af5b | 330 | struct strbuf *err); |
caa4046c MH |
331 | |
332 | /* | |
d1dd721f MH |
333 | * Add a reference deletion to transaction. If old_sha1 is non-NULL, |
334 | * then it holds the value that the reference should have had before | |
335 | * the update (which must not be null_sha1). | |
336 | * | |
337 | * See the above comment "Reference transaction updates" for more | |
338 | * information. | |
caa4046c | 339 | */ |
8c8bdc0d RS |
340 | int ref_transaction_delete(struct ref_transaction *transaction, |
341 | const char *refname, | |
342 | const unsigned char *old_sha1, | |
fb5a6bb6 | 343 | unsigned int flags, const char *msg, |
8c8bdc0d | 344 | struct strbuf *err); |
caa4046c | 345 | |
16180334 MH |
346 | /* |
347 | * Verify, within a transaction, that refname has the value old_sha1, | |
348 | * or, if old_sha1 is null_sha1, then verify that the reference | |
d1dd721f MH |
349 | * doesn't exist. old_sha1 must be non-NULL. |
350 | * | |
351 | * See the above comment "Reference transaction updates" for more | |
352 | * information. | |
16180334 MH |
353 | */ |
354 | int ref_transaction_verify(struct ref_transaction *transaction, | |
355 | const char *refname, | |
356 | const unsigned char *old_sha1, | |
357 | unsigned int flags, | |
358 | struct strbuf *err); | |
359 | ||
caa4046c MH |
360 | /* |
361 | * Commit all of the changes that have been queued in transaction, as | |
28e6a97e RS |
362 | * atomically as possible. |
363 | * | |
364 | * Returns 0 for success, or one of the below error codes for errors. | |
caa4046c | 365 | */ |
28e6a97e RS |
366 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
367 | #define TRANSACTION_NAME_CONFLICT -1 | |
368 | /* All other errors. */ | |
369 | #define TRANSACTION_GENERIC_ERROR -2 | |
caa4046c | 370 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 371 | struct strbuf *err); |
caa4046c | 372 | |
026bd1d3 RS |
373 | /* |
374 | * Free an existing transaction and all associated data. | |
375 | */ | |
376 | void ref_transaction_free(struct ref_transaction *transaction); | |
377 | ||
4b7b520b MH |
378 | /** |
379 | * Lock, update, and unlock a single reference. This function | |
380 | * basically does a transaction containing a single call to | |
381 | * ref_transaction_update(). The parameters to this function have the | |
382 | * same meaning as the corresponding parameters to | |
383 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
384 | * argument. | |
385 | */ | |
386 | int update_ref(const char *msg, const char *refname, | |
387 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
fec14ec3 | 388 | unsigned int flags, enum action_on_err onerr); |
3d9f037c | 389 | |
daebaa78 JH |
390 | extern int parse_hide_refs_config(const char *var, const char *value, const char *); |
391 | extern int ref_is_hidden(const char *); | |
392 | ||
fa5b1830 MH |
393 | enum expire_reflog_flags { |
394 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
395 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
396 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
397 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
398 | }; | |
399 | ||
400 | /* | |
401 | * The following interface is used for reflog expiration. The caller | |
402 | * calls reflog_expire(), supplying it with three callback functions, | |
403 | * of the following types. The callback functions define the | |
404 | * expiration policy that is desired. | |
405 | * | |
406 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
407 | * locked. | |
408 | * | |
409 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
410 | * existing reflog. It should return true iff that entry should be | |
411 | * pruned. | |
412 | * | |
413 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
414 | * unlocked again. | |
415 | */ | |
416 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
417 | const unsigned char *sha1, | |
418 | void *cb_data); | |
419 | typedef int reflog_expiry_should_prune_fn(unsigned char *osha1, | |
420 | unsigned char *nsha1, | |
421 | const char *email, | |
422 | unsigned long timestamp, int tz, | |
423 | const char *message, void *cb_data); | |
424 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
425 | ||
426 | /* | |
427 | * Expire reflog entries for the specified reference. sha1 is the old | |
428 | * value of the reference. flags is a combination of the constants in | |
429 | * enum expire_reflog_flags. The three function pointers are described | |
430 | * above. On success, return zero. | |
431 | */ | |
432 | extern int reflog_expire(const char *refname, const unsigned char *sha1, | |
433 | unsigned int flags, | |
434 | reflog_expiry_prepare_fn prepare_fn, | |
435 | reflog_expiry_should_prune_fn should_prune_fn, | |
436 | reflog_expiry_cleanup_fn cleanup_fn, | |
437 | void *policy_cb_data); | |
438 | ||
95fc7512 | 439 | #endif /* REFS_H */ |