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