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