]>
Commit | Line | Data |
---|---|---|
355885d5 MK |
1 | #ifndef GIT_FSCK_H |
2 | #define GIT_FSCK_H | |
3 | ||
3b41fb0c RS |
4 | #include "oidset.h" |
5 | ||
ba002f3b MK |
6 | #define FSCK_ERROR 1 |
7 | #define FSCK_WARN 2 | |
efaba7cc | 8 | #define FSCK_IGNORE 3 |
ba002f3b | 9 | |
22410549 | 10 | struct fsck_options; |
ef3ca954 | 11 | struct object; |
22410549 | 12 | |
0282f4dc JS |
13 | void fsck_set_msg_type(struct fsck_options *options, |
14 | const char *msg_id, const char *msg_type); | |
15 | void fsck_set_msg_types(struct fsck_options *options, const char *values); | |
5d477a33 | 16 | int is_valid_msg_type(const char *msg_id, const char *msg_type); |
0282f4dc | 17 | |
355885d5 MK |
18 | /* |
19 | * callback function for fsck_walk | |
20 | * type is the expected type of the object or OBJ_ANY | |
21 | * the return value is: | |
22 | * 0 everything OK | |
23 | * <0 error signaled and abort | |
24 | * >0 error signaled and do not abort | |
25 | */ | |
22410549 | 26 | typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct fsck_options *options); |
355885d5 | 27 | |
ba002f3b | 28 | /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */ |
1cd772cc | 29 | typedef int (*fsck_error)(struct fsck_options *o, |
5afc4b1d JK |
30 | const struct object_id *oid, enum object_type object_type, |
31 | int msg_type, const char *message); | |
ba002f3b | 32 | |
1cd772cc | 33 | int fsck_error_function(struct fsck_options *o, |
5afc4b1d JK |
34 | const struct object_id *oid, enum object_type object_type, |
35 | int msg_type, const char *message); | |
d6ffc8d7 | 36 | |
22410549 JS |
37 | struct fsck_options { |
38 | fsck_walk_func walk; | |
39 | fsck_error error_func; | |
40 | unsigned strict:1; | |
0282f4dc | 41 | int *msg_type; |
3b41fb0c | 42 | struct oidset skiplist; |
73390290 | 43 | kh_oid_map_t *object_names; |
22410549 JS |
44 | }; |
45 | ||
d385784f ÆAB |
46 | #define FSCK_OPTIONS_DEFAULT { \ |
47 | .skiplist = OIDSET_INIT, \ | |
48 | .error_func = fsck_error_function \ | |
49 | } | |
50 | #define FSCK_OPTIONS_STRICT { \ | |
51 | .strict = 1, \ | |
52 | .error_func = fsck_error_function, \ | |
53 | } | |
22410549 | 54 | |
355885d5 MK |
55 | /* descend in all linked child objects |
56 | * the return value is: | |
57 | * -1 error in processing the object | |
58 | * <0 return value of the callback, which lead to an abort | |
3ea3c215 | 59 | * >0 return value of the first signaled error >0 (in the case of no other errors) |
355885d5 MK |
60 | * 0 everything OK |
61 | */ | |
22410549 | 62 | int fsck_walk(struct object *obj, void *data, struct fsck_options *options); |
23a173a7 JK |
63 | |
64 | /* | |
65 | * Blob objects my pass a NULL data pointer, which indicates they are too large | |
66 | * to fit in memory. All other types must pass a real buffer. | |
67 | */ | |
90a398bb | 68 | int fsck_object(struct object *obj, void *data, unsigned long size, |
22410549 | 69 | struct fsck_options *options); |
355885d5 | 70 | |
5476e1ef JT |
71 | void register_found_gitmodules(const struct object_id *oid); |
72 | ||
acf9de4c ÆAB |
73 | /* |
74 | * fsck a tag, and pass info about it back to the caller. This is | |
75 | * exposed fsck_object() internals for git-mktag(1). | |
76 | */ | |
77 | int fsck_tag_standalone(const struct object_id *oid, const char *buffer, | |
78 | unsigned long size, struct fsck_options *options, | |
79 | struct object_id *tagged_oid, | |
80 | int *tag_type); | |
81 | ||
159e7b08 JK |
82 | /* |
83 | * Some fsck checks are context-dependent, and may end up queued; run this | |
84 | * after completing all fsck_object() calls in order to resolve any remaining | |
85 | * checks. | |
86 | */ | |
87 | int fsck_finish(struct fsck_options *options); | |
88 | ||
a59cfb32 JK |
89 | /* |
90 | * Subsystem for storing human-readable names for each object. | |
91 | * | |
92 | * If fsck_enable_object_names() has not been called, all other functions are | |
93 | * noops. | |
94 | * | |
95 | * Use fsck_put_object_name() to seed initial names (e.g. from refnames); the | |
96 | * fsck code will extend that while walking trees, etc. | |
97 | * | |
98 | * Use fsck_get_object_name() to get a single name (or NULL if none). Or the | |
99 | * more convenient describe_object(), which always produces an output string | |
100 | * with the oid combined with the name (if any). Note that the return value | |
101 | * points to a rotating array of static buffers, and may be invalidated by a | |
102 | * subsequent call. | |
103 | */ | |
104 | void fsck_enable_object_names(struct fsck_options *options); | |
105 | const char *fsck_get_object_name(struct fsck_options *options, | |
73390290 | 106 | const struct object_id *oid); |
a59cfb32 | 107 | __attribute__((format (printf,3,4))) |
73390290 JK |
108 | void fsck_put_object_name(struct fsck_options *options, |
109 | const struct object_id *oid, | |
a59cfb32 JK |
110 | const char *fmt, ...); |
111 | const char *fsck_describe_object(struct fsck_options *options, | |
73390290 | 112 | const struct object_id *oid); |
a59cfb32 | 113 | |
1f3299fd ÆAB |
114 | /* |
115 | * git_config() callback for use by fsck-y tools that want to support | |
116 | * fsck.<msg> fsck.skipList etc. | |
117 | */ | |
fb79f5bf | 118 | int git_fsck_config(const char *var, const char *value, void *cb); |
1f3299fd | 119 | |
355885d5 | 120 | #endif |