11 #include "sha1-array.h"
16 #define FOREACH_MSG_ID(FUNC) \
18 FUNC(NUL_IN_HEADER, FATAL) \
19 FUNC(UNTERMINATED_HEADER, FATAL) \
21 FUNC(BAD_DATE, ERROR) \
22 FUNC(BAD_DATE_OVERFLOW, ERROR) \
23 FUNC(BAD_EMAIL, ERROR) \
24 FUNC(BAD_NAME, ERROR) \
25 FUNC(BAD_OBJECT_SHA1, ERROR) \
26 FUNC(BAD_PARENT_SHA1, ERROR) \
27 FUNC(BAD_TAG_OBJECT, ERROR) \
28 FUNC(BAD_TIMEZONE, ERROR) \
29 FUNC(BAD_TREE, ERROR) \
30 FUNC(BAD_TREE_SHA1, ERROR) \
31 FUNC(BAD_TYPE, ERROR) \
32 FUNC(DUPLICATE_ENTRIES, ERROR) \
33 FUNC(MISSING_AUTHOR, ERROR) \
34 FUNC(MISSING_COMMITTER, ERROR) \
35 FUNC(MISSING_EMAIL, ERROR) \
36 FUNC(MISSING_GRAFT, ERROR) \
37 FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \
38 FUNC(MISSING_OBJECT, ERROR) \
39 FUNC(MISSING_PARENT, ERROR) \
40 FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \
41 FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \
42 FUNC(MISSING_TAG, ERROR) \
43 FUNC(MISSING_TAG_ENTRY, ERROR) \
44 FUNC(MISSING_TAG_OBJECT, ERROR) \
45 FUNC(MISSING_TREE, ERROR) \
46 FUNC(MISSING_TYPE, ERROR) \
47 FUNC(MISSING_TYPE_ENTRY, ERROR) \
48 FUNC(MULTIPLE_AUTHORS, ERROR) \
49 FUNC(TAG_OBJECT_NOT_TAG, ERROR) \
50 FUNC(TREE_NOT_SORTED, ERROR) \
51 FUNC(UNKNOWN_TYPE, ERROR) \
52 FUNC(ZERO_PADDED_DATE, ERROR) \
54 FUNC(BAD_FILEMODE, WARN) \
55 FUNC(EMPTY_NAME, WARN) \
56 FUNC(FULL_PATHNAME, WARN) \
58 FUNC(HAS_DOTDOT, WARN) \
59 FUNC(HAS_DOTGIT, WARN) \
60 FUNC(NULL_SHA1, WARN) \
61 FUNC(ZERO_PADDED_FILEMODE, WARN) \
62 /* infos (reported as warnings, but ignored by default) */ \
63 FUNC(BAD_TAG_NAME, INFO) \
64 FUNC(MISSING_TAGGER_ENTRY, INFO)
66 #define MSG_ID(id, msg_type) FSCK_MSG_##id,
68 FOREACH_MSG_ID(MSG_ID)
74 #define MSG_ID(id, msg_type) { STR(id), NULL, FSCK_##msg_type },
76 const char *id_string;
77 const char *downcased;
79 } msg_id_info[FSCK_MSG_MAX + 1] = {
80 FOREACH_MSG_ID(MSG_ID)
85 static int parse_msg_id(const char *text)
89 if (!msg_id_info[0].downcased) {
90 /* convert id_string to lower case, without underscores. */
91 for (i = 0; i < FSCK_MSG_MAX; i++) {
92 const char *p = msg_id_info[i].id_string;
94 char *q = xmalloc(len);
96 msg_id_info[i].downcased = q;
101 *(q)++ = tolower(*(p)++);
106 for (i = 0; i < FSCK_MSG_MAX; i++)
107 if (!strcmp(text, msg_id_info[i].downcased))
113 static int fsck_msg_type(enum fsck_msg_id msg_id,
114 struct fsck_options *options)
118 assert(msg_id >= 0 && msg_id < FSCK_MSG_MAX);
120 if (options->msg_type)
121 msg_type = options->msg_type[msg_id];
123 msg_type = msg_id_info[msg_id].msg_type;
124 if (options->strict && msg_type == FSCK_WARN)
125 msg_type = FSCK_ERROR;
131 static void init_skiplist(struct fsck_options *options, const char *path)
133 static struct sha1_array skiplist = SHA1_ARRAY_INIT;
136 unsigned char sha1[20];
138 if (options->skiplist)
139 sorted = options->skiplist->sorted;
142 options->skiplist = &skiplist;
145 fd = open(path, O_RDONLY);
147 die("Could not open skip list: %s", path);
149 int result = read_in_full(fd, buffer, sizeof(buffer));
151 die_errno("Could not read '%s'", path);
154 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n')
155 die("Invalid SHA-1: %s", buffer);
156 sha1_array_append(&skiplist, sha1);
157 if (sorted && skiplist.nr > 1 &&
158 hashcmp(skiplist.sha1[skiplist.nr - 2],
168 static int parse_msg_type(const char *str)
170 if (!strcmp(str, "error"))
172 else if (!strcmp(str, "warn"))
174 else if (!strcmp(str, "ignore"))
177 die("Unknown fsck message type: '%s'", str);
180 int is_valid_msg_type(const char *msg_id, const char *msg_type)
182 if (parse_msg_id(msg_id) < 0)
184 parse_msg_type(msg_type);
188 void fsck_set_msg_type(struct fsck_options *options,
189 const char *msg_id, const char *msg_type)
191 int id = parse_msg_id(msg_id), type;
194 die("Unhandled message id: %s", msg_id);
195 type = parse_msg_type(msg_type);
197 if (type != FSCK_ERROR && msg_id_info[id].msg_type == FSCK_FATAL)
198 die("Cannot demote %s to %s", msg_id, msg_type);
200 if (!options->msg_type) {
203 ALLOC_ARRAY(msg_type, FSCK_MSG_MAX);
204 for (i = 0; i < FSCK_MSG_MAX; i++)
205 msg_type[i] = fsck_msg_type(i, options);
206 options->msg_type = msg_type;
209 options->msg_type[id] = type;
212 void fsck_set_msg_types(struct fsck_options *options, const char *values)
214 char *buf = xstrdup(values), *to_free = buf;
218 int len = strcspn(buf, " ,|"), equal;
228 equal < len && buf[equal] != '=' && buf[equal] != ':';
230 buf[equal] = tolower(buf[equal]);
233 if (!strcmp(buf, "skiplist")) {
235 die("skiplist requires a path");
236 init_skiplist(options, buf + equal + 1);
242 die("Missing '=': '%s'", buf);
244 fsck_set_msg_type(options, buf, buf + equal + 1);
250 static void append_msg_id(struct strbuf *sb, const char *msg_id)
253 char c = *(msg_id)++;
258 strbuf_addch(sb, tolower(c));
261 strbuf_addch(sb, *(msg_id)++);
265 strbuf_addstr(sb, ": ");
268 __attribute__((format (printf, 4, 5)))
269 static int report(struct fsck_options *options, struct object *object,
270 enum fsck_msg_id id, const char *fmt, ...)
273 struct strbuf sb = STRBUF_INIT;
274 int msg_type = fsck_msg_type(id, options), result;
276 if (msg_type == FSCK_IGNORE)
279 if (options->skiplist && object &&
280 sha1_array_lookup(options->skiplist, object->oid.hash) >= 0)
283 if (msg_type == FSCK_FATAL)
284 msg_type = FSCK_ERROR;
285 else if (msg_type == FSCK_INFO)
286 msg_type = FSCK_WARN;
288 append_msg_id(&sb, msg_id_info[id].id_string);
291 strbuf_vaddf(&sb, fmt, ap);
292 result = options->error_func(object, msg_type, sb.buf);
299 static int fsck_walk_tree(struct tree *tree, void *data, struct fsck_options *options)
301 struct tree_desc desc;
302 struct name_entry entry;
305 if (parse_tree(tree))
308 init_tree_desc(&desc, tree->buffer, tree->size);
309 while (tree_entry(&desc, &entry)) {
312 if (S_ISGITLINK(entry.mode))
314 if (S_ISDIR(entry.mode))
315 result = options->walk(&lookup_tree(entry.oid->hash)->object, OBJ_TREE, data, options);
316 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode))
317 result = options->walk(&lookup_blob(entry.oid->hash)->object, OBJ_BLOB, data, options);
319 result = error("in tree %s: entry %s has bad mode %.6o",
320 oid_to_hex(&tree->object.oid), entry.path, entry.mode);
330 static int fsck_walk_commit(struct commit *commit, void *data, struct fsck_options *options)
332 struct commit_list *parents;
336 if (parse_commit(commit))
339 result = options->walk((struct object *)commit->tree, OBJ_TREE, data, options);
344 parents = commit->parents;
346 result = options->walk((struct object *)parents->item, OBJ_COMMIT, data, options);
351 parents = parents->next;
356 static int fsck_walk_tag(struct tag *tag, void *data, struct fsck_options *options)
360 return options->walk(tag->tagged, OBJ_ANY, data, options);
363 int fsck_walk(struct object *obj, void *data, struct fsck_options *options)
371 return fsck_walk_tree((struct tree *)obj, data, options);
373 return fsck_walk_commit((struct commit *)obj, data, options);
375 return fsck_walk_tag((struct tag *)obj, data, options);
377 error("Unknown object type for %s", oid_to_hex(&obj->oid));
383 * The entries in a tree are ordered in the _path_ order,
384 * which means that a directory entry is ordered by adding
385 * a slash to the end of it.
387 * So a directory called "a" is ordered _after_ a file
388 * called "a.c", because "a/" sorts after "a.c".
390 #define TREE_UNORDERED (-1)
391 #define TREE_HAS_DUPS (-2)
393 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
395 int len1 = strlen(name1);
396 int len2 = strlen(name2);
397 int len = len1 < len2 ? len1 : len2;
398 unsigned char c1, c2;
401 cmp = memcmp(name1, name2, len);
405 return TREE_UNORDERED;
408 * Ok, the first <len> characters are the same.
409 * Now we need to order the next one, but turn
410 * a '\0' into a '/' for a directory entry.
416 * git-write-tree used to write out a nonsense tree that has
417 * entries with the same name, one blob and one tree. Make
418 * sure we do not have duplicate entries.
420 return TREE_HAS_DUPS;
421 if (!c1 && S_ISDIR(mode1))
423 if (!c2 && S_ISDIR(mode2))
425 return c1 < c2 ? 0 : TREE_UNORDERED;
428 static int fsck_tree(struct tree *item, struct fsck_options *options)
431 int has_null_sha1 = 0;
432 int has_full_path = 0;
433 int has_empty_name = 0;
437 int has_zero_pad = 0;
438 int has_bad_modes = 0;
439 int has_dup_entries = 0;
440 int not_properly_sorted = 0;
441 struct tree_desc desc;
445 init_tree_desc(&desc, item->buffer, item->size);
453 const struct object_id *oid;
455 oid = tree_entry_extract(&desc, &name, &mode);
457 has_null_sha1 |= is_null_oid(oid);
458 has_full_path |= !!strchr(name, '/');
459 has_empty_name |= !*name;
460 has_dot |= !strcmp(name, ".");
461 has_dotdot |= !strcmp(name, "..");
462 has_dotgit |= (!strcmp(name, ".git") ||
463 is_hfs_dotgit(name) ||
464 is_ntfs_dotgit(name));
465 has_zero_pad |= *(char *)desc.buffer == '0';
466 update_tree_entry(&desc);
479 * This is nonstandard, but we had a few of these
480 * early on when we honored the full set of mode
484 if (!options->strict)
491 switch (verify_ordered(o_mode, o_name, mode, name)) {
493 not_properly_sorted = 1;
509 retval += report(options, &item->object, FSCK_MSG_NULL_SHA1, "contains entries pointing to null sha1");
511 retval += report(options, &item->object, FSCK_MSG_FULL_PATHNAME, "contains full pathnames");
513 retval += report(options, &item->object, FSCK_MSG_EMPTY_NAME, "contains empty pathname");
515 retval += report(options, &item->object, FSCK_MSG_HAS_DOT, "contains '.'");
517 retval += report(options, &item->object, FSCK_MSG_HAS_DOTDOT, "contains '..'");
519 retval += report(options, &item->object, FSCK_MSG_HAS_DOTGIT, "contains '.git'");
521 retval += report(options, &item->object, FSCK_MSG_ZERO_PADDED_FILEMODE, "contains zero-padded file modes");
523 retval += report(options, &item->object, FSCK_MSG_BAD_FILEMODE, "contains bad file modes");
525 retval += report(options, &item->object, FSCK_MSG_DUPLICATE_ENTRIES, "contains duplicate file entries");
526 if (not_properly_sorted)
527 retval += report(options, &item->object, FSCK_MSG_TREE_NOT_SORTED, "not properly sorted");
531 static int verify_headers(const void *data, unsigned long size,
532 struct object *obj, struct fsck_options *options)
534 const char *buffer = (const char *)data;
537 for (i = 0; i < size; i++) {
540 return report(options, obj,
541 FSCK_MSG_NUL_IN_HEADER,
542 "unterminated header: NUL at offset %ld", i);
544 if (i + 1 < size && buffer[i + 1] == '\n')
550 * We did not find double-LF that separates the header
551 * and the body. Not having a body is not a crime but
552 * we do want to see the terminating LF for the last header
555 if (size && buffer[size - 1] == '\n')
558 return report(options, obj,
559 FSCK_MSG_UNTERMINATED_HEADER, "unterminated header");
562 static int fsck_ident(const char **ident, struct object *obj, struct fsck_options *options)
564 const char *p = *ident;
567 *ident = strchrnul(*ident, '\n');
572 return report(options, obj, FSCK_MSG_MISSING_NAME_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
573 p += strcspn(p, "<>\n");
575 return report(options, obj, FSCK_MSG_BAD_NAME, "invalid author/committer line - bad name");
577 return report(options, obj, FSCK_MSG_MISSING_EMAIL, "invalid author/committer line - missing email");
579 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
581 p += strcspn(p, "<>\n");
583 return report(options, obj, FSCK_MSG_BAD_EMAIL, "invalid author/committer line - bad email");
586 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_DATE, "invalid author/committer line - missing space before date");
588 if (*p == '0' && p[1] != ' ')
589 return report(options, obj, FSCK_MSG_ZERO_PADDED_DATE, "invalid author/committer line - zero-padded date");
590 if (date_overflows(strtoul(p, &end, 10)))
591 return report(options, obj, FSCK_MSG_BAD_DATE_OVERFLOW, "invalid author/committer line - date causes integer overflow");
592 if ((end == p || *end != ' '))
593 return report(options, obj, FSCK_MSG_BAD_DATE, "invalid author/committer line - bad date");
595 if ((*p != '+' && *p != '-') ||
601 return report(options, obj, FSCK_MSG_BAD_TIMEZONE, "invalid author/committer line - bad time zone");
606 static int fsck_commit_buffer(struct commit *commit, const char *buffer,
607 unsigned long size, struct fsck_options *options)
609 unsigned char tree_sha1[20], sha1[20];
610 struct commit_graft *graft;
611 unsigned parent_count, parent_line_count = 0, author_count;
614 if (verify_headers(buffer, size, &commit->object, options))
617 if (!skip_prefix(buffer, "tree ", &buffer))
618 return report(options, &commit->object, FSCK_MSG_MISSING_TREE, "invalid format - expected 'tree' line");
619 if (get_sha1_hex(buffer, tree_sha1) || buffer[40] != '\n') {
620 err = report(options, &commit->object, FSCK_MSG_BAD_TREE_SHA1, "invalid 'tree' line format - bad sha1");
625 while (skip_prefix(buffer, "parent ", &buffer)) {
626 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
627 err = report(options, &commit->object, FSCK_MSG_BAD_PARENT_SHA1, "invalid 'parent' line format - bad sha1");
634 graft = lookup_commit_graft(commit->object.oid.hash);
635 parent_count = commit_list_count(commit->parents);
637 if (graft->nr_parent == -1 && !parent_count)
638 ; /* shallow commit */
639 else if (graft->nr_parent != parent_count) {
640 err = report(options, &commit->object, FSCK_MSG_MISSING_GRAFT, "graft objects missing");
645 if (parent_count != parent_line_count) {
646 err = report(options, &commit->object, FSCK_MSG_MISSING_PARENT, "parent objects missing");
652 while (skip_prefix(buffer, "author ", &buffer)) {
654 err = fsck_ident(&buffer, &commit->object, options);
658 if (author_count < 1)
659 err = report(options, &commit->object, FSCK_MSG_MISSING_AUTHOR, "invalid format - expected 'author' line");
660 else if (author_count > 1)
661 err = report(options, &commit->object, FSCK_MSG_MULTIPLE_AUTHORS, "invalid format - multiple 'author' lines");
664 if (!skip_prefix(buffer, "committer ", &buffer))
665 return report(options, &commit->object, FSCK_MSG_MISSING_COMMITTER, "invalid format - expected 'committer' line");
666 err = fsck_ident(&buffer, &commit->object, options);
670 return report(options, &commit->object, FSCK_MSG_BAD_TREE, "could not load commit's tree %s", sha1_to_hex(tree_sha1));
675 static int fsck_commit(struct commit *commit, const char *data,
676 unsigned long size, struct fsck_options *options)
678 const char *buffer = data ? data : get_commit_buffer(commit, &size);
679 int ret = fsck_commit_buffer(commit, buffer, size, options);
681 unuse_commit_buffer(commit, buffer);
685 static int fsck_tag_buffer(struct tag *tag, const char *data,
686 unsigned long size, struct fsck_options *options)
688 unsigned char sha1[20];
691 char *to_free = NULL, *eol;
692 struct strbuf sb = STRBUF_INIT;
697 enum object_type type;
700 read_sha1_file(tag->object.oid.hash, &type, &size);
702 return report(options, &tag->object,
703 FSCK_MSG_MISSING_TAG_OBJECT,
704 "cannot read tag object");
706 if (type != OBJ_TAG) {
707 ret = report(options, &tag->object,
708 FSCK_MSG_TAG_OBJECT_NOT_TAG,
709 "expected tag got %s",
715 ret = verify_headers(buffer, size, &tag->object, options);
719 if (!skip_prefix(buffer, "object ", &buffer)) {
720 ret = report(options, &tag->object, FSCK_MSG_MISSING_OBJECT, "invalid format - expected 'object' line");
723 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
724 ret = report(options, &tag->object, FSCK_MSG_BAD_OBJECT_SHA1, "invalid 'object' line format - bad sha1");
730 if (!skip_prefix(buffer, "type ", &buffer)) {
731 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE_ENTRY, "invalid format - expected 'type' line");
734 eol = strchr(buffer, '\n');
736 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE, "invalid format - unexpected end after 'type' line");
739 if (type_from_string_gently(buffer, eol - buffer, 1) < 0)
740 ret = report(options, &tag->object, FSCK_MSG_BAD_TYPE, "invalid 'type' value");
745 if (!skip_prefix(buffer, "tag ", &buffer)) {
746 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG_ENTRY, "invalid format - expected 'tag' line");
749 eol = strchr(buffer, '\n');
751 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG, "invalid format - unexpected end after 'type' line");
754 strbuf_addf(&sb, "refs/tags/%.*s", (int)(eol - buffer), buffer);
755 if (check_refname_format(sb.buf, 0)) {
756 ret = report(options, &tag->object, FSCK_MSG_BAD_TAG_NAME,
757 "invalid 'tag' name: %.*s",
758 (int)(eol - buffer), buffer);
764 if (!skip_prefix(buffer, "tagger ", &buffer)) {
765 /* early tags do not contain 'tagger' lines; warn only */
766 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAGGER_ENTRY, "invalid format - expected 'tagger' line");
771 ret = fsck_ident(&buffer, &tag->object, options);
779 static int fsck_tag(struct tag *tag, const char *data,
780 unsigned long size, struct fsck_options *options)
782 struct object *tagged = tag->tagged;
785 return report(options, &tag->object, FSCK_MSG_BAD_TAG_OBJECT, "could not load tagged object");
787 return fsck_tag_buffer(tag, data, size, options);
790 int fsck_object(struct object *obj, void *data, unsigned long size,
791 struct fsck_options *options)
794 return report(options, obj, FSCK_MSG_BAD_OBJECT_SHA1, "no valid object to fsck");
796 if (obj->type == OBJ_BLOB)
798 if (obj->type == OBJ_TREE)
799 return fsck_tree((struct tree *) obj, options);
800 if (obj->type == OBJ_COMMIT)
801 return fsck_commit((struct commit *) obj, (const char *) data,
803 if (obj->type == OBJ_TAG)
804 return fsck_tag((struct tag *) obj, (const char *) data,
807 return report(options, obj, FSCK_MSG_UNKNOWN_TYPE, "unknown type '%d' (internal fsck error)",
811 int fsck_error_function(struct object *obj, int msg_type, const char *message)
813 if (msg_type == FSCK_WARN) {
814 warning("object %s: %s", oid_to_hex(&obj->oid), message);
817 error("object %s: %s", oid_to_hex(&obj->oid), message);