]>
Commit | Line | Data |
---|---|---|
1 | #ifndef REFS_H | |
2 | #define REFS_H | |
3 | ||
4 | struct object_id; | |
5 | struct ref_store; | |
6 | struct strbuf; | |
7 | struct string_list; | |
8 | struct worktree; | |
9 | ||
10 | /* | |
11 | * Resolve a reference, recursively following symbolic refererences. | |
12 | * | |
13 | * Store the referred-to object's name in sha1 and return the name of | |
14 | * the non-symbolic reference that ultimately pointed at it. The | |
15 | * return value, if not NULL, is a pointer into either a static buffer | |
16 | * or the input ref. | |
17 | * | |
18 | * If the reference cannot be resolved to an object, the behavior | |
19 | * depends on the RESOLVE_REF_READING flag: | |
20 | * | |
21 | * - If RESOLVE_REF_READING is set, return NULL. | |
22 | * | |
23 | * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of | |
24 | * the last reference name in the chain, which will either be a non-symbolic | |
25 | * reference or an undefined reference. If this is a prelude to | |
26 | * "writing" to the ref, the return value is the name of the ref | |
27 | * that will actually be created or changed. | |
28 | * | |
29 | * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one | |
30 | * level of symbolic reference. The value stored in sha1 for a symbolic | |
31 | * reference will always be null_sha1 in this case, and the return | |
32 | * value is the reference that the symref refers to directly. | |
33 | * | |
34 | * If flags is non-NULL, set the value that it points to the | |
35 | * combination of REF_ISPACKED (if the reference was found among the | |
36 | * packed references), REF_ISSYMREF (if the initial reference was a | |
37 | * symbolic reference), REF_BAD_NAME (if the reference name is ill | |
38 | * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN | |
39 | * (if the ref is malformed or has a bad name). See refs.h for more detail | |
40 | * on each flag. | |
41 | * | |
42 | * If ref is not a properly-formatted, normalized reference, return | |
43 | * NULL. If more than MAXDEPTH recursive symbolic lookups are needed, | |
44 | * give up and return NULL. | |
45 | * | |
46 | * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their | |
47 | * name is invalid according to git-check-ref-format(1). If the name | |
48 | * is bad then the value stored in sha1 will be null_sha1 and the two | |
49 | * flags REF_ISBROKEN and REF_BAD_NAME will be set. | |
50 | * | |
51 | * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/ | |
52 | * directory and do not consist of all caps and underscores cannot be | |
53 | * resolved. The function returns NULL for such ref names. | |
54 | * Caps and underscores refers to the special refs, such as HEAD, | |
55 | * FETCH_HEAD and friends, that all live outside of the refs/ directory. | |
56 | */ | |
57 | #define RESOLVE_REF_READING 0x01 | |
58 | #define RESOLVE_REF_NO_RECURSE 0x02 | |
59 | #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 | |
60 | ||
61 | const char *refs_resolve_ref_unsafe(struct ref_store *refs, | |
62 | const char *refname, | |
63 | int resolve_flags, | |
64 | unsigned char *sha1, | |
65 | int *flags); | |
66 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, | |
67 | unsigned char *sha1, int *flags); | |
68 | ||
69 | char *refs_resolve_refdup(struct ref_store *refs, | |
70 | const char *refname, int resolve_flags, | |
71 | unsigned char *sha1, int *flags); | |
72 | char *resolve_refdup(const char *refname, int resolve_flags, | |
73 | unsigned char *sha1, int *flags); | |
74 | ||
75 | int refs_read_ref_full(struct ref_store *refs, const char *refname, | |
76 | int resolve_flags, unsigned char *sha1, int *flags); | |
77 | int read_ref_full(const char *refname, int resolve_flags, | |
78 | unsigned char *sha1, int *flags); | |
79 | int read_ref(const char *refname, unsigned char *sha1); | |
80 | ||
81 | /* | |
82 | * Return 0 if a reference named refname could be created without | |
83 | * conflicting with the name of an existing reference. Otherwise, | |
84 | * return a negative value and write an explanation to err. If extras | |
85 | * is non-NULL, it is a list of additional refnames with which refname | |
86 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
87 | * conflicts with refs in skip (e.g., because they are scheduled for | |
88 | * deletion in the same operation). Behavior is undefined if the same | |
89 | * name is listed in both extras and skip. | |
90 | * | |
91 | * Two reference names conflict if one of them exactly matches the | |
92 | * leading components of the other; e.g., "foo/bar" conflicts with | |
93 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
94 | * "foo/barbados". | |
95 | * | |
96 | * extras and skip must be sorted. | |
97 | */ | |
98 | ||
99 | int refs_verify_refname_available(struct ref_store *refs, | |
100 | const char *refname, | |
101 | const struct string_list *extras, | |
102 | const struct string_list *skip, | |
103 | struct strbuf *err); | |
104 | ||
105 | int ref_exists(const char *refname); | |
106 | ||
107 | int should_autocreate_reflog(const char *refname); | |
108 | ||
109 | int is_branch(const char *refname); | |
110 | ||
111 | extern int refs_init_db(struct strbuf *err); | |
112 | ||
113 | /* | |
114 | * If refname is a non-symbolic reference that refers to a tag object, | |
115 | * and the tag can be (recursively) dereferenced to a non-tag object, | |
116 | * store the SHA1 of the referred-to object to sha1 and return 0. If | |
117 | * any of these conditions are not met, return a non-zero value. | |
118 | * Symbolic references are considered unpeelable, even if they | |
119 | * ultimately resolve to a peelable tag. | |
120 | */ | |
121 | int refs_peel_ref(struct ref_store *refs, const char *refname, | |
122 | unsigned char *sha1); | |
123 | int peel_ref(const char *refname, unsigned char *sha1); | |
124 | ||
125 | /** | |
126 | * Resolve refname in the nested "gitlink" repository in the specified | |
127 | * submodule (which must be non-NULL). If the resolution is | |
128 | * successful, return 0 and set sha1 to the name of the object; | |
129 | * otherwise, return a non-zero value. | |
130 | */ | |
131 | int resolve_gitlink_ref(const char *submodule, const char *refname, | |
132 | unsigned char *sha1); | |
133 | ||
134 | /* | |
135 | * Return true iff abbrev_name is a possible abbreviation for | |
136 | * full_name according to the rules defined by ref_rev_parse_rules in | |
137 | * refs.c. | |
138 | */ | |
139 | int refname_match(const char *abbrev_name, const char *full_name); | |
140 | ||
141 | int expand_ref(const char *str, int len, unsigned char *sha1, char **ref); | |
142 | int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref); | |
143 | int dwim_log(const char *str, int len, unsigned char *sha1, char **ref); | |
144 | ||
145 | /* | |
146 | * A ref_transaction represents a collection of reference updates that | |
147 | * should succeed or fail together. | |
148 | * | |
149 | * Calling sequence | |
150 | * ---------------- | |
151 | * | |
152 | * - Allocate and initialize a `struct ref_transaction` by calling | |
153 | * `ref_transaction_begin()`. | |
154 | * | |
155 | * - Specify the intended ref updates by calling one or more of the | |
156 | * following functions: | |
157 | * - `ref_transaction_update()` | |
158 | * - `ref_transaction_create()` | |
159 | * - `ref_transaction_delete()` | |
160 | * - `ref_transaction_verify()` | |
161 | * | |
162 | * - Then either: | |
163 | * | |
164 | * - Optionally call `ref_transaction_prepare()` to prepare the | |
165 | * transaction. This locks all references, checks preconditions, | |
166 | * etc. but doesn't finalize anything. If this step fails, the | |
167 | * transaction has been closed and can only be freed. If this step | |
168 | * succeeds, then `ref_transaction_commit()` is almost certain to | |
169 | * succeed. However, you can still call `ref_transaction_abort()` | |
170 | * if you decide not to commit the transaction after all. | |
171 | * | |
172 | * - Call `ref_transaction_commit()` to execute the transaction, | |
173 | * make the changes permanent, and release all locks. If you | |
174 | * haven't already called `ref_transaction_prepare()`, then | |
175 | * `ref_transaction_commit()` calls it for you. | |
176 | * | |
177 | * Or | |
178 | * | |
179 | * - Call `initial_ref_transaction_commit()` if the ref database is | |
180 | * known to be empty and have no other writers (e.g. during | |
181 | * clone). This is likely to be much faster than | |
182 | * `ref_transaction_commit()`. `ref_transaction_prepare()` should | |
183 | * *not* be called before `initial_ref_transaction_commit()`. | |
184 | * | |
185 | * - Then finally, call `ref_transaction_free()` to free the | |
186 | * `ref_transaction` data structure. | |
187 | * | |
188 | * At any time before calling `ref_transaction_commit()`, you can call | |
189 | * `ref_transaction_abort()` to abort the transaction, rollback any | |
190 | * locks, and free any associated resources (including the | |
191 | * `ref_transaction` data structure). | |
192 | * | |
193 | * Putting it all together, a complete reference update looks like | |
194 | * | |
195 | * struct ref_transaction *transaction; | |
196 | * struct strbuf err = STRBUF_INIT; | |
197 | * int ret = 0; | |
198 | * | |
199 | * transaction = ref_store_transaction_begin(refs, &err); | |
200 | * if (!transaction || | |
201 | * ref_transaction_update(...) || | |
202 | * ref_transaction_create(...) || | |
203 | * ...etc... || | |
204 | * ref_transaction_commit(transaction, &err)) { | |
205 | * error("%s", err.buf); | |
206 | * ret = -1; | |
207 | * } | |
208 | * ref_transaction_free(transaction); | |
209 | * strbuf_release(&err); | |
210 | * return ret; | |
211 | * | |
212 | * Error handling | |
213 | * -------------- | |
214 | * | |
215 | * On error, transaction functions append a message about what | |
216 | * went wrong to the 'err' argument. The message mentions what | |
217 | * ref was being updated (if any) when the error occurred so it | |
218 | * can be passed to 'die' or 'error' as-is. | |
219 | * | |
220 | * The message is appended to err without first clearing err. | |
221 | * err will not be '\n' terminated. | |
222 | * | |
223 | * Caveats | |
224 | * ------- | |
225 | * | |
226 | * Note that no locks are taken, and no refs are read, until | |
227 | * `ref_transaction_prepare()` or `ref_transaction_commit()` is | |
228 | * called. So, for example, `ref_transaction_verify()` won't report a | |
229 | * verification failure until the commit is attempted. | |
230 | */ | |
231 | struct ref_transaction; | |
232 | ||
233 | /* | |
234 | * Bit values set in the flags argument passed to each_ref_fn() and | |
235 | * stored in ref_iterator::flags. Other bits are for internal use | |
236 | * only: | |
237 | */ | |
238 | ||
239 | /* Reference is a symbolic reference. */ | |
240 | #define REF_ISSYMREF 0x01 | |
241 | ||
242 | /* Reference is a packed reference. */ | |
243 | #define REF_ISPACKED 0x02 | |
244 | ||
245 | /* | |
246 | * Reference cannot be resolved to an object name: dangling symbolic | |
247 | * reference (directly or indirectly), corrupt reference file, | |
248 | * reference exists but name is bad, or symbolic reference refers to | |
249 | * ill-formatted reference name. | |
250 | */ | |
251 | #define REF_ISBROKEN 0x04 | |
252 | ||
253 | /* | |
254 | * Reference name is not well formed. | |
255 | * | |
256 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
257 | */ | |
258 | #define REF_BAD_NAME 0x08 | |
259 | ||
260 | /* | |
261 | * The signature for the callback function for the for_each_*() | |
262 | * functions below. The memory pointed to by the refname and sha1 | |
263 | * arguments is only guaranteed to be valid for the duration of a | |
264 | * single callback invocation. | |
265 | */ | |
266 | typedef int each_ref_fn(const char *refname, | |
267 | const struct object_id *oid, int flags, void *cb_data); | |
268 | ||
269 | /* | |
270 | * The following functions invoke the specified callback function for | |
271 | * each reference indicated. If the function ever returns a nonzero | |
272 | * value, stop the iteration and return that value. Please note that | |
273 | * it is not safe to modify references while an iteration is in | |
274 | * progress, unless the same callback function invocation that | |
275 | * modifies the reference also returns a nonzero value to immediately | |
276 | * stop the iteration. Returned references are sorted. | |
277 | */ | |
278 | int refs_for_each_ref(struct ref_store *refs, | |
279 | each_ref_fn fn, void *cb_data); | |
280 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
281 | each_ref_fn fn, void *cb_data); | |
282 | int refs_for_each_tag_ref(struct ref_store *refs, | |
283 | each_ref_fn fn, void *cb_data); | |
284 | int refs_for_each_branch_ref(struct ref_store *refs, | |
285 | each_ref_fn fn, void *cb_data); | |
286 | int refs_for_each_remote_ref(struct ref_store *refs, | |
287 | each_ref_fn fn, void *cb_data); | |
288 | ||
289 | int head_ref(each_ref_fn fn, void *cb_data); | |
290 | int for_each_ref(each_ref_fn fn, void *cb_data); | |
291 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); | |
292 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, | |
293 | unsigned int broken); | |
294 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); | |
295 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
296 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
297 | int for_each_replace_ref(each_ref_fn fn, void *cb_data); | |
298 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); | |
299 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, | |
300 | const char *prefix, void *cb_data); | |
301 | ||
302 | int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
303 | int for_each_ref_submodule(const char *submodule, | |
304 | each_ref_fn fn, void *cb_data); | |
305 | int for_each_ref_in_submodule(const char *submodule, const char *prefix, | |
306 | each_ref_fn fn, void *cb_data); | |
307 | int for_each_fullref_in_submodule(const char *submodule, const char *prefix, | |
308 | each_ref_fn fn, void *cb_data, | |
309 | unsigned int broken); | |
310 | int for_each_tag_ref_submodule(const char *submodule, | |
311 | each_ref_fn fn, void *cb_data); | |
312 | int for_each_branch_ref_submodule(const char *submodule, | |
313 | each_ref_fn fn, void *cb_data); | |
314 | int for_each_remote_ref_submodule(const char *submodule, | |
315 | each_ref_fn fn, void *cb_data); | |
316 | ||
317 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); | |
318 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
319 | ||
320 | /* can be used to learn about broken ref and symref */ | |
321 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); | |
322 | int for_each_rawref(each_ref_fn fn, void *cb_data); | |
323 | ||
324 | static inline const char *has_glob_specials(const char *pattern) | |
325 | { | |
326 | return strpbrk(pattern, "?*["); | |
327 | } | |
328 | ||
329 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); | |
330 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
331 | const struct string_list *refnames); | |
332 | ||
333 | /* | |
334 | * Flags for controlling behaviour of pack_refs() | |
335 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
336 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
337 | */ | |
338 | #define PACK_REFS_PRUNE 0x0001 | |
339 | #define PACK_REFS_ALL 0x0002 | |
340 | ||
341 | /* | |
342 | * Write a packed-refs file for the current repository. | |
343 | * flags: Combination of the above PACK_REFS_* flags. | |
344 | */ | |
345 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); | |
346 | ||
347 | /* | |
348 | * Flags controlling ref_transaction_update(), ref_transaction_create(), etc. | |
349 | * REF_NODEREF: act on the ref directly, instead of dereferencing | |
350 | * symbolic references. | |
351 | * | |
352 | * Other flags are reserved for internal use. | |
353 | */ | |
354 | #define REF_NODEREF 0x01 | |
355 | #define REF_FORCE_CREATE_REFLOG 0x40 | |
356 | ||
357 | /* | |
358 | * Flags that can be passed in to ref_transaction_update | |
359 | */ | |
360 | #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \ | |
361 | REF_ISPRUNING | \ | |
362 | REF_FORCE_CREATE_REFLOG | \ | |
363 | REF_NODEREF | |
364 | ||
365 | /* | |
366 | * Setup reflog before using. Fill in err and return -1 on failure. | |
367 | */ | |
368 | int refs_create_reflog(struct ref_store *refs, const char *refname, | |
369 | int force_create, struct strbuf *err); | |
370 | int safe_create_reflog(const char *refname, int force_create, struct strbuf *err); | |
371 | ||
372 | /** Reads log for the value of ref during at_time. **/ | |
373 | int read_ref_at(const char *refname, unsigned int flags, | |
374 | timestamp_t at_time, int cnt, | |
375 | unsigned char *sha1, char **msg, | |
376 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); | |
377 | ||
378 | /** Check if a particular reflog exists */ | |
379 | int refs_reflog_exists(struct ref_store *refs, const char *refname); | |
380 | int reflog_exists(const char *refname); | |
381 | ||
382 | /* | |
383 | * Delete the specified reference. If old_sha1 is non-NULL, then | |
384 | * verify that the current value of the reference is old_sha1 before | |
385 | * deleting it. If old_sha1 is NULL, delete the reference if it | |
386 | * exists, regardless of its old value. It is an error for old_sha1 to | |
387 | * be NULL_SHA1. msg and flags are passed through to | |
388 | * ref_transaction_delete(). | |
389 | */ | |
390 | int refs_delete_ref(struct ref_store *refs, const char *msg, | |
391 | const char *refname, | |
392 | const unsigned char *old_sha1, | |
393 | unsigned int flags); | |
394 | int delete_ref(const char *msg, const char *refname, | |
395 | const unsigned char *old_sha1, unsigned int flags); | |
396 | ||
397 | /* | |
398 | * Delete the specified references. If there are any problems, emit | |
399 | * errors but attempt to keep going (i.e., the deletes are not done in | |
400 | * an all-or-nothing transaction). msg and flags are passed through to | |
401 | * ref_transaction_delete(). | |
402 | */ | |
403 | int refs_delete_refs(struct ref_store *refs, const char *msg, | |
404 | struct string_list *refnames, unsigned int flags); | |
405 | int delete_refs(const char *msg, struct string_list *refnames, | |
406 | unsigned int flags); | |
407 | ||
408 | /** Delete a reflog */ | |
409 | int refs_delete_reflog(struct ref_store *refs, const char *refname); | |
410 | int delete_reflog(const char *refname); | |
411 | ||
412 | /* iterate over reflog entries */ | |
413 | typedef int each_reflog_ent_fn( | |
414 | struct object_id *old_oid, struct object_id *new_oid, | |
415 | const char *committer, timestamp_t timestamp, | |
416 | int tz, const char *msg, void *cb_data); | |
417 | ||
418 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, | |
419 | each_reflog_ent_fn fn, void *cb_data); | |
420 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, | |
421 | const char *refname, | |
422 | each_reflog_ent_fn fn, | |
423 | void *cb_data); | |
424 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); | |
425 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); | |
426 | ||
427 | /* | |
428 | * Calls the specified function for each reflog file until it returns nonzero, | |
429 | * and returns the value. Reflog file order is unspecified. | |
430 | */ | |
431 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); | |
432 | int for_each_reflog(each_ref_fn fn, void *cb_data); | |
433 | ||
434 | #define REFNAME_ALLOW_ONELEVEL 1 | |
435 | #define REFNAME_REFSPEC_PATTERN 2 | |
436 | ||
437 | /* | |
438 | * Return 0 iff refname has the correct format for a refname according | |
439 | * to the rules described in Documentation/git-check-ref-format.txt. | |
440 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
441 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then | |
442 | * allow a single "*" wildcard character in the refspec. No leading or | |
443 | * repeated slashes are accepted. | |
444 | */ | |
445 | int check_refname_format(const char *refname, int flags); | |
446 | ||
447 | const char *prettify_refname(const char *refname); | |
448 | ||
449 | char *shorten_unambiguous_ref(const char *refname, int strict); | |
450 | ||
451 | /** rename ref, return 0 on success **/ | |
452 | int refs_rename_ref(struct ref_store *refs, const char *oldref, | |
453 | const char *newref, const char *logmsg); | |
454 | int rename_ref(const char *oldref, const char *newref, const char *logmsg); | |
455 | ||
456 | int refs_create_symref(struct ref_store *refs, const char *refname, | |
457 | const char *target, const char *logmsg); | |
458 | int create_symref(const char *refname, const char *target, const char *logmsg); | |
459 | ||
460 | enum action_on_err { | |
461 | UPDATE_REFS_MSG_ON_ERR, | |
462 | UPDATE_REFS_DIE_ON_ERR, | |
463 | UPDATE_REFS_QUIET_ON_ERR | |
464 | }; | |
465 | ||
466 | /* | |
467 | * Begin a reference transaction. The reference transaction must | |
468 | * be freed by calling ref_transaction_free(). | |
469 | */ | |
470 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, | |
471 | struct strbuf *err); | |
472 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); | |
473 | ||
474 | /* | |
475 | * Reference transaction updates | |
476 | * | |
477 | * The following four functions add a reference check or update to a | |
478 | * ref_transaction. They have some common similar parameters: | |
479 | * | |
480 | * transaction -- a pointer to an open ref_transaction, obtained | |
481 | * from ref_transaction_begin(). | |
482 | * | |
483 | * refname -- the name of the reference to be affected. | |
484 | * | |
485 | * new_sha1 -- the SHA-1 that should be set to be the new value of | |
486 | * the reference. Some functions allow this parameter to be | |
487 | * NULL, meaning that the reference is not changed, or | |
488 | * null_sha1, meaning that the reference should be deleted. A | |
489 | * copy of this value is made in the transaction. | |
490 | * | |
491 | * old_sha1 -- the SHA-1 value that the reference must have before | |
492 | * the update. Some functions allow this parameter to be NULL, | |
493 | * meaning that the old value of the reference is not checked, | |
494 | * or null_sha1, meaning that the reference must not exist | |
495 | * before the update. A copy of this value is made in the | |
496 | * transaction. | |
497 | * | |
498 | * flags -- flags affecting the update, passed to | |
499 | * update_ref_lock(). Can be REF_NODEREF, which means that | |
500 | * symbolic references should not be followed. | |
501 | * | |
502 | * msg -- a message describing the change (for the reflog). | |
503 | * | |
504 | * err -- a strbuf for receiving a description of any error that | |
505 | * might have occurred. | |
506 | * | |
507 | * The functions make internal copies of refname and msg, so the | |
508 | * caller retains ownership of these parameters. | |
509 | * | |
510 | * The functions return 0 on success and non-zero on failure. A | |
511 | * failure means that the transaction as a whole has failed and needs | |
512 | * to be rolled back. | |
513 | */ | |
514 | ||
515 | /* | |
516 | * Add a reference update to transaction. new_sha1 is the value that | |
517 | * the reference should have after the update, or null_sha1 if it | |
518 | * should be deleted. If new_sha1 is NULL, then the reference is not | |
519 | * changed at all. old_sha1 is the value that the reference must have | |
520 | * before the update, or null_sha1 if it must not have existed | |
521 | * beforehand. The old value is checked after the lock is taken to | |
522 | * prevent races. If the old value doesn't agree with old_sha1, the | |
523 | * whole transaction fails. If old_sha1 is NULL, then the previous | |
524 | * value is not checked. | |
525 | * | |
526 | * See the above comment "Reference transaction updates" for more | |
527 | * information. | |
528 | */ | |
529 | int ref_transaction_update(struct ref_transaction *transaction, | |
530 | const char *refname, | |
531 | const unsigned char *new_sha1, | |
532 | const unsigned char *old_sha1, | |
533 | unsigned int flags, const char *msg, | |
534 | struct strbuf *err); | |
535 | ||
536 | /* | |
537 | * Add a reference creation to transaction. new_sha1 is the value that | |
538 | * the reference should have after the update; it must not be | |
539 | * null_sha1. It is verified that the reference does not exist | |
540 | * already. | |
541 | * | |
542 | * See the above comment "Reference transaction updates" for more | |
543 | * information. | |
544 | */ | |
545 | int ref_transaction_create(struct ref_transaction *transaction, | |
546 | const char *refname, | |
547 | const unsigned char *new_sha1, | |
548 | unsigned int flags, const char *msg, | |
549 | struct strbuf *err); | |
550 | ||
551 | /* | |
552 | * Add a reference deletion to transaction. If old_sha1 is non-NULL, | |
553 | * then it holds the value that the reference should have had before | |
554 | * the update (which must not be null_sha1). | |
555 | * | |
556 | * See the above comment "Reference transaction updates" for more | |
557 | * information. | |
558 | */ | |
559 | int ref_transaction_delete(struct ref_transaction *transaction, | |
560 | const char *refname, | |
561 | const unsigned char *old_sha1, | |
562 | unsigned int flags, const char *msg, | |
563 | struct strbuf *err); | |
564 | ||
565 | /* | |
566 | * Verify, within a transaction, that refname has the value old_sha1, | |
567 | * or, if old_sha1 is null_sha1, then verify that the reference | |
568 | * doesn't exist. old_sha1 must be non-NULL. | |
569 | * | |
570 | * See the above comment "Reference transaction updates" for more | |
571 | * information. | |
572 | */ | |
573 | int ref_transaction_verify(struct ref_transaction *transaction, | |
574 | const char *refname, | |
575 | const unsigned char *old_sha1, | |
576 | unsigned int flags, | |
577 | struct strbuf *err); | |
578 | ||
579 | /* Naming conflict (for example, the ref names A and A/B conflict). */ | |
580 | #define TRANSACTION_NAME_CONFLICT -1 | |
581 | /* All other errors. */ | |
582 | #define TRANSACTION_GENERIC_ERROR -2 | |
583 | ||
584 | /* | |
585 | * Perform the preparatory stages of committing `transaction`. Acquire | |
586 | * any needed locks, check preconditions, etc.; basically, do as much | |
587 | * as possible to ensure that the transaction will be able to go | |
588 | * through, stopping just short of making any irrevocable or | |
589 | * user-visible changes. The updates that this function prepares can | |
590 | * be finished up by calling `ref_transaction_commit()` or rolled back | |
591 | * by calling `ref_transaction_abort()`. | |
592 | * | |
593 | * On success, return 0 and leave the transaction in "prepared" state. | |
594 | * On failure, abort the transaction, write an error message to `err`, | |
595 | * and return one of the `TRANSACTION_*` constants. | |
596 | * | |
597 | * Callers who don't need such fine-grained control over committing | |
598 | * reference transactions should just call `ref_transaction_commit()`. | |
599 | */ | |
600 | int ref_transaction_prepare(struct ref_transaction *transaction, | |
601 | struct strbuf *err); | |
602 | ||
603 | /* | |
604 | * Commit all of the changes that have been queued in transaction, as | |
605 | * atomically as possible. On success, return 0 and leave the | |
606 | * transaction in "closed" state. On failure, roll back the | |
607 | * transaction, write an error message to `err`, and return one of the | |
608 | * `TRANSACTION_*` constants | |
609 | */ | |
610 | int ref_transaction_commit(struct ref_transaction *transaction, | |
611 | struct strbuf *err); | |
612 | ||
613 | /* | |
614 | * Abort `transaction`, which has been begun and possibly prepared, | |
615 | * but not yet committed. | |
616 | */ | |
617 | int ref_transaction_abort(struct ref_transaction *transaction, | |
618 | struct strbuf *err); | |
619 | ||
620 | /* | |
621 | * Like ref_transaction_commit(), but optimized for creating | |
622 | * references when originally initializing a repository (e.g., by "git | |
623 | * clone"). It writes the new references directly to packed-refs | |
624 | * without locking the individual references. | |
625 | * | |
626 | * It is a bug to call this function when there might be other | |
627 | * processes accessing the repository or if there are existing | |
628 | * references that might conflict with the ones being created. All | |
629 | * old_sha1 values must either be absent or NULL_SHA1. | |
630 | */ | |
631 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
632 | struct strbuf *err); | |
633 | ||
634 | /* | |
635 | * Free `*transaction` and all associated data. | |
636 | */ | |
637 | void ref_transaction_free(struct ref_transaction *transaction); | |
638 | ||
639 | /** | |
640 | * Lock, update, and unlock a single reference. This function | |
641 | * basically does a transaction containing a single call to | |
642 | * ref_transaction_update(). The parameters to this function have the | |
643 | * same meaning as the corresponding parameters to | |
644 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
645 | * argument. | |
646 | */ | |
647 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, | |
648 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
649 | unsigned int flags, enum action_on_err onerr); | |
650 | int update_ref(const char *msg, const char *refname, | |
651 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
652 | unsigned int flags, enum action_on_err onerr); | |
653 | int update_ref_oid(const char *msg, const char *refname, | |
654 | const struct object_id *new_oid, const struct object_id *old_oid, | |
655 | unsigned int flags, enum action_on_err onerr); | |
656 | ||
657 | int parse_hide_refs_config(const char *var, const char *value, const char *); | |
658 | ||
659 | /* | |
660 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
661 | * the second parameter point to the full ref name. If a namespace is set and | |
662 | * the ref is inside that namespace, the first parameter is a pointer to the | |
663 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
664 | * the ref is outside that namespace, the first parameter is NULL. The second | |
665 | * parameter always points to the full ref name. | |
666 | */ | |
667 | int ref_is_hidden(const char *, const char *); | |
668 | ||
669 | enum ref_type { | |
670 | REF_TYPE_PER_WORKTREE, | |
671 | REF_TYPE_PSEUDOREF, | |
672 | REF_TYPE_NORMAL, | |
673 | }; | |
674 | ||
675 | enum ref_type ref_type(const char *refname); | |
676 | ||
677 | enum expire_reflog_flags { | |
678 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
679 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
680 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
681 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
682 | }; | |
683 | ||
684 | /* | |
685 | * The following interface is used for reflog expiration. The caller | |
686 | * calls reflog_expire(), supplying it with three callback functions, | |
687 | * of the following types. The callback functions define the | |
688 | * expiration policy that is desired. | |
689 | * | |
690 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
691 | * locked. | |
692 | * | |
693 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
694 | * existing reflog. It should return true iff that entry should be | |
695 | * pruned. | |
696 | * | |
697 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
698 | * unlocked again. | |
699 | */ | |
700 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
701 | const struct object_id *oid, | |
702 | void *cb_data); | |
703 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, | |
704 | struct object_id *noid, | |
705 | const char *email, | |
706 | timestamp_t timestamp, int tz, | |
707 | const char *message, void *cb_data); | |
708 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
709 | ||
710 | /* | |
711 | * Expire reflog entries for the specified reference. sha1 is the old | |
712 | * value of the reference. flags is a combination of the constants in | |
713 | * enum expire_reflog_flags. The three function pointers are described | |
714 | * above. On success, return zero. | |
715 | */ | |
716 | int refs_reflog_expire(struct ref_store *refs, | |
717 | const char *refname, | |
718 | const unsigned char *sha1, | |
719 | unsigned int flags, | |
720 | reflog_expiry_prepare_fn prepare_fn, | |
721 | reflog_expiry_should_prune_fn should_prune_fn, | |
722 | reflog_expiry_cleanup_fn cleanup_fn, | |
723 | void *policy_cb_data); | |
724 | int reflog_expire(const char *refname, const unsigned char *sha1, | |
725 | unsigned int flags, | |
726 | reflog_expiry_prepare_fn prepare_fn, | |
727 | reflog_expiry_should_prune_fn should_prune_fn, | |
728 | reflog_expiry_cleanup_fn cleanup_fn, | |
729 | void *policy_cb_data); | |
730 | ||
731 | int ref_storage_backend_exists(const char *name); | |
732 | ||
733 | struct ref_store *get_main_ref_store(void); | |
734 | /* | |
735 | * Return the ref_store instance for the specified submodule. For the | |
736 | * main repository, use submodule==NULL; such a call cannot fail. For | |
737 | * a submodule, the submodule must exist and be a nonbare repository, | |
738 | * otherwise return NULL. If the requested reference store has not yet | |
739 | * been initialized, initialize it first. | |
740 | * | |
741 | * For backwards compatibility, submodule=="" is treated the same as | |
742 | * submodule==NULL. | |
743 | */ | |
744 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
745 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); | |
746 | ||
747 | #endif /* REFS_H */ |