]>
Commit | Line | Data |
---|---|---|
355885d5 MK |
1 | #ifndef GIT_FSCK_H |
2 | #define GIT_FSCK_H | |
3 | ||
a64215b6 | 4 | #include "object.h" |
3b41fb0c RS |
5 | #include "oidset.h" |
6 | ||
1b32b59f | 7 | enum fsck_msg_type { |
30cf618e ÆAB |
8 | /* for internal use only */ |
9 | FSCK_IGNORE, | |
10 | FSCK_INFO, | |
11 | FSCK_FATAL, | |
12 | /* "public", fed to e.g. error_func callbacks */ | |
13 | FSCK_ERROR, | |
1b32b59f | 14 | FSCK_WARN, |
1b32b59f | 15 | }; |
ba002f3b | 16 | |
f6534dbd JC |
17 | /* |
18 | * Documentation/fsck-msgids.txt documents these; when | |
19 | * modifying this list in any way, make sure to keep the | |
20 | * two in sync. | |
21 | */ | |
22 | ||
44e07da8 ÆAB |
23 | #define FOREACH_FSCK_MSG_ID(FUNC) \ |
24 | /* fatal errors */ \ | |
25 | FUNC(NUL_IN_HEADER, FATAL) \ | |
26 | FUNC(UNTERMINATED_HEADER, FATAL) \ | |
27 | /* errors */ \ | |
28 | FUNC(BAD_DATE, ERROR) \ | |
29 | FUNC(BAD_DATE_OVERFLOW, ERROR) \ | |
30 | FUNC(BAD_EMAIL, ERROR) \ | |
31 | FUNC(BAD_NAME, ERROR) \ | |
32 | FUNC(BAD_OBJECT_SHA1, ERROR) \ | |
33 | FUNC(BAD_PARENT_SHA1, ERROR) \ | |
44e07da8 ÆAB |
34 | FUNC(BAD_TIMEZONE, ERROR) \ |
35 | FUNC(BAD_TREE, ERROR) \ | |
36 | FUNC(BAD_TREE_SHA1, ERROR) \ | |
37 | FUNC(BAD_TYPE, ERROR) \ | |
38 | FUNC(DUPLICATE_ENTRIES, ERROR) \ | |
39 | FUNC(MISSING_AUTHOR, ERROR) \ | |
40 | FUNC(MISSING_COMMITTER, ERROR) \ | |
41 | FUNC(MISSING_EMAIL, ERROR) \ | |
42 | FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \ | |
43 | FUNC(MISSING_OBJECT, ERROR) \ | |
44 | FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \ | |
45 | FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \ | |
46 | FUNC(MISSING_TAG, ERROR) \ | |
47 | FUNC(MISSING_TAG_ENTRY, ERROR) \ | |
48 | FUNC(MISSING_TREE, ERROR) \ | |
44e07da8 ÆAB |
49 | FUNC(MISSING_TYPE, ERROR) \ |
50 | FUNC(MISSING_TYPE_ENTRY, ERROR) \ | |
51 | FUNC(MULTIPLE_AUTHORS, ERROR) \ | |
52 | FUNC(TREE_NOT_SORTED, ERROR) \ | |
53 | FUNC(UNKNOWN_TYPE, ERROR) \ | |
54 | FUNC(ZERO_PADDED_DATE, ERROR) \ | |
55 | FUNC(GITMODULES_MISSING, ERROR) \ | |
56 | FUNC(GITMODULES_BLOB, ERROR) \ | |
57 | FUNC(GITMODULES_LARGE, ERROR) \ | |
58 | FUNC(GITMODULES_NAME, ERROR) \ | |
59 | FUNC(GITMODULES_SYMLINK, ERROR) \ | |
60 | FUNC(GITMODULES_URL, ERROR) \ | |
61 | FUNC(GITMODULES_PATH, ERROR) \ | |
62 | FUNC(GITMODULES_UPDATE, ERROR) \ | |
27ab4784 PS |
63 | FUNC(GITATTRIBUTES_MISSING, ERROR) \ |
64 | FUNC(GITATTRIBUTES_LARGE, ERROR) \ | |
65 | FUNC(GITATTRIBUTES_LINE_LENGTH, ERROR) \ | |
66 | FUNC(GITATTRIBUTES_BLOB, ERROR) \ | |
44e07da8 | 67 | /* warnings */ \ |
44e07da8 ÆAB |
68 | FUNC(EMPTY_NAME, WARN) \ |
69 | FUNC(FULL_PATHNAME, WARN) \ | |
70 | FUNC(HAS_DOT, WARN) \ | |
71 | FUNC(HAS_DOTDOT, WARN) \ | |
72 | FUNC(HAS_DOTGIT, WARN) \ | |
73 | FUNC(NULL_SHA1, WARN) \ | |
74 | FUNC(ZERO_PADDED_FILEMODE, WARN) \ | |
75 | FUNC(NUL_IN_COMMIT, WARN) \ | |
0fbcaef6 | 76 | FUNC(LARGE_PATHNAME, WARN) \ |
44e07da8 | 77 | /* infos (reported as warnings, but ignored by default) */ \ |
4dd3b045 | 78 | FUNC(BAD_FILEMODE, INFO) \ |
44e07da8 | 79 | FUNC(GITMODULES_PARSE, INFO) \ |
bb6832d5 JK |
80 | FUNC(GITIGNORE_SYMLINK, INFO) \ |
81 | FUNC(GITATTRIBUTES_SYMLINK, INFO) \ | |
82 | FUNC(MAILMAP_SYMLINK, INFO) \ | |
44e07da8 ÆAB |
83 | FUNC(BAD_TAG_NAME, INFO) \ |
84 | FUNC(MISSING_TAGGER_ENTRY, INFO) \ | |
85 | /* ignored (elevated when requested) */ \ | |
86 | FUNC(EXTRA_HEADER_ENTRY, IGNORE) | |
87 | ||
88 | #define MSG_ID(id, msg_type) FSCK_MSG_##id, | |
89 | enum fsck_msg_id { | |
90 | FOREACH_FSCK_MSG_ID(MSG_ID) | |
91 | FSCK_MSG_MAX | |
92 | }; | |
93 | #undef MSG_ID | |
94 | ||
22410549 | 95 | struct fsck_options; |
ef3ca954 | 96 | struct object; |
22410549 | 97 | |
53692df2 ÆAB |
98 | void fsck_set_msg_type_from_ids(struct fsck_options *options, |
99 | enum fsck_msg_id msg_id, | |
100 | enum fsck_msg_type msg_type); | |
0282f4dc | 101 | void fsck_set_msg_type(struct fsck_options *options, |
f1abc2d0 | 102 | const char *msg_id, const char *msg_type); |
0282f4dc | 103 | void fsck_set_msg_types(struct fsck_options *options, const char *values); |
5d477a33 | 104 | int is_valid_msg_type(const char *msg_id, const char *msg_type); |
0282f4dc | 105 | |
355885d5 MK |
106 | /* |
107 | * callback function for fsck_walk | |
108 | * type is the expected type of the object or OBJ_ANY | |
109 | * the return value is: | |
110 | * 0 everything OK | |
111 | * <0 error signaled and abort | |
112 | * >0 error signaled and do not abort | |
113 | */ | |
a1aad716 ÆAB |
114 | typedef int (*fsck_walk_func)(struct object *obj, enum object_type object_type, |
115 | void *data, struct fsck_options *options); | |
355885d5 | 116 | |
ba002f3b | 117 | /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */ |
1cd772cc | 118 | typedef int (*fsck_error)(struct fsck_options *o, |
5afc4b1d | 119 | const struct object_id *oid, enum object_type object_type, |
394d5d31 ÆAB |
120 | enum fsck_msg_type msg_type, enum fsck_msg_id msg_id, |
121 | const char *message); | |
ba002f3b | 122 | |
1cd772cc | 123 | int fsck_error_function(struct fsck_options *o, |
5afc4b1d | 124 | const struct object_id *oid, enum object_type object_type, |
394d5d31 ÆAB |
125 | enum fsck_msg_type msg_type, enum fsck_msg_id msg_id, |
126 | const char *message); | |
3745e269 ÆAB |
127 | int fsck_error_cb_print_missing_gitmodules(struct fsck_options *o, |
128 | const struct object_id *oid, | |
129 | enum object_type object_type, | |
130 | enum fsck_msg_type msg_type, | |
131 | enum fsck_msg_id msg_id, | |
132 | const char *message); | |
d6ffc8d7 | 133 | |
22410549 JS |
134 | struct fsck_options { |
135 | fsck_walk_func walk; | |
136 | fsck_error error_func; | |
137 | unsigned strict:1; | |
1b32b59f | 138 | enum fsck_msg_type *msg_type; |
3b41fb0c | 139 | struct oidset skiplist; |
c15087d1 ÆAB |
140 | struct oidset gitmodules_found; |
141 | struct oidset gitmodules_done; | |
27ab4784 PS |
142 | struct oidset gitattributes_found; |
143 | struct oidset gitattributes_done; | |
73390290 | 144 | kh_oid_map_t *object_names; |
22410549 JS |
145 | }; |
146 | ||
d385784f ÆAB |
147 | #define FSCK_OPTIONS_DEFAULT { \ |
148 | .skiplist = OIDSET_INIT, \ | |
c15087d1 ÆAB |
149 | .gitmodules_found = OIDSET_INIT, \ |
150 | .gitmodules_done = OIDSET_INIT, \ | |
27ab4784 PS |
151 | .gitattributes_found = OIDSET_INIT, \ |
152 | .gitattributes_done = OIDSET_INIT, \ | |
d385784f ÆAB |
153 | .error_func = fsck_error_function \ |
154 | } | |
155 | #define FSCK_OPTIONS_STRICT { \ | |
156 | .strict = 1, \ | |
c15087d1 ÆAB |
157 | .gitmodules_found = OIDSET_INIT, \ |
158 | .gitmodules_done = OIDSET_INIT, \ | |
27ab4784 PS |
159 | .gitattributes_found = OIDSET_INIT, \ |
160 | .gitattributes_done = OIDSET_INIT, \ | |
d385784f ÆAB |
161 | .error_func = fsck_error_function, \ |
162 | } | |
3745e269 ÆAB |
163 | #define FSCK_OPTIONS_MISSING_GITMODULES { \ |
164 | .strict = 1, \ | |
165 | .gitmodules_found = OIDSET_INIT, \ | |
166 | .gitmodules_done = OIDSET_INIT, \ | |
27ab4784 PS |
167 | .gitattributes_found = OIDSET_INIT, \ |
168 | .gitattributes_done = OIDSET_INIT, \ | |
3745e269 ÆAB |
169 | .error_func = fsck_error_cb_print_missing_gitmodules, \ |
170 | } | |
22410549 | 171 | |
355885d5 MK |
172 | /* descend in all linked child objects |
173 | * the return value is: | |
174 | * -1 error in processing the object | |
175 | * <0 return value of the callback, which lead to an abort | |
3ea3c215 | 176 | * >0 return value of the first signaled error >0 (in the case of no other errors) |
355885d5 MK |
177 | * 0 everything OK |
178 | */ | |
22410549 | 179 | int fsck_walk(struct object *obj, void *data, struct fsck_options *options); |
23a173a7 JK |
180 | |
181 | /* | |
182 | * Blob objects my pass a NULL data pointer, which indicates they are too large | |
183 | * to fit in memory. All other types must pass a real buffer. | |
184 | */ | |
90a398bb | 185 | int fsck_object(struct object *obj, void *data, unsigned long size, |
22410549 | 186 | struct fsck_options *options); |
355885d5 | 187 | |
35ff327e JK |
188 | /* |
189 | * Same as fsck_object(), but for when the caller doesn't have an object | |
190 | * struct. | |
191 | */ | |
192 | int fsck_buffer(const struct object_id *oid, enum object_type, | |
193 | void *data, unsigned long size, | |
194 | struct fsck_options *options); | |
195 | ||
acf9de4c ÆAB |
196 | /* |
197 | * fsck a tag, and pass info about it back to the caller. This is | |
198 | * exposed fsck_object() internals for git-mktag(1). | |
199 | */ | |
200 | int fsck_tag_standalone(const struct object_id *oid, const char *buffer, | |
201 | unsigned long size, struct fsck_options *options, | |
202 | struct object_id *tagged_oid, | |
203 | int *tag_type); | |
204 | ||
159e7b08 JK |
205 | /* |
206 | * Some fsck checks are context-dependent, and may end up queued; run this | |
207 | * after completing all fsck_object() calls in order to resolve any remaining | |
208 | * checks. | |
209 | */ | |
210 | int fsck_finish(struct fsck_options *options); | |
211 | ||
a59cfb32 JK |
212 | /* |
213 | * Subsystem for storing human-readable names for each object. | |
214 | * | |
215 | * If fsck_enable_object_names() has not been called, all other functions are | |
216 | * noops. | |
217 | * | |
218 | * Use fsck_put_object_name() to seed initial names (e.g. from refnames); the | |
219 | * fsck code will extend that while walking trees, etc. | |
220 | * | |
221 | * Use fsck_get_object_name() to get a single name (or NULL if none). Or the | |
222 | * more convenient describe_object(), which always produces an output string | |
223 | * with the oid combined with the name (if any). Note that the return value | |
224 | * points to a rotating array of static buffers, and may be invalidated by a | |
225 | * subsequent call. | |
226 | */ | |
227 | void fsck_enable_object_names(struct fsck_options *options); | |
228 | const char *fsck_get_object_name(struct fsck_options *options, | |
73390290 | 229 | const struct object_id *oid); |
a59cfb32 | 230 | __attribute__((format (printf,3,4))) |
73390290 JK |
231 | void fsck_put_object_name(struct fsck_options *options, |
232 | const struct object_id *oid, | |
a59cfb32 JK |
233 | const char *fmt, ...); |
234 | const char *fsck_describe_object(struct fsck_options *options, | |
73390290 | 235 | const struct object_id *oid); |
a59cfb32 | 236 | |
a4e7e317 | 237 | struct key_value_info; |
1f3299fd ÆAB |
238 | /* |
239 | * git_config() callback for use by fsck-y tools that want to support | |
240 | * fsck.<msg> fsck.skipList etc. | |
241 | */ | |
a4e7e317 GC |
242 | int git_fsck_config(const char *var, const char *value, |
243 | const struct config_context *ctx, void *cb); | |
1f3299fd | 244 | |
355885d5 | 245 | #endif |