9 #include "cache-tree.h"
10 #include "tree-walk.h"
12 #include "parse-options.h"
15 #include "streaming.h"
17 #define REACHABLE 0x0001
19 #define HAS_OBJ 0x0004
23 static int show_unreachable
;
24 static int include_reflogs
= 1;
25 static int check_full
= 1;
26 static int connectivity_only
;
27 static int check_strict
;
28 static int keep_cache_objects
;
29 static struct fsck_options fsck_walk_options
= FSCK_OPTIONS_DEFAULT
;
30 static struct fsck_options fsck_obj_options
= FSCK_OPTIONS_DEFAULT
;
31 static struct object_id head_oid
;
32 static const char *head_points_at
;
33 static int errors_found
;
34 static int write_lost_and_found
;
36 static int show_progress
= -1;
37 static int show_dangling
= 1;
38 #define ERROR_OBJECT 01
39 #define ERROR_REACHABLE 02
42 static int fsck_config(const char *var
, const char *value
, void *cb
)
44 if (strcmp(var
, "fsck.skiplist") == 0) {
46 struct strbuf sb
= STRBUF_INIT
;
48 if (git_config_pathname(&path
, var
, value
))
50 strbuf_addf(&sb
, "skiplist=%s", path
);
52 fsck_set_msg_types(&fsck_obj_options
, sb
.buf
);
57 if (skip_prefix(var
, "fsck.", &var
)) {
58 fsck_set_msg_type(&fsck_obj_options
, var
, value
);
62 return git_default_config(var
, value
, cb
);
65 static void objreport(struct object
*obj
, const char *msg_type
,
68 fprintf(stderr
, "%s in %s %s: %s\n",
69 msg_type
, typename(obj
->type
), sha1_to_hex(obj
->sha1
), err
);
72 static int objerror(struct object
*obj
, const char *err
)
74 errors_found
|= ERROR_OBJECT
;
75 objreport(obj
, "error", err
);
79 static int fsck_error_func(struct object
*obj
, int type
, const char *message
)
81 objreport(obj
, (type
== FSCK_WARN
) ? "warning" : "error", message
);
82 return (type
== FSCK_WARN
) ? 0 : 1;
85 static struct object_array pending
;
87 static int mark_object(struct object
*obj
, int type
, void *data
, struct fsck_options
*options
)
89 struct object
*parent
= data
;
92 * The only case data is NULL or type is OBJ_ANY is when
93 * mark_object_reachable() calls us. All the callers of
94 * that function has non-NULL obj hence ...
97 /* ... these references to parent->fld are safe here */
98 printf("broken link from %7s %s\n",
99 typename(parent
->type
), sha1_to_hex(parent
->sha1
));
100 printf("broken link from %7s %s\n",
101 (type
== OBJ_ANY
? "unknown" : typename(type
)), "unknown");
102 errors_found
|= ERROR_REACHABLE
;
106 if (type
!= OBJ_ANY
&& obj
->type
!= type
)
107 /* ... and the reference to parent is safe here */
108 objerror(parent
, "wrong object type in link");
110 if (obj
->flags
& REACHABLE
)
112 obj
->flags
|= REACHABLE
;
113 if (!(obj
->flags
& HAS_OBJ
)) {
114 if (parent
&& !has_sha1_file(obj
->sha1
)) {
115 printf("broken link from %7s %s\n",
116 typename(parent
->type
), sha1_to_hex(parent
->sha1
));
117 printf(" to %7s %s\n",
118 typename(obj
->type
), sha1_to_hex(obj
->sha1
));
119 errors_found
|= ERROR_REACHABLE
;
124 add_object_array(obj
, NULL
, &pending
);
128 static void mark_object_reachable(struct object
*obj
)
130 mark_object(obj
, OBJ_ANY
, NULL
, NULL
);
133 static int traverse_one_object(struct object
*obj
)
136 struct tree
*tree
= NULL
;
138 if (obj
->type
== OBJ_TREE
) {
139 tree
= (struct tree
*)obj
;
140 if (parse_tree(tree
) < 0)
141 return 1; /* error already displayed */
143 result
= fsck_walk(obj
, obj
, &fsck_walk_options
);
145 free_tree_buffer(tree
);
149 static int traverse_reachable(void)
151 struct progress
*progress
= NULL
;
155 progress
= start_progress_delay(_("Checking connectivity"), 0, 0, 2);
157 struct object_array_entry
*entry
;
160 entry
= pending
.objects
+ --pending
.nr
;
162 result
|= traverse_one_object(obj
);
163 display_progress(progress
, ++nr
);
165 stop_progress(&progress
);
169 static int mark_used(struct object
*obj
, int type
, void *data
, struct fsck_options
*options
)
178 * Check a single reachable object
180 static void check_reachable_object(struct object
*obj
)
183 * We obviously want the object to be parsed,
184 * except if it was in a pack-file and we didn't
187 if (!(obj
->flags
& HAS_OBJ
)) {
188 if (has_sha1_pack(obj
->sha1
))
189 return; /* it is in pack - forget about it */
190 if (connectivity_only
&& has_sha1_file(obj
->sha1
))
192 printf("missing %s %s\n", typename(obj
->type
), sha1_to_hex(obj
->sha1
));
193 errors_found
|= ERROR_REACHABLE
;
199 * Check a single unreachable object
201 static void check_unreachable_object(struct object
*obj
)
204 * Missing unreachable object? Ignore it. It's not like
205 * we miss it (since it can't be reached), nor do we want
206 * to complain about it being unreachable (since it does
213 * Unreachable object that exists? Show it if asked to,
214 * since this is something that is prunable.
216 if (show_unreachable
) {
217 printf("unreachable %s %s\n", typename(obj
->type
), sha1_to_hex(obj
->sha1
));
222 * "!used" means that nothing at all points to it, including
223 * other unreachable objects. In other words, it's the "tip"
224 * of some set of unreachable objects, usually a commit that
227 * Such starting points are more interesting than some random
228 * set of unreachable objects, so we show them even if the user
229 * hasn't asked for _all_ unreachable objects. If you have
230 * deleted a branch by mistake, this is a prime candidate to
231 * start looking at, for example.
235 printf("dangling %s %s\n", typename(obj
->type
),
236 sha1_to_hex(obj
->sha1
));
237 if (write_lost_and_found
) {
238 char *filename
= git_pathdup("lost-found/%s/%s",
239 obj
->type
== OBJ_COMMIT
? "commit" : "other",
240 sha1_to_hex(obj
->sha1
));
243 if (safe_create_leading_directories_const(filename
)) {
244 error("Could not create lost-found");
248 if (!(f
= fopen(filename
, "w")))
249 die_errno("Could not open '%s'", filename
);
250 if (obj
->type
== OBJ_BLOB
) {
251 if (stream_blob_to_fd(fileno(f
), obj
->sha1
, NULL
, 1))
252 die_errno("Could not write '%s'", filename
);
254 fprintf(f
, "%s\n", sha1_to_hex(obj
->sha1
));
256 die_errno("Could not finish '%s'",
264 * Otherwise? It's there, it's unreachable, and some other unreachable
265 * object points to it. Ignore it - it's not interesting, and we showed
266 * all the interesting cases above.
270 static void check_object(struct object
*obj
)
273 fprintf(stderr
, "Checking %s\n", sha1_to_hex(obj
->sha1
));
275 if (obj
->flags
& REACHABLE
)
276 check_reachable_object(obj
);
278 check_unreachable_object(obj
);
281 static void check_connectivity(void)
285 /* Traverse the pending reachable objects */
286 traverse_reachable();
288 /* Look up all the requirements, warn about missing objects.. */
289 max
= get_max_object_index();
291 fprintf(stderr
, "Checking connectivity (%d objects)\n", max
);
293 for (i
= 0; i
< max
; i
++) {
294 struct object
*obj
= get_indexed_object(i
);
301 static int fsck_obj(struct object
*obj
)
303 if (obj
->flags
& SEEN
)
308 fprintf(stderr
, "Checking %s %s\n",
309 typename(obj
->type
), sha1_to_hex(obj
->sha1
));
311 if (fsck_walk(obj
, NULL
, &fsck_obj_options
))
312 objerror(obj
, "broken links");
313 if (fsck_object(obj
, NULL
, 0, &fsck_obj_options
))
316 if (obj
->type
== OBJ_TREE
) {
317 struct tree
*item
= (struct tree
*) obj
;
319 free_tree_buffer(item
);
322 if (obj
->type
== OBJ_COMMIT
) {
323 struct commit
*commit
= (struct commit
*) obj
;
325 free_commit_buffer(commit
);
327 if (!commit
->parents
&& show_root
)
328 printf("root %s\n", sha1_to_hex(commit
->object
.sha1
));
331 if (obj
->type
== OBJ_TAG
) {
332 struct tag
*tag
= (struct tag
*) obj
;
334 if (show_tags
&& tag
->tagged
) {
335 printf("tagged %s %s", typename(tag
->tagged
->type
), sha1_to_hex(tag
->tagged
->sha1
));
336 printf(" (%s) in %s\n", tag
->tag
, sha1_to_hex(tag
->object
.sha1
));
343 static int fsck_sha1(const unsigned char *sha1
)
345 struct object
*obj
= parse_object(sha1
);
347 errors_found
|= ERROR_OBJECT
;
348 return error("%s: object corrupt or missing",
351 obj
->flags
|= HAS_OBJ
;
352 return fsck_obj(obj
);
355 static int fsck_obj_buffer(const unsigned char *sha1
, enum object_type type
,
356 unsigned long size
, void *buffer
, int *eaten
)
359 obj
= parse_object_buffer(sha1
, type
, size
, buffer
, eaten
);
361 errors_found
|= ERROR_OBJECT
;
362 return error("%s: object corrupt or missing", sha1_to_hex(sha1
));
364 obj
->flags
= HAS_OBJ
;
365 return fsck_obj(obj
);
368 static inline int is_loose_object_file(struct dirent
*de
,
369 char *name
, unsigned char *sha1
)
371 if (strlen(de
->d_name
) != 38)
373 memcpy(name
+ 2, de
->d_name
, 39);
374 return !get_sha1_hex(name
, sha1
);
377 static void fsck_dir(int i
, char *path
)
379 DIR *dir
= opendir(path
);
387 fprintf(stderr
, "Checking directory %s\n", path
);
389 sprintf(name
, "%02x", i
);
390 while ((de
= readdir(dir
)) != NULL
) {
391 unsigned char sha1
[20];
393 if (is_dot_or_dotdot(de
->d_name
))
395 if (is_loose_object_file(de
, name
, sha1
)) {
397 errors_found
|= ERROR_OBJECT
;
400 if (starts_with(de
->d_name
, "tmp_obj_"))
402 fprintf(stderr
, "bad sha1 file: %s/%s\n", path
, de
->d_name
);
407 static int default_refs
;
409 static void fsck_handle_reflog_sha1(const char *refname
, unsigned char *sha1
)
413 if (!is_null_sha1(sha1
)) {
414 obj
= lookup_object(sha1
);
417 mark_object_reachable(obj
);
419 error("%s: invalid reflog entry %s", refname
, sha1_to_hex(sha1
));
420 errors_found
|= ERROR_REACHABLE
;
425 static int fsck_handle_reflog_ent(unsigned char *osha1
, unsigned char *nsha1
,
426 const char *email
, unsigned long timestamp
, int tz
,
427 const char *message
, void *cb_data
)
429 const char *refname
= cb_data
;
432 fprintf(stderr
, "Checking reflog %s->%s\n",
433 sha1_to_hex(osha1
), sha1_to_hex(nsha1
));
435 fsck_handle_reflog_sha1(refname
, osha1
);
436 fsck_handle_reflog_sha1(refname
, nsha1
);
440 static int fsck_handle_reflog(const char *logname
, const struct object_id
*oid
,
441 int flag
, void *cb_data
)
443 for_each_reflog_ent(logname
, fsck_handle_reflog_ent
, (void *)logname
);
447 static int fsck_handle_ref(const char *refname
, const struct object_id
*oid
,
448 int flag
, void *cb_data
)
452 obj
= parse_object(oid
->hash
);
454 error("%s: invalid sha1 pointer %s", refname
, oid_to_hex(oid
));
455 errors_found
|= ERROR_REACHABLE
;
456 /* We'll continue with the rest despite the error.. */
459 if (obj
->type
!= OBJ_COMMIT
&& is_branch(refname
))
460 error("%s: not a commit", refname
);
463 mark_object_reachable(obj
);
468 static void get_default_heads(void)
470 if (head_points_at
&& !is_null_oid(&head_oid
))
471 fsck_handle_ref("HEAD", &head_oid
, 0, NULL
);
472 for_each_rawref(fsck_handle_ref
, NULL
);
474 for_each_reflog(fsck_handle_reflog
, NULL
);
477 * Not having any default heads isn't really fatal, but
478 * it does mean that "--unreachable" no longer makes any
479 * sense (since in this case everything will obviously
480 * be unreachable by definition.
482 * Showing dangling objects is valid, though (as those
483 * dangling objects are likely lost heads).
485 * So we just print a warning about it, and clear the
486 * "show_unreachable" flag.
489 fprintf(stderr
, "notice: No default references\n");
490 show_unreachable
= 0;
494 static void fsck_object_dir(const char *path
)
497 struct progress
*progress
= NULL
;
500 fprintf(stderr
, "Checking object directory\n");
503 progress
= start_progress(_("Checking object directories"), 256);
504 for (i
= 0; i
< 256; i
++) {
505 static char dir
[4096];
506 sprintf(dir
, "%s/%02x", path
, i
);
508 display_progress(progress
, i
+1);
510 stop_progress(&progress
);
513 static int fsck_head_link(void)
516 int null_is_error
= 0;
519 fprintf(stderr
, "Checking HEAD link\n");
521 head_points_at
= resolve_ref_unsafe("HEAD", 0, head_oid
.hash
, &flag
);
523 return error("Invalid HEAD");
524 if (!strcmp(head_points_at
, "HEAD"))
527 else if (!starts_with(head_points_at
, "refs/heads/"))
528 return error("HEAD points to something strange (%s)",
530 if (is_null_oid(&head_oid
)) {
532 return error("HEAD: detached HEAD points at nothing");
533 fprintf(stderr
, "notice: HEAD points to an unborn branch (%s)\n",
534 head_points_at
+ 11);
539 static int fsck_cache_tree(struct cache_tree
*it
)
545 fprintf(stderr
, "Checking cache tree\n");
547 if (0 <= it
->entry_count
) {
548 struct object
*obj
= parse_object(it
->sha1
);
550 error("%s: invalid sha1 pointer in cache-tree",
551 sha1_to_hex(it
->sha1
));
555 mark_object_reachable(obj
);
556 if (obj
->type
!= OBJ_TREE
)
557 err
|= objerror(obj
, "non-tree in cache-tree");
559 for (i
= 0; i
< it
->subtree_nr
; i
++)
560 err
|= fsck_cache_tree(it
->down
[i
]->cache_tree
);
564 static char const * const fsck_usage
[] = {
565 N_("git fsck [<options>] [<object>...]"),
569 static struct option fsck_opts
[] = {
570 OPT__VERBOSE(&verbose
, N_("be verbose")),
571 OPT_BOOL(0, "unreachable", &show_unreachable
, N_("show unreachable objects")),
572 OPT_BOOL(0, "dangling", &show_dangling
, N_("show dangling objects")),
573 OPT_BOOL(0, "tags", &show_tags
, N_("report tags")),
574 OPT_BOOL(0, "root", &show_root
, N_("report root nodes")),
575 OPT_BOOL(0, "cache", &keep_cache_objects
, N_("make index objects head nodes")),
576 OPT_BOOL(0, "reflogs", &include_reflogs
, N_("make reflogs head nodes (default)")),
577 OPT_BOOL(0, "full", &check_full
, N_("also consider packs and alternate objects")),
578 OPT_BOOL(0, "connectivity-only", &connectivity_only
, N_("check only connectivity")),
579 OPT_BOOL(0, "strict", &check_strict
, N_("enable more strict checking")),
580 OPT_BOOL(0, "lost-found", &write_lost_and_found
,
581 N_("write dangling objects in .git/lost-found")),
582 OPT_BOOL(0, "progress", &show_progress
, N_("show progress")),
586 int cmd_fsck(int argc
, const char **argv
, const char *prefix
)
589 struct alternate_object_database
*alt
;
592 check_replace_refs
= 0;
594 argc
= parse_options(argc
, argv
, prefix
, fsck_opts
, fsck_usage
, 0);
596 fsck_walk_options
.walk
= mark_object
;
597 fsck_obj_options
.walk
= mark_used
;
598 fsck_obj_options
.error_func
= fsck_error_func
;
600 fsck_obj_options
.strict
= 1;
602 if (show_progress
== -1)
603 show_progress
= isatty(2);
607 if (write_lost_and_found
) {
612 git_config(fsck_config
, NULL
);
615 if (!connectivity_only
) {
616 fsck_object_dir(get_object_directory());
619 for (alt
= alt_odb_list
; alt
; alt
= alt
->next
) {
620 /* directory name, minus trailing slash */
621 size_t namelen
= alt
->name
- alt
->base
- 1;
622 struct strbuf name
= STRBUF_INIT
;
623 strbuf_add(&name
, alt
->base
, namelen
);
624 fsck_object_dir(name
.buf
);
625 strbuf_release(&name
);
630 struct packed_git
*p
;
631 uint32_t total
= 0, count
= 0;
632 struct progress
*progress
= NULL
;
634 prepare_packed_git();
637 for (p
= packed_git
; p
; p
= p
->next
) {
638 if (open_pack_index(p
))
640 total
+= p
->num_objects
;
643 progress
= start_progress(_("Checking objects"), total
);
645 for (p
= packed_git
; p
; p
= p
->next
) {
646 /* verify gives error messages itself */
647 if (verify_pack(p
, fsck_obj_buffer
,
649 errors_found
|= ERROR_PACK
;
650 count
+= p
->num_objects
;
652 stop_progress(&progress
);
656 for (i
= 0; i
< argc
; i
++) {
657 const char *arg
= argv
[i
];
658 unsigned char sha1
[20];
659 if (!get_sha1(arg
, sha1
)) {
660 struct object
*obj
= lookup_object(sha1
);
662 /* Error is printed by lookup_object(). */
667 mark_object_reachable(obj
);
671 error("invalid parameter: expected sha1, got '%s'", arg
);
675 * If we've not been given any explicit head information, do the
676 * default ones from .git/refs. We also consider the index file
677 * in this case (ie this implies --cache).
681 keep_cache_objects
= 1;
684 if (keep_cache_objects
) {
686 for (i
= 0; i
< active_nr
; i
++) {
691 mode
= active_cache
[i
]->ce_mode
;
692 if (S_ISGITLINK(mode
))
694 blob
= lookup_blob(active_cache
[i
]->sha1
);
699 mark_object_reachable(obj
);
701 if (active_cache_tree
)
702 fsck_cache_tree(active_cache_tree
);
705 check_connectivity();