]>
Commit | Line | Data |
---|---|---|
95fc7512 DB |
1 | #ifndef REFS_H |
2 | #define REFS_H | |
3 | ||
504c4d42 | 4 | struct object_id; |
077be78d | 5 | struct ref_store; |
504c4d42 NTND |
6 | struct strbuf; |
7 | struct string_list; | |
17eff96b | 8 | struct worktree; |
504c4d42 | 9 | |
fb58c8d5 MH |
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 | ||
7d2df051 NTND |
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); | |
1354c9b2 MH |
66 | const char *resolve_ref_unsafe(const char *refname, int resolve_flags, |
67 | unsigned char *sha1, int *flags); | |
fb58c8d5 | 68 | |
7d2df051 NTND |
69 | char *refs_resolve_refdup(struct ref_store *refs, |
70 | const char *refname, int resolve_flags, | |
71 | unsigned char *sha1, int *flags); | |
1354c9b2 MH |
72 | char *resolve_refdup(const char *refname, int resolve_flags, |
73 | unsigned char *sha1, int *flags); | |
fb58c8d5 | 74 | |
7d2df051 NTND |
75 | int refs_read_ref_full(struct ref_store *refs, const char *refname, |
76 | int resolve_flags, unsigned char *sha1, int *flags); | |
1354c9b2 MH |
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); | |
fb58c8d5 | 80 | |
7d2df051 NTND |
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, | |
b05855b5 | 101 | const struct string_list *extras, |
7d2df051 NTND |
102 | const struct string_list *skip, |
103 | struct strbuf *err); | |
104 | ||
1354c9b2 | 105 | int ref_exists(const char *refname); |
fb58c8d5 | 106 | |
341fb286 CW |
107 | int should_autocreate_reflog(const char *refname); |
108 | ||
1354c9b2 | 109 | int is_branch(const char *refname); |
fb58c8d5 | 110 | |
6fb5acfd DT |
111 | extern int refs_init_db(struct strbuf *err); |
112 | ||
fb58c8d5 MH |
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 | */ | |
7d2df051 NTND |
121 | int refs_peel_ref(struct ref_store *refs, const char *refname, |
122 | unsigned char *sha1); | |
1354c9b2 | 123 | int peel_ref(const char *refname, unsigned char *sha1); |
fb58c8d5 MH |
124 | |
125 | /** | |
a8355bb7 MH |
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. | |
fb58c8d5 | 130 | */ |
a8355bb7 | 131 | int resolve_gitlink_ref(const char *submodule, const char *refname, |
1354c9b2 | 132 | unsigned char *sha1); |
fb58c8d5 MH |
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 | */ | |
1354c9b2 | 139 | int refname_match(const char *abbrev_name, const char *full_name); |
fb58c8d5 | 140 | |
a460ea4a | 141 | int expand_ref(const char *str, int len, unsigned char *sha1, char **ref); |
1354c9b2 MH |
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); | |
fb58c8d5 | 144 | |
b416af5b RS |
145 | /* |
146 | * A ref_transaction represents a collection of ref updates | |
147 | * that should succeed or fail together. | |
148 | * | |
149 | * Calling sequence | |
150 | * ---------------- | |
151 | * - Allocate and initialize a `struct ref_transaction` by calling | |
152 | * `ref_transaction_begin()`. | |
153 | * | |
154 | * - List intended ref updates by calling functions like | |
155 | * `ref_transaction_update()` and `ref_transaction_create()`. | |
156 | * | |
157 | * - Call `ref_transaction_commit()` to execute the transaction. | |
158 | * If this succeeds, the ref updates will have taken place and | |
159 | * the transaction cannot be rolled back. | |
160 | * | |
49386868 DT |
161 | * - Instead of `ref_transaction_commit`, use |
162 | * `initial_ref_transaction_commit()` if the ref database is known | |
163 | * to be empty (e.g. during clone). This is likely to be much | |
164 | * faster. | |
165 | * | |
b416af5b RS |
166 | * - At any time call `ref_transaction_free()` to discard the |
167 | * transaction and free associated resources. In particular, | |
168 | * this rolls back the transaction if it has not been | |
169 | * successfully committed. | |
170 | * | |
171 | * Error handling | |
172 | * -------------- | |
173 | * | |
174 | * On error, transaction functions append a message about what | |
175 | * went wrong to the 'err' argument. The message mentions what | |
176 | * ref was being updated (if any) when the error occurred so it | |
177 | * can be passed to 'die' or 'error' as-is. | |
178 | * | |
179 | * The message is appended to err without first clearing err. | |
180 | * err will not be '\n' terminated. | |
49386868 DT |
181 | * |
182 | * Caveats | |
183 | * ------- | |
184 | * | |
185 | * Note that no locks are taken, and no refs are read, until | |
186 | * `ref_transaction_commit` is called. So `ref_transaction_verify` | |
187 | * won't report a verification failure until the commit is attempted. | |
b416af5b | 188 | */ |
caa4046c MH |
189 | struct ref_transaction; |
190 | ||
89df9c84 | 191 | /* |
3bc581b9 MH |
192 | * Bit values set in the flags argument passed to each_ref_fn() and |
193 | * stored in ref_iterator::flags. Other bits are for internal use | |
194 | * only: | |
89df9c84 MH |
195 | */ |
196 | ||
197 | /* Reference is a symbolic reference. */ | |
98ac34b2 | 198 | #define REF_ISSYMREF 0x01 |
89df9c84 MH |
199 | |
200 | /* Reference is a packed reference. */ | |
98ac34b2 | 201 | #define REF_ISPACKED 0x02 |
89df9c84 MH |
202 | |
203 | /* | |
204 | * Reference cannot be resolved to an object name: dangling symbolic | |
d0f810f0 RS |
205 | * reference (directly or indirectly), corrupt reference file, |
206 | * reference exists but name is bad, or symbolic reference refers to | |
207 | * ill-formatted reference name. | |
89df9c84 | 208 | */ |
98ac34b2 | 209 | #define REF_ISBROKEN 0x04 |
f4204ab9 | 210 | |
d0f810f0 RS |
211 | /* |
212 | * Reference name is not well formed. | |
213 | * | |
214 | * See git-check-ref-format(1) for the definition of well formed ref names. | |
215 | */ | |
216 | #define REF_BAD_NAME 0x08 | |
217 | ||
8a65ff76 | 218 | /* |
4f78c24c MH |
219 | * The signature for the callback function for the for_each_*() |
220 | * functions below. The memory pointed to by the refname and sha1 | |
221 | * arguments is only guaranteed to be valid for the duration of a | |
222 | * single callback invocation. | |
223 | */ | |
224 | typedef int each_ref_fn(const char *refname, | |
2b2a5be3 MH |
225 | const struct object_id *oid, int flags, void *cb_data); |
226 | ||
4f78c24c MH |
227 | /* |
228 | * The following functions invoke the specified callback function for | |
229 | * each reference indicated. If the function ever returns a nonzero | |
230 | * value, stop the iteration and return that value. Please note that | |
231 | * it is not safe to modify references while an iteration is in | |
232 | * progress, unless the same callback function invocation that | |
233 | * modifies the reference also returns a nonzero value to immediately | |
adac8115 | 234 | * stop the iteration. Returned references are sorted. |
8a65ff76 | 235 | */ |
7d2df051 NTND |
236 | int refs_for_each_ref(struct ref_store *refs, |
237 | each_ref_fn fn, void *cb_data); | |
238 | int refs_for_each_ref_in(struct ref_store *refs, const char *prefix, | |
239 | each_ref_fn fn, void *cb_data); | |
240 | int refs_for_each_tag_ref(struct ref_store *refs, | |
241 | each_ref_fn fn, void *cb_data); | |
242 | int refs_for_each_branch_ref(struct ref_store *refs, | |
243 | each_ref_fn fn, void *cb_data); | |
244 | int refs_for_each_remote_ref(struct ref_store *refs, | |
245 | each_ref_fn fn, void *cb_data); | |
246 | ||
1354c9b2 MH |
247 | int head_ref(each_ref_fn fn, void *cb_data); |
248 | int for_each_ref(each_ref_fn fn, void *cb_data); | |
249 | int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data); | |
250 | int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, | |
251 | unsigned int broken); | |
252 | int for_each_tag_ref(each_ref_fn fn, void *cb_data); | |
253 | int for_each_branch_ref(each_ref_fn fn, void *cb_data); | |
254 | int for_each_remote_ref(each_ref_fn fn, void *cb_data); | |
255 | int for_each_replace_ref(each_ref_fn fn, void *cb_data); | |
256 | int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data); | |
257 | int for_each_glob_ref_in(each_ref_fn fn, const char *pattern, | |
258 | const char *prefix, void *cb_data); | |
259 | ||
260 | int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data); | |
261 | int for_each_ref_submodule(const char *submodule, | |
262 | each_ref_fn fn, void *cb_data); | |
263 | int for_each_ref_in_submodule(const char *submodule, const char *prefix, | |
9ef6aeb0 | 264 | each_ref_fn fn, void *cb_data); |
1354c9b2 MH |
265 | int for_each_tag_ref_submodule(const char *submodule, |
266 | each_ref_fn fn, void *cb_data); | |
267 | int for_each_branch_ref_submodule(const char *submodule, | |
268 | each_ref_fn fn, void *cb_data); | |
269 | int for_each_remote_ref_submodule(const char *submodule, | |
270 | each_ref_fn fn, void *cb_data); | |
9ef6aeb0 | 271 | |
1354c9b2 MH |
272 | int head_ref_namespaced(each_ref_fn fn, void *cb_data); |
273 | int for_each_namespaced_ref(each_ref_fn fn, void *cb_data); | |
a1bea2c1 | 274 | |
fb58c8d5 | 275 | /* can be used to learn about broken ref and symref */ |
7d2df051 | 276 | int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 277 | int for_each_rawref(each_ref_fn fn, void *cb_data); |
fb58c8d5 | 278 | |
894a9d33 TR |
279 | static inline const char *has_glob_specials(const char *pattern) |
280 | { | |
281 | return strpbrk(pattern, "?*["); | |
282 | } | |
283 | ||
1354c9b2 MH |
284 | void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname); |
285 | void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, | |
286 | const struct string_list *refnames); | |
f8948e2f | 287 | |
32d462ce MH |
288 | /* |
289 | * Flags for controlling behaviour of pack_refs() | |
290 | * PACK_REFS_PRUNE: Prune loose refs after packing | |
291 | * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs | |
292 | */ | |
293 | #define PACK_REFS_PRUNE 0x0001 | |
294 | #define PACK_REFS_ALL 0x0002 | |
295 | ||
296 | /* | |
297 | * Write a packed-refs file for the current repository. | |
298 | * flags: Combination of the above PACK_REFS_* flags. | |
299 | */ | |
7d2df051 | 300 | int refs_pack_refs(struct ref_store *refs, unsigned int flags); |
32d462ce | 301 | |
835e3c99 | 302 | /* |
31e07f76 | 303 | * Flags controlling ref_transaction_update(), ref_transaction_create(), etc. |
029cdb4a RS |
304 | * REF_NODEREF: act on the ref directly, instead of dereferencing |
305 | * symbolic references. | |
306 | * | |
581d4e0c | 307 | * Other flags are reserved for internal use. |
835e3c99 | 308 | */ |
68db31cc | 309 | #define REF_NODEREF 0x01 |
0f2a71d9 | 310 | #define REF_FORCE_CREATE_REFLOG 0x40 |
95fc7512 | 311 | |
bd3b02da | 312 | /* |
a4c653df | 313 | * Setup reflog before using. Fill in err and return -1 on failure. |
bd3b02da | 314 | */ |
7d2df051 NTND |
315 | int refs_create_reflog(struct ref_store *refs, const char *refname, |
316 | int force_create, struct strbuf *err); | |
abd0cd3a | 317 | int safe_create_reflog(const char *refname, int force_create, struct strbuf *err); |
859c3017 | 318 | |
d556fae2 | 319 | /** Reads log for the value of ref during at_time. **/ |
1354c9b2 | 320 | int read_ref_at(const char *refname, unsigned int flags, |
dddbad72 | 321 | timestamp_t at_time, int cnt, |
1354c9b2 | 322 | unsigned char *sha1, char **msg, |
dddbad72 | 323 | timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt); |
d556fae2 | 324 | |
4da58835 | 325 | /** Check if a particular reflog exists */ |
7d2df051 | 326 | int refs_reflog_exists(struct ref_store *refs, const char *refname); |
1354c9b2 | 327 | int reflog_exists(const char *refname); |
4da58835 | 328 | |
fc1c2168 | 329 | /* |
1c03c4d3 MH |
330 | * Delete the specified reference. If old_sha1 is non-NULL, then |
331 | * verify that the current value of the reference is old_sha1 before | |
332 | * deleting it. If old_sha1 is NULL, delete the reference if it | |
333 | * exists, regardless of its old value. It is an error for old_sha1 to | |
64da4199 MH |
334 | * be NULL_SHA1. msg and flags are passed through to |
335 | * ref_transaction_delete(). | |
fc1c2168 | 336 | */ |
c0fe4e8b NTND |
337 | int refs_delete_ref(struct ref_store *refs, const char *msg, |
338 | const char *refname, | |
339 | const unsigned char *old_sha1, | |
340 | unsigned int flags); | |
755b49ae KM |
341 | int delete_ref(const char *msg, const char *refname, |
342 | const unsigned char *old_sha1, unsigned int flags); | |
fc1c2168 | 343 | |
98ffd5ff MH |
344 | /* |
345 | * Delete the specified references. If there are any problems, emit | |
346 | * errors but attempt to keep going (i.e., the deletes are not done in | |
64da4199 | 347 | * an all-or-nothing transaction). msg and flags are passed through to |
c5f04ddd | 348 | * ref_transaction_delete(). |
98ffd5ff | 349 | */ |
64da4199 MH |
350 | int refs_delete_refs(struct ref_store *refs, const char *msg, |
351 | struct string_list *refnames, unsigned int flags); | |
352 | int delete_refs(const char *msg, struct string_list *refnames, | |
353 | unsigned int flags); | |
98ffd5ff | 354 | |
4da58835 | 355 | /** Delete a reflog */ |
7d2df051 | 356 | int refs_delete_reflog(struct ref_store *refs, const char *refname); |
1354c9b2 | 357 | int delete_reflog(const char *refname); |
4da58835 | 358 | |
2ff81662 | 359 | /* iterate over reflog entries */ |
1354c9b2 | 360 | typedef int each_reflog_ent_fn( |
9461d272 | 361 | struct object_id *old_oid, struct object_id *new_oid, |
dddbad72 | 362 | const char *committer, timestamp_t timestamp, |
1354c9b2 MH |
363 | int tz, const char *msg, void *cb_data); |
364 | ||
7d2df051 NTND |
365 | int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname, |
366 | each_reflog_ent_fn fn, void *cb_data); | |
367 | int refs_for_each_reflog_ent_reverse(struct ref_store *refs, | |
368 | const char *refname, | |
369 | each_reflog_ent_fn fn, | |
370 | void *cb_data); | |
dfefa935 | 371 | int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
98f85ff4 | 372 | int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data); |
2ff81662 | 373 | |
eb8381c8 NP |
374 | /* |
375 | * Calls the specified function for each reflog file until it returns nonzero, | |
adac8115 | 376 | * and returns the value. Reflog file order is unspecified. |
eb8381c8 | 377 | */ |
7d2df051 | 378 | int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data); |
1354c9b2 | 379 | int for_each_reflog(each_ref_fn fn, void *cb_data); |
eb8381c8 | 380 | |
8d9c5010 MH |
381 | #define REFNAME_ALLOW_ONELEVEL 1 |
382 | #define REFNAME_REFSPEC_PATTERN 2 | |
383 | ||
384 | /* | |
dfefa935 MH |
385 | * Return 0 iff refname has the correct format for a refname according |
386 | * to the rules described in Documentation/git-check-ref-format.txt. | |
387 | * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level | |
8d9c5010 | 388 | * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then |
cd377f45 JK |
389 | * allow a single "*" wildcard character in the refspec. No leading or |
390 | * repeated slashes are accepted. | |
8d9c5010 | 391 | */ |
1354c9b2 | 392 | int check_refname_format(const char *refname, int flags); |
95fc7512 | 393 | |
1354c9b2 | 394 | const char *prettify_refname(const char *refname); |
fb58c8d5 | 395 | |
1354c9b2 | 396 | char *shorten_unambiguous_ref(const char *refname, int strict); |
a9c37a72 | 397 | |
c976d415 | 398 | /** rename ref, return 0 on success **/ |
7d2df051 NTND |
399 | int refs_rename_ref(struct ref_store *refs, const char *oldref, |
400 | const char *newref, const char *logmsg); | |
1354c9b2 | 401 | int rename_ref(const char *oldref, const char *newref, const char *logmsg); |
c976d415 | 402 | |
7d2df051 NTND |
403 | int refs_create_symref(struct ref_store *refs, const char *refname, |
404 | const char *target, const char *logmsg); | |
1354c9b2 | 405 | int create_symref(const char *refname, const char *target, const char *logmsg); |
0ebde32c | 406 | |
f4124112 MH |
407 | enum action_on_err { |
408 | UPDATE_REFS_MSG_ON_ERR, | |
409 | UPDATE_REFS_DIE_ON_ERR, | |
410 | UPDATE_REFS_QUIET_ON_ERR | |
411 | }; | |
412 | ||
caa4046c MH |
413 | /* |
414 | * Begin a reference transaction. The reference transaction must | |
33f9fc59 | 415 | * be freed by calling ref_transaction_free(). |
caa4046c | 416 | */ |
c0fe4e8b NTND |
417 | struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs, |
418 | struct strbuf *err); | |
93a644ea | 419 | struct ref_transaction *ref_transaction_begin(struct strbuf *err); |
caa4046c | 420 | |
caa4046c | 421 | /* |
d1dd721f MH |
422 | * Reference transaction updates |
423 | * | |
424 | * The following four functions add a reference check or update to a | |
425 | * ref_transaction. They have some common similar parameters: | |
426 | * | |
427 | * transaction -- a pointer to an open ref_transaction, obtained | |
428 | * from ref_transaction_begin(). | |
429 | * | |
430 | * refname -- the name of the reference to be affected. | |
431 | * | |
fd2ce9c0 MH |
432 | * new_sha1 -- the SHA-1 that should be set to be the new value of |
433 | * the reference. Some functions allow this parameter to be | |
434 | * NULL, meaning that the reference is not changed, or | |
435 | * null_sha1, meaning that the reference should be deleted. A | |
436 | * copy of this value is made in the transaction. | |
437 | * | |
438 | * old_sha1 -- the SHA-1 value that the reference must have before | |
439 | * the update. Some functions allow this parameter to be NULL, | |
440 | * meaning that the old value of the reference is not checked, | |
441 | * or null_sha1, meaning that the reference must not exist | |
442 | * before the update. A copy of this value is made in the | |
443 | * transaction. | |
444 | * | |
d1dd721f MH |
445 | * flags -- flags affecting the update, passed to |
446 | * update_ref_lock(). Can be REF_NODEREF, which means that | |
447 | * symbolic references should not be followed. | |
448 | * | |
449 | * msg -- a message describing the change (for the reflog). | |
450 | * | |
451 | * err -- a strbuf for receiving a description of any error that | |
dc72b500 | 452 | * might have occurred. |
d1dd721f MH |
453 | * |
454 | * The functions make internal copies of refname and msg, so the | |
455 | * caller retains ownership of these parameters. | |
456 | * | |
457 | * The functions return 0 on success and non-zero on failure. A | |
458 | * failure means that the transaction as a whole has failed and needs | |
459 | * to be rolled back. | |
caa4046c MH |
460 | */ |
461 | ||
caa4046c | 462 | /* |
16180334 MH |
463 | * Add a reference update to transaction. new_sha1 is the value that |
464 | * the reference should have after the update, or null_sha1 if it | |
465 | * should be deleted. If new_sha1 is NULL, then the reference is not | |
466 | * changed at all. old_sha1 is the value that the reference must have | |
467 | * before the update, or null_sha1 if it must not have existed | |
468 | * beforehand. The old value is checked after the lock is taken to | |
469 | * prevent races. If the old value doesn't agree with old_sha1, the | |
470 | * whole transaction fails. If old_sha1 is NULL, then the previous | |
471 | * value is not checked. | |
472 | * | |
d1dd721f MH |
473 | * See the above comment "Reference transaction updates" for more |
474 | * information. | |
caa4046c | 475 | */ |
8e34800e RS |
476 | int ref_transaction_update(struct ref_transaction *transaction, |
477 | const char *refname, | |
478 | const unsigned char *new_sha1, | |
479 | const unsigned char *old_sha1, | |
1d147bdf | 480 | unsigned int flags, const char *msg, |
8e34800e | 481 | struct strbuf *err); |
caa4046c MH |
482 | |
483 | /* | |
d1dd721f MH |
484 | * Add a reference creation to transaction. new_sha1 is the value that |
485 | * the reference should have after the update; it must not be | |
486 | * null_sha1. It is verified that the reference does not exist | |
caa4046c | 487 | * already. |
d1dd721f MH |
488 | * |
489 | * See the above comment "Reference transaction updates" for more | |
490 | * information. | |
caa4046c | 491 | */ |
b416af5b RS |
492 | int ref_transaction_create(struct ref_transaction *transaction, |
493 | const char *refname, | |
494 | const unsigned char *new_sha1, | |
fec14ec3 | 495 | unsigned int flags, const char *msg, |
b416af5b | 496 | struct strbuf *err); |
caa4046c MH |
497 | |
498 | /* | |
d1dd721f MH |
499 | * Add a reference deletion to transaction. If old_sha1 is non-NULL, |
500 | * then it holds the value that the reference should have had before | |
501 | * the update (which must not be null_sha1). | |
502 | * | |
503 | * See the above comment "Reference transaction updates" for more | |
504 | * information. | |
caa4046c | 505 | */ |
8c8bdc0d RS |
506 | int ref_transaction_delete(struct ref_transaction *transaction, |
507 | const char *refname, | |
508 | const unsigned char *old_sha1, | |
fb5a6bb6 | 509 | unsigned int flags, const char *msg, |
8c8bdc0d | 510 | struct strbuf *err); |
caa4046c | 511 | |
16180334 MH |
512 | /* |
513 | * Verify, within a transaction, that refname has the value old_sha1, | |
514 | * or, if old_sha1 is null_sha1, then verify that the reference | |
d1dd721f MH |
515 | * doesn't exist. old_sha1 must be non-NULL. |
516 | * | |
517 | * See the above comment "Reference transaction updates" for more | |
518 | * information. | |
16180334 MH |
519 | */ |
520 | int ref_transaction_verify(struct ref_transaction *transaction, | |
521 | const char *refname, | |
522 | const unsigned char *old_sha1, | |
523 | unsigned int flags, | |
524 | struct strbuf *err); | |
525 | ||
caa4046c MH |
526 | /* |
527 | * Commit all of the changes that have been queued in transaction, as | |
28e6a97e RS |
528 | * atomically as possible. |
529 | * | |
530 | * Returns 0 for success, or one of the below error codes for errors. | |
caa4046c | 531 | */ |
28e6a97e RS |
532 | /* Naming conflict (for example, the ref names A and A/B conflict). */ |
533 | #define TRANSACTION_NAME_CONFLICT -1 | |
534 | /* All other errors. */ | |
535 | #define TRANSACTION_GENERIC_ERROR -2 | |
caa4046c | 536 | int ref_transaction_commit(struct ref_transaction *transaction, |
db7516ab | 537 | struct strbuf *err); |
caa4046c | 538 | |
58f233ce MH |
539 | /* |
540 | * Like ref_transaction_commit(), but optimized for creating | |
541 | * references when originally initializing a repository (e.g., by "git | |
542 | * clone"). It writes the new references directly to packed-refs | |
543 | * without locking the individual references. | |
544 | * | |
545 | * It is a bug to call this function when there might be other | |
546 | * processes accessing the repository or if there are existing | |
547 | * references that might conflict with the ones being created. All | |
548 | * old_sha1 values must either be absent or NULL_SHA1. | |
549 | */ | |
550 | int initial_ref_transaction_commit(struct ref_transaction *transaction, | |
551 | struct strbuf *err); | |
552 | ||
026bd1d3 RS |
553 | /* |
554 | * Free an existing transaction and all associated data. | |
555 | */ | |
556 | void ref_transaction_free(struct ref_transaction *transaction); | |
557 | ||
4b7b520b MH |
558 | /** |
559 | * Lock, update, and unlock a single reference. This function | |
560 | * basically does a transaction containing a single call to | |
561 | * ref_transaction_update(). The parameters to this function have the | |
562 | * same meaning as the corresponding parameters to | |
563 | * ref_transaction_update(). Handle errors as requested by the `onerr` | |
564 | * argument. | |
565 | */ | |
c0fe4e8b NTND |
566 | int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname, |
567 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
568 | unsigned int flags, enum action_on_err onerr); | |
4b7b520b MH |
569 | int update_ref(const char *msg, const char *refname, |
570 | const unsigned char *new_sha1, const unsigned char *old_sha1, | |
fec14ec3 | 571 | unsigned int flags, enum action_on_err onerr); |
8f6dc7e3 | 572 | int update_ref_oid(const char *msg, const char *refname, |
573 | const struct object_id *new_oid, const struct object_id *old_oid, | |
574 | unsigned int flags, enum action_on_err onerr); | |
3d9f037c | 575 | |
1354c9b2 | 576 | int parse_hide_refs_config(const char *var, const char *value, const char *); |
fb58c8d5 | 577 | |
78a766ab LF |
578 | /* |
579 | * Check whether a ref is hidden. If no namespace is set, both the first and | |
580 | * the second parameter point to the full ref name. If a namespace is set and | |
581 | * the ref is inside that namespace, the first parameter is a pointer to the | |
582 | * name of the ref with the namespace prefix removed. If a namespace is set and | |
583 | * the ref is outside that namespace, the first parameter is NULL. The second | |
584 | * parameter always points to the full ref name. | |
585 | */ | |
1354c9b2 | 586 | int ref_is_hidden(const char *, const char *); |
daebaa78 | 587 | |
266b1827 DT |
588 | enum ref_type { |
589 | REF_TYPE_PER_WORKTREE, | |
590 | REF_TYPE_PSEUDOREF, | |
591 | REF_TYPE_NORMAL, | |
592 | }; | |
593 | ||
594 | enum ref_type ref_type(const char *refname); | |
595 | ||
fa5b1830 MH |
596 | enum expire_reflog_flags { |
597 | EXPIRE_REFLOGS_DRY_RUN = 1 << 0, | |
598 | EXPIRE_REFLOGS_UPDATE_REF = 1 << 1, | |
599 | EXPIRE_REFLOGS_VERBOSE = 1 << 2, | |
600 | EXPIRE_REFLOGS_REWRITE = 1 << 3 | |
601 | }; | |
602 | ||
603 | /* | |
604 | * The following interface is used for reflog expiration. The caller | |
605 | * calls reflog_expire(), supplying it with three callback functions, | |
606 | * of the following types. The callback functions define the | |
607 | * expiration policy that is desired. | |
608 | * | |
609 | * reflog_expiry_prepare_fn -- Called once after the reference is | |
610 | * locked. | |
611 | * | |
612 | * reflog_expiry_should_prune_fn -- Called once for each entry in the | |
613 | * existing reflog. It should return true iff that entry should be | |
614 | * pruned. | |
615 | * | |
616 | * reflog_expiry_cleanup_fn -- Called once before the reference is | |
617 | * unlocked again. | |
618 | */ | |
619 | typedef void reflog_expiry_prepare_fn(const char *refname, | |
4322478a | 620 | const struct object_id *oid, |
fa5b1830 | 621 | void *cb_data); |
4322478a | 622 | typedef int reflog_expiry_should_prune_fn(struct object_id *ooid, |
623 | struct object_id *noid, | |
fa5b1830 | 624 | const char *email, |
dddbad72 | 625 | timestamp_t timestamp, int tz, |
fa5b1830 MH |
626 | const char *message, void *cb_data); |
627 | typedef void reflog_expiry_cleanup_fn(void *cb_data); | |
628 | ||
629 | /* | |
630 | * Expire reflog entries for the specified reference. sha1 is the old | |
631 | * value of the reference. flags is a combination of the constants in | |
632 | * enum expire_reflog_flags. The three function pointers are described | |
633 | * above. On success, return zero. | |
634 | */ | |
7d2df051 NTND |
635 | int refs_reflog_expire(struct ref_store *refs, |
636 | const char *refname, | |
637 | const unsigned char *sha1, | |
638 | unsigned int flags, | |
639 | reflog_expiry_prepare_fn prepare_fn, | |
640 | reflog_expiry_should_prune_fn should_prune_fn, | |
641 | reflog_expiry_cleanup_fn cleanup_fn, | |
642 | void *policy_cb_data); | |
1354c9b2 MH |
643 | int reflog_expire(const char *refname, const unsigned char *sha1, |
644 | unsigned int flags, | |
645 | reflog_expiry_prepare_fn prepare_fn, | |
646 | reflog_expiry_should_prune_fn should_prune_fn, | |
647 | reflog_expiry_cleanup_fn cleanup_fn, | |
648 | void *policy_cb_data); | |
fa5b1830 | 649 | |
3dce444f RS |
650 | int ref_storage_backend_exists(const char *name); |
651 | ||
077be78d | 652 | struct ref_store *get_main_ref_store(void); |
18d0002d NTND |
653 | /* |
654 | * Return the ref_store instance for the specified submodule. For the | |
655 | * main repository, use submodule==NULL; such a call cannot fail. For | |
656 | * a submodule, the submodule must exist and be a nonbare repository, | |
657 | * otherwise return NULL. If the requested reference store has not yet | |
658 | * been initialized, initialize it first. | |
659 | * | |
660 | * For backwards compatibility, submodule=="" is treated the same as | |
661 | * submodule==NULL. | |
662 | */ | |
663 | struct ref_store *get_submodule_ref_store(const char *submodule); | |
17eff96b | 664 | struct ref_store *get_worktree_ref_store(const struct worktree *wt); |
077be78d | 665 | |
95fc7512 | 666 | #endif /* REFS_H */ |