builtin / grep.con commit Merge branch 'kc/gitweb-pathinfo-w-anchor' (cd3065f)
   1/*
   2 * Builtin "git grep"
   3 *
   4 * Copyright (c) 2006 Junio C Hamano
   5 */
   6#include "cache.h"
   7#include "blob.h"
   8#include "tree.h"
   9#include "commit.h"
  10#include "tag.h"
  11#include "tree-walk.h"
  12#include "builtin.h"
  13#include "parse-options.h"
  14#include "string-list.h"
  15#include "run-command.h"
  16#include "userdiff.h"
  17#include "grep.h"
  18#include "quote.h"
  19#include "dir.h"
  20#include "thread-utils.h"
  21
  22static char const * const grep_usage[] = {
  23        "git grep [options] [-e] <pattern> [<rev>...] [[--] <path>...]",
  24        NULL
  25};
  26
  27static int use_threads = 1;
  28
  29#ifndef NO_PTHREADS
  30#define THREADS 8
  31static pthread_t threads[THREADS];
  32
  33static void *load_sha1(const unsigned char *sha1, unsigned long *size,
  34                       const char *name);
  35static void *load_file(const char *filename, size_t *sz);
  36
  37enum work_type {WORK_SHA1, WORK_FILE};
  38
  39/* We use one producer thread and THREADS consumer
  40 * threads. The producer adds struct work_items to 'todo' and the
  41 * consumers pick work items from the same array.
  42 */
  43struct work_item {
  44        enum work_type type;
  45        char *name;
  46
  47        /* if type == WORK_SHA1, then 'identifier' is a SHA1,
  48         * otherwise type == WORK_FILE, and 'identifier' is a NUL
  49         * terminated filename.
  50         */
  51        void *identifier;
  52        char done;
  53        struct strbuf out;
  54};
  55
  56/* In the range [todo_done, todo_start) in 'todo' we have work_items
  57 * that have been or are processed by a consumer thread. We haven't
  58 * written the result for these to stdout yet.
  59 *
  60 * The work_items in [todo_start, todo_end) are waiting to be picked
  61 * up by a consumer thread.
  62 *
  63 * The ranges are modulo TODO_SIZE.
  64 */
  65#define TODO_SIZE 128
  66static struct work_item todo[TODO_SIZE];
  67static int todo_start;
  68static int todo_end;
  69static int todo_done;
  70
  71/* Has all work items been added? */
  72static int all_work_added;
  73
  74/* This lock protects all the variables above. */
  75static pthread_mutex_t grep_mutex;
  76
  77/* Used to serialize calls to read_sha1_file. */
  78static pthread_mutex_t read_sha1_mutex;
  79
  80#define grep_lock() pthread_mutex_lock(&grep_mutex)
  81#define grep_unlock() pthread_mutex_unlock(&grep_mutex)
  82#define read_sha1_lock() pthread_mutex_lock(&read_sha1_mutex)
  83#define read_sha1_unlock() pthread_mutex_unlock(&read_sha1_mutex)
  84
  85/* Signalled when a new work_item is added to todo. */
  86static pthread_cond_t cond_add;
  87
  88/* Signalled when the result from one work_item is written to
  89 * stdout.
  90 */
  91static pthread_cond_t cond_write;
  92
  93/* Signalled when we are finished with everything. */
  94static pthread_cond_t cond_result;
  95
  96static int print_hunk_marks_between_files;
  97static int printed_something;
  98
  99static void add_work(enum work_type type, char *name, void *id)
 100{
 101        grep_lock();
 102
 103        while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
 104                pthread_cond_wait(&cond_write, &grep_mutex);
 105        }
 106
 107        todo[todo_end].type = type;
 108        todo[todo_end].name = name;
 109        todo[todo_end].identifier = id;
 110        todo[todo_end].done = 0;
 111        strbuf_reset(&todo[todo_end].out);
 112        todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
 113
 114        pthread_cond_signal(&cond_add);
 115        grep_unlock();
 116}
 117
 118static struct work_item *get_work(void)
 119{
 120        struct work_item *ret;
 121
 122        grep_lock();
 123        while (todo_start == todo_end && !all_work_added) {
 124                pthread_cond_wait(&cond_add, &grep_mutex);
 125        }
 126
 127        if (todo_start == todo_end && all_work_added) {
 128                ret = NULL;
 129        } else {
 130                ret = &todo[todo_start];
 131                todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
 132        }
 133        grep_unlock();
 134        return ret;
 135}
 136
 137static void grep_sha1_async(struct grep_opt *opt, char *name,
 138                            const unsigned char *sha1)
 139{
 140        unsigned char *s;
 141        s = xmalloc(20);
 142        memcpy(s, sha1, 20);
 143        add_work(WORK_SHA1, name, s);
 144}
 145
 146static void grep_file_async(struct grep_opt *opt, char *name,
 147                            const char *filename)
 148{
 149        add_work(WORK_FILE, name, xstrdup(filename));
 150}
 151
 152static void work_done(struct work_item *w)
 153{
 154        int old_done;
 155
 156        grep_lock();
 157        w->done = 1;
 158        old_done = todo_done;
 159        for(; todo[todo_done].done && todo_done != todo_start;
 160            todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
 161                w = &todo[todo_done];
 162                if (w->out.len) {
 163                        if (print_hunk_marks_between_files && printed_something)
 164                                write_or_die(1, "--\n", 3);
 165                        write_or_die(1, w->out.buf, w->out.len);
 166                        printed_something = 1;
 167                }
 168                free(w->name);
 169                free(w->identifier);
 170        }
 171
 172        if (old_done != todo_done)
 173                pthread_cond_signal(&cond_write);
 174
 175        if (all_work_added && todo_done == todo_end)
 176                pthread_cond_signal(&cond_result);
 177
 178        grep_unlock();
 179}
 180
 181static void *run(void *arg)
 182{
 183        int hit = 0;
 184        struct grep_opt *opt = arg;
 185
 186        while (1) {
 187                struct work_item *w = get_work();
 188                if (!w)
 189                        break;
 190
 191                opt->output_priv = w;
 192                if (w->type == WORK_SHA1) {
 193                        unsigned long sz;
 194                        void* data = load_sha1(w->identifier, &sz, w->name);
 195
 196                        if (data) {
 197                                hit |= grep_buffer(opt, w->name, data, sz);
 198                                free(data);
 199                        }
 200                } else if (w->type == WORK_FILE) {
 201                        size_t sz;
 202                        void* data = load_file(w->identifier, &sz);
 203                        if (data) {
 204                                hit |= grep_buffer(opt, w->name, data, sz);
 205                                free(data);
 206                        }
 207                } else {
 208                        assert(0);
 209                }
 210
 211                work_done(w);
 212        }
 213        free_grep_patterns(arg);
 214        free(arg);
 215
 216        return (void*) (intptr_t) hit;
 217}
 218
 219static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
 220{
 221        struct work_item *w = opt->output_priv;
 222        strbuf_add(&w->out, buf, size);
 223}
 224
 225static void start_threads(struct grep_opt *opt)
 226{
 227        int i;
 228
 229        pthread_mutex_init(&grep_mutex, NULL);
 230        pthread_mutex_init(&read_sha1_mutex, NULL);
 231        pthread_cond_init(&cond_add, NULL);
 232        pthread_cond_init(&cond_write, NULL);
 233        pthread_cond_init(&cond_result, NULL);
 234
 235        for (i = 0; i < ARRAY_SIZE(todo); i++) {
 236                strbuf_init(&todo[i].out, 0);
 237        }
 238
 239        for (i = 0; i < ARRAY_SIZE(threads); i++) {
 240                int err;
 241                struct grep_opt *o = grep_opt_dup(opt);
 242                o->output = strbuf_out;
 243                compile_grep_patterns(o);
 244                err = pthread_create(&threads[i], NULL, run, o);
 245
 246                if (err)
 247                        die("grep: failed to create thread: %s",
 248                            strerror(err));
 249        }
 250}
 251
 252static int wait_all(void)
 253{
 254        int hit = 0;
 255        int i;
 256
 257        grep_lock();
 258        all_work_added = 1;
 259
 260        /* Wait until all work is done. */
 261        while (todo_done != todo_end)
 262                pthread_cond_wait(&cond_result, &grep_mutex);
 263
 264        /* Wake up all the consumer threads so they can see that there
 265         * is no more work to do.
 266         */
 267        pthread_cond_broadcast(&cond_add);
 268        grep_unlock();
 269
 270        for (i = 0; i < ARRAY_SIZE(threads); i++) {
 271                void *h;
 272                pthread_join(threads[i], &h);
 273                hit |= (int) (intptr_t) h;
 274        }
 275
 276        pthread_mutex_destroy(&grep_mutex);
 277        pthread_mutex_destroy(&read_sha1_mutex);
 278        pthread_cond_destroy(&cond_add);
 279        pthread_cond_destroy(&cond_write);
 280        pthread_cond_destroy(&cond_result);
 281
 282        return hit;
 283}
 284#else /* !NO_PTHREADS */
 285#define read_sha1_lock()
 286#define read_sha1_unlock()
 287
 288static int wait_all(void)
 289{
 290        return 0;
 291}
 292#endif
 293
 294static int grep_config(const char *var, const char *value, void *cb)
 295{
 296        struct grep_opt *opt = cb;
 297        char *color = NULL;
 298
 299        switch (userdiff_config(var, value)) {
 300        case 0: break;
 301        case -1: return -1;
 302        default: return 0;
 303        }
 304
 305        if (!strcmp(var, "color.grep"))
 306                opt->color = git_config_colorbool(var, value, -1);
 307        else if (!strcmp(var, "color.grep.context"))
 308                color = opt->color_context;
 309        else if (!strcmp(var, "color.grep.filename"))
 310                color = opt->color_filename;
 311        else if (!strcmp(var, "color.grep.function"))
 312                color = opt->color_function;
 313        else if (!strcmp(var, "color.grep.linenumber"))
 314                color = opt->color_lineno;
 315        else if (!strcmp(var, "color.grep.match"))
 316                color = opt->color_match;
 317        else if (!strcmp(var, "color.grep.selected"))
 318                color = opt->color_selected;
 319        else if (!strcmp(var, "color.grep.separator"))
 320                color = opt->color_sep;
 321        else
 322                return git_color_default_config(var, value, cb);
 323        if (color) {
 324                if (!value)
 325                        return config_error_nonbool(var);
 326                color_parse(value, var, color);
 327        }
 328        return 0;
 329}
 330
 331static void *lock_and_read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 332{
 333        void *data;
 334
 335        if (use_threads) {
 336                read_sha1_lock();
 337                data = read_sha1_file(sha1, type, size);
 338                read_sha1_unlock();
 339        } else {
 340                data = read_sha1_file(sha1, type, size);
 341        }
 342        return data;
 343}
 344
 345static void *load_sha1(const unsigned char *sha1, unsigned long *size,
 346                       const char *name)
 347{
 348        enum object_type type;
 349        void *data = lock_and_read_sha1_file(sha1, &type, size);
 350
 351        if (!data)
 352                error("'%s': unable to read %s", name, sha1_to_hex(sha1));
 353
 354        return data;
 355}
 356
 357static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1,
 358                     const char *filename, int tree_name_len)
 359{
 360        struct strbuf pathbuf = STRBUF_INIT;
 361        char *name;
 362
 363        if (opt->relative && opt->prefix_length) {
 364                quote_path_relative(filename + tree_name_len, -1, &pathbuf,
 365                                    opt->prefix);
 366                strbuf_insert(&pathbuf, 0, filename, tree_name_len);
 367        } else {
 368                strbuf_addstr(&pathbuf, filename);
 369        }
 370
 371        name = strbuf_detach(&pathbuf, NULL);
 372
 373#ifndef NO_PTHREADS
 374        if (use_threads) {
 375                grep_sha1_async(opt, name, sha1);
 376                return 0;
 377        } else
 378#endif
 379        {
 380                int hit;
 381                unsigned long sz;
 382                void *data = load_sha1(sha1, &sz, name);
 383                if (!data)
 384                        hit = 0;
 385                else
 386                        hit = grep_buffer(opt, name, data, sz);
 387
 388                free(data);
 389                free(name);
 390                return hit;
 391        }
 392}
 393
 394static void *load_file(const char *filename, size_t *sz)
 395{
 396        struct stat st;
 397        char *data;
 398        int i;
 399
 400        if (lstat(filename, &st) < 0) {
 401        err_ret:
 402                if (errno != ENOENT)
 403                        error("'%s': %s", filename, strerror(errno));
 404                return 0;
 405        }
 406        if (!S_ISREG(st.st_mode))
 407                return 0;
 408        *sz = xsize_t(st.st_size);
 409        i = open(filename, O_RDONLY);
 410        if (i < 0)
 411                goto err_ret;
 412        data = xmalloc(*sz + 1);
 413        if (st.st_size != read_in_full(i, data, *sz)) {
 414                error("'%s': short read %s", filename, strerror(errno));
 415                close(i);
 416                free(data);
 417                return 0;
 418        }
 419        close(i);
 420        data[*sz] = 0;
 421        return data;
 422}
 423
 424static int grep_file(struct grep_opt *opt, const char *filename)
 425{
 426        struct strbuf buf = STRBUF_INIT;
 427        char *name;
 428
 429        if (opt->relative && opt->prefix_length)
 430                quote_path_relative(filename, -1, &buf, opt->prefix);
 431        else
 432                strbuf_addstr(&buf, filename);
 433        name = strbuf_detach(&buf, NULL);
 434
 435#ifndef NO_PTHREADS
 436        if (use_threads) {
 437                grep_file_async(opt, name, filename);
 438                return 0;
 439        } else
 440#endif
 441        {
 442                int hit;
 443                size_t sz;
 444                void *data = load_file(filename, &sz);
 445                if (!data)
 446                        hit = 0;
 447                else
 448                        hit = grep_buffer(opt, name, data, sz);
 449
 450                free(data);
 451                free(name);
 452                return hit;
 453        }
 454}
 455
 456static void append_path(struct grep_opt *opt, const void *data, size_t len)
 457{
 458        struct string_list *path_list = opt->output_priv;
 459
 460        if (len == 1 && *(const char *)data == '\0')
 461                return;
 462        string_list_append(path_list, xstrndup(data, len));
 463}
 464
 465static void run_pager(struct grep_opt *opt, const char *prefix)
 466{
 467        struct string_list *path_list = opt->output_priv;
 468        const char **argv = xmalloc(sizeof(const char *) * (path_list->nr + 1));
 469        int i, status;
 470
 471        for (i = 0; i < path_list->nr; i++)
 472                argv[i] = path_list->items[i].string;
 473        argv[path_list->nr] = NULL;
 474
 475        if (prefix && chdir(prefix))
 476                die("Failed to chdir: %s", prefix);
 477        status = run_command_v_opt(argv, RUN_USING_SHELL);
 478        if (status)
 479                exit(status);
 480        free(argv);
 481}
 482
 483static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec, int cached)
 484{
 485        int hit = 0;
 486        int nr;
 487        read_cache();
 488
 489        for (nr = 0; nr < active_nr; nr++) {
 490                struct cache_entry *ce = active_cache[nr];
 491                if (!S_ISREG(ce->ce_mode))
 492                        continue;
 493                if (!match_pathspec_depth(pathspec, ce->name, ce_namelen(ce), 0, NULL))
 494                        continue;
 495                /*
 496                 * If CE_VALID is on, we assume worktree file and its cache entry
 497                 * are identical, even if worktree file has been modified, so use
 498                 * cache version instead
 499                 */
 500                if (cached || (ce->ce_flags & CE_VALID) || ce_skip_worktree(ce)) {
 501                        if (ce_stage(ce))
 502                                continue;
 503                        hit |= grep_sha1(opt, ce->sha1, ce->name, 0);
 504                }
 505                else
 506                        hit |= grep_file(opt, ce->name);
 507                if (ce_stage(ce)) {
 508                        do {
 509                                nr++;
 510                        } while (nr < active_nr &&
 511                                 !strcmp(ce->name, active_cache[nr]->name));
 512                        nr--; /* compensate for loop control */
 513                }
 514                if (hit && opt->status_only)
 515                        break;
 516        }
 517        return hit;
 518}
 519
 520static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
 521                     struct tree_desc *tree, struct strbuf *base, int tn_len)
 522{
 523        int hit = 0, matched = 0;
 524        struct name_entry entry;
 525        int old_baselen = base->len;
 526
 527        while (tree_entry(tree, &entry)) {
 528                int te_len = tree_entry_len(entry.path, entry.sha1);
 529
 530                if (matched != 2) {
 531                        matched = tree_entry_interesting(&entry, base, tn_len, pathspec);
 532                        if (matched == -1)
 533                                break; /* no more matches */
 534                        if (!matched)
 535                                continue;
 536                }
 537
 538                strbuf_add(base, entry.path, te_len);
 539
 540                if (S_ISREG(entry.mode)) {
 541                        hit |= grep_sha1(opt, entry.sha1, base->buf, tn_len);
 542                }
 543                else if (S_ISDIR(entry.mode)) {
 544                        enum object_type type;
 545                        struct tree_desc sub;
 546                        void *data;
 547                        unsigned long size;
 548
 549                        data = lock_and_read_sha1_file(entry.sha1, &type, &size);
 550                        if (!data)
 551                                die("unable to read tree (%s)",
 552                                    sha1_to_hex(entry.sha1));
 553
 554                        strbuf_addch(base, '/');
 555                        init_tree_desc(&sub, data, size);
 556                        hit |= grep_tree(opt, pathspec, &sub, base, tn_len);
 557                        free(data);
 558                }
 559                strbuf_setlen(base, old_baselen);
 560
 561                if (hit && opt->status_only)
 562                        break;
 563        }
 564        return hit;
 565}
 566
 567static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
 568                       struct object *obj, const char *name)
 569{
 570        if (obj->type == OBJ_BLOB)
 571                return grep_sha1(opt, obj->sha1, name, 0);
 572        if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
 573                struct tree_desc tree;
 574                void *data;
 575                unsigned long size;
 576                struct strbuf base;
 577                int hit, len;
 578
 579                data = read_object_with_reference(obj->sha1, tree_type,
 580                                                  &size, NULL);
 581                if (!data)
 582                        die("unable to read tree (%s)", sha1_to_hex(obj->sha1));
 583
 584                len = name ? strlen(name) : 0;
 585                strbuf_init(&base, PATH_MAX + len + 1);
 586                if (len) {
 587                        strbuf_add(&base, name, len);
 588                        strbuf_addch(&base, ':');
 589                }
 590                init_tree_desc(&tree, data, size);
 591                hit = grep_tree(opt, pathspec, &tree, &base, base.len);
 592                strbuf_release(&base);
 593                free(data);
 594                return hit;
 595        }
 596        die("unable to grep from object of type %s", typename(obj->type));
 597}
 598
 599static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
 600                        const struct object_array *list)
 601{
 602        unsigned int i;
 603        int hit = 0;
 604        const unsigned int nr = list->nr;
 605
 606        for (i = 0; i < nr; i++) {
 607                struct object *real_obj;
 608                real_obj = deref_tag(list->objects[i].item, NULL, 0);
 609                if (grep_object(opt, pathspec, real_obj, list->objects[i].name)) {
 610                        hit = 1;
 611                        if (opt->status_only)
 612                                break;
 613                }
 614        }
 615        return hit;
 616}
 617
 618static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec)
 619{
 620        struct dir_struct dir;
 621        int i, hit = 0;
 622
 623        memset(&dir, 0, sizeof(dir));
 624        setup_standard_excludes(&dir);
 625
 626        fill_directory(&dir, pathspec->raw);
 627        for (i = 0; i < dir.nr; i++) {
 628                const char *name = dir.entries[i]->name;
 629                int namelen = strlen(name);
 630                if (!match_pathspec_depth(pathspec, name, namelen, 0, NULL))
 631                        continue;
 632                hit |= grep_file(opt, dir.entries[i]->name);
 633                if (hit && opt->status_only)
 634                        break;
 635        }
 636        return hit;
 637}
 638
 639static int context_callback(const struct option *opt, const char *arg,
 640                            int unset)
 641{
 642        struct grep_opt *grep_opt = opt->value;
 643        int value;
 644        const char *endp;
 645
 646        if (unset) {
 647                grep_opt->pre_context = grep_opt->post_context = 0;
 648                return 0;
 649        }
 650        value = strtol(arg, (char **)&endp, 10);
 651        if (*endp) {
 652                return error("switch `%c' expects a numerical value",
 653                             opt->short_name);
 654        }
 655        grep_opt->pre_context = grep_opt->post_context = value;
 656        return 0;
 657}
 658
 659static int file_callback(const struct option *opt, const char *arg, int unset)
 660{
 661        struct grep_opt *grep_opt = opt->value;
 662        int from_stdin = !strcmp(arg, "-");
 663        FILE *patterns;
 664        int lno = 0;
 665        struct strbuf sb = STRBUF_INIT;
 666
 667        patterns = from_stdin ? stdin : fopen(arg, "r");
 668        if (!patterns)
 669                die_errno("cannot open '%s'", arg);
 670        while (strbuf_getline(&sb, patterns, '\n') == 0) {
 671                char *s;
 672                size_t len;
 673
 674                /* ignore empty line like grep does */
 675                if (sb.len == 0)
 676                        continue;
 677
 678                s = strbuf_detach(&sb, &len);
 679                append_grep_pat(grep_opt, s, len, arg, ++lno, GREP_PATTERN);
 680        }
 681        if (!from_stdin)
 682                fclose(patterns);
 683        strbuf_release(&sb);
 684        return 0;
 685}
 686
 687static int not_callback(const struct option *opt, const char *arg, int unset)
 688{
 689        struct grep_opt *grep_opt = opt->value;
 690        append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
 691        return 0;
 692}
 693
 694static int and_callback(const struct option *opt, const char *arg, int unset)
 695{
 696        struct grep_opt *grep_opt = opt->value;
 697        append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
 698        return 0;
 699}
 700
 701static int open_callback(const struct option *opt, const char *arg, int unset)
 702{
 703        struct grep_opt *grep_opt = opt->value;
 704        append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
 705        return 0;
 706}
 707
 708static int close_callback(const struct option *opt, const char *arg, int unset)
 709{
 710        struct grep_opt *grep_opt = opt->value;
 711        append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
 712        return 0;
 713}
 714
 715static int pattern_callback(const struct option *opt, const char *arg,
 716                            int unset)
 717{
 718        struct grep_opt *grep_opt = opt->value;
 719        append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
 720        return 0;
 721}
 722
 723static int help_callback(const struct option *opt, const char *arg, int unset)
 724{
 725        return -1;
 726}
 727
 728int cmd_grep(int argc, const char **argv, const char *prefix)
 729{
 730        int hit = 0;
 731        int cached = 0;
 732        int seen_dashdash = 0;
 733        int external_grep_allowed__ignored;
 734        const char *show_in_pager = NULL, *default_pager = "dummy";
 735        struct grep_opt opt;
 736        struct object_array list = OBJECT_ARRAY_INIT;
 737        const char **paths = NULL;
 738        struct pathspec pathspec;
 739        struct string_list path_list = STRING_LIST_INIT_NODUP;
 740        int i;
 741        int dummy;
 742        int use_index = 1;
 743        struct option options[] = {
 744                OPT_BOOLEAN(0, "cached", &cached,
 745                        "search in index instead of in the work tree"),
 746                OPT_BOOLEAN(0, "index", &use_index,
 747                        "--no-index finds in contents not managed by git"),
 748                OPT_GROUP(""),
 749                OPT_BOOLEAN('v', "invert-match", &opt.invert,
 750                        "show non-matching lines"),
 751                OPT_BOOLEAN('i', "ignore-case", &opt.ignore_case,
 752                        "case insensitive matching"),
 753                OPT_BOOLEAN('w', "word-regexp", &opt.word_regexp,
 754                        "match patterns only at word boundaries"),
 755                OPT_SET_INT('a', "text", &opt.binary,
 756                        "process binary files as text", GREP_BINARY_TEXT),
 757                OPT_SET_INT('I', NULL, &opt.binary,
 758                        "don't match patterns in binary files",
 759                        GREP_BINARY_NOMATCH),
 760                { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, "depth",
 761                        "descend at most <depth> levels", PARSE_OPT_NONEG,
 762                        NULL, 1 },
 763                OPT_GROUP(""),
 764                OPT_BIT('E', "extended-regexp", &opt.regflags,
 765                        "use extended POSIX regular expressions", REG_EXTENDED),
 766                OPT_NEGBIT('G', "basic-regexp", &opt.regflags,
 767                        "use basic POSIX regular expressions (default)",
 768                        REG_EXTENDED),
 769                OPT_BOOLEAN('F', "fixed-strings", &opt.fixed,
 770                        "interpret patterns as fixed strings"),
 771                OPT_GROUP(""),
 772                OPT_BOOLEAN('n', NULL, &opt.linenum, "show line numbers"),
 773                OPT_NEGBIT('h', NULL, &opt.pathname, "don't show filenames", 1),
 774                OPT_BIT('H', NULL, &opt.pathname, "show filenames", 1),
 775                OPT_NEGBIT(0, "full-name", &opt.relative,
 776                        "show filenames relative to top directory", 1),
 777                OPT_BOOLEAN('l', "files-with-matches", &opt.name_only,
 778                        "show only filenames instead of matching lines"),
 779                OPT_BOOLEAN(0, "name-only", &opt.name_only,
 780                        "synonym for --files-with-matches"),
 781                OPT_BOOLEAN('L', "files-without-match",
 782                        &opt.unmatch_name_only,
 783                        "show only the names of files without match"),
 784                OPT_BOOLEAN('z', "null", &opt.null_following_name,
 785                        "print NUL after filenames"),
 786                OPT_BOOLEAN('c', "count", &opt.count,
 787                        "show the number of matches instead of matching lines"),
 788                OPT__COLOR(&opt.color, "highlight matches"),
 789                OPT_GROUP(""),
 790                OPT_CALLBACK('C', NULL, &opt, "n",
 791                        "show <n> context lines before and after matches",
 792                        context_callback),
 793                OPT_INTEGER('B', NULL, &opt.pre_context,
 794                        "show <n> context lines before matches"),
 795                OPT_INTEGER('A', NULL, &opt.post_context,
 796                        "show <n> context lines after matches"),
 797                OPT_NUMBER_CALLBACK(&opt, "shortcut for -C NUM",
 798                        context_callback),
 799                OPT_BOOLEAN('p', "show-function", &opt.funcname,
 800                        "show a line with the function name before matches"),
 801                OPT_GROUP(""),
 802                OPT_CALLBACK('f', NULL, &opt, "file",
 803                        "read patterns from file", file_callback),
 804                { OPTION_CALLBACK, 'e', NULL, &opt, "pattern",
 805                        "match <pattern>", PARSE_OPT_NONEG, pattern_callback },
 806                { OPTION_CALLBACK, 0, "and", &opt, NULL,
 807                  "combine patterns specified with -e",
 808                  PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
 809                OPT_BOOLEAN(0, "or", &dummy, ""),
 810                { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
 811                  PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
 812                { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
 813                  PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
 814                  open_callback },
 815                { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
 816                  PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
 817                  close_callback },
 818                OPT__QUIET(&opt.status_only,
 819                           "indicate hit with exit status without output"),
 820                OPT_BOOLEAN(0, "all-match", &opt.all_match,
 821                        "show only matches from files that match all patterns"),
 822                OPT_GROUP(""),
 823                { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
 824                        "pager", "show matching files in the pager",
 825                        PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
 826                OPT_BOOLEAN(0, "ext-grep", &external_grep_allowed__ignored,
 827                            "allow calling of grep(1) (ignored by this build)"),
 828                { OPTION_CALLBACK, 0, "help-all", &options, NULL, "show usage",
 829                  PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
 830                OPT_END()
 831        };
 832
 833        /*
 834         * 'git grep -h', unlike 'git grep -h <pattern>', is a request
 835         * to show usage information and exit.
 836         */
 837        if (argc == 2 && !strcmp(argv[1], "-h"))
 838                usage_with_options(grep_usage, options);
 839
 840        memset(&opt, 0, sizeof(opt));
 841        opt.prefix = prefix;
 842        opt.prefix_length = (prefix && *prefix) ? strlen(prefix) : 0;
 843        opt.relative = 1;
 844        opt.pathname = 1;
 845        opt.pattern_tail = &opt.pattern_list;
 846        opt.header_tail = &opt.header_list;
 847        opt.regflags = REG_NEWLINE;
 848        opt.max_depth = -1;
 849
 850        strcpy(opt.color_context, "");
 851        strcpy(opt.color_filename, "");
 852        strcpy(opt.color_function, "");
 853        strcpy(opt.color_lineno, "");
 854        strcpy(opt.color_match, GIT_COLOR_BOLD_RED);
 855        strcpy(opt.color_selected, "");
 856        strcpy(opt.color_sep, GIT_COLOR_CYAN);
 857        opt.color = -1;
 858        git_config(grep_config, &opt);
 859        if (opt.color == -1)
 860                opt.color = git_use_color_default;
 861
 862        /*
 863         * If there is no -- then the paths must exist in the working
 864         * tree.  If there is no explicit pattern specified with -e or
 865         * -f, we take the first unrecognized non option to be the
 866         * pattern, but then what follows it must be zero or more
 867         * valid refs up to the -- (if exists), and then existing
 868         * paths.  If there is an explicit pattern, then the first
 869         * unrecognized non option is the beginning of the refs list
 870         * that continues up to the -- (if exists), and then paths.
 871         */
 872        argc = parse_options(argc, argv, prefix, options, grep_usage,
 873                             PARSE_OPT_KEEP_DASHDASH |
 874                             PARSE_OPT_STOP_AT_NON_OPTION |
 875                             PARSE_OPT_NO_INTERNAL_HELP);
 876
 877        if (use_index && !startup_info->have_repository)
 878                /* die the same way as if we did it at the beginning */
 879                setup_git_directory();
 880
 881        /*
 882         * skip a -- separator; we know it cannot be
 883         * separating revisions from pathnames if
 884         * we haven't even had any patterns yet
 885         */
 886        if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
 887                argv++;
 888                argc--;
 889        }
 890
 891        /* First unrecognized non-option token */
 892        if (argc > 0 && !opt.pattern_list) {
 893                append_grep_pattern(&opt, argv[0], "command line", 0,
 894                                    GREP_PATTERN);
 895                argv++;
 896                argc--;
 897        }
 898
 899        if (show_in_pager == default_pager)
 900                show_in_pager = git_pager(1);
 901        if (show_in_pager) {
 902                opt.color = 0;
 903                opt.name_only = 1;
 904                opt.null_following_name = 1;
 905                opt.output_priv = &path_list;
 906                opt.output = append_path;
 907                string_list_append(&path_list, show_in_pager);
 908                use_threads = 0;
 909        }
 910
 911        if (!opt.pattern_list)
 912                die("no pattern given.");
 913        if (!opt.fixed && opt.ignore_case)
 914                opt.regflags |= REG_ICASE;
 915        if ((opt.regflags != REG_NEWLINE) && opt.fixed)
 916                die("cannot mix --fixed-strings and regexp");
 917
 918#ifndef NO_PTHREADS
 919        if (online_cpus() == 1 || !grep_threads_ok(&opt))
 920                use_threads = 0;
 921
 922        if (use_threads) {
 923                if (opt.pre_context || opt.post_context)
 924                        print_hunk_marks_between_files = 1;
 925                start_threads(&opt);
 926        }
 927#else
 928        use_threads = 0;
 929#endif
 930
 931        compile_grep_patterns(&opt);
 932
 933        /* Check revs and then paths */
 934        for (i = 0; i < argc; i++) {
 935                const char *arg = argv[i];
 936                unsigned char sha1[20];
 937                /* Is it a rev? */
 938                if (!get_sha1(arg, sha1)) {
 939                        struct object *object = parse_object(sha1);
 940                        if (!object)
 941                                die("bad object %s", arg);
 942                        add_object_array(object, arg, &list);
 943                        continue;
 944                }
 945                if (!strcmp(arg, "--")) {
 946                        i++;
 947                        seen_dashdash = 1;
 948                }
 949                break;
 950        }
 951
 952        /* The rest are paths */
 953        if (!seen_dashdash) {
 954                int j;
 955                for (j = i; j < argc; j++)
 956                        verify_filename(prefix, argv[j]);
 957        }
 958
 959        if (i < argc)
 960                paths = get_pathspec(prefix, argv + i);
 961        else if (prefix) {
 962                paths = xcalloc(2, sizeof(const char *));
 963                paths[0] = prefix;
 964                paths[1] = NULL;
 965        }
 966        init_pathspec(&pathspec, paths);
 967        pathspec.max_depth = opt.max_depth;
 968        pathspec.recursive = 1;
 969
 970        if (show_in_pager && (cached || list.nr))
 971                die("--open-files-in-pager only works on the worktree");
 972
 973        if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
 974                const char *pager = path_list.items[0].string;
 975                int len = strlen(pager);
 976
 977                if (len > 4 && is_dir_sep(pager[len - 5]))
 978                        pager += len - 4;
 979
 980                if (!strcmp("less", pager) || !strcmp("vi", pager)) {
 981                        struct strbuf buf = STRBUF_INIT;
 982                        strbuf_addf(&buf, "+/%s%s",
 983                                        strcmp("less", pager) ? "" : "*",
 984                                        opt.pattern_list->pattern);
 985                        string_list_append(&path_list, buf.buf);
 986                        strbuf_detach(&buf, NULL);
 987                }
 988        }
 989
 990        if (!show_in_pager)
 991                setup_pager();
 992
 993
 994        if (!use_index) {
 995                if (cached)
 996                        die("--cached cannot be used with --no-index.");
 997                if (list.nr)
 998                        die("--no-index cannot be used with revs.");
 999                hit = grep_directory(&opt, &pathspec);
1000        } else if (!list.nr) {
1001                if (!cached)
1002                        setup_work_tree();
1003
1004                hit = grep_cache(&opt, &pathspec, cached);
1005        } else {
1006                if (cached)
1007                        die("both --cached and trees are given.");
1008                hit = grep_objects(&opt, &pathspec, &list);
1009        }
1010
1011        if (use_threads)
1012                hit |= wait_all();
1013        if (hit && show_in_pager)
1014                run_pager(&opt, prefix);
1015        free_grep_patterns(&opt);
1016        return !hit;
1017}