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