builtin/grep.c

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