15 #define FOREACH_MSG_ID(FUNC) \
17 FUNC(NUL_IN_HEADER, FATAL) \
18 FUNC(UNTERMINATED_HEADER, FATAL) \
20 FUNC(BAD_DATE, ERROR) \
21 FUNC(BAD_DATE_OVERFLOW, ERROR) \
22 FUNC(BAD_EMAIL, ERROR) \
23 FUNC(BAD_NAME, ERROR) \
24 FUNC(BAD_OBJECT_SHA1, ERROR) \
25 FUNC(BAD_PARENT_SHA1, ERROR) \
26 FUNC(BAD_TAG_OBJECT, ERROR) \
27 FUNC(BAD_TIMEZONE, ERROR) \
28 FUNC(BAD_TREE, ERROR) \
29 FUNC(BAD_TREE_SHA1, ERROR) \
30 FUNC(BAD_TYPE, ERROR) \
31 FUNC(DUPLICATE_ENTRIES, ERROR) \
32 FUNC(MISSING_AUTHOR, ERROR) \
33 FUNC(MISSING_COMMITTER, ERROR) \
34 FUNC(MISSING_EMAIL, ERROR) \
35 FUNC(MISSING_GRAFT, ERROR) \
36 FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \
37 FUNC(MISSING_OBJECT, ERROR) \
38 FUNC(MISSING_PARENT, ERROR) \
39 FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \
40 FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \
41 FUNC(MISSING_TAG, ERROR) \
42 FUNC(MISSING_TAG_ENTRY, ERROR) \
43 FUNC(MISSING_TAG_OBJECT, ERROR) \
44 FUNC(MISSING_TREE, ERROR) \
45 FUNC(MISSING_TYPE, ERROR) \
46 FUNC(MISSING_TYPE_ENTRY, ERROR) \
47 FUNC(MULTIPLE_AUTHORS, ERROR) \
48 FUNC(TAG_OBJECT_NOT_TAG, ERROR) \
49 FUNC(TREE_NOT_SORTED, ERROR) \
50 FUNC(UNKNOWN_TYPE, ERROR) \
51 FUNC(ZERO_PADDED_DATE, ERROR) \
53 FUNC(BAD_FILEMODE, WARN) \
54 FUNC(EMPTY_NAME, WARN) \
55 FUNC(FULL_PATHNAME, WARN) \
57 FUNC(HAS_DOTDOT, WARN) \
58 FUNC(HAS_DOTGIT, WARN) \
59 FUNC(NULL_SHA1, WARN) \
60 FUNC(ZERO_PADDED_FILEMODE, WARN) \
61 /* infos (reported as warnings, but ignored by default) */ \
62 FUNC(BAD_TAG_NAME, INFO) \
63 FUNC(MISSING_TAGGER_ENTRY, INFO)
65 #define MSG_ID(id, msg_type) FSCK_MSG_##id,
67 FOREACH_MSG_ID(MSG_ID)
73 #define MSG_ID(id, msg_type) { STR(id), NULL, FSCK_##msg_type },
75 const char *id_string;
76 const char *downcased;
78 } msg_id_info[FSCK_MSG_MAX + 1] = {
79 FOREACH_MSG_ID(MSG_ID)
84 static int parse_msg_id(const char *text)
88 if (!msg_id_info[0].downcased) {
89 /* convert id_string to lower case, without underscores. */
90 for (i = 0; i < FSCK_MSG_MAX; i++) {
91 const char *p = msg_id_info[i].id_string;
93 char *q = xmalloc(len);
95 msg_id_info[i].downcased = q;
100 *(q)++ = tolower(*(p)++);
105 for (i = 0; i < FSCK_MSG_MAX; i++)
106 if (!strcmp(text, msg_id_info[i].downcased))
112 static int fsck_msg_type(enum fsck_msg_id msg_id,
113 struct fsck_options *options)
117 assert(msg_id >= 0 && msg_id < FSCK_MSG_MAX);
119 if (options->msg_type)
120 msg_type = options->msg_type[msg_id];
122 msg_type = msg_id_info[msg_id].msg_type;
123 if (options->strict && msg_type == FSCK_WARN)
124 msg_type = FSCK_ERROR;
130 static int parse_msg_type(const char *str)
132 if (!strcmp(str, "error"))
134 else if (!strcmp(str, "warn"))
136 else if (!strcmp(str, "ignore"))
139 die("Unknown fsck message type: '%s'", str);
142 int is_valid_msg_type(const char *msg_id, const char *msg_type)
144 if (parse_msg_id(msg_id) < 0)
146 parse_msg_type(msg_type);
150 void fsck_set_msg_type(struct fsck_options *options,
151 const char *msg_id, const char *msg_type)
153 int id = parse_msg_id(msg_id), type;
156 die("Unhandled message id: %s", msg_id);
157 type = parse_msg_type(msg_type);
159 if (type != FSCK_ERROR && msg_id_info[id].msg_type == FSCK_FATAL)
160 die("Cannot demote %s to %s", msg_id, msg_type);
162 if (!options->msg_type) {
164 int *msg_type = xmalloc(sizeof(int) * FSCK_MSG_MAX);
165 for (i = 0; i < FSCK_MSG_MAX; i++)
166 msg_type[i] = fsck_msg_type(i, options);
167 options->msg_type = msg_type;
170 options->msg_type[id] = type;
173 void fsck_set_msg_types(struct fsck_options *options, const char *values)
175 char *buf = xstrdup(values), *to_free = buf;
179 int len = strcspn(buf, " ,|"), equal;
189 equal < len && buf[equal] != '=' && buf[equal] != ':';
191 buf[equal] = tolower(buf[equal]);
195 die("Missing '=': '%s'", buf);
197 fsck_set_msg_type(options, buf, buf + equal + 1);
203 static void append_msg_id(struct strbuf *sb, const char *msg_id)
206 char c = *(msg_id)++;
211 strbuf_addch(sb, tolower(c));
214 strbuf_addch(sb, *(msg_id)++);
218 strbuf_addstr(sb, ": ");
221 __attribute__((format (printf, 4, 5)))
222 static int report(struct fsck_options *options, struct object *object,
223 enum fsck_msg_id id, const char *fmt, ...)
226 struct strbuf sb = STRBUF_INIT;
227 int msg_type = fsck_msg_type(id, options), result;
229 if (msg_type == FSCK_IGNORE)
232 if (msg_type == FSCK_FATAL)
233 msg_type = FSCK_ERROR;
234 else if (msg_type == FSCK_INFO)
235 msg_type = FSCK_WARN;
237 append_msg_id(&sb, msg_id_info[id].id_string);
240 strbuf_vaddf(&sb, fmt, ap);
241 result = options->error_func(object, msg_type, sb.buf);
248 static int fsck_walk_tree(struct tree *tree, void *data, struct fsck_options *options)
250 struct tree_desc desc;
251 struct name_entry entry;
254 if (parse_tree(tree))
257 init_tree_desc(&desc, tree->buffer, tree->size);
258 while (tree_entry(&desc, &entry)) {
261 if (S_ISGITLINK(entry.mode))
263 if (S_ISDIR(entry.mode))
264 result = options->walk(&lookup_tree(entry.sha1)->object, OBJ_TREE, data, options);
265 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode))
266 result = options->walk(&lookup_blob(entry.sha1)->object, OBJ_BLOB, data, options);
268 result = error("in tree %s: entry %s has bad mode %.6o",
269 sha1_to_hex(tree->object.sha1), entry.path, entry.mode);
279 static int fsck_walk_commit(struct commit *commit, void *data, struct fsck_options *options)
281 struct commit_list *parents;
285 if (parse_commit(commit))
288 result = options->walk((struct object *)commit->tree, OBJ_TREE, data, options);
293 parents = commit->parents;
295 result = options->walk((struct object *)parents->item, OBJ_COMMIT, data, options);
300 parents = parents->next;
305 static int fsck_walk_tag(struct tag *tag, void *data, struct fsck_options *options)
309 return options->walk(tag->tagged, OBJ_ANY, data, options);
312 int fsck_walk(struct object *obj, void *data, struct fsck_options *options)
320 return fsck_walk_tree((struct tree *)obj, data, options);
322 return fsck_walk_commit((struct commit *)obj, data, options);
324 return fsck_walk_tag((struct tag *)obj, data, options);
326 error("Unknown object type for %s", sha1_to_hex(obj->sha1));
332 * The entries in a tree are ordered in the _path_ order,
333 * which means that a directory entry is ordered by adding
334 * a slash to the end of it.
336 * So a directory called "a" is ordered _after_ a file
337 * called "a.c", because "a/" sorts after "a.c".
339 #define TREE_UNORDERED (-1)
340 #define TREE_HAS_DUPS (-2)
342 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
344 int len1 = strlen(name1);
345 int len2 = strlen(name2);
346 int len = len1 < len2 ? len1 : len2;
347 unsigned char c1, c2;
350 cmp = memcmp(name1, name2, len);
354 return TREE_UNORDERED;
357 * Ok, the first <len> characters are the same.
358 * Now we need to order the next one, but turn
359 * a '\0' into a '/' for a directory entry.
365 * git-write-tree used to write out a nonsense tree that has
366 * entries with the same name, one blob and one tree. Make
367 * sure we do not have duplicate entries.
369 return TREE_HAS_DUPS;
370 if (!c1 && S_ISDIR(mode1))
372 if (!c2 && S_ISDIR(mode2))
374 return c1 < c2 ? 0 : TREE_UNORDERED;
377 static int fsck_tree(struct tree *item, struct fsck_options *options)
380 int has_null_sha1 = 0;
381 int has_full_path = 0;
382 int has_empty_name = 0;
386 int has_zero_pad = 0;
387 int has_bad_modes = 0;
388 int has_dup_entries = 0;
389 int not_properly_sorted = 0;
390 struct tree_desc desc;
394 init_tree_desc(&desc, item->buffer, item->size);
402 const unsigned char *sha1;
404 sha1 = tree_entry_extract(&desc, &name, &mode);
406 has_null_sha1 |= is_null_sha1(sha1);
407 has_full_path |= !!strchr(name, '/');
408 has_empty_name |= !*name;
409 has_dot |= !strcmp(name, ".");
410 has_dotdot |= !strcmp(name, "..");
411 has_dotgit |= (!strcmp(name, ".git") ||
412 is_hfs_dotgit(name) ||
413 is_ntfs_dotgit(name));
414 has_zero_pad |= *(char *)desc.buffer == '0';
415 update_tree_entry(&desc);
428 * This is nonstandard, but we had a few of these
429 * early on when we honored the full set of mode
433 if (!options->strict)
440 switch (verify_ordered(o_mode, o_name, mode, name)) {
442 not_properly_sorted = 1;
458 retval += report(options, &item->object, FSCK_MSG_NULL_SHA1, "contains entries pointing to null sha1");
460 retval += report(options, &item->object, FSCK_MSG_FULL_PATHNAME, "contains full pathnames");
462 retval += report(options, &item->object, FSCK_MSG_EMPTY_NAME, "contains empty pathname");
464 retval += report(options, &item->object, FSCK_MSG_HAS_DOT, "contains '.'");
466 retval += report(options, &item->object, FSCK_MSG_HAS_DOTDOT, "contains '..'");
468 retval += report(options, &item->object, FSCK_MSG_HAS_DOTGIT, "contains '.git'");
470 retval += report(options, &item->object, FSCK_MSG_ZERO_PADDED_FILEMODE, "contains zero-padded file modes");
472 retval += report(options, &item->object, FSCK_MSG_BAD_FILEMODE, "contains bad file modes");
474 retval += report(options, &item->object, FSCK_MSG_DUPLICATE_ENTRIES, "contains duplicate file entries");
475 if (not_properly_sorted)
476 retval += report(options, &item->object, FSCK_MSG_TREE_NOT_SORTED, "not properly sorted");
480 static int require_end_of_header(const void *data, unsigned long size,
481 struct object *obj, struct fsck_options *options)
483 const char *buffer = (const char *)data;
486 for (i = 0; i < size; i++) {
489 return report(options, obj,
490 FSCK_MSG_NUL_IN_HEADER,
491 "unterminated header: NUL at offset %ld", i);
493 if (i + 1 < size && buffer[i + 1] == '\n')
498 return report(options, obj,
499 FSCK_MSG_UNTERMINATED_HEADER, "unterminated header");
502 static int fsck_ident(const char **ident, struct object *obj, struct fsck_options *options)
504 const char *p = *ident;
507 *ident = strchrnul(*ident, '\n');
512 return report(options, obj, FSCK_MSG_MISSING_NAME_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
513 p += strcspn(p, "<>\n");
515 return report(options, obj, FSCK_MSG_BAD_NAME, "invalid author/committer line - bad name");
517 return report(options, obj, FSCK_MSG_MISSING_EMAIL, "invalid author/committer line - missing email");
519 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
521 p += strcspn(p, "<>\n");
523 return report(options, obj, FSCK_MSG_BAD_EMAIL, "invalid author/committer line - bad email");
526 return report(options, obj, FSCK_MSG_MISSING_SPACE_BEFORE_DATE, "invalid author/committer line - missing space before date");
528 if (*p == '0' && p[1] != ' ')
529 return report(options, obj, FSCK_MSG_ZERO_PADDED_DATE, "invalid author/committer line - zero-padded date");
530 if (date_overflows(strtoul(p, &end, 10)))
531 return report(options, obj, FSCK_MSG_BAD_DATE_OVERFLOW, "invalid author/committer line - date causes integer overflow");
532 if ((end == p || *end != ' '))
533 return report(options, obj, FSCK_MSG_BAD_DATE, "invalid author/committer line - bad date");
535 if ((*p != '+' && *p != '-') ||
541 return report(options, obj, FSCK_MSG_BAD_TIMEZONE, "invalid author/committer line - bad time zone");
546 static int fsck_commit_buffer(struct commit *commit, const char *buffer,
547 unsigned long size, struct fsck_options *options)
549 unsigned char tree_sha1[20], sha1[20];
550 struct commit_graft *graft;
551 unsigned parent_count, parent_line_count = 0, author_count;
554 if (require_end_of_header(buffer, size, &commit->object, options))
557 if (!skip_prefix(buffer, "tree ", &buffer))
558 return report(options, &commit->object, FSCK_MSG_MISSING_TREE, "invalid format - expected 'tree' line");
559 if (get_sha1_hex(buffer, tree_sha1) || buffer[40] != '\n') {
560 err = report(options, &commit->object, FSCK_MSG_BAD_TREE_SHA1, "invalid 'tree' line format - bad sha1");
565 while (skip_prefix(buffer, "parent ", &buffer)) {
566 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
567 err = report(options, &commit->object, FSCK_MSG_BAD_PARENT_SHA1, "invalid 'parent' line format - bad sha1");
574 graft = lookup_commit_graft(commit->object.sha1);
575 parent_count = commit_list_count(commit->parents);
577 if (graft->nr_parent == -1 && !parent_count)
578 ; /* shallow commit */
579 else if (graft->nr_parent != parent_count) {
580 err = report(options, &commit->object, FSCK_MSG_MISSING_GRAFT, "graft objects missing");
585 if (parent_count != parent_line_count) {
586 err = report(options, &commit->object, FSCK_MSG_MISSING_PARENT, "parent objects missing");
592 while (skip_prefix(buffer, "author ", &buffer)) {
594 err = fsck_ident(&buffer, &commit->object, options);
598 if (author_count < 1)
599 err = report(options, &commit->object, FSCK_MSG_MISSING_AUTHOR, "invalid format - expected 'author' line");
600 else if (author_count > 1)
601 err = report(options, &commit->object, FSCK_MSG_MULTIPLE_AUTHORS, "invalid format - multiple 'author' lines");
604 if (!skip_prefix(buffer, "committer ", &buffer))
605 return report(options, &commit->object, FSCK_MSG_MISSING_COMMITTER, "invalid format - expected 'committer' line");
606 err = fsck_ident(&buffer, &commit->object, options);
610 return report(options, &commit->object, FSCK_MSG_BAD_TREE, "could not load commit's tree %s", sha1_to_hex(tree_sha1));
615 static int fsck_commit(struct commit *commit, const char *data,
616 unsigned long size, struct fsck_options *options)
618 const char *buffer = data ? data : get_commit_buffer(commit, &size);
619 int ret = fsck_commit_buffer(commit, buffer, size, options);
621 unuse_commit_buffer(commit, buffer);
625 static int fsck_tag_buffer(struct tag *tag, const char *data,
626 unsigned long size, struct fsck_options *options)
628 unsigned char sha1[20];
631 char *to_free = NULL, *eol;
632 struct strbuf sb = STRBUF_INIT;
637 enum object_type type;
640 read_sha1_file(tag->object.sha1, &type, &size);
642 return report(options, &tag->object,
643 FSCK_MSG_MISSING_TAG_OBJECT,
644 "cannot read tag object");
646 if (type != OBJ_TAG) {
647 ret = report(options, &tag->object,
648 FSCK_MSG_TAG_OBJECT_NOT_TAG,
649 "expected tag got %s",
655 if (require_end_of_header(buffer, size, &tag->object, options))
658 if (!skip_prefix(buffer, "object ", &buffer)) {
659 ret = report(options, &tag->object, FSCK_MSG_MISSING_OBJECT, "invalid format - expected 'object' line");
662 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
663 ret = report(options, &tag->object, FSCK_MSG_BAD_OBJECT_SHA1, "invalid 'object' line format - bad sha1");
669 if (!skip_prefix(buffer, "type ", &buffer)) {
670 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE_ENTRY, "invalid format - expected 'type' line");
673 eol = strchr(buffer, '\n');
675 ret = report(options, &tag->object, FSCK_MSG_MISSING_TYPE, "invalid format - unexpected end after 'type' line");
678 if (type_from_string_gently(buffer, eol - buffer, 1) < 0)
679 ret = report(options, &tag->object, FSCK_MSG_BAD_TYPE, "invalid 'type' value");
684 if (!skip_prefix(buffer, "tag ", &buffer)) {
685 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG_ENTRY, "invalid format - expected 'tag' line");
688 eol = strchr(buffer, '\n');
690 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAG, "invalid format - unexpected end after 'type' line");
693 strbuf_addf(&sb, "refs/tags/%.*s", (int)(eol - buffer), buffer);
694 if (check_refname_format(sb.buf, 0)) {
695 ret = report(options, &tag->object, FSCK_MSG_BAD_TAG_NAME,
696 "invalid 'tag' name: %.*s",
697 (int)(eol - buffer), buffer);
703 if (!skip_prefix(buffer, "tagger ", &buffer)) {
704 /* early tags do not contain 'tagger' lines; warn only */
705 ret = report(options, &tag->object, FSCK_MSG_MISSING_TAGGER_ENTRY, "invalid format - expected 'tagger' line");
710 ret = fsck_ident(&buffer, &tag->object, options);
718 static int fsck_tag(struct tag *tag, const char *data,
719 unsigned long size, struct fsck_options *options)
721 struct object *tagged = tag->tagged;
724 return report(options, &tag->object, FSCK_MSG_BAD_TAG_OBJECT, "could not load tagged object");
726 return fsck_tag_buffer(tag, data, size, options);
729 int fsck_object(struct object *obj, void *data, unsigned long size,
730 struct fsck_options *options)
733 return report(options, obj, FSCK_MSG_BAD_OBJECT_SHA1, "no valid object to fsck");
735 if (obj->type == OBJ_BLOB)
737 if (obj->type == OBJ_TREE)
738 return fsck_tree((struct tree *) obj, options);
739 if (obj->type == OBJ_COMMIT)
740 return fsck_commit((struct commit *) obj, (const char *) data,
742 if (obj->type == OBJ_TAG)
743 return fsck_tag((struct tag *) obj, (const char *) data,
746 return report(options, obj, FSCK_MSG_UNKNOWN_TYPE, "unknown type '%d' (internal fsck error)",
750 int fsck_error_function(struct object *obj, int msg_type, const char *message)
752 if (msg_type == FSCK_WARN) {
753 warning("object %s: %s", sha1_to_hex(obj->sha1), message);
756 error("object %s: %s", sha1_to_hex(obj->sha1), message);