fsck.h

   1 #ifndef GIT_FSCK_H
   2 #define GIT_FSCK_H
   3
   4 #include "object.h"
   5 #include "oidset.h"
   6
   7 enum fsck_msg_type {
   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,
  14         FSCK_WARN,
  15 };
  16
  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
  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) \
  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) \
  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) \
  63         FUNC(GITATTRIBUTES_MISSING, ERROR) \
  64         FUNC(GITATTRIBUTES_LARGE, ERROR) \
  65         FUNC(GITATTRIBUTES_LINE_LENGTH, ERROR) \
  66         FUNC(GITATTRIBUTES_BLOB, ERROR) \
  67         /* warnings */ \
  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) \
  76         /* infos (reported as warnings, but ignored by default) */ \
  77         FUNC(BAD_FILEMODE, INFO) \
  78         FUNC(GITMODULES_PARSE, INFO) \
  79         FUNC(GITIGNORE_SYMLINK, INFO) \
  80         FUNC(GITATTRIBUTES_SYMLINK, INFO) \
  81         FUNC(MAILMAP_SYMLINK, INFO) \
  82         FUNC(BAD_TAG_NAME, INFO) \
  83         FUNC(MISSING_TAGGER_ENTRY, INFO) \
  84         /* ignored (elevated when requested) */ \
  85         FUNC(EXTRA_HEADER_ENTRY, IGNORE)
  86
  87 #define MSG_ID(id, msg_type) FSCK_MSG_##id,
  88 enum fsck_msg_id {
  89         FOREACH_FSCK_MSG_ID(MSG_ID)
  90         FSCK_MSG_MAX
  91 };
  92 #undef MSG_ID
  93
  94 struct fsck_options;
  95 struct object;
  96
  97 void fsck_set_msg_type_from_ids(struct fsck_options *options,
  98                                 enum fsck_msg_id msg_id,
  99                                 enum fsck_msg_type msg_type);
 100 void fsck_set_msg_type(struct fsck_options *options,
 101                        const char *msg_id, const char *msg_type);
 102 void fsck_set_msg_types(struct fsck_options *options, const char *values);
 103 int is_valid_msg_type(const char *msg_id, const char *msg_type);
 104
 105 /*
 106  * callback function for fsck_walk
 107  * type is the expected type of the object or OBJ_ANY
 108  * the return value is:
 109  *     0        everything OK
 110  *     <0       error signaled and abort
 111  *     >0       error signaled and do not abort
 112  */
 113 typedef int (*fsck_walk_func)(struct object *obj, enum object_type object_type,
 114                               void *data, struct fsck_options *options);
 115
 116 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
 117 typedef int (*fsck_error)(struct fsck_options *o,
 118                           const struct object_id *oid, enum object_type object_type,
 119                           enum fsck_msg_type msg_type, enum fsck_msg_id msg_id,
 120                           const char *message);
 121
 122 int fsck_error_function(struct fsck_options *o,
 123                         const struct object_id *oid, enum object_type object_type,
 124                         enum fsck_msg_type msg_type, enum fsck_msg_id msg_id,
 125                         const char *message);
 126 int fsck_error_cb_print_missing_gitmodules(struct fsck_options *o,
 127                                            const struct object_id *oid,
 128                                            enum object_type object_type,
 129                                            enum fsck_msg_type msg_type,
 130                                            enum fsck_msg_id msg_id,
 131                                            const char *message);
 132
 133 struct fsck_options {
 134         fsck_walk_func walk;
 135         fsck_error error_func;
 136         unsigned strict:1;
 137         enum fsck_msg_type *msg_type;
 138         struct oidset skiplist;
 139         struct oidset gitmodules_found;
 140         struct oidset gitmodules_done;
 141         struct oidset gitattributes_found;
 142         struct oidset gitattributes_done;
 143         kh_oid_map_t *object_names;
 144 };
 145
 146 #define FSCK_OPTIONS_DEFAULT { \
 147         .skiplist = OIDSET_INIT, \
 148         .gitmodules_found = OIDSET_INIT, \
 149         .gitmodules_done = OIDSET_INIT, \
 150         .gitattributes_found = OIDSET_INIT, \
 151         .gitattributes_done = OIDSET_INIT, \
 152         .error_func = fsck_error_function \
 153 }
 154 #define FSCK_OPTIONS_STRICT { \
 155         .strict = 1, \
 156         .gitmodules_found = OIDSET_INIT, \
 157         .gitmodules_done = OIDSET_INIT, \
 158         .gitattributes_found = OIDSET_INIT, \
 159         .gitattributes_done = OIDSET_INIT, \
 160         .error_func = fsck_error_function, \
 161 }
 162 #define FSCK_OPTIONS_MISSING_GITMODULES { \
 163         .strict = 1, \
 164         .gitmodules_found = OIDSET_INIT, \
 165         .gitmodules_done = OIDSET_INIT, \
 166         .gitattributes_found = OIDSET_INIT, \
 167         .gitattributes_done = OIDSET_INIT, \
 168         .error_func = fsck_error_cb_print_missing_gitmodules, \
 169 }
 170
 171 /* descend in all linked child objects
 172  * the return value is:
 173  *    -1        error in processing the object
 174  *    <0        return value of the callback, which lead to an abort
 175  *    >0        return value of the first signaled error >0 (in the case of no other errors)
 176  *    0         everything OK
 177  */
 178 int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
 179
 180 /*
 181  * Blob objects my pass a NULL data pointer, which indicates they are too large
 182  * to fit in memory. All other types must pass a real buffer.
 183  */
 184 int fsck_object(struct object *obj, void *data, unsigned long size,
 185         struct fsck_options *options);
 186
 187 /*
 188  * Same as fsck_object(), but for when the caller doesn't have an object
 189  * struct.
 190  */
 191 int fsck_buffer(const struct object_id *oid, enum object_type,
 192                 void *data, unsigned long size,
 193                 struct fsck_options *options);
 194
 195 /*
 196  * fsck a tag, and pass info about it back to the caller. This is
 197  * exposed fsck_object() internals for git-mktag(1).
 198  */
 199 int fsck_tag_standalone(const struct object_id *oid, const char *buffer,
 200                         unsigned long size, struct fsck_options *options,
 201                         struct object_id *tagged_oid,
 202                         int *tag_type);
 203
 204 /*
 205  * Some fsck checks are context-dependent, and may end up queued; run this
 206  * after completing all fsck_object() calls in order to resolve any remaining
 207  * checks.
 208  */
 209 int fsck_finish(struct fsck_options *options);
 210
 211 /*
 212  * Subsystem for storing human-readable names for each object.
 213  *
 214  * If fsck_enable_object_names() has not been called, all other functions are
 215  * noops.
 216  *
 217  * Use fsck_put_object_name() to seed initial names (e.g. from refnames); the
 218  * fsck code will extend that while walking trees, etc.
 219  *
 220  * Use fsck_get_object_name() to get a single name (or NULL if none). Or the
 221  * more convenient describe_object(), which always produces an output string
 222  * with the oid combined with the name (if any). Note that the return value
 223  * points to a rotating array of static buffers, and may be invalidated by a
 224  * subsequent call.
 225  */
 226 void fsck_enable_object_names(struct fsck_options *options);
 227 const char *fsck_get_object_name(struct fsck_options *options,
 228                                  const struct object_id *oid);
 229 __attribute__((format (printf,3,4)))
 230 void fsck_put_object_name(struct fsck_options *options,
 231                           const struct object_id *oid,
 232                           const char *fmt, ...);
 233 const char *fsck_describe_object(struct fsck_options *options,
 234                                  const struct object_id *oid);
 235
 236 struct key_value_info;
 237 /*
 238  * git_config() callback for use by fsck-y tools that want to support
 239  * fsck.<msg> fsck.skipList etc.
 240  */
 241 int git_fsck_config(const char *var, const char *value,
 242                     const struct config_context *ctx, void *cb);
 243
 244 #endif