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#include "submodule.h"
22#include "submodule-config.h"
23static char const * const grep_usage[] = {
25 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
26 NULL
27};
28static const char *super_prefix;
30static int recurse_submodules;
31static struct argv_array submodule_options = ARGV_ARRAY_INIT;
32static const char *parent_basename;
33static int grep_submodule_launch(struct grep_opt *opt,
35 const struct grep_source *gs);
36#define GREP_NUM_THREADS_DEFAULT 8
38static int num_threads;
39#ifndef NO_PTHREADS
41static pthread_t *threads;
42/* We use one producer thread and THREADS consumer
44 * threads. The producer adds struct work_items to 'todo' and the
45 * consumers pick work items from the same array.
46 */
47struct work_item {
48 struct grep_source source;
49 char done;
50 struct strbuf out;
51};
52/* In the range [todo_done, todo_start) in 'todo' we have work_items
54 * that have been or are processed by a consumer thread. We haven't
55 * written the result for these to stdout yet.
56 *
57 * The work_items in [todo_start, todo_end) are waiting to be picked
58 * up by a consumer thread.
59 *
60 * The ranges are modulo TODO_SIZE.
61 */
62#define TODO_SIZE 128
63static struct work_item todo[TODO_SIZE];
64static int todo_start;
65static int todo_end;
66static int todo_done;
67/* Has all work items been added? */
69static int all_work_added;
70/* This lock protects all the variables above. */
72static pthread_mutex_t grep_mutex;
73static inline void grep_lock(void)
75{
76 if (num_threads)
77 pthread_mutex_lock(&grep_mutex);
78}
79static inline void grep_unlock(void)
81{
82 if (num_threads)
83 pthread_mutex_unlock(&grep_mutex);
84}
85/* Signalled when a new work_item is added to todo. */
87static pthread_cond_t cond_add;
88/* Signalled when the result from one work_item is written to
90 * stdout.
91 */
92static pthread_cond_t cond_write;
93/* Signalled when we are finished with everything. */
95static pthread_cond_t cond_result;
96static int skip_first_line;
98static void add_work(struct grep_opt *opt, enum grep_source_type type,
100 const char *name, const char *path, const void *id)
101{
102 grep_lock();
103 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
105 pthread_cond_wait(&cond_write, &grep_mutex);
106 }
107 grep_source_init(&todo[todo_end].source, type, name, path, id);
109 if (opt->binary != GREP_BINARY_TEXT)
110 grep_source_load_driver(&todo[todo_end].source);
111 todo[todo_end].done = 0;
112 strbuf_reset(&todo[todo_end].out);
113 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
114 pthread_cond_signal(&cond_add);
116 grep_unlock();
117}
118static struct work_item *get_work(void)
120{
121 struct work_item *ret;
122 grep_lock();
124 while (todo_start == todo_end && !all_work_added) {
125 pthread_cond_wait(&cond_add, &grep_mutex);
126 }
127 if (todo_start == todo_end && all_work_added) {
129 ret = NULL;
130 } else {
131 ret = &todo[todo_start];
132 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
133 }
134 grep_unlock();
135 return ret;
136}
137static void work_done(struct work_item *w)
139{
140 int old_done;
141 grep_lock();
143 w->done = 1;
144 old_done = todo_done;
145 for(; todo[todo_done].done && todo_done != todo_start;
146 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
147 w = &todo[todo_done];
148 if (w->out.len) {
149 const char *p = w->out.buf;
150 size_t len = w->out.len;
151 /* Skip the leading hunk mark of the first file. */
153 if (skip_first_line) {
154 while (len) {
155 len--;
156 if (*p++ == '\n')
157 break;
158 }
159 skip_first_line = 0;
160 }
161 write_or_die(1, p, len);
163 }
164 grep_source_clear(&w->source);
165 }
166 if (old_done != todo_done)
168 pthread_cond_signal(&cond_write);
169 if (all_work_added && todo_done == todo_end)
171 pthread_cond_signal(&cond_result);
172 grep_unlock();
174}
175static void *run(void *arg)
177{
178 int hit = 0;
179 struct grep_opt *opt = arg;
180 while (1) {
182 struct work_item *w = get_work();
183 if (!w)
184 break;
185 opt->output_priv = w;
187 if (w->source.type == GREP_SOURCE_SUBMODULE)
188 hit |= grep_submodule_launch(opt, &w->source);
189 else
190 hit |= grep_source(opt, &w->source);
191 grep_source_clear_data(&w->source);
192 work_done(w);
193 }
194 free_grep_patterns(arg);
195 free(arg);
196 return (void*) (intptr_t) hit;
198}
199static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
201{
202 struct work_item *w = opt->output_priv;
203 strbuf_add(&w->out, buf, size);
204}
205static void start_threads(struct grep_opt *opt)
207{
208 int i;
209 pthread_mutex_init(&grep_mutex, NULL);
211 pthread_mutex_init(&grep_read_mutex, NULL);
212 pthread_mutex_init(&grep_attr_mutex, NULL);
213 pthread_cond_init(&cond_add, NULL);
214 pthread_cond_init(&cond_write, NULL);
215 pthread_cond_init(&cond_result, NULL);
216 grep_use_locks = 1;
217 for (i = 0; i < ARRAY_SIZE(todo); i++) {
219 strbuf_init(&todo[i].out, 0);
220 }
221 threads = xcalloc(num_threads, sizeof(*threads));
223 for (i = 0; i < num_threads; i++) {
224 int err;
225 struct grep_opt *o = grep_opt_dup(opt);
226 o->output = strbuf_out;
227 o->debug = 0;
228 compile_grep_patterns(o);
229 err = pthread_create(&threads[i], NULL, run, o);
230 if (err)
232 die(_("grep: failed to create thread: %s"),
233 strerror(err));
234 }
235}
236static int wait_all(void)
238{
239 int hit = 0;
240 int i;
241 grep_lock();
243 all_work_added = 1;
244 /* Wait until all work is done. */
246 while (todo_done != todo_end)
247 pthread_cond_wait(&cond_result, &grep_mutex);
248 /* Wake up all the consumer threads so they can see that there
250 * is no more work to do.
251 */
252 pthread_cond_broadcast(&cond_add);
253 grep_unlock();
254 for (i = 0; i < num_threads; i++) {
256 void *h;
257 pthread_join(threads[i], &h);
258 hit |= (int) (intptr_t) h;
259 }
260 free(threads);
262 pthread_mutex_destroy(&grep_mutex);
264 pthread_mutex_destroy(&grep_read_mutex);
265 pthread_mutex_destroy(&grep_attr_mutex);
266 pthread_cond_destroy(&cond_add);
267 pthread_cond_destroy(&cond_write);
268 pthread_cond_destroy(&cond_result);
269 grep_use_locks = 0;
270 return hit;
272}
273#else /* !NO_PTHREADS */
274static int wait_all(void)
276{
277 return 0;
278}
279#endif
280static int grep_cmd_config(const char *var, const char *value, void *cb)
282{
283 int st = grep_config(var, value, cb);
284 if (git_color_default_config(var, value, cb) < 0)
285 st = -1;
286 if (!strcmp(var, "grep.threads")) {
288 num_threads = git_config_int(var, value);
289 if (num_threads < 0)
290 die(_("invalid number of threads specified (%d) for %s"),
291 num_threads, var);
292 }
293 return st;
295}
296static void *lock_and_read_oid_file(const struct object_id *oid, enum object_type *type, unsigned long *size)
298{
299 void *data;
300 grep_read_lock();
302 data = read_sha1_file(oid->hash, type, size);
303 grep_read_unlock();
304 return data;
305}
306static int grep_oid(struct grep_opt *opt, const struct object_id *oid,
308 const char *filename, int tree_name_len,
309 const char *path)
310{
311 struct strbuf pathbuf = STRBUF_INIT;
312 if (super_prefix) {
314 strbuf_add(&pathbuf, filename, tree_name_len);
315 strbuf_addstr(&pathbuf, super_prefix);
316 strbuf_addstr(&pathbuf, filename + tree_name_len);
317 } else {
318 strbuf_addstr(&pathbuf, filename);
319 }
320 if (opt->relative && opt->prefix_length) {
322 char *name = strbuf_detach(&pathbuf, NULL);
323 quote_path_relative(name + tree_name_len, opt->prefix, &pathbuf);
324 strbuf_insert(&pathbuf, 0, name, tree_name_len);
325 free(name);
326 }
327#ifndef NO_PTHREADS
329 if (num_threads) {
330 add_work(opt, GREP_SOURCE_SHA1, pathbuf.buf, path, oid);
331 strbuf_release(&pathbuf);
332 return 0;
333 } else
334#endif
335 {
336 struct grep_source gs;
337 int hit;
338 grep_source_init(&gs, GREP_SOURCE_SHA1, pathbuf.buf, path, oid);
340 strbuf_release(&pathbuf);
341 hit = grep_source(opt, &gs);
342 grep_source_clear(&gs);
344 return hit;
345 }
346}
347static int grep_file(struct grep_opt *opt, const char *filename)
349{
350 struct strbuf buf = STRBUF_INIT;
351 if (super_prefix)
353 strbuf_addstr(&buf, super_prefix);
354 strbuf_addstr(&buf, filename);
355 if (opt->relative && opt->prefix_length) {
357 char *name = strbuf_detach(&buf, NULL);
358 quote_path_relative(name, opt->prefix, &buf);
359 free(name);
360 }
361#ifndef NO_PTHREADS
363 if (num_threads) {
364 add_work(opt, GREP_SOURCE_FILE, buf.buf, filename, filename);
365 strbuf_release(&buf);
366 return 0;
367 } else
368#endif
369 {
370 struct grep_source gs;
371 int hit;
372 grep_source_init(&gs, GREP_SOURCE_FILE, buf.buf, filename, filename);
374 strbuf_release(&buf);
375 hit = grep_source(opt, &gs);
376 grep_source_clear(&gs);
378 return hit;
379 }
380}
381static void append_path(struct grep_opt *opt, const void *data, size_t len)
383{
384 struct string_list *path_list = opt->output_priv;
385 if (len == 1 && *(const char *)data == '\0')
387 return;
388 string_list_append(path_list, xstrndup(data, len));
389}
390static void run_pager(struct grep_opt *opt, const char *prefix)
392{
393 struct string_list *path_list = opt->output_priv;
394 struct child_process child = CHILD_PROCESS_INIT;
395 int i, status;
396 for (i = 0; i < path_list->nr; i++)
398 argv_array_push(&child.args, path_list->items[i].string);
399 child.dir = prefix;
400 child.use_shell = 1;
401 status = run_command(&child);
403 if (status)
404 exit(status);
405}
406static void compile_submodule_options(const struct grep_opt *opt,
408 const char **argv,
409 int cached, int untracked,
410 int opt_exclude, int use_index,
411 int pattern_type_arg)
412{
413 struct grep_pat *pattern;
414 if (recurse_submodules)
416 argv_array_push(&submodule_options, "--recurse-submodules");
417 if (cached)
419 argv_array_push(&submodule_options, "--cached");
420 if (!use_index)
421 argv_array_push(&submodule_options, "--no-index");
422 if (untracked)
423 argv_array_push(&submodule_options, "--untracked");
424 if (opt_exclude > 0)
425 argv_array_push(&submodule_options, "--exclude-standard");
426 if (opt->invert)
428 argv_array_push(&submodule_options, "-v");
429 if (opt->ignore_case)
430 argv_array_push(&submodule_options, "-i");
431 if (opt->word_regexp)
432 argv_array_push(&submodule_options, "-w");
433 switch (opt->binary) {
434 case GREP_BINARY_NOMATCH:
435 argv_array_push(&submodule_options, "-I");
436 break;
437 case GREP_BINARY_TEXT:
438 argv_array_push(&submodule_options, "-a");
439 break;
440 default:
441 break;
442 }
443 if (opt->allow_textconv)
444 argv_array_push(&submodule_options, "--textconv");
445 if (opt->max_depth != -1)
446 argv_array_pushf(&submodule_options, "--max-depth=%d",
447 opt->max_depth);
448 if (opt->linenum)
449 argv_array_push(&submodule_options, "-n");
450 if (!opt->pathname)
451 argv_array_push(&submodule_options, "-h");
452 if (!opt->relative)
453 argv_array_push(&submodule_options, "--full-name");
454 if (opt->name_only)
455 argv_array_push(&submodule_options, "-l");
456 if (opt->unmatch_name_only)
457 argv_array_push(&submodule_options, "-L");
458 if (opt->null_following_name)
459 argv_array_push(&submodule_options, "-z");
460 if (opt->count)
461 argv_array_push(&submodule_options, "-c");
462 if (opt->file_break)
463 argv_array_push(&submodule_options, "--break");
464 if (opt->heading)
465 argv_array_push(&submodule_options, "--heading");
466 if (opt->pre_context)
467 argv_array_pushf(&submodule_options, "--before-context=%d",
468 opt->pre_context);
469 if (opt->post_context)
470 argv_array_pushf(&submodule_options, "--after-context=%d",
471 opt->post_context);
472 if (opt->funcname)
473 argv_array_push(&submodule_options, "-p");
474 if (opt->funcbody)
475 argv_array_push(&submodule_options, "-W");
476 if (opt->all_match)
477 argv_array_push(&submodule_options, "--all-match");
478 if (opt->debug)
479 argv_array_push(&submodule_options, "--debug");
480 if (opt->status_only)
481 argv_array_push(&submodule_options, "-q");
482 switch (pattern_type_arg) {
484 case GREP_PATTERN_TYPE_BRE:
485 argv_array_push(&submodule_options, "-G");
486 break;
487 case GREP_PATTERN_TYPE_ERE:
488 argv_array_push(&submodule_options, "-E");
489 break;
490 case GREP_PATTERN_TYPE_FIXED:
491 argv_array_push(&submodule_options, "-F");
492 break;
493 case GREP_PATTERN_TYPE_PCRE:
494 argv_array_push(&submodule_options, "-P");
495 break;
496 case GREP_PATTERN_TYPE_UNSPECIFIED:
497 break;
498 default:
499 die("BUG: Added a new grep pattern type without updating switch statement");
500 }
501 for (pattern = opt->pattern_list; pattern != NULL;
503 pattern = pattern->next) {
504 switch (pattern->token) {
505 case GREP_PATTERN:
506 argv_array_pushf(&submodule_options, "-e%s",
507 pattern->pattern);
508 break;
509 case GREP_AND:
510 case GREP_OPEN_PAREN:
511 case GREP_CLOSE_PAREN:
512 case GREP_NOT:
513 case GREP_OR:
514 argv_array_push(&submodule_options, pattern->pattern);
515 break;
516 /* BODY and HEAD are not used by git-grep */
517 case GREP_PATTERN_BODY:
518 case GREP_PATTERN_HEAD:
519 break;
520 }
521 }
522 /*
524 * Limit number of threads for child process to use.
525 * This is to prevent potential fork-bomb behavior of git-grep as each
526 * submodule process has its own thread pool.
527 */
528 argv_array_pushf(&submodule_options, "--threads=%d",
529 (num_threads + 1) / 2);
530 /* Add Pathspecs */
532 argv_array_push(&submodule_options, "--");
533 for (; *argv; argv++)
534 argv_array_push(&submodule_options, *argv);
535}
536/*
538 * Launch child process to grep contents of a submodule
539 */
540static int grep_submodule_launch(struct grep_opt *opt,
541 const struct grep_source *gs)
542{
543 struct child_process cp = CHILD_PROCESS_INIT;
544 int status, i;
545 const char *end_of_base;
546 const char *name;
547 struct strbuf child_output = STRBUF_INIT;
548 end_of_base = strchr(gs->name, ':');
550 if (gs->identifier && end_of_base)
551 name = end_of_base + 1;
552 else
553 name = gs->name;
554 prepare_submodule_repo_env(&cp.env_array);
556 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
557 if (opt->relative && opt->prefix_length)
559 argv_array_pushf(&cp.env_array, "%s=%s",
560 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
561 opt->prefix);
562 /* Add super prefix */
564 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
565 super_prefix ? super_prefix : "",
566 name);
567 argv_array_push(&cp.args, "grep");
568 /*
570 * Add basename of parent project
571 * When performing grep on a tree object the filename is prefixed
572 * with the object's name: 'tree-name:filename'. In order to
573 * provide uniformity of output we want to pass the name of the
574 * parent project's object name to the submodule so the submodule can
575 * prefix its output with the parent's name and not its own SHA1.
576 */
577 if (gs->identifier && end_of_base)
578 argv_array_pushf(&cp.args, "--parent-basename=%.*s",
579 (int) (end_of_base - gs->name),
580 gs->name);
581 /* Add options */
583 for (i = 0; i < submodule_options.argc; i++) {
584 /*
585 * If there is a tree identifier for the submodule, add the
586 * rev after adding the submodule options but before the
587 * pathspecs. To do this we listen for the '--' and insert the
588 * sha1 before pushing the '--' onto the child process argv
589 * array.
590 */
591 if (gs->identifier &&
592 !strcmp("--", submodule_options.argv[i])) {
593 argv_array_push(&cp.args, sha1_to_hex(gs->identifier));
594 }
595 argv_array_push(&cp.args, submodule_options.argv[i]);
597 }
598 cp.git_cmd = 1;
600 cp.dir = gs->path;
601 /*
603 * Capture output to output buffer and check the return code from the
604 * child process. A '0' indicates a hit, a '1' indicates no hit and
605 * anything else is an error.
606 */
607 status = capture_command(&cp, &child_output, 0);
608 if (status && (status != 1)) {
609 /* flush the buffer */
610 write_or_die(1, child_output.buf, child_output.len);
611 die("process for submodule '%s' failed with exit code: %d",
612 gs->name, status);
613 }
614 opt->output(opt, child_output.buf, child_output.len);
616 strbuf_release(&child_output);
617 /* invert the return code to make a hit equal to 1 */
618 return !status;
619}
620/*
622 * Prep grep structures for a submodule grep
623 * sha1: the sha1 of the submodule or NULL if using the working tree
624 * filename: name of the submodule including tree name of parent
625 * path: location of the submodule
626 */
627static int grep_submodule(struct grep_opt *opt, const unsigned char *sha1,
628 const char *filename, const char *path)
629{
630 if (!is_submodule_initialized(path))
631 return 0;
632 if (!is_submodule_populated_gently(path, NULL)) {
633 /*
634 * If searching history, check for the presense of the
635 * submodule's gitdir before skipping the submodule.
636 */
637 if (sha1) {
638 const struct submodule *sub =
639 submodule_from_path(null_sha1, path);
640 if (sub)
641 path = git_path("modules/%s", sub->name);
642 if (!(is_directory(path) && is_git_directory(path)))
644 return 0;
645 } else {
646 return 0;
647 }
648 }
649#ifndef NO_PTHREADS
651 if (num_threads) {
652 add_work(opt, GREP_SOURCE_SUBMODULE, filename, path, sha1);
653 return 0;
654 } else
655#endif
656 {
657 struct grep_source gs;
658 int hit;
659 grep_source_init(&gs, GREP_SOURCE_SUBMODULE,
661 filename, path, sha1);
662 hit = grep_submodule_launch(opt, &gs);
663 grep_source_clear(&gs);
665 return hit;
666 }
667}
668static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec,
670 int cached)
671{
672 int hit = 0;
673 int nr;
674 struct strbuf name = STRBUF_INIT;
675 int name_base_len = 0;
676 if (super_prefix) {
677 name_base_len = strlen(super_prefix);
678 strbuf_addstr(&name, super_prefix);
679 }
680 read_cache();
682 for (nr = 0; nr < active_nr; nr++) {
684 const struct cache_entry *ce = active_cache[nr];
685 strbuf_setlen(&name, name_base_len);
686 strbuf_addstr(&name, ce->name);
687 if (S_ISREG(ce->ce_mode) &&
689 match_pathspec(pathspec, name.buf, name.len, 0, NULL,
690 S_ISDIR(ce->ce_mode) ||
691 S_ISGITLINK(ce->ce_mode))) {
692 /*
693 * If CE_VALID is on, we assume worktree file and its
694 * cache entry are identical, even if worktree file has
695 * been modified, so use cache version instead
696 */
697 if (cached || (ce->ce_flags & CE_VALID) ||
698 ce_skip_worktree(ce)) {
699 if (ce_stage(ce) || ce_intent_to_add(ce))
700 continue;
701 hit |= grep_oid(opt, &ce->oid, ce->name,
702 0, ce->name);
703 } else {
704 hit |= grep_file(opt, ce->name);
705 }
706 } else if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
707 submodule_path_match(pathspec, name.buf, NULL)) {
708 hit |= grep_submodule(opt, NULL, ce->name, ce->name);
709 } else {
710 continue;
711 }
712 if (ce_stage(ce)) {
714 do {
715 nr++;
716 } while (nr < active_nr &&
717 !strcmp(ce->name, active_cache[nr]->name));
718 nr--; /* compensate for loop control */
719 }
720 if (hit && opt->status_only)
721 break;
722 }
723 strbuf_release(&name);
725 return hit;
726}
727static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
729 struct tree_desc *tree, struct strbuf *base, int tn_len,
730 int check_attr)
731{
732 int hit = 0;
733 enum interesting match = entry_not_interesting;
734 struct name_entry entry;
735 int old_baselen = base->len;
736 struct strbuf name = STRBUF_INIT;
737 int name_base_len = 0;
738 if (super_prefix) {
739 strbuf_addstr(&name, super_prefix);
740 name_base_len = name.len;
741 }
742 while (tree_entry(tree, &entry)) {
744 int te_len = tree_entry_len(&entry);
745 if (match != all_entries_interesting) {
747 strbuf_addstr(&name, base->buf + tn_len);
748 match = tree_entry_interesting(&entry, &name,
749 0, pathspec);
750 strbuf_setlen(&name, name_base_len);
751 if (match == all_entries_not_interesting)
753 break;
754 if (match == entry_not_interesting)
755 continue;
756 }
757 strbuf_add(base, entry.path, te_len);
759 if (S_ISREG(entry.mode)) {
761 hit |= grep_oid(opt, entry.oid, base->buf, tn_len,
762 check_attr ? base->buf + tn_len : NULL);
763 } else if (S_ISDIR(entry.mode)) {
764 enum object_type type;
765 struct tree_desc sub;
766 void *data;
767 unsigned long size;
768 data = lock_and_read_oid_file(entry.oid, &type, &size);
770 if (!data)
771 die(_("unable to read tree (%s)"),
772 oid_to_hex(entry.oid));
773 strbuf_addch(base, '/');
775 init_tree_desc(&sub, data, size);
776 hit |= grep_tree(opt, pathspec, &sub, base, tn_len,
777 check_attr);
778 free(data);
779 } else if (recurse_submodules && S_ISGITLINK(entry.mode)) {
780 hit |= grep_submodule(opt, entry.oid->hash, base->buf,
781 base->buf + tn_len);
782 }
783 strbuf_setlen(base, old_baselen);
785 if (hit && opt->status_only)
787 break;
788 }
789 strbuf_release(&name);
791 return hit;
792}
793static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
795 struct object *obj, const char *name, const char *path)
796{
797 if (obj->type == OBJ_BLOB)
798 return grep_oid(opt, &obj->oid, name, 0, path);
799 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
800 struct tree_desc tree;
801 void *data;
802 unsigned long size;
803 struct strbuf base;
804 int hit, len;
805 grep_read_lock();
807 data = read_object_with_reference(obj->oid.hash, tree_type,
808 &size, NULL);
809 grep_read_unlock();
810 if (!data)
812 die(_("unable to read tree (%s)"), oid_to_hex(&obj->oid));
813 /* Use parent's name as base when recursing submodules */
815 if (recurse_submodules && parent_basename)
816 name = parent_basename;
817 len = name ? strlen(name) : 0;
819 strbuf_init(&base, PATH_MAX + len + 1);
820 if (len) {
821 strbuf_add(&base, name, len);
822 strbuf_addch(&base, ':');
823 }
824 init_tree_desc(&tree, data, size);
825 hit = grep_tree(opt, pathspec, &tree, &base, base.len,
826 obj->type == OBJ_COMMIT);
827 strbuf_release(&base);
828 free(data);
829 return hit;
830 }
831 die(_("unable to grep from object of type %s"), typename(obj->type));
832}
833static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
835 const struct object_array *list)
836{
837 unsigned int i;
838 int hit = 0;
839 const unsigned int nr = list->nr;
840 for (i = 0; i < nr; i++) {
842 struct object *real_obj;
843 real_obj = deref_tag(list->objects[i].item, NULL, 0);
844 /* load the gitmodules file for this rev */
846 if (recurse_submodules) {
847 submodule_free();
848 gitmodules_config_sha1(real_obj->oid.hash);
849 }
850 if (grep_object(opt, pathspec, real_obj, list->objects[i].name, list->objects[i].path)) {
851 hit = 1;
852 if (opt->status_only)
853 break;
854 }
855 }
856 return hit;
857}
858static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
860 int exc_std, int use_index)
861{
862 struct dir_struct dir;
863 int i, hit = 0;
864 memset(&dir, 0, sizeof(dir));
866 if (!use_index)
867 dir.flags |= DIR_NO_GITLINKS;
868 if (exc_std)
869 setup_standard_excludes(&dir);
870 fill_directory(&dir, pathspec);
872 for (i = 0; i < dir.nr; i++) {
873 if (!dir_path_match(dir.entries[i], pathspec, 0, NULL))
874 continue;
875 hit |= grep_file(opt, dir.entries[i]->name);
876 if (hit && opt->status_only)
877 break;
878 }
879 return hit;
880}
881static int context_callback(const struct option *opt, const char *arg,
883 int unset)
884{
885 struct grep_opt *grep_opt = opt->value;
886 int value;
887 const char *endp;
888 if (unset) {
890 grep_opt->pre_context = grep_opt->post_context = 0;
891 return 0;
892 }
893 value = strtol(arg, (char **)&endp, 10);
894 if (*endp) {
895 return error(_("switch `%c' expects a numerical value"),
896 opt->short_name);
897 }
898 grep_opt->pre_context = grep_opt->post_context = value;
899 return 0;
900}
901static int file_callback(const struct option *opt, const char *arg, int unset)
903{
904 struct grep_opt *grep_opt = opt->value;
905 int from_stdin = !strcmp(arg, "-");
906 FILE *patterns;
907 int lno = 0;
908 struct strbuf sb = STRBUF_INIT;
909 patterns = from_stdin ? stdin : fopen(arg, "r");
911 if (!patterns)
912 die_errno(_("cannot open '%s'"), arg);
913 while (strbuf_getline(&sb, patterns) == 0) {
914 /* ignore empty line like grep does */
915 if (sb.len == 0)
916 continue;
917 append_grep_pat(grep_opt, sb.buf, sb.len, arg, ++lno,
919 GREP_PATTERN);
920 }
921 if (!from_stdin)
922 fclose(patterns);
923 strbuf_release(&sb);
924 return 0;
925}
926static int not_callback(const struct option *opt, const char *arg, int unset)
928{
929 struct grep_opt *grep_opt = opt->value;
930 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
931 return 0;
932}
933static int and_callback(const struct option *opt, const char *arg, int unset)
935{
936 struct grep_opt *grep_opt = opt->value;
937 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
938 return 0;
939}
940static int open_callback(const struct option *opt, const char *arg, int unset)
942{
943 struct grep_opt *grep_opt = opt->value;
944 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
945 return 0;
946}
947static int close_callback(const struct option *opt, const char *arg, int unset)
949{
950 struct grep_opt *grep_opt = opt->value;
951 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
952 return 0;
953}
954static int pattern_callback(const struct option *opt, const char *arg,
956 int unset)
957{
958 struct grep_opt *grep_opt = opt->value;
959 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
960 return 0;
961}
962int cmd_grep(int argc, const char **argv, const char *prefix)
964{
965 int hit = 0;
966 int cached = 0, untracked = 0, opt_exclude = -1;
967 int seen_dashdash = 0;
968 int external_grep_allowed__ignored;
969 const char *show_in_pager = NULL, *default_pager = "dummy";
970 struct grep_opt opt;
971 struct object_array list = OBJECT_ARRAY_INIT;
972 struct pathspec pathspec;
973 struct string_list path_list = STRING_LIST_INIT_NODUP;
974 int i;
975 int dummy;
976 int use_index = 1;
977 int pattern_type_arg = GREP_PATTERN_TYPE_UNSPECIFIED;
978 int allow_revs;
979 struct option options[] = {
981 OPT_BOOL(0, "cached", &cached,
982 N_("search in index instead of in the work tree")),
983 OPT_NEGBIT(0, "no-index", &use_index,
984 N_("find in contents not managed by git"), 1),
985 OPT_BOOL(0, "untracked", &untracked,
986 N_("search in both tracked and untracked files")),
987 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
988 N_("ignore files specified via '.gitignore'"), 1),
989 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
990 N_("recursively search in each submodule")),
991 OPT_STRING(0, "parent-basename", &parent_basename,
992 N_("basename"),
993 N_("prepend parent project's basename to output")),
994 OPT_GROUP(""),
995 OPT_BOOL('v', "invert-match", &opt.invert,
996 N_("show non-matching lines")),
997 OPT_BOOL('i', "ignore-case", &opt.ignore_case,
998 N_("case insensitive matching")),
999 OPT_BOOL('w', "word-regexp", &opt.word_regexp,
1000 N_("match patterns only at word boundaries")),
1001 OPT_SET_INT('a', "text", &opt.binary,
1002 N_("process binary files as text"), GREP_BINARY_TEXT),
1003 OPT_SET_INT('I', NULL, &opt.binary,
1004 N_("don't match patterns in binary files"),
1005 GREP_BINARY_NOMATCH),
1006 OPT_BOOL(0, "textconv", &opt.allow_textconv,
1007 N_("process binary files with textconv filters")),
1008 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, N_("depth"),
1009 N_("descend at most <depth> levels"), PARSE_OPT_NONEG,
1010 NULL, 1 },
1011 OPT_GROUP(""),
1012 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg,
1013 N_("use extended POSIX regular expressions"),
1014 GREP_PATTERN_TYPE_ERE),
1015 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg,
1016 N_("use basic POSIX regular expressions (default)"),
1017 GREP_PATTERN_TYPE_BRE),
1018 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg,
1019 N_("interpret patterns as fixed strings"),
1020 GREP_PATTERN_TYPE_FIXED),
1021 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg,
1022 N_("use Perl-compatible regular expressions"),
1023 GREP_PATTERN_TYPE_PCRE),
1024 OPT_GROUP(""),
1025 OPT_BOOL('n', "line-number", &opt.linenum, N_("show line numbers")),
1026 OPT_NEGBIT('h', NULL, &opt.pathname, N_("don't show filenames"), 1),
1027 OPT_BIT('H', NULL, &opt.pathname, N_("show filenames"), 1),
1028 OPT_NEGBIT(0, "full-name", &opt.relative,
1029 N_("show filenames relative to top directory"), 1),
1030 OPT_BOOL('l', "files-with-matches", &opt.name_only,
1031 N_("show only filenames instead of matching lines")),
1032 OPT_BOOL(0, "name-only", &opt.name_only,
1033 N_("synonym for --files-with-matches")),
1034 OPT_BOOL('L', "files-without-match",
1035 &opt.unmatch_name_only,
1036 N_("show only the names of files without match")),
1037 OPT_BOOL('z', "null", &opt.null_following_name,
1038 N_("print NUL after filenames")),
1039 OPT_BOOL('c', "count", &opt.count,
1040 N_("show the number of matches instead of matching lines")),
1041 OPT__COLOR(&opt.color, N_("highlight matches")),
1042 OPT_BOOL(0, "break", &opt.file_break,
1043 N_("print empty line between matches from different files")),
1044 OPT_BOOL(0, "heading", &opt.heading,
1045 N_("show filename only once above matches from same file")),
1046 OPT_GROUP(""),
1047 OPT_CALLBACK('C', "context", &opt, N_("n"),
1048 N_("show <n> context lines before and after matches"),
1049 context_callback),
1050 OPT_INTEGER('B', "before-context", &opt.pre_context,
1051 N_("show <n> context lines before matches")),
1052 OPT_INTEGER('A', "after-context", &opt.post_context,
1053 N_("show <n> context lines after matches")),
1054 OPT_INTEGER(0, "threads", &num_threads,
1055 N_("use <n> worker threads")),
1056 OPT_NUMBER_CALLBACK(&opt, N_("shortcut for -C NUM"),
1057 context_callback),
1058 OPT_BOOL('p', "show-function", &opt.funcname,
1059 N_("show a line with the function name before matches")),
1060 OPT_BOOL('W', "function-context", &opt.funcbody,
1061 N_("show the surrounding function")),
1062 OPT_GROUP(""),
1063 OPT_CALLBACK('f', NULL, &opt, N_("file"),
1064 N_("read patterns from file"), file_callback),
1065 { OPTION_CALLBACK, 'e', NULL, &opt, N_("pattern"),
1066 N_("match <pattern>"), PARSE_OPT_NONEG, pattern_callback },
1067 { OPTION_CALLBACK, 0, "and", &opt, NULL,
1068 N_("combine patterns specified with -e"),
1069 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
1070 OPT_BOOL(0, "or", &dummy, ""),
1071 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
1072 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
1073 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
1074 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
1075 open_callback },
1076 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
1077 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
1078 close_callback },
1079 OPT__QUIET(&opt.status_only,
1080 N_("indicate hit with exit status without output")),
1081 OPT_BOOL(0, "all-match", &opt.all_match,
1082 N_("show only matches from files that match all patterns")),
1083 { OPTION_SET_INT, 0, "debug", &opt.debug, NULL,
1084 N_("show parse tree for grep expression"),
1085 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1 },
1086 OPT_GROUP(""),
1087 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
1088 N_("pager"), N_("show matching files in the pager"),
1089 PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
1090 OPT_BOOL(0, "ext-grep", &external_grep_allowed__ignored,
1091 N_("allow calling of grep(1) (ignored by this build)")),
1092 OPT_END()
1093 };
1094 init_grep_defaults();
1096 git_config(grep_cmd_config, NULL);
1097 grep_init(&opt, prefix);
1098 super_prefix = get_super_prefix();
1099 /*
1101 * If there is no -- then the paths must exist in the working
1102 * tree. If there is no explicit pattern specified with -e or
1103 * -f, we take the first unrecognized non option to be the
1104 * pattern, but then what follows it must be zero or more
1105 * valid refs up to the -- (if exists), and then existing
1106 * paths. If there is an explicit pattern, then the first
1107 * unrecognized non option is the beginning of the refs list
1108 * that continues up to the -- (if exists), and then paths.
1109 */
1110 argc = parse_options(argc, argv, prefix, options, grep_usage,
1111 PARSE_OPT_KEEP_DASHDASH |
1112 PARSE_OPT_STOP_AT_NON_OPTION);
1113 grep_commit_pattern_type(pattern_type_arg, &opt);
1114 if (use_index && !startup_info->have_repository) {
1116 int fallback = 0;
1117 git_config_get_bool("grep.fallbacktonoindex", &fallback);
1118 if (fallback)
1119 use_index = 0;
1120 else
1121 /* die the same way as if we did it at the beginning */
1122 setup_git_directory();
1123 }
1124 /*
1126 * skip a -- separator; we know it cannot be
1127 * separating revisions from pathnames if
1128 * we haven't even had any patterns yet
1129 */
1130 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
1131 argv++;
1132 argc--;
1133 }
1134 /* First unrecognized non-option token */
1136 if (argc > 0 && !opt.pattern_list) {
1137 append_grep_pattern(&opt, argv[0], "command line", 0,
1138 GREP_PATTERN);
1139 argv++;
1140 argc--;
1141 }
1142 if (show_in_pager == default_pager)
1144 show_in_pager = git_pager(1);
1145 if (show_in_pager) {
1146 opt.color = 0;
1147 opt.name_only = 1;
1148 opt.null_following_name = 1;
1149 opt.output_priv = &path_list;
1150 opt.output = append_path;
1151 string_list_append(&path_list, show_in_pager);
1152 }
1153 if (!opt.pattern_list)
1155 die(_("no pattern given."));
1156 if (!opt.fixed && opt.ignore_case)
1157 opt.regflags |= REG_ICASE;
1158 compile_grep_patterns(&opt);
1160 /*
1162 * We have to find "--" in a separate pass, because its presence
1163 * influences how we will parse arguments that come before it.
1164 */
1165 for (i = 0; i < argc; i++) {
1166 if (!strcmp(argv[i], "--")) {
1167 seen_dashdash = 1;
1168 break;
1169 }
1170 }
1171 /*
1173 * Resolve any rev arguments. If we have a dashdash, then everything up
1174 * to it must resolve as a rev. If not, then we stop at the first
1175 * non-rev and assume everything else is a path.
1176 */
1177 allow_revs = use_index && !untracked;
1178 for (i = 0; i < argc; i++) {
1179 const char *arg = argv[i];
1180 struct object_id oid;
1181 struct object_context oc;
1182 struct object *object;
1183 if (!strcmp(arg, "--")) {
1185 i++;
1186 break;
1187 }
1188 if (!allow_revs) {
1190 if (seen_dashdash)
1191 die(_("--no-index or --untracked cannot be used with revs"));
1192 break;
1193 }
1194 if (get_sha1_with_context(arg, 0, oid.hash, &oc)) {
1196 if (seen_dashdash)
1197 die(_("unable to resolve revision: %s"), arg);
1198 break;
1199 }
1200 object = parse_object_or_die(oid.hash, arg);
1202 if (!seen_dashdash)
1203 verify_non_filename(prefix, arg);
1204 add_object_array_with_path(object, arg, &list, oc.mode, oc.path);
1205 }
1206 /*
1208 * Anything left over is presumed to be a path. But in the non-dashdash
1209 * "do what I mean" case, we verify and complain when that isn't true.
1210 */
1211 if (!seen_dashdash) {
1212 int j;
1213 for (j = i; j < argc; j++)
1214 verify_filename(prefix, argv[j], j == i && allow_revs);
1215 }
1216 parse_pathspec(&pathspec, 0,
1218 PATHSPEC_PREFER_CWD |
1219 (opt.max_depth != -1 ? PATHSPEC_MAXDEPTH_VALID : 0),
1220 prefix, argv + i);
1221 pathspec.max_depth = opt.max_depth;
1222 pathspec.recursive = 1;
1223#ifndef NO_PTHREADS
1225 if (list.nr || cached || show_in_pager)
1226 num_threads = 0;
1227 else if (num_threads == 0)
1228 num_threads = GREP_NUM_THREADS_DEFAULT;
1229 else if (num_threads < 0)
1230 die(_("invalid number of threads specified (%d)"), num_threads);
1231#else
1232 num_threads = 0;
1233#endif
1234#ifndef NO_PTHREADS
1236 if (num_threads) {
1237 if (!(opt.name_only || opt.unmatch_name_only || opt.count)
1238 && (opt.pre_context || opt.post_context ||
1239 opt.file_break || opt.funcbody))
1240 skip_first_line = 1;
1241 start_threads(&opt);
1242 }
1243#endif
1244 if (recurse_submodules) {
1246 gitmodules_config();
1247 compile_submodule_options(&opt, argv + i, cached, untracked,
1248 opt_exclude, use_index,
1249 pattern_type_arg);
1250 }
1251 if (show_in_pager && (cached || list.nr))
1253 die(_("--open-files-in-pager only works on the worktree"));
1254 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
1256 const char *pager = path_list.items[0].string;
1257 int len = strlen(pager);
1258 if (len > 4 && is_dir_sep(pager[len - 5]))
1260 pager += len - 4;
1261 if (opt.ignore_case && !strcmp("less", pager))
1263 string_list_append(&path_list, "-I");
1264 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
1266 struct strbuf buf = STRBUF_INIT;
1267 strbuf_addf(&buf, "+/%s%s",
1268 strcmp("less", pager) ? "" : "*",
1269 opt.pattern_list->pattern);
1270 string_list_append(&path_list, buf.buf);
1271 strbuf_detach(&buf, NULL);
1272 }
1273 }
1274 if (recurse_submodules && (!use_index || untracked))
1276 die(_("option not supported with --recurse-submodules."));
1277 if (!show_in_pager && !opt.status_only)
1279 setup_pager();
1280 if (!use_index && (untracked || cached))
1282 die(_("--cached or --untracked cannot be used with --no-index."));
1283 if (!use_index || untracked) {
1285 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
1286 hit = grep_directory(&opt, &pathspec, use_exclude, use_index);
1287 } else if (0 <= opt_exclude) {
1288 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1289 } else if (!list.nr) {
1290 if (!cached)
1291 setup_work_tree();
1292 hit = grep_cache(&opt, &pathspec, cached);
1294 } else {
1295 if (cached)
1296 die(_("both --cached and trees are given."));
1297 hit = grep_objects(&opt, &pathspec, &list);
1298 }
1299 if (num_threads)
1301 hit |= wait_all();
1302 if (hit && show_in_pager)
1303 run_pager(&opt, prefix);
1304 clear_pathspec(&pathspec);
1305 free_grep_patterns(&opt);
1306 return !hit;
1307}