11 #include "sha1-array.h"
17 #define FOREACH_MSG_ID(FUNC) \
19 FUNC(NUL_IN_HEADER, FATAL) \
20 FUNC(UNTERMINATED_HEADER, FATAL) \
22 FUNC(BAD_DATE, ERROR) \
23 FUNC(BAD_DATE_OVERFLOW, ERROR) \
24 FUNC(BAD_EMAIL, ERROR) \
25 FUNC(BAD_NAME, ERROR) \
26 FUNC(BAD_OBJECT_SHA1, ERROR) \
27 FUNC(BAD_PARENT_SHA1, ERROR) \
28 FUNC(BAD_TAG_OBJECT, ERROR) \
29 FUNC(BAD_TIMEZONE, ERROR) \
30 FUNC(BAD_TREE, ERROR) \
31 FUNC(BAD_TREE_SHA1, ERROR) \
32 FUNC(BAD_TYPE, ERROR) \
33 FUNC(DUPLICATE_ENTRIES, ERROR) \
34 FUNC(MISSING_AUTHOR, ERROR) \
35 FUNC(MISSING_COMMITTER, ERROR) \
36 FUNC(MISSING_EMAIL, ERROR) \
37 FUNC(MISSING_GRAFT, ERROR) \
38 FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \
39 FUNC(MISSING_OBJECT, ERROR) \
40 FUNC(MISSING_PARENT, ERROR) \
41 FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \
42 FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \
43 FUNC(MISSING_TAG, ERROR) \
44 FUNC(MISSING_TAG_ENTRY, ERROR) \
45 FUNC(MISSING_TAG_OBJECT, ERROR) \
46 FUNC(MISSING_TREE, ERROR) \
47 FUNC(MISSING_TYPE, ERROR) \
48 FUNC(MISSING_TYPE_ENTRY, ERROR) \
49 FUNC(MULTIPLE_AUTHORS, ERROR) \
50 FUNC(TAG_OBJECT_NOT_TAG, ERROR) \
51 FUNC(TREE_NOT_SORTED, ERROR) \
52 FUNC(UNKNOWN_TYPE, ERROR) \
53 FUNC(ZERO_PADDED_DATE, ERROR) \
55 FUNC(BAD_FILEMODE, WARN) \
56 FUNC(EMPTY_NAME, WARN) \
57 FUNC(FULL_PATHNAME, WARN) \
59 FUNC(HAS_DOTDOT, WARN) \
60 FUNC(HAS_DOTGIT, WARN) \
61 FUNC(NULL_SHA1, WARN) \
62 FUNC(ZERO_PADDED_FILEMODE, WARN) \
63 FUNC(NUL_IN_COMMIT, WARN) \
64 /* infos (reported as warnings, but ignored by default) */ \
65 FUNC(BAD_TAG_NAME, INFO) \
66 FUNC(MISSING_TAGGER_ENTRY, INFO)
68 #define MSG_ID(id, msg_type) FSCK_MSG_##id,
70 FOREACH_MSG_ID(MSG_ID)
76 #define MSG_ID(id, msg_type) { STR(id), NULL, FSCK_##msg_type },
78 const char *id_string;
79 const char *downcased;
81 } msg_id_info[FSCK_MSG_MAX + 1] = {
82 FOREACH_MSG_ID(MSG_ID)
87 static int parse_msg_id(const char *text)
91 if (!msg_id_info[0].downcased) {
92 /* convert id_string to lower case, without underscores. */
93 for (i = 0; i < FSCK_MSG_MAX; i++) {
94 const char *p = msg_id_info[i].id_string;
96 char *q = xmalloc(len);
98 msg_id_info[i].downcased = q;
103 *(q)++ = tolower(*(p)++);
108 for (i = 0; i < FSCK_MSG_MAX; i++)
109 if (!strcmp(text, msg_id_info[i].downcased))
115 static int fsck_msg_type(enum fsck_msg_id msg_id,
116 struct fsck_options *options)
120 assert(msg_id >= 0 && msg_id < FSCK_MSG_MAX);
122 if (options->msg_type)
123 msg_type = options->msg_type[msg_id];
125 msg_type = msg_id_info[msg_id].msg_type;
126 if (options->strict && msg_type == FSCK_WARN)
127 msg_type = FSCK_ERROR;
133 static void init_skiplist(struct fsck_options *options, const char *path)
135 static struct sha1_array skiplist = SHA1_ARRAY_INIT;
138 unsigned char sha1[20];
140 if (options->skiplist)
141 sorted = options->skiplist->sorted;
144 options->skiplist = &skiplist;
147 fd = open(path, O_RDONLY);
149 die("Could not open skip list: %s", path);
151 int result = read_in_full(fd, buffer, sizeof(buffer));
153 die_errno("Could not read '%s'", path);
156 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n')
157 die("Invalid SHA-1: %s", buffer);
158 sha1_array_append(&skiplist, sha1);
159 if (sorted && skiplist.nr > 1 &&
160 hashcmp(skiplist.sha1[skiplist.nr - 2],
170 static int parse_msg_type(const char *str)
172 if (!strcmp(str, "error"))
174 else if (!strcmp(str, "warn"))
176 else if (!strcmp(str, "ignore"))
179 die("Unknown fsck message type: '%s'", str);
182 int is_valid_msg_type(const char *msg_id, const char *msg_type)
184 if (parse_msg_id(msg_id) < 0)
186 parse_msg_type(msg_type);
190 void fsck_set_msg_type(struct fsck_options *options,
191 const char *msg_id, const char *msg_type)
193 int id = parse_msg_id(msg_id), type;
196 die("Unhandled message id: %s", msg_id);
197 type = parse_msg_type(msg_type);
199 if (type != FSCK_ERROR && msg_id_info[id].msg_type == FSCK_FATAL)
200 die("Cannot demote %s to %s", msg_id, msg_type);
202 if (!options->msg_type) {
205 ALLOC_ARRAY(msg_type, FSCK_MSG_MAX);
206 for (i = 0; i < FSCK_MSG_MAX; i++)
207 msg_type[i] = fsck_msg_type(i, options);
208 options->msg_type = msg_type;
211 options->msg_type[id] = type;
214 void fsck_set_msg_types(struct fsck_options *options, const char *values)
216 char *buf = xstrdup(values), *to_free = buf;
220 int len = strcspn(buf, " ,|"), equal;
230 equal < len && buf[equal] != '=' && buf[equal] != ':';
232 buf[equal] = tolower(buf[equal]);
235 if (!strcmp(buf, "skiplist")) {
237 die("skiplist requires a path");
238 init_skiplist(options, buf + equal + 1);
244 die("Missing '=': '%s'", buf);
246 fsck_set_msg_type(options, buf, buf + equal + 1);
252 static void append_msg_id(struct strbuf *sb, const char *msg_id)
255 char c = *(msg_id)++;
260 strbuf_addch(sb, tolower(c));
263 strbuf_addch(sb, *(msg_id)++);
267 strbuf_addstr(sb, ": ");
270 __attribute__((format (printf, 4, 5)))
271 static int report(struct fsck_options *options, struct object *object,
272 enum fsck_msg_id id, const char *fmt, ...)
275 struct strbuf sb = STRBUF_INIT;
276 int msg_type = fsck_msg_type(id, options), result;
278 if (msg_type == FSCK_IGNORE)
281 if (options->skiplist && object &&
282 sha1_array_lookup(options->skiplist, object->oid.hash) >= 0)
285 if (msg_type == FSCK_FATAL)
286 msg_type = FSCK_ERROR;
287 else if (msg_type == FSCK_INFO)
288 msg_type = FSCK_WARN;
290 append_msg_id(&sb, msg_id_info[id].id_string);
293 strbuf_vaddf(&sb, fmt, ap);
294 result = options->error_func(object, msg_type, sb.buf);
301 static char *get_object_name(struct fsck_options *options, struct object *obj)
303 if (!options->object_names)
305 return lookup_decoration(options->object_names, obj);
308 static void put_object_name(struct fsck_options *options, struct object *obj,
309 const char *fmt, ...)
312 struct strbuf buf = STRBUF_INIT;
315 if (!options->object_names)
317 existing = lookup_decoration(options->object_names, obj);
321 strbuf_vaddf(&buf, fmt, ap);
322 add_decoration(options->object_names, obj, strbuf_detach(&buf, NULL));
326 static int fsck_walk_tree(struct tree *tree, void *data, struct fsck_options *options)
328 struct tree_desc desc;
329 struct name_entry entry;
333 if (parse_tree(tree))
336 name = get_object_name(options, &tree->object);
337 init_tree_desc(&desc, tree->buffer, tree->size);
338 while (tree_entry(&desc, &entry)) {
342 if (S_ISGITLINK(entry.mode))
345 if (S_ISDIR(entry.mode)) {
346 obj = &lookup_tree(entry.oid->hash)->object;
348 put_object_name(options, obj, "%s%s/", name,
350 result = options->walk(obj, OBJ_TREE, data, options);
352 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode)) {
353 obj = &lookup_blob(entry.oid->hash)->object;
355 put_object_name(options, obj, "%s%s", name,
357 result = options->walk(obj, OBJ_BLOB, data, options);
360 result = error("in tree %s: entry %s has bad mode %.6o",
361 oid_to_hex(&tree->object.oid), entry.path, entry.mode);
371 static int fsck_walk_commit(struct commit *commit, void *data, struct fsck_options *options)
373 int counter = 0, generation = 0, name_prefix_len = 0;
374 struct commit_list *parents;
379 if (parse_commit(commit))
382 name = get_object_name(options, &commit->object);
384 put_object_name(options, &commit->tree->object, "%s:", name);
386 result = options->walk((struct object *)commit->tree, OBJ_TREE, data, options);
391 parents = commit->parents;
392 if (name && parents) {
393 int len = strlen(name), power;
395 if (len && name[len - 1] == '^') {
397 name_prefix_len = len - 1;
399 else { /* parse ~<generation> suffix */
400 for (generation = 0, power = 1;
401 len && isdigit(name[len - 1]);
403 generation += power * (name[--len] - '0');
404 if (power > 1 && len && name[len - 1] == '~')
405 name_prefix_len = len - 1;
411 struct object *obj = &parents->item->object;
414 put_object_name(options, obj, "%s^%d",
416 else if (generation > 0)
417 put_object_name(options, obj, "%.*s~%d",
418 name_prefix_len, name, generation + 1);
420 put_object_name(options, obj, "%s^", name);
422 result = options->walk((struct object *)parents->item, OBJ_COMMIT, data, options);
427 parents = parents->next;
432 static int fsck_walk_tag(struct tag *tag, void *data, struct fsck_options *options)
434 char *name = get_object_name(options, &tag->object);
439 put_object_name(options, tag->tagged, "%s", name);
440 return options->walk(tag->tagged, OBJ_ANY, data, options);
443 int fsck_walk(struct object *obj, void *data, struct fsck_options *options)
451 return fsck_walk_tree((struct tree *)obj, data, options);
453 return fsck_walk_commit((struct commit *)obj, data, options);
455 return fsck_walk_tag((struct tag *)obj, data, options);
457 error("Unknown object type for %s", oid_to_hex(&obj->oid));
463 * The entries in a tree are ordered in the _path_ order,
464 * which means that a directory entry is ordered by adding
465 * a slash to the end of it.
467 * So a directory called "a" is ordered _after_ a file
468 * called "a.c", because "a/" sorts after "a.c".
470 #define TREE_UNORDERED (-1)
471 #define TREE_HAS_DUPS (-2)
473 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
475 int len1 = strlen(name1);
476 int len2 = strlen(name2);
477 int len = len1 < len2 ? len1 : len2;
478 unsigned char c1, c2;
481 cmp = memcmp(name1, name2, len);
485 return TREE_UNORDERED;
488 * Ok, the first <len> characters are the same.
489 * Now we need to order the next one, but turn
490 * a '\0' into a '/' for a directory entry.
496 * git-write-tree used to write out a nonsense tree that has
497 * entries with the same name, one blob and one tree. Make
498 * sure we do not have duplicate entries.
500 return TREE_HAS_DUPS;
501 if (!c1 && S_ISDIR(mode1))
503 if (!c2 && S_ISDIR(mode2))
505 return c1 < c2 ? 0 : TREE_UNORDERED;
508 static int fsck_tree(struct tree *item, struct fsck_options *options)
511 int has_null_sha1 = 0;
512 int has_full_path = 0;
513 int has_empty_name = 0;
517 int has_zero_pad = 0;
518 int has_bad_modes = 0;
519 int has_dup_entries = 0;
520 int not_properly_sorted = 0;
521 struct tree_desc desc;
525 init_tree_desc(&desc, item->buffer, item->size);
533 const struct object_id *oid;
535 oid = tree_entry_extract(&desc, &name, &mode);
537 has_null_sha1 |= is_null_oid(oid);
538 has_full_path |= !!strchr(name, '/');
539 has_empty_name |= !*name;
540 has_dot |= !strcmp(name, ".");
541 has_dotdot |= !strcmp(name, "..");
542 has_dotgit |= (!strcmp(name, ".git") ||
543 is_hfs_dotgit(name) ||
544 is_ntfs_dotgit(name));
545 has_zero_pad |= *(char *)desc.buffer == '0';
546 update_tree_entry(&desc);
559 * This is nonstandard, but we had a few of these
560 * early on when we honored the full set of mode
564 if (!options->strict)
571 switch (verify_ordered(o_mode, o_name, mode, name)) {
573 not_properly_sorted = 1;
589 retval += report(options, &item->object, FSCK_MSG_NULL_SHA1, "contains entries pointing to null sha1");
591 retval += report(options, &item->object, FSCK_MSG_FULL_PATHNAME, "contains full pathnames");
593 retval += report(options, &item->object, FSCK_MSG_EMPTY_NAME, "contains empty pathname");
595 retval += report(options, &item->object, FSCK_MSG_HAS_DOT, "contains '.'");
597 retval += report(options, &item->object, FSCK_MSG_HAS_DOTDOT, "contains '..'");
599 retval += report(options, &item->object, FSCK_MSG_HAS_DOTGIT, "contains '.git'");
601 retval += report(options, &item->object, FSCK_MSG_ZERO_PADDED_FILEMODE, "contains zero-padded file modes");
603 retval += report(options, &item->object, FSCK_MSG_BAD_FILEMODE, "contains bad file modes");
605 retval += report(options, &item->object, FSCK_MSG_DUPLICATE_ENTRIES, "contains duplicate file entries");
606 if (not_properly_sorted)
607 retval += report(options, &item->object, FSCK_MSG_TREE_NOT_SORTED, "not properly sorted");
611 static int verify_headers(const void *data, unsigned long size,
612 struct object *obj, struct fsck_options *options)
614 const char *buffer = (const char *)data;
617 for (i = 0; i < size; i++) {
620 return report(options, obj,
621 FSCK_MSG_NUL_IN_HEADER,
622 "unterminated header: NUL at offset %ld", i);
624 if (i + 1 < size && buffer[i + 1] == '\n')
630 * We did not find double-LF that separates the header
631 * and the body. Not having a body is not a crime but
632 * we do want to see the terminating LF for the last header
635 if (size && buffer[size - 1] == '\n')
638 return report(options, obj,
639 FSCK_MSG_UNTERMINATED_HEADER, "unterminated header");
642 static int fsck_ident(const char **ident, struct object *obj, struct fsck_options *options)
644 const char *p = *ident;
647 *ident = strchrnul(*ident, '\n');
652 return report(options, obj, FSCK_MSG_MISSING_NAME_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
653 p += strcspn(p, "<>\n");
655 return report(options, obj, FSCK_MSG_BAD_NAME, "invalid author/committer line - bad name");
657 return report(options, obj, FSCK_MSG_MISSING_EMAIL, "invalid author/committer line - missing email");
659 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
661 p += strcspn(p, "<>\n");
663 return report(options, obj, FSCK_MSG_BAD_EMAIL, "invalid author/committer line - bad email");
666 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_DATE, "invalid author/committer line - missing space before date");
668 if (*p == '0' && p[1] != ' ')
669 return report(options, obj, FSCK_MSG_ZERO_PADDED_DATE, "invalid author/committer line - zero-padded date");
670 if (date_overflows(strtoul(p, &end, 10)))
671 return report(options, obj, FSCK_MSG_BAD_DATE_OVERFLOW, "invalid author/committer line - date causes integer overflow");
672 if ((end == p || *end != ' '))
673 return report(options, obj, FSCK_MSG_BAD_DATE, "invalid author/committer line - bad date");
675 if ((*p != '+' && *p != '-') ||
681 return report(options, obj, FSCK_MSG_BAD_TIMEZONE, "invalid author/committer line - bad time zone");
686 static int fsck_commit_buffer(struct commit *commit, const char *buffer,
687 unsigned long size, struct fsck_options *options)
689 unsigned char tree_sha1[20], sha1[20];
690 struct commit_graft *graft;
691 unsigned parent_count, parent_line_count = 0, author_count;
693 const char *buffer_begin = buffer;
695 if (verify_headers(buffer, size, &commit->object, options))
698 if (!skip_prefix(buffer, "tree ", &buffer))
699 return report(options, &commit->object, FSCK_MSG_MISSING_TREE, "invalid format - expected 'tree' line");
700 if (get_sha1_hex(buffer, tree_sha1) || buffer[40] != '\n') {
701 err = report(options, &commit->object, FSCK_MSG_BAD_TREE_SHA1, "invalid 'tree' line format - bad sha1");
706 while (skip_prefix(buffer, "parent ", &buffer)) {
707 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
708 err = report(options, &commit->object, FSCK_MSG_BAD_PARENT_SHA1, "invalid 'parent' line format - bad sha1");
715 graft = lookup_commit_graft(commit->object.oid.hash);
716 parent_count = commit_list_count(commit->parents);
718 if (graft->nr_parent == -1 && !parent_count)
719 ; /* shallow commit */
720 else if (graft->nr_parent != parent_count) {
721 err = report(options, &commit->object, FSCK_MSG_MISSING_GRAFT, "graft objects missing");
726 if (parent_count != parent_line_count) {
727 err = report(options, &commit->object, FSCK_MSG_MISSING_PARENT, "parent objects missing");
733 while (skip_prefix(buffer, "author ", &buffer)) {
735 err = fsck_ident(&buffer, &commit->object, options);
739 if (author_count < 1)
740 err = report(options, &commit->object, FSCK_MSG_MISSING_AUTHOR, "invalid format - expected 'author' line");
741 else if (author_count > 1)
742 err = report(options, &commit->object, FSCK_MSG_MULTIPLE_AUTHORS, "invalid format - multiple 'author' lines");
745 if (!skip_prefix(buffer, "committer ", &buffer))
746 return report(options, &commit->object, FSCK_MSG_MISSING_COMMITTER, "invalid format - expected 'committer' line");
747 err = fsck_ident(&buffer, &commit->object, options);
751 err = report(options, &commit->object, FSCK_MSG_BAD_TREE, "could not load commit's tree %s", sha1_to_hex(tree_sha1));
755 if (memchr(buffer_begin, '\0', size)) {
756 err = report(options, &commit->object, FSCK_MSG_NUL_IN_COMMIT,
757 "NUL byte in the commit object body");
764 static int fsck_commit(struct commit *commit, const char *data,
765 unsigned long size, struct fsck_options *options)
767 const char *buffer = data ? data : get_commit_buffer(commit, &size);
768 int ret = fsck_commit_buffer(commit, buffer, size, options);
770 unuse_commit_buffer(commit, buffer);
774 static int fsck_tag_buffer(struct tag *tag, const char *data,
775 unsigned long size, struct fsck_options *options)
777 unsigned char sha1[20];
780 char *to_free = NULL, *eol;
781 struct strbuf sb = STRBUF_INIT;
786 enum object_type type;
789 read_sha1_file(tag->object.oid.hash, &type, &size);
791 return report(options, &tag->object,
792 FSCK_MSG_MISSING_TAG_OBJECT,
793 "cannot read tag object");
795 if (type != OBJ_TAG) {
796 ret = report(options, &tag->object,
797 FSCK_MSG_TAG_OBJECT_NOT_TAG,
798 "expected tag got %s",
804 ret = verify_headers(buffer, size, &tag->object, options);
808 if (!skip_prefix(buffer, "object ", &buffer)) {
809 ret = report(options, &tag->object, FSCK_MSG_MISSING_OBJECT, "invalid format - expected 'object' line");
812 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
813 ret = report(options, &tag->object, FSCK_MSG_BAD_OBJECT_SHA1, "invalid 'object' line format - bad sha1");
819 if (!skip_prefix(buffer, "type ", &buffer)) {
820 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE_ENTRY, "invalid format - expected 'type' line");
823 eol = strchr(buffer, '\n');
825 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE, "invalid format - unexpected end after 'type' line");
828 if (type_from_string_gently(buffer, eol - buffer, 1) < 0)
829 ret = report(options, &tag->object, FSCK_MSG_BAD_TYPE, "invalid 'type' value");
834 if (!skip_prefix(buffer, "tag ", &buffer)) {
835 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG_ENTRY, "invalid format - expected 'tag' line");
838 eol = strchr(buffer, '\n');
840 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG, "invalid format - unexpected end after 'type' line");
843 strbuf_addf(&sb, "refs/tags/%.*s", (int)(eol - buffer), buffer);
844 if (check_refname_format(sb.buf, 0)) {
845 ret = report(options, &tag->object, FSCK_MSG_BAD_TAG_NAME,
846 "invalid 'tag' name: %.*s",
847 (int)(eol - buffer), buffer);
853 if (!skip_prefix(buffer, "tagger ", &buffer)) {
854 /* early tags do not contain 'tagger' lines; warn only */
855 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAGGER_ENTRY, "invalid format - expected 'tagger' line");
860 ret = fsck_ident(&buffer, &tag->object, options);
868 static int fsck_tag(struct tag *tag, const char *data,
869 unsigned long size, struct fsck_options *options)
871 struct object *tagged = tag->tagged;
874 return report(options, &tag->object, FSCK_MSG_BAD_TAG_OBJECT, "could not load tagged object");
876 return fsck_tag_buffer(tag, data, size, options);
879 int fsck_object(struct object *obj, void *data, unsigned long size,
880 struct fsck_options *options)
883 return report(options, obj, FSCK_MSG_BAD_OBJECT_SHA1, "no valid object to fsck");
885 if (obj->type == OBJ_BLOB)
887 if (obj->type == OBJ_TREE)
888 return fsck_tree((struct tree *) obj, options);
889 if (obj->type == OBJ_COMMIT)
890 return fsck_commit((struct commit *) obj, (const char *) data,
892 if (obj->type == OBJ_TAG)
893 return fsck_tag((struct tag *) obj, (const char *) data,
896 return report(options, obj, FSCK_MSG_UNKNOWN_TYPE, "unknown type '%d' (internal fsck error)",
900 int fsck_error_function(struct object *obj, int msg_type, const char *message)
902 if (msg_type == FSCK_WARN) {
903 warning("object %s: %s", oid_to_hex(&obj->oid), message);
906 error("object %s: %s", oid_to_hex(&obj->oid), message);