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