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