]>
Commit | Line | Data |
---|---|---|
4cb77009 MH |
1 | #ifndef REFS_REFS_INTERNAL_H |
2 | #define REFS_REFS_INTERNAL_H | |
3 | ||
4eb4416d | 4 | #include "refs.h" |
13f925f3 | 5 | #include "iterator.h" |
91c2f204 | 6 | |
4eb4416d RJ |
7 | struct ref_transaction; |
8 | ||
4cb77009 MH |
9 | /* |
10 | * Data structures and functions for the internal use of the refs | |
11 | * module. Code outside of the refs module should use only the public | |
12 | * functions defined in "refs.h", and should *not* include this file. | |
13 | */ | |
14 | ||
15 | /* | |
5ac95fee | 16 | * The following flags can appear in `ref_update::flags`. Their |
91774afc | 17 | * numerical values must not conflict with those of REF_NO_DEREF and |
5ac95fee MH |
18 | * REF_FORCE_CREATE_REFLOG, which are also stored in |
19 | * `ref_update::flags`. | |
4cb77009 | 20 | */ |
4cb77009 MH |
21 | |
22 | /* | |
78fb4579 | 23 | * The reference should be updated to new_oid. |
4cb77009 | 24 | */ |
5ac95fee | 25 | #define REF_HAVE_NEW (1 << 2) |
4cb77009 MH |
26 | |
27 | /* | |
5ac95fee | 28 | * The current reference's value should be checked to make sure that |
78fb4579 | 29 | * it agrees with old_oid. |
4cb77009 | 30 | */ |
5ac95fee | 31 | #define REF_HAVE_OLD (1 << 3) |
44639777 | 32 | |
63c05673 HWN |
33 | /* |
34 | * Used as a flag in ref_update::flags when we want to log a ref | |
35 | * update but not actually perform it. This is used when a symbolic | |
36 | * ref update is split up. | |
37 | */ | |
38 | #define REF_LOG_ONLY (1 << 7) | |
39 | ||
4ff0f01c MH |
40 | /* |
41 | * Return the length of time to retry acquiring a loose reference lock | |
42 | * before giving up, in milliseconds: | |
43 | */ | |
44 | long get_files_ref_lock_timeout_ms(void); | |
45 | ||
4cb77009 MH |
46 | /* |
47 | * Return true iff refname is minimally safe. "Safe" here means that | |
48 | * deleting a loose reference by this name will not do any damage, for | |
49 | * example by causing a file that is not a reference to be deleted. | |
50 | * This function does not check that the reference name is legal; for | |
51 | * that, use check_refname_format(). | |
52 | * | |
15ee2c72 MH |
53 | * A refname that starts with "refs/" is considered safe iff it |
54 | * doesn't contain any "." or ".." components or consecutive '/' | |
55 | * characters, end with '/', or (on Windows) contain any '\' | |
56 | * characters. Names that do not start with "refs/" are considered | |
57 | * safe iff they consist entirely of upper case characters and '_' | |
58 | * (like "HEAD" and "MERGE_HEAD" but not "config" or "FOO/BAR"). | |
4cb77009 MH |
59 | */ |
60 | int refname_is_safe(const char *refname); | |
61 | ||
67be7c5a MH |
62 | /* |
63 | * Helper function: return true if refname, which has the specified | |
64 | * oid and flags, can be resolved to an object in the database. If the | |
65 | * referred-to object does not exist, emit a warning and return false. | |
66 | */ | |
67 | int ref_resolves_to_object(const char *refname, | |
9bc45a28 | 68 | struct repository *repo, |
67be7c5a MH |
69 | const struct object_id *oid, |
70 | unsigned int flags); | |
71 | ||
4cb77009 MH |
72 | enum peel_status { |
73 | /* object was peeled successfully: */ | |
74 | PEEL_PEELED = 0, | |
75 | ||
76 | /* | |
77 | * object cannot be peeled because the named object (or an | |
78 | * object referred to by a tag in the peel chain), does not | |
79 | * exist. | |
80 | */ | |
81 | PEEL_INVALID = -1, | |
82 | ||
83 | /* object cannot be peeled because it is not a tag: */ | |
84 | PEEL_NON_TAG = -2, | |
85 | ||
86 | /* ref_entry contains no peeled value because it is a symref: */ | |
87 | PEEL_IS_SYMREF = -3, | |
88 | ||
89 | /* | |
90 | * ref_entry cannot be peeled because it is broken (i.e., the | |
91 | * symbolic reference cannot even be resolved to an object | |
92 | * name): | |
93 | */ | |
94 | PEEL_BROKEN = -4 | |
95 | }; | |
96 | ||
97 | /* | |
98 | * Peel the named object; i.e., if the object is a tag, resolve the | |
99 | * tag recursively until a non-tag is found. If successful, store the | |
ac2ed0d7 | 100 | * result to oid and return PEEL_PEELED. If the object is not a tag |
4cb77009 | 101 | * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively, |
78fb4579 | 102 | * and leave oid unchanged. |
4cb77009 | 103 | */ |
ac2ed0d7 | 104 | enum peel_status peel_object(const struct object_id *name, struct object_id *oid); |
4cb77009 | 105 | |
4cb77009 | 106 | /** |
78fb4579 MH |
107 | * Information needed for a single ref update. Set new_oid to the new |
108 | * value or to null_oid to delete the ref. To check the old value | |
109 | * while the ref is locked, set (flags & REF_HAVE_OLD) and set old_oid | |
110 | * to the old value, or to null_oid to ensure the ref does not exist | |
111 | * before update. | |
4cb77009 MH |
112 | */ |
113 | struct ref_update { | |
114 | /* | |
5ac95fee MH |
115 | * If (flags & REF_HAVE_NEW), set the reference to this value |
116 | * (or delete it, if `new_oid` is `null_oid`). | |
4cb77009 | 117 | */ |
98491298 | 118 | struct object_id new_oid; |
6e30b2f6 | 119 | |
4cb77009 MH |
120 | /* |
121 | * If (flags & REF_HAVE_OLD), check that the reference | |
5ac95fee MH |
122 | * previously had this value (or didn't previously exist, if |
123 | * `old_oid` is `null_oid`). | |
4cb77009 | 124 | */ |
98491298 | 125 | struct object_id old_oid; |
6e30b2f6 | 126 | |
4cb77009 | 127 | /* |
91774afc | 128 | * One or more of REF_NO_DEREF, REF_FORCE_CREATE_REFLOG, |
5ac95fee | 129 | * REF_HAVE_NEW, REF_HAVE_OLD, or backend-specific flags. |
4cb77009 MH |
130 | */ |
131 | unsigned int flags; | |
6e30b2f6 | 132 | |
7d618264 | 133 | void *backend_data; |
92b1551b | 134 | unsigned int type; |
4cb77009 | 135 | char *msg; |
6e30b2f6 MH |
136 | |
137 | /* | |
138 | * If this ref_update was split off of a symref update via | |
139 | * split_symref_update(), then this member points at that | |
140 | * update. This is used for two purposes: | |
141 | * 1. When reporting errors, we report the refname under which | |
142 | * the update was originally requested. | |
143 | * 2. When we read the old value of this reference, we | |
144 | * propagate it back to its parent update for recording in | |
145 | * the latter's reflog. | |
146 | */ | |
147 | struct ref_update *parent_update; | |
148 | ||
4cb77009 MH |
149 | const char refname[FLEX_ARRAY]; |
150 | }; | |
151 | ||
8b72fea7 HWN |
152 | int refs_read_raw_ref(struct ref_store *ref_store, const char *refname, |
153 | struct object_id *oid, struct strbuf *referent, | |
154 | unsigned int *type, int *failure_errno); | |
470be518 | 155 | |
2ced105c MH |
156 | /* |
157 | * Write an error to `err` and return a nonzero value iff the same | |
158 | * refname appears multiple times in `refnames`. `refnames` must be | |
159 | * sorted on entry to this function. | |
160 | */ | |
161 | int ref_update_reject_duplicates(struct string_list *refnames, | |
162 | struct strbuf *err); | |
163 | ||
71564516 MH |
164 | /* |
165 | * Add a ref_update with the specified properties to transaction, and | |
166 | * return a pointer to the new object. This function does not verify | |
78fb4579 | 167 | * that refname is well-formed. new_oid and old_oid are only |
71564516 MH |
168 | * dereferenced if the REF_HAVE_NEW and REF_HAVE_OLD bits, |
169 | * respectively, are set in flags. | |
170 | */ | |
171 | struct ref_update *ref_transaction_add_update( | |
172 | struct ref_transaction *transaction, | |
173 | const char *refname, unsigned int flags, | |
89f3bbdd | 174 | const struct object_id *new_oid, |
175 | const struct object_id *old_oid, | |
71564516 MH |
176 | const char *msg); |
177 | ||
4cb77009 MH |
178 | /* |
179 | * Transaction states. | |
30173b88 MH |
180 | * |
181 | * OPEN: The transaction is initialized and new updates can still be | |
182 | * added to it. An OPEN transaction can be prepared, | |
183 | * committed, freed, or aborted (freeing and aborting an open | |
184 | * transaction are equivalent). | |
185 | * | |
186 | * PREPARED: ref_transaction_prepare(), which locks all of the | |
187 | * references involved in the update and checks that the | |
188 | * update has no errors, has been called successfully for the | |
189 | * transaction. A PREPARED transaction can be committed or | |
190 | * aborted. | |
191 | * | |
192 | * CLOSED: The transaction is no longer active. A transaction becomes | |
193 | * CLOSED if there is a failure while building the transaction | |
194 | * or if a transaction is committed or aborted. A CLOSED | |
195 | * transaction can only be freed. | |
4cb77009 MH |
196 | */ |
197 | enum ref_transaction_state { | |
30173b88 MH |
198 | REF_TRANSACTION_OPEN = 0, |
199 | REF_TRANSACTION_PREPARED = 1, | |
200 | REF_TRANSACTION_CLOSED = 2 | |
4cb77009 MH |
201 | }; |
202 | ||
203 | /* | |
204 | * Data structure for holding a reference transaction, which can | |
205 | * consist of checks and updates to multiple references, carried out | |
206 | * as atomically as possible. This structure is opaque to callers. | |
207 | */ | |
208 | struct ref_transaction { | |
c0fe4e8b | 209 | struct ref_store *ref_store; |
4cb77009 MH |
210 | struct ref_update **updates; |
211 | size_t alloc; | |
212 | size_t nr; | |
213 | enum ref_transaction_state state; | |
3bf4f561 | 214 | void *backend_data; |
4cb77009 MH |
215 | }; |
216 | ||
0845122c DT |
217 | /* |
218 | * Check for entries in extras that are within the specified | |
219 | * directory, where dirname is a reference directory name including | |
220 | * the trailing slash (e.g., "refs/heads/foo/"). Ignore any | |
221 | * conflicting references that are found in skip. If there is a | |
222 | * conflicting reference, return its name. | |
223 | * | |
224 | * extras and skip must be sorted lists of reference names. Either one | |
225 | * can be NULL, signifying the empty list. | |
226 | */ | |
227 | const char *find_descendant_ref(const char *dirname, | |
228 | const struct string_list *extras, | |
229 | const struct string_list *skip); | |
230 | ||
2d0663b2 DT |
231 | /* We allow "recursive" symbolic refs. Only within reason, though */ |
232 | #define SYMREF_MAXDEPTH 5 | |
93770590 | 233 | |
bf708add | 234 | /* |
9aab952e JK |
235 | * These flags are passed to refs_ref_iterator_begin() (and do_for_each_ref(), |
236 | * which feeds it). | |
bf708add | 237 | */ |
9aab952e JK |
238 | enum do_for_each_ref_flags { |
239 | /* | |
240 | * Include broken references in a do_for_each_ref*() iteration, which | |
241 | * would normally be omitted. This includes both refs that point to | |
242 | * missing objects (a true repository corruption), ones with illegal | |
243 | * names (which we prefer not to expose to callers), as well as | |
244 | * dangling symbolic refs (i.e., those that point to a non-existent | |
245 | * ref; this is not a corruption, but as they have no valid oid, we | |
246 | * omit them from normal iteration results). | |
247 | */ | |
248 | DO_FOR_EACH_INCLUDE_BROKEN = (1 << 0), | |
249 | ||
250 | /* | |
251 | * Only include per-worktree refs in a do_for_each_ref*() iteration. | |
252 | * Normally this will be used with a files ref_store, since that's | |
253 | * where all reference backends will presumably store their | |
254 | * per-worktree refs. | |
255 | */ | |
256 | DO_FOR_EACH_PER_WORKTREE_ONLY = (1 << 1), | |
8dccb224 JK |
257 | |
258 | /* | |
259 | * Omit dangling symrefs from output; this only has an effect with | |
260 | * INCLUDE_BROKEN, since they are otherwise not included at all. | |
261 | */ | |
262 | DO_FOR_EACH_OMIT_DANGLING_SYMREFS = (1 << 2), | |
9aab952e | 263 | }; |
93770590 | 264 | |
3bc581b9 MH |
265 | /* |
266 | * Reference iterators | |
267 | * | |
268 | * A reference iterator encapsulates the state of an in-progress | |
269 | * iteration over references. Create an instance of `struct | |
270 | * ref_iterator` via one of the functions in this module. | |
271 | * | |
272 | * A freshly-created ref_iterator doesn't yet point at a reference. To | |
273 | * advance the iterator, call ref_iterator_advance(). If successful, | |
274 | * this sets the iterator's refname, oid, and flags fields to describe | |
275 | * the next reference and returns ITER_OK. The data pointed at by | |
276 | * refname and oid belong to the iterator; if you want to retain them | |
277 | * after calling ref_iterator_advance() again or calling | |
278 | * ref_iterator_abort(), you must make a copy. When the iteration has | |
279 | * been exhausted, ref_iterator_advance() releases any resources | |
15beaaa3 | 280 | * associated with the iteration, frees the ref_iterator object, and |
3bc581b9 MH |
281 | * returns ITER_DONE. If you want to abort the iteration early, call |
282 | * ref_iterator_abort(), which also frees the ref_iterator object and | |
283 | * any associated resources. If there was an internal error advancing | |
284 | * to the next entry, ref_iterator_advance() aborts the iteration, | |
285 | * frees the ref_iterator, and returns ITER_ERROR. | |
286 | * | |
287 | * The reference currently being looked at can be peeled by calling | |
288 | * ref_iterator_peel(). This function is often faster than peel_ref(), | |
289 | * so it should be preferred when iterating over references. | |
290 | * | |
291 | * Putting it all together, a typical iteration looks like this: | |
292 | * | |
293 | * int ok; | |
294 | * struct ref_iterator *iter = ...; | |
295 | * | |
296 | * while ((ok = ref_iterator_advance(iter)) == ITER_OK) { | |
297 | * if (want_to_stop_iteration()) { | |
298 | * ok = ref_iterator_abort(iter); | |
299 | * break; | |
300 | * } | |
301 | * | |
302 | * // Access information about the current reference: | |
303 | * if (!(iter->flags & REF_ISSYMREF)) | |
7b6057c8 | 304 | * printf("%s is %s\n", iter->refname, oid_to_hex(iter->oid)); |
3bc581b9 MH |
305 | * |
306 | * // If you need to peel the reference: | |
307 | * ref_iterator_peel(iter, &oid); | |
308 | * } | |
309 | * | |
310 | * if (ok != ITER_DONE) | |
311 | * handle_error(); | |
312 | */ | |
313 | struct ref_iterator { | |
314 | struct ref_iterator_vtable *vtable; | |
8738a8a4 MH |
315 | |
316 | /* | |
317 | * Does this `ref_iterator` iterate over references in order | |
318 | * by refname? | |
319 | */ | |
320 | unsigned int ordered : 1; | |
321 | ||
3bc581b9 MH |
322 | const char *refname; |
323 | const struct object_id *oid; | |
324 | unsigned int flags; | |
325 | }; | |
326 | ||
327 | /* | |
328 | * Advance the iterator to the first or next item and return ITER_OK. | |
329 | * If the iteration is exhausted, free the resources associated with | |
330 | * the ref_iterator and return ITER_DONE. On errors, free the iterator | |
331 | * resources and return ITER_ERROR. It is a bug to use ref_iterator or | |
332 | * call this function again after it has returned ITER_DONE or | |
333 | * ITER_ERROR. | |
334 | */ | |
335 | int ref_iterator_advance(struct ref_iterator *ref_iterator); | |
336 | ||
337 | /* | |
338 | * If possible, peel the reference currently being viewed by the | |
339 | * iterator. Return 0 on success. | |
340 | */ | |
341 | int ref_iterator_peel(struct ref_iterator *ref_iterator, | |
342 | struct object_id *peeled); | |
343 | ||
344 | /* | |
345 | * End the iteration before it has been exhausted, freeing the | |
346 | * reference iterator and any associated resources and returning | |
347 | * ITER_DONE. If the abort itself failed, return ITER_ERROR. | |
348 | */ | |
349 | int ref_iterator_abort(struct ref_iterator *ref_iterator); | |
350 | ||
351 | /* | |
352 | * An iterator over nothing (its first ref_iterator_advance() call | |
353 | * returns ITER_DONE). | |
354 | */ | |
355 | struct ref_iterator *empty_ref_iterator_begin(void); | |
356 | ||
357 | /* | |
358 | * Return true iff ref_iterator is an empty_ref_iterator. | |
359 | */ | |
360 | int is_empty_ref_iterator(struct ref_iterator *ref_iterator); | |
361 | ||
e121b9cb MH |
362 | /* |
363 | * Return an iterator that goes over each reference in `refs` for | |
364 | * which the refname begins with prefix. If trim is non-zero, then | |
84ee4ca1 | 365 | * trim that many characters off the beginning of each refname. |
9aab952e | 366 | * The output is ordered by refname. |
e121b9cb MH |
367 | */ |
368 | struct ref_iterator *refs_ref_iterator_begin( | |
369 | struct ref_store *refs, | |
9aab952e JK |
370 | const char *prefix, int trim, |
371 | enum do_for_each_ref_flags flags); | |
e121b9cb | 372 | |
3bc581b9 MH |
373 | /* |
374 | * A callback function used to instruct merge_ref_iterator how to | |
375 | * interleave the entries from iter0 and iter1. The function should | |
376 | * return one of the constants defined in enum iterator_selection. It | |
377 | * must not advance either of the iterators itself. | |
378 | * | |
379 | * The function must be prepared to handle the case that iter0 and/or | |
380 | * iter1 is NULL, which indicates that the corresponding sub-iterator | |
381 | * has been exhausted. Its return value must be consistent with the | |
382 | * current states of the iterators; e.g., it must not return | |
383 | * ITER_SKIP_1 if iter1 has already been exhausted. | |
384 | */ | |
385 | typedef enum iterator_selection ref_iterator_select_fn( | |
386 | struct ref_iterator *iter0, struct ref_iterator *iter1, | |
387 | void *cb_data); | |
388 | ||
389 | /* | |
390 | * Iterate over the entries from iter0 and iter1, with the values | |
391 | * interleaved as directed by the select function. The iterator takes | |
392 | * ownership of iter0 and iter1 and frees them when the iteration is | |
8738a8a4 MH |
393 | * over. A derived class should set `ordered` to 1 or 0 based on |
394 | * whether it generates its output in order by reference name. | |
3bc581b9 MH |
395 | */ |
396 | struct ref_iterator *merge_ref_iterator_begin( | |
8738a8a4 | 397 | int ordered, |
3bc581b9 MH |
398 | struct ref_iterator *iter0, struct ref_iterator *iter1, |
399 | ref_iterator_select_fn *select, void *cb_data); | |
400 | ||
401 | /* | |
402 | * An iterator consisting of the union of the entries from front and | |
403 | * back. If there are entries common to the two sub-iterators, use the | |
404 | * one from front. Each iterator must iterate over its entries in | |
405 | * strcmp() order by refname for this to work. | |
406 | * | |
407 | * The new iterator takes ownership of its arguments and frees them | |
408 | * when the iteration is over. As a convenience to callers, if front | |
409 | * or back is an empty_ref_iterator, then abort that one immediately | |
410 | * and return the other iterator directly, without wrapping it. | |
411 | */ | |
412 | struct ref_iterator *overlay_ref_iterator_begin( | |
413 | struct ref_iterator *front, struct ref_iterator *back); | |
414 | ||
415 | /* | |
416 | * Wrap iter0, only letting through the references whose names start | |
417 | * with prefix. If trim is set, set iter->refname to the name of the | |
418 | * reference with that many characters trimmed off the front; | |
419 | * otherwise set it to the full refname. The new iterator takes over | |
420 | * ownership of iter0 and frees it when iteration is over. It makes | |
421 | * its own copy of prefix. | |
422 | * | |
423 | * As an convenience to callers, if prefix is the empty string and | |
424 | * trim is zero, this function returns iter0 directly, without | |
425 | * wrapping it. | |
8738a8a4 MH |
426 | * |
427 | * The resulting ref_iterator is ordered if iter0 is. | |
3bc581b9 MH |
428 | */ |
429 | struct ref_iterator *prefix_ref_iterator_begin(struct ref_iterator *iter0, | |
430 | const char *prefix, | |
431 | int trim); | |
432 | ||
3bc581b9 MH |
433 | /* Internal implementation of reference iteration: */ |
434 | ||
435 | /* | |
436 | * Base class constructor for ref_iterators. Initialize the | |
437 | * ref_iterator part of iter, setting its vtable pointer as specified. | |
8738a8a4 MH |
438 | * `ordered` should be set to 1 if the iterator will iterate over |
439 | * references in order by refname; otherwise it should be set to 0. | |
3bc581b9 MH |
440 | * This is meant to be called only by the initializers of derived |
441 | * classes. | |
442 | */ | |
443 | void base_ref_iterator_init(struct ref_iterator *iter, | |
8738a8a4 MH |
444 | struct ref_iterator_vtable *vtable, |
445 | int ordered); | |
3bc581b9 MH |
446 | |
447 | /* | |
448 | * Base class destructor for ref_iterators. Destroy the ref_iterator | |
449 | * part of iter and shallow-free the object. This is meant to be | |
450 | * called only by the destructors of derived classes. | |
451 | */ | |
452 | void base_ref_iterator_free(struct ref_iterator *iter); | |
453 | ||
454 | /* Virtual function declarations for ref_iterators: */ | |
455 | ||
84ee4ca1 HWN |
456 | /* |
457 | * backend-specific implementation of ref_iterator_advance. For symrefs, the | |
458 | * function should set REF_ISSYMREF, and it should also dereference the symref | |
9aab952e JK |
459 | * to provide the OID referent. It should respect do_for_each_ref_flags |
460 | * that were passed to refs_ref_iterator_begin(). | |
84ee4ca1 | 461 | */ |
3bc581b9 MH |
462 | typedef int ref_iterator_advance_fn(struct ref_iterator *ref_iterator); |
463 | ||
617480d7 HWN |
464 | /* |
465 | * Peels the current ref, returning 0 for success or -1 for failure. | |
466 | */ | |
3bc581b9 MH |
467 | typedef int ref_iterator_peel_fn(struct ref_iterator *ref_iterator, |
468 | struct object_id *peeled); | |
469 | ||
470 | /* | |
471 | * Implementations of this function should free any resources specific | |
472 | * to the derived class, then call base_ref_iterator_free() to clean | |
473 | * up and free the ref_iterator object. | |
474 | */ | |
475 | typedef int ref_iterator_abort_fn(struct ref_iterator *ref_iterator); | |
476 | ||
477 | struct ref_iterator_vtable { | |
478 | ref_iterator_advance_fn *advance; | |
479 | ref_iterator_peel_fn *peel; | |
480 | ref_iterator_abort_fn *abort; | |
481 | }; | |
482 | ||
93770590 | 483 | /* |
4c4de895 MH |
484 | * current_ref_iter is a performance hack: when iterating over |
485 | * references using the for_each_ref*() functions, current_ref_iter is | |
486 | * set to the reference iterator before calling the callback function. | |
487 | * If the callback function calls peel_ref(), then peel_ref() first | |
488 | * checks whether the reference to be peeled is the one referred to by | |
489 | * the iterator (it usually is) and if so, asks the iterator for the | |
490 | * peeled version of the reference if it is available. This avoids a | |
491 | * refname lookup in a common case. current_ref_iter is set to NULL | |
492 | * when the iteration is over. | |
493 | */ | |
494 | extern struct ref_iterator *current_ref_iter; | |
495 | ||
496 | /* | |
497 | * The common backend for the for_each_*ref* functions. Call fn for | |
498 | * each reference in iter. If the iterator itself ever returns | |
499 | * ITER_ERROR, return -1. If fn ever returns a non-zero value, stop | |
500 | * the iteration and return that value. Otherwise, return 0. In any | |
501 | * case, free the iterator when done. This function is basically an | |
502 | * adapter between the callback style of reference iteration and the | |
503 | * iterator style. | |
504 | */ | |
4a6067cd SB |
505 | int do_for_each_repo_ref_iterator(struct repository *r, |
506 | struct ref_iterator *iter, | |
507 | each_repo_ref_fn fn, void *cb_data); | |
2d0663b2 | 508 | |
1a769003 MH |
509 | struct ref_store; |
510 | ||
0c09ec07 DT |
511 | /* refs backends */ |
512 | ||
9e7ec634 NTND |
513 | /* ref_store_init flags */ |
514 | #define REF_STORE_READ (1 << 0) | |
515 | #define REF_STORE_WRITE (1 << 1) /* can perform update operations */ | |
516 | #define REF_STORE_ODB (1 << 2) /* has access to object database */ | |
517 | #define REF_STORE_MAIN (1 << 3) | |
0d8a814d NTND |
518 | #define REF_STORE_ALL_CAPS (REF_STORE_READ | \ |
519 | REF_STORE_WRITE | \ | |
520 | REF_STORE_ODB | \ | |
521 | REF_STORE_MAIN) | |
9e7ec634 | 522 | |
e1e33b72 | 523 | /* |
5d0bc90e NTND |
524 | * Initialize the ref_store for the specified gitdir. These functions |
525 | * should call base_ref_store_init() to initialize the shared part of | |
526 | * the ref_store and to record the ref_store for later lookup. | |
e1e33b72 | 527 | */ |
34224e14 JT |
528 | typedef struct ref_store *ref_store_init_fn(struct repository *repo, |
529 | const char *gitdir, | |
9e7ec634 | 530 | unsigned int flags); |
e1e33b72 | 531 | |
6fb5acfd DT |
532 | typedef int ref_init_db_fn(struct ref_store *refs, struct strbuf *err); |
533 | ||
30173b88 MH |
534 | typedef int ref_transaction_prepare_fn(struct ref_store *refs, |
535 | struct ref_transaction *transaction, | |
536 | struct strbuf *err); | |
537 | ||
538 | typedef int ref_transaction_finish_fn(struct ref_store *refs, | |
539 | struct ref_transaction *transaction, | |
540 | struct strbuf *err); | |
541 | ||
542 | typedef int ref_transaction_abort_fn(struct ref_store *refs, | |
543 | struct ref_transaction *transaction, | |
544 | struct strbuf *err); | |
545 | ||
e1e33b72 MH |
546 | typedef int ref_transaction_commit_fn(struct ref_store *refs, |
547 | struct ref_transaction *transaction, | |
548 | struct strbuf *err); | |
549 | ||
8231527e | 550 | typedef int pack_refs_fn(struct ref_store *ref_store, unsigned int flags); |
284689ba MH |
551 | typedef int create_symref_fn(struct ref_store *ref_store, |
552 | const char *ref_target, | |
553 | const char *refs_heads_master, | |
554 | const char *logmsg); | |
64da4199 | 555 | typedef int delete_refs_fn(struct ref_store *ref_store, const char *msg, |
a27dcf89 | 556 | struct string_list *refnames, unsigned int flags); |
9b6b40d9 DT |
557 | typedef int rename_ref_fn(struct ref_store *ref_store, |
558 | const char *oldref, const char *newref, | |
559 | const char *logmsg); | |
52d59cc6 SD |
560 | typedef int copy_ref_fn(struct ref_store *ref_store, |
561 | const char *oldref, const char *newref, | |
562 | const char *logmsg); | |
8231527e | 563 | |
1a769003 | 564 | /* |
e1860571 MH |
565 | * Iterate over the references in `ref_store` whose names start with |
566 | * `prefix`. `prefix` is matched as a literal string, without regard | |
567 | * for path separators. If prefix is NULL or the empty string, iterate | |
8738a8a4 MH |
568 | * over all references in `ref_store`. The output is ordered by |
569 | * refname. | |
1a769003 MH |
570 | */ |
571 | typedef struct ref_iterator *ref_iterator_begin_fn( | |
572 | struct ref_store *ref_store, | |
573 | const char *prefix, unsigned int flags); | |
574 | ||
e3688bd6 DT |
575 | /* reflog functions */ |
576 | ||
577 | /* | |
578 | * Iterate over the references in the specified ref_store that have a | |
579 | * reflog. The refs are iterated over in arbitrary order. | |
580 | */ | |
581 | typedef struct ref_iterator *reflog_iterator_begin_fn( | |
582 | struct ref_store *ref_store); | |
583 | ||
584 | typedef int for_each_reflog_ent_fn(struct ref_store *ref_store, | |
585 | const char *refname, | |
586 | each_reflog_ent_fn fn, | |
587 | void *cb_data); | |
588 | typedef int for_each_reflog_ent_reverse_fn(struct ref_store *ref_store, | |
589 | const char *refname, | |
590 | each_reflog_ent_fn fn, | |
591 | void *cb_data); | |
592 | typedef int reflog_exists_fn(struct ref_store *ref_store, const char *refname); | |
593 | typedef int create_reflog_fn(struct ref_store *ref_store, const char *refname, | |
7b089120 | 594 | struct strbuf *err); |
e3688bd6 DT |
595 | typedef int delete_reflog_fn(struct ref_store *ref_store, const char *refname); |
596 | typedef int reflog_expire_fn(struct ref_store *ref_store, | |
cc40b5ce | 597 | const char *refname, |
e3688bd6 DT |
598 | unsigned int flags, |
599 | reflog_expiry_prepare_fn prepare_fn, | |
600 | reflog_expiry_should_prune_fn should_prune_fn, | |
601 | reflog_expiry_cleanup_fn cleanup_fn, | |
602 | void *policy_cb_data); | |
603 | ||
cf596442 | 604 | /* |
34c7ad8f MH |
605 | * Read a reference from the specified reference store, non-recursively. |
606 | * Set type to describe the reference, and: | |
cf596442 | 607 | * |
99afe91a | 608 | * - If refname is the name of a normal reference, fill in oid |
cf596442 MH |
609 | * (leaving referent unchanged). |
610 | * | |
611 | * - If refname is the name of a symbolic reference, write the full | |
612 | * name of the reference to which it refers (e.g. | |
613 | * "refs/heads/master") to referent and set the REF_ISSYMREF bit in | |
99afe91a | 614 | * type (leaving oid unchanged). The caller is responsible for |
cf596442 MH |
615 | * validating that referent is a valid reference name. |
616 | * | |
617 | * WARNING: refname might be used as part of a filename, so it is | |
618 | * important from a security standpoint that it be safe in the sense | |
619 | * of refname_is_safe(). Moreover, for symrefs this function sets | |
620 | * referent to whatever the repository says, which might not be a | |
621 | * properly-formatted or even safe reference name. NEITHER INPUT NOR | |
622 | * OUTPUT REFERENCE NAMES ARE VALIDATED WITHIN THIS FUNCTION. | |
623 | * | |
5b12e16b HWN |
624 | * Return 0 on success, or -1 on failure. If the ref exists but is neither a |
625 | * symbolic ref nor an object ID, it is broken. In this case set REF_ISBROKEN in | |
626 | * type, and return -1 (failure_errno should not be ENOENT) | |
627 | * | |
628 | * failure_errno provides errno codes that are interpreted beyond error | |
629 | * reporting. The following error codes have special meaning: | |
630 | * * ENOENT: the ref doesn't exist | |
631 | * * EISDIR: ref name is a directory | |
632 | * * ENOTDIR: ref prefix is not a directory | |
cf596442 MH |
633 | * |
634 | * Backend-specific flags might be set in type as well, regardless of | |
635 | * outcome. | |
636 | * | |
637 | * It is OK for refname to point into referent. If so: | |
638 | * | |
639 | * - if the function succeeds with REF_ISSYMREF, referent will be | |
640 | * overwritten and the memory formerly pointed to by it might be | |
641 | * changed or even freed. | |
642 | * | |
643 | * - in all other cases, referent will be untouched, and therefore | |
644 | * refname will still be valid and unchanged. | |
645 | */ | |
5b12e16b HWN |
646 | typedef int read_raw_ref_fn(struct ref_store *ref_store, const char *refname, |
647 | struct object_id *oid, struct strbuf *referent, | |
648 | unsigned int *type, int *failure_errno); | |
127b42a1 | 649 | |
cd475b3b PS |
650 | /* |
651 | * Read a symbolic reference from the specified reference store. This function | |
652 | * is optional: if not implemented by a backend, then `read_raw_ref_fn` is used | |
653 | * to read the symbolcic reference instead. It is intended to be implemented | |
654 | * only in case the backend can optimize the reading of symbolic references. | |
655 | * | |
656 | * Return 0 on success, or -1 on failure. `referent` will be set to the target | |
657 | * of the symbolic reference on success. This function explicitly does not | |
658 | * distinguish between error cases and the reference not being a symbolic | |
659 | * reference to allow backends to optimize this operation in case symbolic and | |
660 | * non-symbolic references are treated differently. | |
661 | */ | |
662 | typedef int read_symbolic_ref_fn(struct ref_store *ref_store, const char *refname, | |
663 | struct strbuf *referent); | |
664 | ||
3dce444f RS |
665 | struct ref_storage_be { |
666 | struct ref_storage_be *next; | |
667 | const char *name; | |
00eebe35 | 668 | ref_store_init_fn *init; |
6fb5acfd | 669 | ref_init_db_fn *init_db; |
30173b88 MH |
670 | |
671 | ref_transaction_prepare_fn *transaction_prepare; | |
672 | ref_transaction_finish_fn *transaction_finish; | |
673 | ref_transaction_abort_fn *transaction_abort; | |
fc681463 | 674 | ref_transaction_commit_fn *initial_transaction_commit; |
e1e33b72 | 675 | |
8231527e | 676 | pack_refs_fn *pack_refs; |
284689ba | 677 | create_symref_fn *create_symref; |
a27dcf89 | 678 | delete_refs_fn *delete_refs; |
9b6b40d9 | 679 | rename_ref_fn *rename_ref; |
52d59cc6 | 680 | copy_ref_fn *copy_ref; |
8231527e | 681 | |
1a769003 | 682 | ref_iterator_begin_fn *iterator_begin; |
e1e33b72 | 683 | read_raw_ref_fn *read_raw_ref; |
cd475b3b | 684 | read_symbolic_ref_fn *read_symbolic_ref; |
e3688bd6 DT |
685 | |
686 | reflog_iterator_begin_fn *reflog_iterator_begin; | |
687 | for_each_reflog_ent_fn *for_each_reflog_ent; | |
688 | for_each_reflog_ent_reverse_fn *for_each_reflog_ent_reverse; | |
689 | reflog_exists_fn *reflog_exists; | |
690 | create_reflog_fn *create_reflog; | |
691 | delete_reflog_fn *delete_reflog; | |
692 | reflog_expire_fn *reflog_expire; | |
3dce444f RS |
693 | }; |
694 | ||
695 | extern struct ref_storage_be refs_be_files; | |
e0cc8ac8 | 696 | extern struct ref_storage_be refs_be_packed; |
3dce444f | 697 | |
00eebe35 MH |
698 | /* |
699 | * A representation of the reference store for the main repository or | |
700 | * a submodule. The ref_store instances for submodules are kept in a | |
4877c6c7 | 701 | * hash map; see get_submodule_ref_store() for more info. |
00eebe35 MH |
702 | */ |
703 | struct ref_store { | |
704 | /* The backend describing this ref_store's storage scheme: */ | |
705 | const struct ref_storage_be *be; | |
5085aef4 | 706 | |
34224e14 JT |
707 | struct repository *repo; |
708 | ||
709 | /* | |
710 | * The gitdir that this ref_store applies to. Note that this is not | |
711 | * necessarily repo->gitdir if the repo has multiple worktrees. | |
712 | */ | |
5085aef4 | 713 | char *gitdir; |
00eebe35 MH |
714 | }; |
715 | ||
e39620f0 | 716 | /* |
df3458e9 HWN |
717 | * Parse contents of a loose ref file. *failure_errno maybe be set to EINVAL for |
718 | * invalid contents. | |
e39620f0 HWN |
719 | */ |
720 | int parse_loose_ref_contents(const char *buf, struct object_id *oid, | |
df3458e9 HWN |
721 | struct strbuf *referent, unsigned int *type, |
722 | int *failure_errno); | |
e39620f0 | 723 | |
00eebe35 | 724 | /* |
fbfd0a29 MH |
725 | * Fill in the generic part of refs and add it to our collection of |
726 | * reference stores. | |
00eebe35 | 727 | */ |
f9f7fd3b HWN |
728 | void base_ref_store_init(struct ref_store *refs, struct repository *repo, |
729 | const char *path, const struct ref_storage_be *be); | |
00eebe35 | 730 | |
4441f427 HWN |
731 | /* |
732 | * Support GIT_TRACE_REFS by optionally wrapping the given ref_store instance. | |
733 | */ | |
734 | struct ref_store *maybe_debug_wrap_ref_store(const char *gitdir, struct ref_store *store); | |
735 | ||
4cb77009 | 736 | #endif /* REFS_REFS_INTERNAL_H */ |