]>
Commit | Line | Data |
---|---|---|
4cb77009 MH |
1 | #ifndef REFS_REFS_INTERNAL_H |
2 | #define REFS_REFS_INTERNAL_H | |
3 | ||
4 | /* | |
5 | * Data structures and functions for the internal use of the refs | |
6 | * module. Code outside of the refs module should use only the public | |
7 | * functions defined in "refs.h", and should *not* include this file. | |
8 | */ | |
9 | ||
10 | /* | |
11 | * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken | |
12 | * refs (i.e., because the reference is about to be deleted anyway). | |
13 | */ | |
14 | #define REF_DELETING 0x02 | |
15 | ||
16 | /* | |
17 | * Used as a flag in ref_update::flags when a loose ref is being | |
c52ce248 | 18 | * pruned. This flag must only be used when REF_NODEREF is set. |
4cb77009 MH |
19 | */ |
20 | #define REF_ISPRUNING 0x04 | |
21 | ||
22 | /* | |
23 | * Used as a flag in ref_update::flags when the reference should be | |
24 | * updated to new_sha1. | |
25 | */ | |
26 | #define REF_HAVE_NEW 0x08 | |
27 | ||
28 | /* | |
29 | * Used as a flag in ref_update::flags when old_sha1 should be | |
30 | * checked. | |
31 | */ | |
32 | #define REF_HAVE_OLD 0x10 | |
33 | ||
34 | /* | |
35 | * Used as a flag in ref_update::flags when the lockfile needs to be | |
36 | * committed. | |
37 | */ | |
38 | #define REF_NEEDS_COMMIT 0x20 | |
39 | ||
40 | /* | |
41 | * 0x40 is REF_FORCE_CREATE_REFLOG, so skip it if you're adding a | |
42 | * value to ref_update::flags | |
43 | */ | |
44 | ||
d99aa884 DT |
45 | /* |
46 | * Used as a flag in ref_update::flags when we want to log a ref | |
47 | * update but not actually perform it. This is used when a symbolic | |
48 | * ref update is split up. | |
49 | */ | |
50 | #define REF_LOG_ONLY 0x80 | |
51 | ||
92b1551b MH |
52 | /* |
53 | * Internal flag, meaning that the containing ref_update was via an | |
54 | * update to HEAD. | |
55 | */ | |
56 | #define REF_UPDATE_VIA_HEAD 0x100 | |
57 | ||
4cb77009 MH |
58 | /* |
59 | * Return true iff refname is minimally safe. "Safe" here means that | |
60 | * deleting a loose reference by this name will not do any damage, for | |
61 | * example by causing a file that is not a reference to be deleted. | |
62 | * This function does not check that the reference name is legal; for | |
63 | * that, use check_refname_format(). | |
64 | * | |
65 | * We consider a refname that starts with "refs/" to be safe as long | |
66 | * as any ".." components that it might contain do not escape "refs/". | |
67 | * Names that do not start with "refs/" are considered safe iff they | |
68 | * consist entirely of upper case characters and '_' (like "HEAD" and | |
69 | * "MERGE_HEAD" but not "config" or "FOO/BAR"). | |
70 | */ | |
71 | int refname_is_safe(const char *refname); | |
72 | ||
73 | enum peel_status { | |
74 | /* object was peeled successfully: */ | |
75 | PEEL_PEELED = 0, | |
76 | ||
77 | /* | |
78 | * object cannot be peeled because the named object (or an | |
79 | * object referred to by a tag in the peel chain), does not | |
80 | * exist. | |
81 | */ | |
82 | PEEL_INVALID = -1, | |
83 | ||
84 | /* object cannot be peeled because it is not a tag: */ | |
85 | PEEL_NON_TAG = -2, | |
86 | ||
87 | /* ref_entry contains no peeled value because it is a symref: */ | |
88 | PEEL_IS_SYMREF = -3, | |
89 | ||
90 | /* | |
91 | * ref_entry cannot be peeled because it is broken (i.e., the | |
92 | * symbolic reference cannot even be resolved to an object | |
93 | * name): | |
94 | */ | |
95 | PEEL_BROKEN = -4 | |
96 | }; | |
97 | ||
98 | /* | |
99 | * Peel the named object; i.e., if the object is a tag, resolve the | |
100 | * tag recursively until a non-tag is found. If successful, store the | |
101 | * result to sha1 and return PEEL_PEELED. If the object is not a tag | |
102 | * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively, | |
103 | * and leave sha1 unchanged. | |
104 | */ | |
105 | enum peel_status peel_object(const unsigned char *name, unsigned char *sha1); | |
106 | ||
107 | /* | |
108 | * Return 0 if a reference named refname could be created without | |
109 | * conflicting with the name of an existing reference. Otherwise, | |
110 | * return a negative value and write an explanation to err. If extras | |
111 | * is non-NULL, it is a list of additional refnames with which refname | |
112 | * is not allowed to conflict. If skip is non-NULL, ignore potential | |
113 | * conflicts with refs in skip (e.g., because they are scheduled for | |
114 | * deletion in the same operation). Behavior is undefined if the same | |
115 | * name is listed in both extras and skip. | |
116 | * | |
117 | * Two reference names conflict if one of them exactly matches the | |
118 | * leading components of the other; e.g., "foo/bar" conflicts with | |
119 | * both "foo" and with "foo/bar/baz" but not with "foo/bar" or | |
120 | * "foo/barbados". | |
121 | * | |
122 | * extras and skip must be sorted. | |
123 | */ | |
124 | int verify_refname_available(const char *newname, | |
3a8af7be MH |
125 | const struct string_list *extras, |
126 | const struct string_list *skip, | |
4cb77009 MH |
127 | struct strbuf *err); |
128 | ||
129 | /* | |
130 | * Copy the reflog message msg to buf, which has been allocated sufficiently | |
131 | * large, while cleaning up the whitespaces. Especially, convert LF to space, | |
132 | * because reflog file is one line per entry. | |
133 | */ | |
134 | int copy_reflog_msg(char *buf, const char *msg); | |
135 | ||
136 | int should_autocreate_reflog(const char *refname); | |
137 | ||
138 | /** | |
139 | * Information needed for a single ref update. Set new_sha1 to the new | |
140 | * value or to null_sha1 to delete the ref. To check the old value | |
141 | * while the ref is locked, set (flags & REF_HAVE_OLD) and set | |
142 | * old_sha1 to the old value, or to null_sha1 to ensure the ref does | |
143 | * not exist before update. | |
144 | */ | |
145 | struct ref_update { | |
6e30b2f6 | 146 | |
4cb77009 MH |
147 | /* |
148 | * If (flags & REF_HAVE_NEW), set the reference to this value: | |
149 | */ | |
150 | unsigned char new_sha1[20]; | |
6e30b2f6 | 151 | |
4cb77009 MH |
152 | /* |
153 | * If (flags & REF_HAVE_OLD), check that the reference | |
154 | * previously had this value: | |
155 | */ | |
156 | unsigned char old_sha1[20]; | |
6e30b2f6 | 157 | |
4cb77009 MH |
158 | /* |
159 | * One or more of REF_HAVE_NEW, REF_HAVE_OLD, REF_NODEREF, | |
92b1551b MH |
160 | * REF_DELETING, REF_ISPRUNING, REF_LOG_ONLY, and |
161 | * REF_UPDATE_VIA_HEAD: | |
4cb77009 MH |
162 | */ |
163 | unsigned int flags; | |
6e30b2f6 | 164 | |
4cb77009 | 165 | struct ref_lock *lock; |
92b1551b | 166 | unsigned int type; |
4cb77009 | 167 | char *msg; |
6e30b2f6 MH |
168 | |
169 | /* | |
170 | * If this ref_update was split off of a symref update via | |
171 | * split_symref_update(), then this member points at that | |
172 | * update. This is used for two purposes: | |
173 | * 1. When reporting errors, we report the refname under which | |
174 | * the update was originally requested. | |
175 | * 2. When we read the old value of this reference, we | |
176 | * propagate it back to its parent update for recording in | |
177 | * the latter's reflog. | |
178 | */ | |
179 | struct ref_update *parent_update; | |
180 | ||
4cb77009 MH |
181 | const char refname[FLEX_ARRAY]; |
182 | }; | |
183 | ||
71564516 MH |
184 | /* |
185 | * Add a ref_update with the specified properties to transaction, and | |
186 | * return a pointer to the new object. This function does not verify | |
187 | * that refname is well-formed. new_sha1 and old_sha1 are only | |
188 | * dereferenced if the REF_HAVE_NEW and REF_HAVE_OLD bits, | |
189 | * respectively, are set in flags. | |
190 | */ | |
191 | struct ref_update *ref_transaction_add_update( | |
192 | struct ref_transaction *transaction, | |
193 | const char *refname, unsigned int flags, | |
194 | const unsigned char *new_sha1, | |
195 | const unsigned char *old_sha1, | |
196 | const char *msg); | |
197 | ||
4cb77009 MH |
198 | /* |
199 | * Transaction states. | |
200 | * OPEN: The transaction is in a valid state and can accept new updates. | |
201 | * An OPEN transaction can be committed. | |
202 | * CLOSED: A closed transaction is no longer active and no other operations | |
203 | * than free can be used on it in this state. | |
204 | * A transaction can either become closed by successfully committing | |
205 | * an active transaction or if there is a failure while building | |
206 | * the transaction thus rendering it failed/inactive. | |
207 | */ | |
208 | enum ref_transaction_state { | |
209 | REF_TRANSACTION_OPEN = 0, | |
210 | REF_TRANSACTION_CLOSED = 1 | |
211 | }; | |
212 | ||
213 | /* | |
214 | * Data structure for holding a reference transaction, which can | |
215 | * consist of checks and updates to multiple references, carried out | |
216 | * as atomically as possible. This structure is opaque to callers. | |
217 | */ | |
218 | struct ref_transaction { | |
219 | struct ref_update **updates; | |
220 | size_t alloc; | |
221 | size_t nr; | |
222 | enum ref_transaction_state state; | |
223 | }; | |
224 | ||
5f3c3a4e DT |
225 | int files_log_ref_write(const char *refname, const unsigned char *old_sha1, |
226 | const unsigned char *new_sha1, const char *msg, | |
227 | int flags, struct strbuf *err); | |
228 | ||
0845122c DT |
229 | /* |
230 | * Check for entries in extras that are within the specified | |
231 | * directory, where dirname is a reference directory name including | |
232 | * the trailing slash (e.g., "refs/heads/foo/"). Ignore any | |
233 | * conflicting references that are found in skip. If there is a | |
234 | * conflicting reference, return its name. | |
235 | * | |
236 | * extras and skip must be sorted lists of reference names. Either one | |
237 | * can be NULL, signifying the empty list. | |
238 | */ | |
239 | const char *find_descendant_ref(const char *dirname, | |
240 | const struct string_list *extras, | |
241 | const struct string_list *skip); | |
242 | ||
243 | int rename_ref_available(const char *oldname, const char *newname); | |
244 | ||
2d0663b2 DT |
245 | /* We allow "recursive" symbolic refs. Only within reason, though */ |
246 | #define SYMREF_MAXDEPTH 5 | |
93770590 DT |
247 | |
248 | /* Include broken references in a do_for_each_ref*() iteration: */ | |
249 | #define DO_FOR_EACH_INCLUDE_BROKEN 0x01 | |
250 | ||
251 | /* | |
067622b0 | 252 | * Call fn for each reference in the specified submodule for which the |
4633a846 MH |
253 | * refname begins with prefix. If trim is non-zero, then trim that |
254 | * many characters off the beginning of each refname before passing | |
255 | * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to | |
256 | * include broken references in the iteration. If fn ever returns a | |
257 | * non-zero value, stop the iteration and return that value; | |
258 | * otherwise, return 0. | |
067622b0 MH |
259 | * |
260 | * This is the common backend for the for_each_*ref* functions. | |
93770590 | 261 | */ |
4633a846 | 262 | int do_for_each_ref(const char *submodule, const char *prefix, |
93770590 | 263 | each_ref_fn fn, int trim, int flags, void *cb_data); |
2d0663b2 | 264 | |
cf596442 MH |
265 | /* |
266 | * Read the specified reference from the filesystem or packed refs | |
267 | * file, non-recursively. Set type to describe the reference, and: | |
268 | * | |
269 | * - If refname is the name of a normal reference, fill in sha1 | |
270 | * (leaving referent unchanged). | |
271 | * | |
272 | * - If refname is the name of a symbolic reference, write the full | |
273 | * name of the reference to which it refers (e.g. | |
274 | * "refs/heads/master") to referent and set the REF_ISSYMREF bit in | |
275 | * type (leaving sha1 unchanged). The caller is responsible for | |
276 | * validating that referent is a valid reference name. | |
277 | * | |
278 | * WARNING: refname might be used as part of a filename, so it is | |
279 | * important from a security standpoint that it be safe in the sense | |
280 | * of refname_is_safe(). Moreover, for symrefs this function sets | |
281 | * referent to whatever the repository says, which might not be a | |
282 | * properly-formatted or even safe reference name. NEITHER INPUT NOR | |
283 | * OUTPUT REFERENCE NAMES ARE VALIDATED WITHIN THIS FUNCTION. | |
284 | * | |
285 | * Return 0 on success. If the ref doesn't exist, set errno to ENOENT | |
286 | * and return -1. If the ref exists but is neither a symbolic ref nor | |
287 | * a sha1, it is broken; set REF_ISBROKEN in type, set errno to | |
288 | * EINVAL, and return -1. If there is another error reading the ref, | |
289 | * set errno appropriately and return -1. | |
290 | * | |
291 | * Backend-specific flags might be set in type as well, regardless of | |
292 | * outcome. | |
293 | * | |
294 | * It is OK for refname to point into referent. If so: | |
295 | * | |
296 | * - if the function succeeds with REF_ISSYMREF, referent will be | |
297 | * overwritten and the memory formerly pointed to by it might be | |
298 | * changed or even freed. | |
299 | * | |
300 | * - in all other cases, referent will be untouched, and therefore | |
301 | * refname will still be valid and unchanged. | |
302 | */ | |
2d0663b2 | 303 | int read_raw_ref(const char *refname, unsigned char *sha1, |
92b38093 | 304 | struct strbuf *referent, unsigned int *type); |
2d0663b2 | 305 | |
4cb77009 | 306 | #endif /* REFS_REFS_INTERNAL_H */ |