fsck.h

   1 #ifndef GIT_FSCK_H
   2 #define GIT_FSCK_H
   3
   4 #include "oidset.h"
   5
   6 #define FSCK_ERROR 1
   7 #define FSCK_WARN 2
   8 #define FSCK_IGNORE 3
   9
  10 struct fsck_options;
  11 struct object;
  12
  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);
  16 int is_valid_msg_type(const char *msg_id, const char *msg_type);
  17
  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  */
  26 typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct fsck_options *options);
  27
  28 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
  29 typedef int (*fsck_error)(struct fsck_options *o,
  30         struct object *obj, int type, const char *message);
  31
  32 int fsck_error_function(struct fsck_options *o,
  33         struct object *obj, int type, const char *message);
  34
  35 struct fsck_options {
  36         fsck_walk_func walk;
  37         fsck_error error_func;
  38         unsigned strict:1;
  39         int *msg_type;
  40         struct oidset skiplist;
  41         struct decoration *object_names;
  42 };
  43
  44 #define FSCK_OPTIONS_DEFAULT { NULL, fsck_error_function, 0, NULL, OIDSET_INIT }
  45 #define FSCK_OPTIONS_STRICT { NULL, fsck_error_function, 1, NULL, OIDSET_INIT }
  46
  47 /* descend in all linked child objects
  48  * the return value is:
  49  *    -1        error in processing the object
  50  *    <0        return value of the callback, which lead to an abort
  51  *    >0        return value of the first signaled error >0 (in the case of no other errors)
  52  *    0         everything OK
  53  */
  54 int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
  55 /* If NULL is passed for data, we assume the object is local and read it. */
  56 int fsck_object(struct object *obj, void *data, unsigned long size,
  57         struct fsck_options *options);
  58
  59 /*
  60  * Some fsck checks are context-dependent, and may end up queued; run this
  61  * after completing all fsck_object() calls in order to resolve any remaining
  62  * checks.
  63  */
  64 int fsck_finish(struct fsck_options *options);
  65
  66 #endif