fsck.h

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