4 * Copyright (c) 2006 Junio C Hamano
12 #include "tree-walk.h"
14 #include "parse-options.h"
15 #include "string-list.h"
16 #include "run-command.h"
22 #include "submodule.h"
23 #include "submodule-config.h"
25 static char const * const grep_usage[] = {
26 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
30 static const char *super_prefix;
31 static int recurse_submodules;
32 static struct argv_array submodule_options = ARGV_ARRAY_INIT;
33 static const char *parent_basename;
35 static int grep_submodule_launch(struct grep_opt *opt,
36 const struct grep_source *gs);
38 #define GREP_NUM_THREADS_DEFAULT 8
39 static int num_threads;
42 static pthread_t *threads;
44 /* We use one producer thread and THREADS consumer
45 * threads. The producer adds struct work_items to 'todo' and the
46 * consumers pick work items from the same array.
49 struct grep_source source;
54 /* In the range [todo_done, todo_start) in 'todo' we have work_items
55 * that have been or are processed by a consumer thread. We haven't
56 * written the result for these to stdout yet.
58 * The work_items in [todo_start, todo_end) are waiting to be picked
59 * up by a consumer thread.
61 * The ranges are modulo TODO_SIZE.
64 static struct work_item todo[TODO_SIZE];
65 static int todo_start;
69 /* Has all work items been added? */
70 static int all_work_added;
72 /* This lock protects all the variables above. */
73 static pthread_mutex_t grep_mutex;
75 static inline void grep_lock(void)
78 pthread_mutex_lock(&grep_mutex);
81 static inline void grep_unlock(void)
84 pthread_mutex_unlock(&grep_mutex);
87 /* Signalled when a new work_item is added to todo. */
88 static pthread_cond_t cond_add;
90 /* Signalled when the result from one work_item is written to
93 static pthread_cond_t cond_write;
95 /* Signalled when we are finished with everything. */
96 static pthread_cond_t cond_result;
98 static int skip_first_line;
100 static void add_work(struct grep_opt *opt, enum grep_source_type type,
101 const char *name, const char *path, const void *id)
105 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
106 pthread_cond_wait(&cond_write, &grep_mutex);
109 grep_source_init(&todo[todo_end].source, type, name, path, id);
110 if (opt->binary != GREP_BINARY_TEXT)
111 grep_source_load_driver(&todo[todo_end].source);
112 todo[todo_end].done = 0;
113 strbuf_reset(&todo[todo_end].out);
114 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
116 pthread_cond_signal(&cond_add);
120 static struct work_item *get_work(void)
122 struct work_item *ret;
125 while (todo_start == todo_end && !all_work_added) {
126 pthread_cond_wait(&cond_add, &grep_mutex);
129 if (todo_start == todo_end && all_work_added) {
132 ret = &todo[todo_start];
133 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
139 static void work_done(struct work_item *w)
145 old_done = todo_done;
146 for(; todo[todo_done].done && todo_done != todo_start;
147 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
148 w = &todo[todo_done];
150 const char *p = w->out.buf;
151 size_t len = w->out.len;
153 /* Skip the leading hunk mark of the first file. */
154 if (skip_first_line) {
163 write_or_die(1, p, len);
165 grep_source_clear(&w->source);
168 if (old_done != todo_done)
169 pthread_cond_signal(&cond_write);
171 if (all_work_added && todo_done == todo_end)
172 pthread_cond_signal(&cond_result);
177 static void *run(void *arg)
180 struct grep_opt *opt = arg;
183 struct work_item *w = get_work();
187 opt->output_priv = w;
188 if (w->source.type == GREP_SOURCE_SUBMODULE)
189 hit |= grep_submodule_launch(opt, &w->source);
191 hit |= grep_source(opt, &w->source);
192 grep_source_clear_data(&w->source);
195 free_grep_patterns(arg);
198 return (void*) (intptr_t) hit;
201 static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
203 struct work_item *w = opt->output_priv;
204 strbuf_add(&w->out, buf, size);
207 static void start_threads(struct grep_opt *opt)
211 pthread_mutex_init(&grep_mutex, NULL);
212 pthread_mutex_init(&grep_read_mutex, NULL);
213 pthread_mutex_init(&grep_attr_mutex, NULL);
214 pthread_cond_init(&cond_add, NULL);
215 pthread_cond_init(&cond_write, NULL);
216 pthread_cond_init(&cond_result, NULL);
219 for (i = 0; i < ARRAY_SIZE(todo); i++) {
220 strbuf_init(&todo[i].out, 0);
223 threads = xcalloc(num_threads, sizeof(*threads));
224 for (i = 0; i < num_threads; i++) {
226 struct grep_opt *o = grep_opt_dup(opt);
227 o->output = strbuf_out;
229 compile_grep_patterns(o);
230 err = pthread_create(&threads[i], NULL, run, o);
233 die(_("grep: failed to create thread: %s"),
238 static int wait_all(void)
246 /* Wait until all work is done. */
247 while (todo_done != todo_end)
248 pthread_cond_wait(&cond_result, &grep_mutex);
250 /* Wake up all the consumer threads so they can see that there
251 * is no more work to do.
253 pthread_cond_broadcast(&cond_add);
256 for (i = 0; i < num_threads; i++) {
258 pthread_join(threads[i], &h);
259 hit |= (int) (intptr_t) h;
264 pthread_mutex_destroy(&grep_mutex);
265 pthread_mutex_destroy(&grep_read_mutex);
266 pthread_mutex_destroy(&grep_attr_mutex);
267 pthread_cond_destroy(&cond_add);
268 pthread_cond_destroy(&cond_write);
269 pthread_cond_destroy(&cond_result);
274 #else /* !NO_PTHREADS */
276 static int wait_all(void)
282 static int grep_cmd_config(const char *var, const char *value, void *cb)
284 int st = grep_config(var, value, cb);
285 if (git_color_default_config(var, value, cb) < 0)
288 if (!strcmp(var, "grep.threads")) {
289 num_threads = git_config_int(var, value);
291 die(_("invalid number of threads specified (%d) for %s"),
298 static void *lock_and_read_oid_file(const struct object_id *oid, enum object_type *type, unsigned long *size)
303 data = read_sha1_file(oid->hash, type, size);
308 static int grep_oid(struct grep_opt *opt, const struct object_id *oid,
309 const char *filename, int tree_name_len,
312 struct strbuf pathbuf = STRBUF_INIT;
315 strbuf_add(&pathbuf, filename, tree_name_len);
316 strbuf_addstr(&pathbuf, super_prefix);
317 strbuf_addstr(&pathbuf, filename + tree_name_len);
319 strbuf_addstr(&pathbuf, filename);
322 if (opt->relative && opt->prefix_length) {
323 char *name = strbuf_detach(&pathbuf, NULL);
324 quote_path_relative(name + tree_name_len, opt->prefix, &pathbuf);
325 strbuf_insert(&pathbuf, 0, name, tree_name_len);
331 add_work(opt, GREP_SOURCE_SHA1, pathbuf.buf, path, oid);
332 strbuf_release(&pathbuf);
337 struct grep_source gs;
340 grep_source_init(&gs, GREP_SOURCE_SHA1, pathbuf.buf, path, oid);
341 strbuf_release(&pathbuf);
342 hit = grep_source(opt, &gs);
344 grep_source_clear(&gs);
349 static int grep_file(struct grep_opt *opt, const char *filename)
351 struct strbuf buf = STRBUF_INIT;
354 strbuf_addstr(&buf, super_prefix);
355 strbuf_addstr(&buf, filename);
357 if (opt->relative && opt->prefix_length) {
358 char *name = strbuf_detach(&buf, NULL);
359 quote_path_relative(name, opt->prefix, &buf);
365 add_work(opt, GREP_SOURCE_FILE, buf.buf, filename, filename);
366 strbuf_release(&buf);
371 struct grep_source gs;
374 grep_source_init(&gs, GREP_SOURCE_FILE, buf.buf, filename, filename);
375 strbuf_release(&buf);
376 hit = grep_source(opt, &gs);
378 grep_source_clear(&gs);
383 static void append_path(struct grep_opt *opt, const void *data, size_t len)
385 struct string_list *path_list = opt->output_priv;
387 if (len == 1 && *(const char *)data == '\0')
389 string_list_append(path_list, xstrndup(data, len));
392 static void run_pager(struct grep_opt *opt, const char *prefix)
394 struct string_list *path_list = opt->output_priv;
395 struct child_process child = CHILD_PROCESS_INIT;
398 for (i = 0; i < path_list->nr; i++)
399 argv_array_push(&child.args, path_list->items[i].string);
403 status = run_command(&child);
408 static void compile_submodule_options(const struct grep_opt *opt,
410 int cached, int untracked,
411 int opt_exclude, int use_index,
412 int pattern_type_arg)
414 struct grep_pat *pattern;
416 if (recurse_submodules)
417 argv_array_push(&submodule_options, "--recurse-submodules");
420 argv_array_push(&submodule_options, "--cached");
422 argv_array_push(&submodule_options, "--no-index");
424 argv_array_push(&submodule_options, "--untracked");
426 argv_array_push(&submodule_options, "--exclude-standard");
429 argv_array_push(&submodule_options, "-v");
430 if (opt->ignore_case)
431 argv_array_push(&submodule_options, "-i");
432 if (opt->word_regexp)
433 argv_array_push(&submodule_options, "-w");
434 switch (opt->binary) {
435 case GREP_BINARY_NOMATCH:
436 argv_array_push(&submodule_options, "-I");
438 case GREP_BINARY_TEXT:
439 argv_array_push(&submodule_options, "-a");
444 if (opt->allow_textconv)
445 argv_array_push(&submodule_options, "--textconv");
446 if (opt->max_depth != -1)
447 argv_array_pushf(&submodule_options, "--max-depth=%d",
450 argv_array_push(&submodule_options, "-n");
452 argv_array_push(&submodule_options, "-h");
454 argv_array_push(&submodule_options, "--full-name");
456 argv_array_push(&submodule_options, "-l");
457 if (opt->unmatch_name_only)
458 argv_array_push(&submodule_options, "-L");
459 if (opt->null_following_name)
460 argv_array_push(&submodule_options, "-z");
462 argv_array_push(&submodule_options, "-c");
464 argv_array_push(&submodule_options, "--break");
466 argv_array_push(&submodule_options, "--heading");
467 if (opt->pre_context)
468 argv_array_pushf(&submodule_options, "--before-context=%d",
470 if (opt->post_context)
471 argv_array_pushf(&submodule_options, "--after-context=%d",
474 argv_array_push(&submodule_options, "-p");
476 argv_array_push(&submodule_options, "-W");
478 argv_array_push(&submodule_options, "--all-match");
480 argv_array_push(&submodule_options, "--debug");
481 if (opt->status_only)
482 argv_array_push(&submodule_options, "-q");
484 switch (pattern_type_arg) {
485 case GREP_PATTERN_TYPE_BRE:
486 argv_array_push(&submodule_options, "-G");
488 case GREP_PATTERN_TYPE_ERE:
489 argv_array_push(&submodule_options, "-E");
491 case GREP_PATTERN_TYPE_FIXED:
492 argv_array_push(&submodule_options, "-F");
494 case GREP_PATTERN_TYPE_PCRE:
495 argv_array_push(&submodule_options, "-P");
497 case GREP_PATTERN_TYPE_UNSPECIFIED:
501 for (pattern = opt->pattern_list; pattern != NULL;
502 pattern = pattern->next) {
503 switch (pattern->token) {
505 argv_array_pushf(&submodule_options, "-e%s",
509 case GREP_OPEN_PAREN:
510 case GREP_CLOSE_PAREN:
513 argv_array_push(&submodule_options, pattern->pattern);
515 /* BODY and HEAD are not used by git-grep */
516 case GREP_PATTERN_BODY:
517 case GREP_PATTERN_HEAD:
523 * Limit number of threads for child process to use.
524 * This is to prevent potential fork-bomb behavior of git-grep as each
525 * submodule process has its own thread pool.
527 argv_array_pushf(&submodule_options, "--threads=%d",
528 (num_threads + 1) / 2);
531 argv_array_push(&submodule_options, "--");
532 for (; *argv; argv++)
533 argv_array_push(&submodule_options, *argv);
537 * Launch child process to grep contents of a submodule
539 static int grep_submodule_launch(struct grep_opt *opt,
540 const struct grep_source *gs)
542 struct child_process cp = CHILD_PROCESS_INIT;
544 const char *end_of_base;
546 struct strbuf child_output = STRBUF_INIT;
548 end_of_base = strchr(gs->name, ':');
549 if (gs->identifier && end_of_base)
550 name = end_of_base + 1;
554 prepare_submodule_repo_env(&cp.env_array);
555 argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
557 if (opt->relative && opt->prefix_length)
558 argv_array_pushf(&cp.env_array, "%s=%s",
559 GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
562 /* Add super prefix */
563 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
564 super_prefix ? super_prefix : "",
566 argv_array_push(&cp.args, "grep");
569 * Add basename of parent project
570 * When performing grep on a tree object the filename is prefixed
571 * with the object's name: 'tree-name:filename'. In order to
572 * provide uniformity of output we want to pass the name of the
573 * parent project's object name to the submodule so the submodule can
574 * prefix its output with the parent's name and not its own SHA1.
576 if (gs->identifier && end_of_base)
577 argv_array_pushf(&cp.args, "--parent-basename=%.*s",
578 (int) (end_of_base - gs->name),
582 for (i = 0; i < submodule_options.argc; i++) {
584 * If there is a tree identifier for the submodule, add the
585 * rev after adding the submodule options but before the
586 * pathspecs. To do this we listen for the '--' and insert the
587 * sha1 before pushing the '--' onto the child process argv
590 if (gs->identifier &&
591 !strcmp("--", submodule_options.argv[i])) {
592 argv_array_push(&cp.args, sha1_to_hex(gs->identifier));
595 argv_array_push(&cp.args, submodule_options.argv[i]);
602 * Capture output to output buffer and check the return code from the
603 * child process. A '0' indicates a hit, a '1' indicates no hit and
604 * anything else is an error.
606 status = capture_command(&cp, &child_output, 0);
607 if (status && (status != 1)) {
608 /* flush the buffer */
609 write_or_die(1, child_output.buf, child_output.len);
610 die("process for submodule '%s' failed with exit code: %d",
614 opt->output(opt, child_output.buf, child_output.len);
615 strbuf_release(&child_output);
616 /* invert the return code to make a hit equal to 1 */
621 * Prep grep structures for a submodule grep
622 * sha1: the sha1 of the submodule or NULL if using the working tree
623 * filename: name of the submodule including tree name of parent
624 * path: location of the submodule
626 static int grep_submodule(struct grep_opt *opt, const unsigned char *sha1,
627 const char *filename, const char *path)
629 if (!is_submodule_initialized(path))
631 if (!is_submodule_populated_gently(path, NULL)) {
633 * If searching history, check for the presense of the
634 * submodule's gitdir before skipping the submodule.
637 const struct submodule *sub =
638 submodule_from_path(null_sha1, path);
640 path = git_path("modules/%s", sub->name);
642 if (!(is_directory(path) && is_git_directory(path)))
651 add_work(opt, GREP_SOURCE_SUBMODULE, filename, path, sha1);
656 struct grep_source gs;
659 grep_source_init(&gs, GREP_SOURCE_SUBMODULE,
660 filename, path, sha1);
661 hit = grep_submodule_launch(opt, &gs);
663 grep_source_clear(&gs);
668 static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec,
673 struct strbuf name = STRBUF_INIT;
674 int name_base_len = 0;
676 name_base_len = strlen(super_prefix);
677 strbuf_addstr(&name, super_prefix);
682 for (nr = 0; nr < active_nr; nr++) {
683 const struct cache_entry *ce = active_cache[nr];
684 strbuf_setlen(&name, name_base_len);
685 strbuf_addstr(&name, ce->name);
687 if (S_ISREG(ce->ce_mode) &&
688 match_pathspec(pathspec, name.buf, name.len, 0, NULL,
689 S_ISDIR(ce->ce_mode) ||
690 S_ISGITLINK(ce->ce_mode))) {
692 * If CE_VALID is on, we assume worktree file and its
693 * cache entry are identical, even if worktree file has
694 * been modified, so use cache version instead
696 if (cached || (ce->ce_flags & CE_VALID) ||
697 ce_skip_worktree(ce)) {
698 if (ce_stage(ce) || ce_intent_to_add(ce))
700 hit |= grep_oid(opt, &ce->oid, ce->name,
703 hit |= grep_file(opt, ce->name);
705 } else if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
706 submodule_path_match(pathspec, name.buf, NULL)) {
707 hit |= grep_submodule(opt, NULL, ce->name, ce->name);
715 } while (nr < active_nr &&
716 !strcmp(ce->name, active_cache[nr]->name));
717 nr--; /* compensate for loop control */
719 if (hit && opt->status_only)
723 strbuf_release(&name);
727 static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
728 struct tree_desc *tree, struct strbuf *base, int tn_len,
732 enum interesting match = entry_not_interesting;
733 struct name_entry entry;
734 int old_baselen = base->len;
735 struct strbuf name = STRBUF_INIT;
736 int name_base_len = 0;
738 strbuf_addstr(&name, super_prefix);
739 name_base_len = name.len;
742 while (tree_entry(tree, &entry)) {
743 int te_len = tree_entry_len(&entry);
745 if (match != all_entries_interesting) {
746 strbuf_addstr(&name, base->buf + tn_len);
747 match = tree_entry_interesting(&entry, &name,
749 strbuf_setlen(&name, name_base_len);
751 if (match == all_entries_not_interesting)
753 if (match == entry_not_interesting)
757 strbuf_add(base, entry.path, te_len);
759 if (S_ISREG(entry.mode)) {
760 hit |= grep_oid(opt, entry.oid, base->buf, tn_len,
761 check_attr ? base->buf + tn_len : NULL);
762 } else if (S_ISDIR(entry.mode)) {
763 enum object_type type;
764 struct tree_desc sub;
768 data = lock_and_read_oid_file(entry.oid, &type, &size);
770 die(_("unable to read tree (%s)"),
771 oid_to_hex(entry.oid));
773 strbuf_addch(base, '/');
774 init_tree_desc(&sub, data, size);
775 hit |= grep_tree(opt, pathspec, &sub, base, tn_len,
778 } else if (recurse_submodules && S_ISGITLINK(entry.mode)) {
779 hit |= grep_submodule(opt, entry.oid->hash, base->buf,
783 strbuf_setlen(base, old_baselen);
785 if (hit && opt->status_only)
789 strbuf_release(&name);
793 static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
794 struct object *obj, const char *name, const char *path)
796 if (obj->type == OBJ_BLOB)
797 return grep_oid(opt, &obj->oid, name, 0, path);
798 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
799 struct tree_desc tree;
806 data = read_object_with_reference(obj->oid.hash, tree_type,
811 die(_("unable to read tree (%s)"), oid_to_hex(&obj->oid));
813 /* Use parent's name as base when recursing submodules */
814 if (recurse_submodules && parent_basename)
815 name = parent_basename;
817 len = name ? strlen(name) : 0;
818 strbuf_init(&base, PATH_MAX + len + 1);
820 strbuf_add(&base, name, len);
821 strbuf_addch(&base, ':');
823 init_tree_desc(&tree, data, size);
824 hit = grep_tree(opt, pathspec, &tree, &base, base.len,
825 obj->type == OBJ_COMMIT);
826 strbuf_release(&base);
830 die(_("unable to grep from object of type %s"), typename(obj->type));
833 static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
834 const struct object_array *list)
838 const unsigned int nr = list->nr;
840 for (i = 0; i < nr; i++) {
841 struct object *real_obj;
842 real_obj = deref_tag(list->objects[i].item, NULL, 0);
844 /* load the gitmodules file for this rev */
845 if (recurse_submodules) {
847 gitmodules_config_sha1(real_obj->oid.hash);
849 if (grep_object(opt, pathspec, real_obj, list->objects[i].name, list->objects[i].path)) {
851 if (opt->status_only)
858 static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
859 int exc_std, int use_index)
861 struct dir_struct dir;
864 memset(&dir, 0, sizeof(dir));
866 dir.flags |= DIR_NO_GITLINKS;
868 setup_standard_excludes(&dir);
870 fill_directory(&dir, pathspec);
871 for (i = 0; i < dir.nr; i++) {
872 if (!dir_path_match(dir.entries[i], pathspec, 0, NULL))
874 hit |= grep_file(opt, dir.entries[i]->name);
875 if (hit && opt->status_only)
881 static int context_callback(const struct option *opt, const char *arg,
884 struct grep_opt *grep_opt = opt->value;
889 grep_opt->pre_context = grep_opt->post_context = 0;
892 value = strtol(arg, (char **)&endp, 10);
894 return error(_("switch `%c' expects a numerical value"),
897 grep_opt->pre_context = grep_opt->post_context = value;
901 static int file_callback(const struct option *opt, const char *arg, int unset)
903 struct grep_opt *grep_opt = opt->value;
904 int from_stdin = !strcmp(arg, "-");
907 struct strbuf sb = STRBUF_INIT;
909 patterns = from_stdin ? stdin : fopen(arg, "r");
911 die_errno(_("cannot open '%s'"), arg);
912 while (strbuf_getline(&sb, patterns) == 0) {
913 /* ignore empty line like grep does */
917 append_grep_pat(grep_opt, sb.buf, sb.len, arg, ++lno,
926 static int not_callback(const struct option *opt, const char *arg, int unset)
928 struct grep_opt *grep_opt = opt->value;
929 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
933 static int and_callback(const struct option *opt, const char *arg, int unset)
935 struct grep_opt *grep_opt = opt->value;
936 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
940 static int open_callback(const struct option *opt, const char *arg, int unset)
942 struct grep_opt *grep_opt = opt->value;
943 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
947 static int close_callback(const struct option *opt, const char *arg, int unset)
949 struct grep_opt *grep_opt = opt->value;
950 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
954 static int pattern_callback(const struct option *opt, const char *arg,
957 struct grep_opt *grep_opt = opt->value;
958 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
962 int cmd_grep(int argc, const char **argv, const char *prefix)
965 int cached = 0, untracked = 0, opt_exclude = -1;
966 int seen_dashdash = 0;
967 int external_grep_allowed__ignored;
968 const char *show_in_pager = NULL, *default_pager = "dummy";
970 struct object_array list = OBJECT_ARRAY_INIT;
971 struct pathspec pathspec;
972 struct string_list path_list = STRING_LIST_INIT_NODUP;
976 int pattern_type_arg = GREP_PATTERN_TYPE_UNSPECIFIED;
979 struct option options[] = {
980 OPT_BOOL(0, "cached", &cached,
981 N_("search in index instead of in the work tree")),
982 OPT_NEGBIT(0, "no-index", &use_index,
983 N_("find in contents not managed by git"), 1),
984 OPT_BOOL(0, "untracked", &untracked,
985 N_("search in both tracked and untracked files")),
986 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
987 N_("ignore files specified via '.gitignore'"), 1),
988 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
989 N_("recursively search in each submodule")),
990 OPT_STRING(0, "parent-basename", &parent_basename,
992 N_("prepend parent project's basename to output")),
994 OPT_BOOL('v', "invert-match", &opt.invert,
995 N_("show non-matching lines")),
996 OPT_BOOL('i', "ignore-case", &opt.ignore_case,
997 N_("case insensitive matching")),
998 OPT_BOOL('w', "word-regexp", &opt.word_regexp,
999 N_("match patterns only at word boundaries")),
1000 OPT_SET_INT('a', "text", &opt.binary,
1001 N_("process binary files as text"), GREP_BINARY_TEXT),
1002 OPT_SET_INT('I', NULL, &opt.binary,
1003 N_("don't match patterns in binary files"),
1004 GREP_BINARY_NOMATCH),
1005 OPT_BOOL(0, "textconv", &opt.allow_textconv,
1006 N_("process binary files with textconv filters")),
1007 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, N_("depth"),
1008 N_("descend at most <depth> levels"), PARSE_OPT_NONEG,
1011 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg,
1012 N_("use extended POSIX regular expressions"),
1013 GREP_PATTERN_TYPE_ERE),
1014 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg,
1015 N_("use basic POSIX regular expressions (default)"),
1016 GREP_PATTERN_TYPE_BRE),
1017 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg,
1018 N_("interpret patterns as fixed strings"),
1019 GREP_PATTERN_TYPE_FIXED),
1020 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg,
1021 N_("use Perl-compatible regular expressions"),
1022 GREP_PATTERN_TYPE_PCRE),
1024 OPT_BOOL('n', "line-number", &opt.linenum, N_("show line numbers")),
1025 OPT_NEGBIT('h', NULL, &opt.pathname, N_("don't show filenames"), 1),
1026 OPT_BIT('H', NULL, &opt.pathname, N_("show filenames"), 1),
1027 OPT_NEGBIT(0, "full-name", &opt.relative,
1028 N_("show filenames relative to top directory"), 1),
1029 OPT_BOOL('l', "files-with-matches", &opt.name_only,
1030 N_("show only filenames instead of matching lines")),
1031 OPT_BOOL(0, "name-only", &opt.name_only,
1032 N_("synonym for --files-with-matches")),
1033 OPT_BOOL('L', "files-without-match",
1034 &opt.unmatch_name_only,
1035 N_("show only the names of files without match")),
1036 OPT_BOOL('z', "null", &opt.null_following_name,
1037 N_("print NUL after filenames")),
1038 OPT_BOOL('c', "count", &opt.count,
1039 N_("show the number of matches instead of matching lines")),
1040 OPT__COLOR(&opt.color, N_("highlight matches")),
1041 OPT_BOOL(0, "break", &opt.file_break,
1042 N_("print empty line between matches from different files")),
1043 OPT_BOOL(0, "heading", &opt.heading,
1044 N_("show filename only once above matches from same file")),
1046 OPT_CALLBACK('C', "context", &opt, N_("n"),
1047 N_("show <n> context lines before and after matches"),
1049 OPT_INTEGER('B', "before-context", &opt.pre_context,
1050 N_("show <n> context lines before matches")),
1051 OPT_INTEGER('A', "after-context", &opt.post_context,
1052 N_("show <n> context lines after matches")),
1053 OPT_INTEGER(0, "threads", &num_threads,
1054 N_("use <n> worker threads")),
1055 OPT_NUMBER_CALLBACK(&opt, N_("shortcut for -C NUM"),
1057 OPT_BOOL('p', "show-function", &opt.funcname,
1058 N_("show a line with the function name before matches")),
1059 OPT_BOOL('W', "function-context", &opt.funcbody,
1060 N_("show the surrounding function")),
1062 OPT_CALLBACK('f', NULL, &opt, N_("file"),
1063 N_("read patterns from file"), file_callback),
1064 { OPTION_CALLBACK, 'e', NULL, &opt, N_("pattern"),
1065 N_("match <pattern>"), PARSE_OPT_NONEG, pattern_callback },
1066 { OPTION_CALLBACK, 0, "and", &opt, NULL,
1067 N_("combine patterns specified with -e"),
1068 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
1069 OPT_BOOL(0, "or", &dummy, ""),
1070 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
1071 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
1072 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
1073 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
1075 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
1076 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
1078 OPT__QUIET(&opt.status_only,
1079 N_("indicate hit with exit status without output")),
1080 OPT_BOOL(0, "all-match", &opt.all_match,
1081 N_("show only matches from files that match all patterns")),
1082 { OPTION_SET_INT, 0, "debug", &opt.debug, NULL,
1083 N_("show parse tree for grep expression"),
1084 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1 },
1086 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
1087 N_("pager"), N_("show matching files in the pager"),
1088 PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
1089 OPT_BOOL(0, "ext-grep", &external_grep_allowed__ignored,
1090 N_("allow calling of grep(1) (ignored by this build)")),
1094 init_grep_defaults();
1095 git_config(grep_cmd_config, NULL);
1096 grep_init(&opt, prefix);
1097 super_prefix = get_super_prefix();
1100 * If there is no -- then the paths must exist in the working
1101 * tree. If there is no explicit pattern specified with -e or
1102 * -f, we take the first unrecognized non option to be the
1103 * pattern, but then what follows it must be zero or more
1104 * valid refs up to the -- (if exists), and then existing
1105 * paths. If there is an explicit pattern, then the first
1106 * unrecognized non option is the beginning of the refs list
1107 * that continues up to the -- (if exists), and then paths.
1109 argc = parse_options(argc, argv, prefix, options, grep_usage,
1110 PARSE_OPT_KEEP_DASHDASH |
1111 PARSE_OPT_STOP_AT_NON_OPTION);
1112 grep_commit_pattern_type(pattern_type_arg, &opt);
1114 if (use_index && !startup_info->have_repository) {
1116 git_config_get_bool("grep.fallbacktonoindex", &fallback);
1120 /* die the same way as if we did it at the beginning */
1121 setup_git_directory();
1125 * skip a -- separator; we know it cannot be
1126 * separating revisions from pathnames if
1127 * we haven't even had any patterns yet
1129 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
1134 /* First unrecognized non-option token */
1135 if (argc > 0 && !opt.pattern_list) {
1136 append_grep_pattern(&opt, argv[0], "command line", 0,
1142 if (show_in_pager == default_pager)
1143 show_in_pager = git_pager(1);
1144 if (show_in_pager) {
1147 opt.null_following_name = 1;
1148 opt.output_priv = &path_list;
1149 opt.output = append_path;
1150 string_list_append(&path_list, show_in_pager);
1153 if (!opt.pattern_list)
1154 die(_("no pattern given."));
1155 if (!opt.fixed && opt.ignore_case)
1156 opt.regflags |= REG_ICASE;
1158 compile_grep_patterns(&opt);
1161 * We have to find "--" in a separate pass, because its presence
1162 * influences how we will parse arguments that come before it.
1164 for (i = 0; i < argc; i++) {
1165 if (!strcmp(argv[i], "--")) {
1172 * Resolve any rev arguments. If we have a dashdash, then everything up
1173 * to it must resolve as a rev. If not, then we stop at the first
1174 * non-rev and assume everything else is a path.
1176 allow_revs = use_index && !untracked;
1177 for (i = 0; i < argc; i++) {
1178 const char *arg = argv[i];
1179 struct object_id oid;
1180 struct object_context oc;
1181 struct object *object;
1183 if (!strcmp(arg, "--")) {
1190 die(_("--no-index or --untracked cannot be used with revs"));
1194 if (get_sha1_with_context(arg, 0, oid.hash, &oc)) {
1196 die(_("unable to resolve revision: %s"), arg);
1200 object = parse_object_or_die(oid.hash, arg);
1202 verify_non_filename(prefix, arg);
1203 add_object_array_with_path(object, arg, &list, oc.mode, oc.path);
1207 * Anything left over is presumed to be a path. But in the non-dashdash
1208 * "do what I mean" case, we verify and complain when that isn't true.
1210 if (!seen_dashdash) {
1212 for (j = i; j < argc; j++)
1213 verify_filename(prefix, argv[j], j == i && allow_revs);
1216 parse_pathspec(&pathspec, 0,
1217 PATHSPEC_PREFER_CWD |
1218 (opt.max_depth != -1 ? PATHSPEC_MAXDEPTH_VALID : 0),
1220 pathspec.max_depth = opt.max_depth;
1221 pathspec.recursive = 1;
1224 if (list.nr || cached || show_in_pager)
1226 else if (num_threads == 0)
1227 num_threads = GREP_NUM_THREADS_DEFAULT;
1228 else if (num_threads < 0)
1229 die(_("invalid number of threads specified (%d)"), num_threads);
1236 if (!(opt.name_only || opt.unmatch_name_only || opt.count)
1237 && (opt.pre_context || opt.post_context ||
1238 opt.file_break || opt.funcbody))
1239 skip_first_line = 1;
1240 start_threads(&opt);
1244 if (recurse_submodules) {
1245 gitmodules_config();
1246 compile_submodule_options(&opt, argv + i, cached, untracked,
1247 opt_exclude, use_index,
1251 if (show_in_pager && (cached || list.nr))
1252 die(_("--open-files-in-pager only works on the worktree"));
1254 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
1255 const char *pager = path_list.items[0].string;
1256 int len = strlen(pager);
1258 if (len > 4 && is_dir_sep(pager[len - 5]))
1261 if (opt.ignore_case && !strcmp("less", pager))
1262 string_list_append(&path_list, "-I");
1264 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
1265 struct strbuf buf = STRBUF_INIT;
1266 strbuf_addf(&buf, "+/%s%s",
1267 strcmp("less", pager) ? "" : "*",
1268 opt.pattern_list->pattern);
1269 string_list_append(&path_list, buf.buf);
1270 strbuf_detach(&buf, NULL);
1274 if (recurse_submodules && (!use_index || untracked))
1275 die(_("option not supported with --recurse-submodules."));
1277 if (!show_in_pager && !opt.status_only)
1280 if (!use_index && (untracked || cached))
1281 die(_("--cached or --untracked cannot be used with --no-index."));
1283 if (!use_index || untracked) {
1284 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
1285 hit = grep_directory(&opt, &pathspec, use_exclude, use_index);
1286 } else if (0 <= opt_exclude) {
1287 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1288 } else if (!list.nr) {
1292 hit = grep_cache(&opt, &pathspec, cached);
1295 die(_("both --cached and trees are given."));
1296 hit = grep_objects(&opt, &pathspec, &list);
1301 if (hit && show_in_pager)
1302 run_pager(&opt, prefix);
1303 clear_pathspec(&pathspec);
1304 free_grep_patterns(&opt);