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