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