builtin / fsck.con commit Merge branch 'rh/ishes-doc' (89dde78)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "commit.h"
   4#include "tree.h"
   5#include "blob.h"
   6#include "tag.h"
   7#include "refs.h"
   8#include "pack.h"
   9#include "cache-tree.h"
  10#include "tree-walk.h"
  11#include "fsck.h"
  12#include "parse-options.h"
  13#include "dir.h"
  14#include "progress.h"
  15#include "streaming.h"
  16
  17#define REACHABLE 0x0001
  18#define SEEN      0x0002
  19#define HAS_OBJ   0x0004
  20
  21static int show_root;
  22static int show_tags;
  23static int show_unreachable;
  24static int include_reflogs = 1;
  25static int check_full = 1;
  26static int check_strict;
  27static int keep_cache_objects;
  28static unsigned char head_sha1[20];
  29static const char *head_points_at;
  30static int errors_found;
  31static int write_lost_and_found;
  32static int verbose;
  33static int show_progress = -1;
  34static int show_dangling = 1;
  35#define ERROR_OBJECT 01
  36#define ERROR_REACHABLE 02
  37#define ERROR_PACK 04
  38
  39#ifdef NO_D_INO_IN_DIRENT
  40#define SORT_DIRENT 0
  41#define DIRENT_SORT_HINT(de) 0
  42#else
  43#define SORT_DIRENT 1
  44#define DIRENT_SORT_HINT(de) ((de)->d_ino)
  45#endif
  46
  47static void objreport(struct object *obj, const char *severity,
  48                      const char *err, va_list params)
  49{
  50        fprintf(stderr, "%s in %s %s: ",
  51                severity, typename(obj->type), sha1_to_hex(obj->sha1));
  52        vfprintf(stderr, err, params);
  53        fputs("\n", stderr);
  54}
  55
  56__attribute__((format (printf, 2, 3)))
  57static int objerror(struct object *obj, const char *err, ...)
  58{
  59        va_list params;
  60        va_start(params, err);
  61        errors_found |= ERROR_OBJECT;
  62        objreport(obj, "error", err, params);
  63        va_end(params);
  64        return -1;
  65}
  66
  67__attribute__((format (printf, 3, 4)))
  68static int fsck_error_func(struct object *obj, int type, const char *err, ...)
  69{
  70        va_list params;
  71        va_start(params, err);
  72        objreport(obj, (type == FSCK_WARN) ? "warning" : "error", err, params);
  73        va_end(params);
  74        return (type == FSCK_WARN) ? 0 : 1;
  75}
  76
  77static struct object_array pending;
  78
  79static int mark_object(struct object *obj, int type, void *data)
  80{
  81        struct object *parent = data;
  82
  83        /*
  84         * The only case data is NULL or type is OBJ_ANY is when
  85         * mark_object_reachable() calls us.  All the callers of
  86         * that function has non-NULL obj hence ...
  87         */
  88        if (!obj) {
  89                /* ... these references to parent->fld are safe here */
  90                printf("broken link from %7s %s\n",
  91                           typename(parent->type), sha1_to_hex(parent->sha1));
  92                printf("broken link from %7s %s\n",
  93                           (type == OBJ_ANY ? "unknown" : typename(type)), "unknown");
  94                errors_found |= ERROR_REACHABLE;
  95                return 1;
  96        }
  97
  98        if (type != OBJ_ANY && obj->type != type)
  99                /* ... and the reference to parent is safe here */
 100                objerror(parent, "wrong object type in link");
 101
 102        if (obj->flags & REACHABLE)
 103                return 0;
 104        obj->flags |= REACHABLE;
 105        if (!(obj->flags & HAS_OBJ)) {
 106                if (parent && !has_sha1_file(obj->sha1)) {
 107                        printf("broken link from %7s %s\n",
 108                                 typename(parent->type), sha1_to_hex(parent->sha1));
 109                        printf("              to %7s %s\n",
 110                                 typename(obj->type), sha1_to_hex(obj->sha1));
 111                        errors_found |= ERROR_REACHABLE;
 112                }
 113                return 1;
 114        }
 115
 116        add_object_array(obj, NULL, &pending);
 117        return 0;
 118}
 119
 120static void mark_object_reachable(struct object *obj)
 121{
 122        mark_object(obj, OBJ_ANY, NULL);
 123}
 124
 125static int traverse_one_object(struct object *obj)
 126{
 127        int result;
 128        struct tree *tree = NULL;
 129
 130        if (obj->type == OBJ_TREE) {
 131                tree = (struct tree *)obj;
 132                if (parse_tree(tree) < 0)
 133                        return 1; /* error already displayed */
 134        }
 135        result = fsck_walk(obj, mark_object, obj);
 136        if (tree)
 137                free_tree_buffer(tree);
 138        return result;
 139}
 140
 141static int traverse_reachable(void)
 142{
 143        struct progress *progress = NULL;
 144        unsigned int nr = 0;
 145        int result = 0;
 146        if (show_progress)
 147                progress = start_progress_delay("Checking connectivity", 0, 0, 2);
 148        while (pending.nr) {
 149                struct object_array_entry *entry;
 150                struct object *obj;
 151
 152                entry = pending.objects + --pending.nr;
 153                obj = entry->item;
 154                result |= traverse_one_object(obj);
 155                display_progress(progress, ++nr);
 156        }
 157        stop_progress(&progress);
 158        return !!result;
 159}
 160
 161static int mark_used(struct object *obj, int type, void *data)
 162{
 163        if (!obj)
 164                return 1;
 165        obj->used = 1;
 166        return 0;
 167}
 168
 169/*
 170 * Check a single reachable object
 171 */
 172static void check_reachable_object(struct object *obj)
 173{
 174        /*
 175         * We obviously want the object to be parsed,
 176         * except if it was in a pack-file and we didn't
 177         * do a full fsck
 178         */
 179        if (!(obj->flags & HAS_OBJ)) {
 180                if (has_sha1_pack(obj->sha1))
 181                        return; /* it is in pack - forget about it */
 182                printf("missing %s %s\n", typename(obj->type), sha1_to_hex(obj->sha1));
 183                errors_found |= ERROR_REACHABLE;
 184                return;
 185        }
 186}
 187
 188/*
 189 * Check a single unreachable object
 190 */
 191static void check_unreachable_object(struct object *obj)
 192{
 193        /*
 194         * Missing unreachable object? Ignore it. It's not like
 195         * we miss it (since it can't be reached), nor do we want
 196         * to complain about it being unreachable (since it does
 197         * not exist).
 198         */
 199        if (!obj->parsed)
 200                return;
 201
 202        /*
 203         * Unreachable object that exists? Show it if asked to,
 204         * since this is something that is prunable.
 205         */
 206        if (show_unreachable) {
 207                printf("unreachable %s %s\n", typename(obj->type), sha1_to_hex(obj->sha1));
 208                return;
 209        }
 210
 211        /*
 212         * "!used" means that nothing at all points to it, including
 213         * other unreachable objects. In other words, it's the "tip"
 214         * of some set of unreachable objects, usually a commit that
 215         * got dropped.
 216         *
 217         * Such starting points are more interesting than some random
 218         * set of unreachable objects, so we show them even if the user
 219         * hasn't asked for _all_ unreachable objects. If you have
 220         * deleted a branch by mistake, this is a prime candidate to
 221         * start looking at, for example.
 222         */
 223        if (!obj->used) {
 224                if (show_dangling)
 225                        printf("dangling %s %s\n", typename(obj->type),
 226                               sha1_to_hex(obj->sha1));
 227                if (write_lost_and_found) {
 228                        char *filename = git_path("lost-found/%s/%s",
 229                                obj->type == OBJ_COMMIT ? "commit" : "other",
 230                                sha1_to_hex(obj->sha1));
 231                        FILE *f;
 232
 233                        if (safe_create_leading_directories(filename)) {
 234                                error("Could not create lost-found");
 235                                return;
 236                        }
 237                        if (!(f = fopen(filename, "w")))
 238                                die_errno("Could not open '%s'", filename);
 239                        if (obj->type == OBJ_BLOB) {
 240                                if (stream_blob_to_fd(fileno(f), obj->sha1, NULL, 1))
 241                                        die_errno("Could not write '%s'", filename);
 242                        } else
 243                                fprintf(f, "%s\n", sha1_to_hex(obj->sha1));
 244                        if (fclose(f))
 245                                die_errno("Could not finish '%s'",
 246                                          filename);
 247                }
 248                return;
 249        }
 250
 251        /*
 252         * Otherwise? It's there, it's unreachable, and some other unreachable
 253         * object points to it. Ignore it - it's not interesting, and we showed
 254         * all the interesting cases above.
 255         */
 256}
 257
 258static void check_object(struct object *obj)
 259{
 260        if (verbose)
 261                fprintf(stderr, "Checking %s\n", sha1_to_hex(obj->sha1));
 262
 263        if (obj->flags & REACHABLE)
 264                check_reachable_object(obj);
 265        else
 266                check_unreachable_object(obj);
 267}
 268
 269static void check_connectivity(void)
 270{
 271        int i, max;
 272
 273        /* Traverse the pending reachable objects */
 274        traverse_reachable();
 275
 276        /* Look up all the requirements, warn about missing objects.. */
 277        max = get_max_object_index();
 278        if (verbose)
 279                fprintf(stderr, "Checking connectivity (%d objects)\n", max);
 280
 281        for (i = 0; i < max; i++) {
 282                struct object *obj = get_indexed_object(i);
 283
 284                if (obj)
 285                        check_object(obj);
 286        }
 287}
 288
 289static int fsck_obj(struct object *obj)
 290{
 291        if (obj->flags & SEEN)
 292                return 0;
 293        obj->flags |= SEEN;
 294
 295        if (verbose)
 296                fprintf(stderr, "Checking %s %s\n",
 297                        typename(obj->type), sha1_to_hex(obj->sha1));
 298
 299        if (fsck_walk(obj, mark_used, NULL))
 300                objerror(obj, "broken links");
 301        if (fsck_object(obj, check_strict, fsck_error_func))
 302                return -1;
 303
 304        if (obj->type == OBJ_TREE) {
 305                struct tree *item = (struct tree *) obj;
 306
 307                free_tree_buffer(item);
 308        }
 309
 310        if (obj->type == OBJ_COMMIT) {
 311                struct commit *commit = (struct commit *) obj;
 312
 313                free(commit->buffer);
 314                commit->buffer = NULL;
 315
 316                if (!commit->parents && show_root)
 317                        printf("root %s\n", sha1_to_hex(commit->object.sha1));
 318        }
 319
 320        if (obj->type == OBJ_TAG) {
 321                struct tag *tag = (struct tag *) obj;
 322
 323                if (show_tags && tag->tagged) {
 324                        printf("tagged %s %s", typename(tag->tagged->type), sha1_to_hex(tag->tagged->sha1));
 325                        printf(" (%s) in %s\n", tag->tag, sha1_to_hex(tag->object.sha1));
 326                }
 327        }
 328
 329        return 0;
 330}
 331
 332static int fsck_sha1(const unsigned char *sha1)
 333{
 334        struct object *obj = parse_object(sha1);
 335        if (!obj) {
 336                errors_found |= ERROR_OBJECT;
 337                return error("%s: object corrupt or missing",
 338                             sha1_to_hex(sha1));
 339        }
 340        obj->flags |= HAS_OBJ;
 341        return fsck_obj(obj);
 342}
 343
 344static int fsck_obj_buffer(const unsigned char *sha1, enum object_type type,
 345                           unsigned long size, void *buffer, int *eaten)
 346{
 347        struct object *obj;
 348        obj = parse_object_buffer(sha1, type, size, buffer, eaten);
 349        if (!obj) {
 350                errors_found |= ERROR_OBJECT;
 351                return error("%s: object corrupt or missing", sha1_to_hex(sha1));
 352        }
 353        obj->flags = HAS_OBJ;
 354        return fsck_obj(obj);
 355}
 356
 357/*
 358 * This is the sorting chunk size: make it reasonably
 359 * big so that we can sort well..
 360 */
 361#define MAX_SHA1_ENTRIES (1024)
 362
 363struct sha1_entry {
 364        unsigned long ino;
 365        unsigned char sha1[20];
 366};
 367
 368static struct {
 369        unsigned long nr;
 370        struct sha1_entry *entry[MAX_SHA1_ENTRIES];
 371} sha1_list;
 372
 373static int ino_compare(const void *_a, const void *_b)
 374{
 375        const struct sha1_entry *a = _a, *b = _b;
 376        unsigned long ino1 = a->ino, ino2 = b->ino;
 377        return ino1 < ino2 ? -1 : ino1 > ino2 ? 1 : 0;
 378}
 379
 380static void fsck_sha1_list(void)
 381{
 382        int i, nr = sha1_list.nr;
 383
 384        if (SORT_DIRENT)
 385                qsort(sha1_list.entry, nr,
 386                      sizeof(struct sha1_entry *), ino_compare);
 387        for (i = 0; i < nr; i++) {
 388                struct sha1_entry *entry = sha1_list.entry[i];
 389                unsigned char *sha1 = entry->sha1;
 390
 391                sha1_list.entry[i] = NULL;
 392                fsck_sha1(sha1);
 393                free(entry);
 394        }
 395        sha1_list.nr = 0;
 396}
 397
 398static void add_sha1_list(unsigned char *sha1, unsigned long ino)
 399{
 400        struct sha1_entry *entry = xmalloc(sizeof(*entry));
 401        int nr;
 402
 403        entry->ino = ino;
 404        hashcpy(entry->sha1, sha1);
 405        nr = sha1_list.nr;
 406        if (nr == MAX_SHA1_ENTRIES) {
 407                fsck_sha1_list();
 408                nr = 0;
 409        }
 410        sha1_list.entry[nr] = entry;
 411        sha1_list.nr = ++nr;
 412}
 413
 414static inline int is_loose_object_file(struct dirent *de,
 415                                       char *name, unsigned char *sha1)
 416{
 417        if (strlen(de->d_name) != 38)
 418                return 0;
 419        memcpy(name + 2, de->d_name, 39);
 420        return !get_sha1_hex(name, sha1);
 421}
 422
 423static void fsck_dir(int i, char *path)
 424{
 425        DIR *dir = opendir(path);
 426        struct dirent *de;
 427        char name[100];
 428
 429        if (!dir)
 430                return;
 431
 432        if (verbose)
 433                fprintf(stderr, "Checking directory %s\n", path);
 434
 435        sprintf(name, "%02x", i);
 436        while ((de = readdir(dir)) != NULL) {
 437                unsigned char sha1[20];
 438
 439                if (is_dot_or_dotdot(de->d_name))
 440                        continue;
 441                if (is_loose_object_file(de, name, sha1)) {
 442                        add_sha1_list(sha1, DIRENT_SORT_HINT(de));
 443                        continue;
 444                }
 445                if (!prefixcmp(de->d_name, "tmp_obj_"))
 446                        continue;
 447                fprintf(stderr, "bad sha1 file: %s/%s\n", path, de->d_name);
 448        }
 449        closedir(dir);
 450}
 451
 452static int default_refs;
 453
 454static int fsck_handle_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
 455                const char *email, unsigned long timestamp, int tz,
 456                const char *message, void *cb_data)
 457{
 458        struct object *obj;
 459
 460        if (verbose)
 461                fprintf(stderr, "Checking reflog %s->%s\n",
 462                        sha1_to_hex(osha1), sha1_to_hex(nsha1));
 463
 464        if (!is_null_sha1(osha1)) {
 465                obj = lookup_object(osha1);
 466                if (obj) {
 467                        obj->used = 1;
 468                        mark_object_reachable(obj);
 469                }
 470        }
 471        obj = lookup_object(nsha1);
 472        if (obj) {
 473                obj->used = 1;
 474                mark_object_reachable(obj);
 475        }
 476        return 0;
 477}
 478
 479static int fsck_handle_reflog(const char *logname, const unsigned char *sha1, int flag, void *cb_data)
 480{
 481        for_each_reflog_ent(logname, fsck_handle_reflog_ent, NULL);
 482        return 0;
 483}
 484
 485static int is_branch(const char *refname)
 486{
 487        return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
 488}
 489
 490static int fsck_handle_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
 491{
 492        struct object *obj;
 493
 494        obj = parse_object(sha1);
 495        if (!obj) {
 496                error("%s: invalid sha1 pointer %s", refname, sha1_to_hex(sha1));
 497                /* We'll continue with the rest despite the error.. */
 498                return 0;
 499        }
 500        if (obj->type != OBJ_COMMIT && is_branch(refname))
 501                error("%s: not a commit", refname);
 502        default_refs++;
 503        obj->used = 1;
 504        mark_object_reachable(obj);
 505
 506        return 0;
 507}
 508
 509static void get_default_heads(void)
 510{
 511        if (head_points_at && !is_null_sha1(head_sha1))
 512                fsck_handle_ref("HEAD", head_sha1, 0, NULL);
 513        for_each_ref(fsck_handle_ref, NULL);
 514        if (include_reflogs)
 515                for_each_reflog(fsck_handle_reflog, NULL);
 516
 517        /*
 518         * Not having any default heads isn't really fatal, but
 519         * it does mean that "--unreachable" no longer makes any
 520         * sense (since in this case everything will obviously
 521         * be unreachable by definition.
 522         *
 523         * Showing dangling objects is valid, though (as those
 524         * dangling objects are likely lost heads).
 525         *
 526         * So we just print a warning about it, and clear the
 527         * "show_unreachable" flag.
 528         */
 529        if (!default_refs) {
 530                fprintf(stderr, "notice: No default references\n");
 531                show_unreachable = 0;
 532        }
 533}
 534
 535static void fsck_object_dir(const char *path)
 536{
 537        int i;
 538        struct progress *progress = NULL;
 539
 540        if (verbose)
 541                fprintf(stderr, "Checking object directory\n");
 542
 543        if (show_progress)
 544                progress = start_progress("Checking object directories", 256);
 545        for (i = 0; i < 256; i++) {
 546                static char dir[4096];
 547                sprintf(dir, "%s/%02x", path, i);
 548                fsck_dir(i, dir);
 549                display_progress(progress, i+1);
 550        }
 551        stop_progress(&progress);
 552        fsck_sha1_list();
 553}
 554
 555static int fsck_head_link(void)
 556{
 557        int flag;
 558        int null_is_error = 0;
 559
 560        if (verbose)
 561                fprintf(stderr, "Checking HEAD link\n");
 562
 563        head_points_at = resolve_ref_unsafe("HEAD", head_sha1, 0, &flag);
 564        if (!head_points_at)
 565                return error("Invalid HEAD");
 566        if (!strcmp(head_points_at, "HEAD"))
 567                /* detached HEAD */
 568                null_is_error = 1;
 569        else if (prefixcmp(head_points_at, "refs/heads/"))
 570                return error("HEAD points to something strange (%s)",
 571                             head_points_at);
 572        if (is_null_sha1(head_sha1)) {
 573                if (null_is_error)
 574                        return error("HEAD: detached HEAD points at nothing");
 575                fprintf(stderr, "notice: HEAD points to an unborn branch (%s)\n",
 576                        head_points_at + 11);
 577        }
 578        return 0;
 579}
 580
 581static int fsck_cache_tree(struct cache_tree *it)
 582{
 583        int i;
 584        int err = 0;
 585
 586        if (verbose)
 587                fprintf(stderr, "Checking cache tree\n");
 588
 589        if (0 <= it->entry_count) {
 590                struct object *obj = parse_object(it->sha1);
 591                if (!obj) {
 592                        error("%s: invalid sha1 pointer in cache-tree",
 593                              sha1_to_hex(it->sha1));
 594                        return 1;
 595                }
 596                obj->used = 1;
 597                mark_object_reachable(obj);
 598                if (obj->type != OBJ_TREE)
 599                        err |= objerror(obj, "non-tree in cache-tree");
 600        }
 601        for (i = 0; i < it->subtree_nr; i++)
 602                err |= fsck_cache_tree(it->down[i]->cache_tree);
 603        return err;
 604}
 605
 606static char const * const fsck_usage[] = {
 607        N_("git fsck [options] [<object>...]"),
 608        NULL
 609};
 610
 611static struct option fsck_opts[] = {
 612        OPT__VERBOSE(&verbose, N_("be verbose")),
 613        OPT_BOOL(0, "unreachable", &show_unreachable, N_("show unreachable objects")),
 614        OPT_BOOL(0, "dangling", &show_dangling, N_("show dangling objects")),
 615        OPT_BOOL(0, "tags", &show_tags, N_("report tags")),
 616        OPT_BOOL(0, "root", &show_root, N_("report root nodes")),
 617        OPT_BOOL(0, "cache", &keep_cache_objects, N_("make index objects head nodes")),
 618        OPT_BOOL(0, "reflogs", &include_reflogs, N_("make reflogs head nodes (default)")),
 619        OPT_BOOL(0, "full", &check_full, N_("also consider packs and alternate objects")),
 620        OPT_BOOL(0, "strict", &check_strict, N_("enable more strict checking")),
 621        OPT_BOOL(0, "lost-found", &write_lost_and_found,
 622                                N_("write dangling objects in .git/lost-found")),
 623        OPT_BOOL(0, "progress", &show_progress, N_("show progress")),
 624        OPT_END(),
 625};
 626
 627int cmd_fsck(int argc, const char **argv, const char *prefix)
 628{
 629        int i, heads;
 630        struct alternate_object_database *alt;
 631
 632        errors_found = 0;
 633        read_replace_refs = 0;
 634
 635        argc = parse_options(argc, argv, prefix, fsck_opts, fsck_usage, 0);
 636
 637        if (show_progress == -1)
 638                show_progress = isatty(2);
 639        if (verbose)
 640                show_progress = 0;
 641
 642        if (write_lost_and_found) {
 643                check_full = 1;
 644                include_reflogs = 0;
 645        }
 646
 647        fsck_head_link();
 648        fsck_object_dir(get_object_directory());
 649
 650        prepare_alt_odb();
 651        for (alt = alt_odb_list; alt; alt = alt->next) {
 652                char namebuf[PATH_MAX];
 653                int namelen = alt->name - alt->base;
 654                memcpy(namebuf, alt->base, namelen);
 655                namebuf[namelen - 1] = 0;
 656                fsck_object_dir(namebuf);
 657        }
 658
 659        if (check_full) {
 660                struct packed_git *p;
 661                uint32_t total = 0, count = 0;
 662                struct progress *progress = NULL;
 663
 664                prepare_packed_git();
 665
 666                if (show_progress) {
 667                        for (p = packed_git; p; p = p->next) {
 668                                if (open_pack_index(p))
 669                                        continue;
 670                                total += p->num_objects;
 671                        }
 672
 673                        progress = start_progress("Checking objects", total);
 674                }
 675                for (p = packed_git; p; p = p->next) {
 676                        /* verify gives error messages itself */
 677                        if (verify_pack(p, fsck_obj_buffer,
 678                                        progress, count))
 679                                errors_found |= ERROR_PACK;
 680                        count += p->num_objects;
 681                }
 682                stop_progress(&progress);
 683        }
 684
 685        heads = 0;
 686        for (i = 0; i < argc; i++) {
 687                const char *arg = argv[i];
 688                unsigned char sha1[20];
 689                if (!get_sha1(arg, sha1)) {
 690                        struct object *obj = lookup_object(sha1);
 691
 692                        /* Error is printed by lookup_object(). */
 693                        if (!obj)
 694                                continue;
 695
 696                        obj->used = 1;
 697                        mark_object_reachable(obj);
 698                        heads++;
 699                        continue;
 700                }
 701                error("invalid parameter: expected sha1, got '%s'", arg);
 702        }
 703
 704        /*
 705         * If we've not been given any explicit head information, do the
 706         * default ones from .git/refs. We also consider the index file
 707         * in this case (ie this implies --cache).
 708         */
 709        if (!heads) {
 710                get_default_heads();
 711                keep_cache_objects = 1;
 712        }
 713
 714        if (keep_cache_objects) {
 715                read_cache();
 716                for (i = 0; i < active_nr; i++) {
 717                        unsigned int mode;
 718                        struct blob *blob;
 719                        struct object *obj;
 720
 721                        mode = active_cache[i]->ce_mode;
 722                        if (S_ISGITLINK(mode))
 723                                continue;
 724                        blob = lookup_blob(active_cache[i]->sha1);
 725                        if (!blob)
 726                                continue;
 727                        obj = &blob->object;
 728                        obj->used = 1;
 729                        mark_object_reachable(obj);
 730                }
 731                if (active_cache_tree)
 732                        fsck_cache_tree(active_cache_tree);
 733        }
 734
 735        check_connectivity();
 736        return errors_found;
 737}