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
;
230 compile_grep_patterns(o
);
231 err
= pthread_create(&threads
[i
], NULL
, run
, o
);
234 die(_("grep: failed to create thread: %s"),
239 static int wait_all(void)
247 /* Wait until all work is done. */
248 while (todo_done
!= todo_end
)
249 pthread_cond_wait(&cond_result
, &grep_mutex
);
251 /* Wake up all the consumer threads so they can see that there
252 * is no more work to do.
254 pthread_cond_broadcast(&cond_add
);
257 for (i
= 0; i
< num_threads
; i
++) {
259 pthread_join(threads
[i
], &h
);
260 hit
|= (int) (intptr_t) h
;
265 pthread_mutex_destroy(&grep_mutex
);
266 pthread_mutex_destroy(&grep_read_mutex
);
267 pthread_mutex_destroy(&grep_attr_mutex
);
268 pthread_cond_destroy(&cond_add
);
269 pthread_cond_destroy(&cond_write
);
270 pthread_cond_destroy(&cond_result
);
275 #else /* !NO_PTHREADS */
277 static int wait_all(void)
283 static int grep_cmd_config(const char *var
, const char *value
, void *cb
)
285 int st
= grep_config(var
, value
, cb
);
286 if (git_color_default_config(var
, value
, cb
) < 0)
289 if (!strcmp(var
, "grep.threads")) {
290 num_threads
= git_config_int(var
, value
);
292 die(_("invalid number of threads specified (%d) for %s"),
295 else if (num_threads
&& num_threads
!= 1) {
297 * TRANSLATORS: %s is the configuration
298 * variable for tweaking threads, currently
301 warning(_("no threads support, ignoring %s"), var
);
307 if (!strcmp(var
, "submodule.recurse"))
308 recurse_submodules
= git_config_bool(var
, value
);
313 static void *lock_and_read_oid_file(const struct object_id
*oid
, enum object_type
*type
, unsigned long *size
)
318 data
= read_sha1_file(oid
->hash
, type
, size
);
323 static int grep_oid(struct grep_opt
*opt
, const struct object_id
*oid
,
324 const char *filename
, int tree_name_len
,
327 struct strbuf pathbuf
= STRBUF_INIT
;
330 strbuf_add(&pathbuf
, filename
, tree_name_len
);
331 strbuf_addstr(&pathbuf
, super_prefix
);
332 strbuf_addstr(&pathbuf
, filename
+ tree_name_len
);
334 strbuf_addstr(&pathbuf
, filename
);
337 if (opt
->relative
&& opt
->prefix_length
) {
338 char *name
= strbuf_detach(&pathbuf
, NULL
);
339 quote_path_relative(name
+ tree_name_len
, opt
->prefix
, &pathbuf
);
340 strbuf_insert(&pathbuf
, 0, name
, tree_name_len
);
346 add_work(opt
, GREP_SOURCE_OID
, pathbuf
.buf
, path
, oid
);
347 strbuf_release(&pathbuf
);
352 struct grep_source gs
;
355 grep_source_init(&gs
, GREP_SOURCE_OID
, pathbuf
.buf
, path
, oid
);
356 strbuf_release(&pathbuf
);
357 hit
= grep_source(opt
, &gs
);
359 grep_source_clear(&gs
);
364 static int grep_file(struct grep_opt
*opt
, const char *filename
)
366 struct strbuf buf
= STRBUF_INIT
;
369 strbuf_addstr(&buf
, super_prefix
);
370 strbuf_addstr(&buf
, filename
);
372 if (opt
->relative
&& opt
->prefix_length
) {
373 char *name
= strbuf_detach(&buf
, NULL
);
374 quote_path_relative(name
, opt
->prefix
, &buf
);
380 add_work(opt
, GREP_SOURCE_FILE
, buf
.buf
, filename
, filename
);
381 strbuf_release(&buf
);
386 struct grep_source gs
;
389 grep_source_init(&gs
, GREP_SOURCE_FILE
, buf
.buf
, filename
, filename
);
390 strbuf_release(&buf
);
391 hit
= grep_source(opt
, &gs
);
393 grep_source_clear(&gs
);
398 static void append_path(struct grep_opt
*opt
, const void *data
, size_t len
)
400 struct string_list
*path_list
= opt
->output_priv
;
402 if (len
== 1 && *(const char *)data
== '\0')
404 string_list_append(path_list
, xstrndup(data
, len
));
407 static void run_pager(struct grep_opt
*opt
, const char *prefix
)
409 struct string_list
*path_list
= opt
->output_priv
;
410 struct child_process child
= CHILD_PROCESS_INIT
;
413 for (i
= 0; i
< path_list
->nr
; i
++)
414 argv_array_push(&child
.args
, path_list
->items
[i
].string
);
418 status
= run_command(&child
);
423 static void compile_submodule_options(const struct grep_opt
*opt
,
425 int cached
, int untracked
,
426 int opt_exclude
, int use_index
,
427 int pattern_type_arg
)
429 struct grep_pat
*pattern
;
431 if (recurse_submodules
)
432 argv_array_push(&submodule_options
, "--recurse-submodules");
435 argv_array_push(&submodule_options
, "--cached");
437 argv_array_push(&submodule_options
, "--no-index");
439 argv_array_push(&submodule_options
, "--untracked");
441 argv_array_push(&submodule_options
, "--exclude-standard");
444 argv_array_push(&submodule_options
, "-v");
445 if (opt
->ignore_case
)
446 argv_array_push(&submodule_options
, "-i");
447 if (opt
->word_regexp
)
448 argv_array_push(&submodule_options
, "-w");
449 switch (opt
->binary
) {
450 case GREP_BINARY_NOMATCH
:
451 argv_array_push(&submodule_options
, "-I");
453 case GREP_BINARY_TEXT
:
454 argv_array_push(&submodule_options
, "-a");
459 if (opt
->allow_textconv
)
460 argv_array_push(&submodule_options
, "--textconv");
461 if (opt
->max_depth
!= -1)
462 argv_array_pushf(&submodule_options
, "--max-depth=%d",
465 argv_array_push(&submodule_options
, "-n");
467 argv_array_push(&submodule_options
, "-h");
469 argv_array_push(&submodule_options
, "--full-name");
471 argv_array_push(&submodule_options
, "-l");
472 if (opt
->unmatch_name_only
)
473 argv_array_push(&submodule_options
, "-L");
474 if (opt
->null_following_name
)
475 argv_array_push(&submodule_options
, "-z");
477 argv_array_push(&submodule_options
, "-c");
479 argv_array_push(&submodule_options
, "--break");
481 argv_array_push(&submodule_options
, "--heading");
482 if (opt
->pre_context
)
483 argv_array_pushf(&submodule_options
, "--before-context=%d",
485 if (opt
->post_context
)
486 argv_array_pushf(&submodule_options
, "--after-context=%d",
489 argv_array_push(&submodule_options
, "-p");
491 argv_array_push(&submodule_options
, "-W");
493 argv_array_push(&submodule_options
, "--all-match");
495 argv_array_push(&submodule_options
, "--debug");
496 if (opt
->status_only
)
497 argv_array_push(&submodule_options
, "-q");
499 switch (pattern_type_arg
) {
500 case GREP_PATTERN_TYPE_BRE
:
501 argv_array_push(&submodule_options
, "-G");
503 case GREP_PATTERN_TYPE_ERE
:
504 argv_array_push(&submodule_options
, "-E");
506 case GREP_PATTERN_TYPE_FIXED
:
507 argv_array_push(&submodule_options
, "-F");
509 case GREP_PATTERN_TYPE_PCRE
:
510 argv_array_push(&submodule_options
, "-P");
512 case GREP_PATTERN_TYPE_UNSPECIFIED
:
515 die("BUG: Added a new grep pattern type without updating switch statement");
518 for (pattern
= opt
->pattern_list
; pattern
!= NULL
;
519 pattern
= pattern
->next
) {
520 switch (pattern
->token
) {
522 argv_array_pushf(&submodule_options
, "-e%s",
526 case GREP_OPEN_PAREN
:
527 case GREP_CLOSE_PAREN
:
530 argv_array_push(&submodule_options
, pattern
->pattern
);
532 /* BODY and HEAD are not used by git-grep */
533 case GREP_PATTERN_BODY
:
534 case GREP_PATTERN_HEAD
:
540 * Limit number of threads for child process to use.
541 * This is to prevent potential fork-bomb behavior of git-grep as each
542 * submodule process has its own thread pool.
544 argv_array_pushf(&submodule_options
, "--threads=%d",
545 (num_threads
+ 1) / 2);
548 argv_array_push(&submodule_options
, "--");
549 for (; *argv
; argv
++)
550 argv_array_push(&submodule_options
, *argv
);
554 * Launch child process to grep contents of a submodule
556 static int grep_submodule_launch(struct grep_opt
*opt
,
557 const struct grep_source
*gs
)
559 struct child_process cp
= CHILD_PROCESS_INIT
;
561 const char *end_of_base
;
563 struct strbuf child_output
= STRBUF_INIT
;
565 end_of_base
= strchr(gs
->name
, ':');
566 if (gs
->identifier
&& end_of_base
)
567 name
= end_of_base
+ 1;
571 prepare_submodule_repo_env(&cp
.env_array
);
572 argv_array_push(&cp
.env_array
, GIT_DIR_ENVIRONMENT
);
574 if (opt
->relative
&& opt
->prefix_length
)
575 argv_array_pushf(&cp
.env_array
, "%s=%s",
576 GIT_TOPLEVEL_PREFIX_ENVIRONMENT
,
579 /* Add super prefix */
580 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
581 super_prefix
? super_prefix
: "",
583 argv_array_push(&cp
.args
, "grep");
586 * Add basename of parent project
587 * When performing grep on a tree object the filename is prefixed
588 * with the object's name: 'tree-name:filename'. In order to
589 * provide uniformity of output we want to pass the name of the
590 * parent project's object name to the submodule so the submodule can
591 * prefix its output with the parent's name and not its own OID.
593 if (gs
->identifier
&& end_of_base
)
594 argv_array_pushf(&cp
.args
, "--parent-basename=%.*s",
595 (int) (end_of_base
- gs
->name
),
599 for (i
= 0; i
< submodule_options
.argc
; i
++) {
601 * If there is a tree identifier for the submodule, add the
602 * rev after adding the submodule options but before the
603 * pathspecs. To do this we listen for the '--' and insert the
604 * oid before pushing the '--' onto the child process argv
607 if (gs
->identifier
&&
608 !strcmp("--", submodule_options
.argv
[i
])) {
609 argv_array_push(&cp
.args
, oid_to_hex(gs
->identifier
));
612 argv_array_push(&cp
.args
, submodule_options
.argv
[i
]);
619 * Capture output to output buffer and check the return code from the
620 * child process. A '0' indicates a hit, a '1' indicates no hit and
621 * anything else is an error.
623 status
= capture_command(&cp
, &child_output
, 0);
624 if (status
&& (status
!= 1)) {
625 /* flush the buffer */
626 write_or_die(1, child_output
.buf
, child_output
.len
);
627 die("process for submodule '%s' failed with exit code: %d",
631 opt
->output(opt
, child_output
.buf
, child_output
.len
);
632 strbuf_release(&child_output
);
633 /* invert the return code to make a hit equal to 1 */
638 * Prep grep structures for a submodule grep
639 * oid: the oid of the submodule or NULL if using the working tree
640 * filename: name of the submodule including tree name of parent
641 * path: location of the submodule
643 static int grep_submodule(struct grep_opt
*opt
, const struct object_id
*oid
,
644 const char *filename
, const char *path
)
646 if (!is_submodule_initialized(path
))
648 if (!is_submodule_populated_gently(path
, NULL
)) {
650 * If searching history, check for the presense of the
651 * submodule's gitdir before skipping the submodule.
654 const struct submodule
*sub
=
655 submodule_from_path(null_sha1
, path
);
657 path
= git_path("modules/%s", sub
->name
);
659 if (!(is_directory(path
) && is_git_directory(path
)))
668 add_work(opt
, GREP_SOURCE_SUBMODULE
, filename
, path
, oid
);
673 struct grep_source gs
;
676 grep_source_init(&gs
, GREP_SOURCE_SUBMODULE
,
677 filename
, path
, oid
);
678 hit
= grep_submodule_launch(opt
, &gs
);
680 grep_source_clear(&gs
);
685 static int grep_cache(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
690 struct strbuf name
= STRBUF_INIT
;
691 int name_base_len
= 0;
693 name_base_len
= strlen(super_prefix
);
694 strbuf_addstr(&name
, super_prefix
);
699 for (nr
= 0; nr
< active_nr
; nr
++) {
700 const struct cache_entry
*ce
= active_cache
[nr
];
701 strbuf_setlen(&name
, name_base_len
);
702 strbuf_addstr(&name
, ce
->name
);
704 if (S_ISREG(ce
->ce_mode
) &&
705 match_pathspec(pathspec
, name
.buf
, name
.len
, 0, NULL
,
706 S_ISDIR(ce
->ce_mode
) ||
707 S_ISGITLINK(ce
->ce_mode
))) {
709 * If CE_VALID is on, we assume worktree file and its
710 * cache entry are identical, even if worktree file has
711 * been modified, so use cache version instead
713 if (cached
|| (ce
->ce_flags
& CE_VALID
) ||
714 ce_skip_worktree(ce
)) {
715 if (ce_stage(ce
) || ce_intent_to_add(ce
))
717 hit
|= grep_oid(opt
, &ce
->oid
, ce
->name
,
720 hit
|= grep_file(opt
, ce
->name
);
722 } else if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
723 submodule_path_match(pathspec
, name
.buf
, NULL
)) {
724 hit
|= grep_submodule(opt
, NULL
, ce
->name
, ce
->name
);
732 } while (nr
< active_nr
&&
733 !strcmp(ce
->name
, active_cache
[nr
]->name
));
734 nr
--; /* compensate for loop control */
736 if (hit
&& opt
->status_only
)
740 strbuf_release(&name
);
744 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
745 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
749 enum interesting match
= entry_not_interesting
;
750 struct name_entry entry
;
751 int old_baselen
= base
->len
;
752 struct strbuf name
= STRBUF_INIT
;
753 int name_base_len
= 0;
755 strbuf_addstr(&name
, super_prefix
);
756 name_base_len
= name
.len
;
759 while (tree_entry(tree
, &entry
)) {
760 int te_len
= tree_entry_len(&entry
);
762 if (match
!= all_entries_interesting
) {
763 strbuf_addstr(&name
, base
->buf
+ tn_len
);
764 match
= tree_entry_interesting(&entry
, &name
,
766 strbuf_setlen(&name
, name_base_len
);
768 if (match
== all_entries_not_interesting
)
770 if (match
== entry_not_interesting
)
774 strbuf_add(base
, entry
.path
, te_len
);
776 if (S_ISREG(entry
.mode
)) {
777 hit
|= grep_oid(opt
, entry
.oid
, base
->buf
, tn_len
,
778 check_attr
? base
->buf
+ tn_len
: NULL
);
779 } else if (S_ISDIR(entry
.mode
)) {
780 enum object_type type
;
781 struct tree_desc sub
;
785 data
= lock_and_read_oid_file(entry
.oid
, &type
, &size
);
787 die(_("unable to read tree (%s)"),
788 oid_to_hex(entry
.oid
));
790 strbuf_addch(base
, '/');
791 init_tree_desc(&sub
, data
, size
);
792 hit
|= grep_tree(opt
, pathspec
, &sub
, base
, tn_len
,
795 } else if (recurse_submodules
&& S_ISGITLINK(entry
.mode
)) {
796 hit
|= grep_submodule(opt
, entry
.oid
, base
->buf
,
800 strbuf_setlen(base
, old_baselen
);
802 if (hit
&& opt
->status_only
)
806 strbuf_release(&name
);
810 static int grep_object(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
811 struct object
*obj
, const char *name
, const char *path
)
813 if (obj
->type
== OBJ_BLOB
)
814 return grep_oid(opt
, &obj
->oid
, name
, 0, path
);
815 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
816 struct tree_desc tree
;
823 data
= read_object_with_reference(obj
->oid
.hash
, tree_type
,
828 die(_("unable to read tree (%s)"), oid_to_hex(&obj
->oid
));
830 /* Use parent's name as base when recursing submodules */
831 if (recurse_submodules
&& parent_basename
)
832 name
= parent_basename
;
834 len
= name
? strlen(name
) : 0;
835 strbuf_init(&base
, PATH_MAX
+ len
+ 1);
837 strbuf_add(&base
, name
, len
);
838 strbuf_addch(&base
, ':');
840 init_tree_desc(&tree
, data
, size
);
841 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
,
842 obj
->type
== OBJ_COMMIT
);
843 strbuf_release(&base
);
847 die(_("unable to grep from object of type %s"), typename(obj
->type
));
850 static int grep_objects(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
851 const struct object_array
*list
)
855 const unsigned int nr
= list
->nr
;
857 for (i
= 0; i
< nr
; i
++) {
858 struct object
*real_obj
;
859 real_obj
= deref_tag(list
->objects
[i
].item
, NULL
, 0);
861 /* load the gitmodules file for this rev */
862 if (recurse_submodules
) {
864 gitmodules_config_sha1(real_obj
->oid
.hash
);
866 if (grep_object(opt
, pathspec
, real_obj
, list
->objects
[i
].name
, list
->objects
[i
].path
)) {
868 if (opt
->status_only
)
875 static int grep_directory(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
876 int exc_std
, int use_index
)
878 struct dir_struct dir
;
881 memset(&dir
, 0, sizeof(dir
));
883 dir
.flags
|= DIR_NO_GITLINKS
;
885 setup_standard_excludes(&dir
);
887 fill_directory(&dir
, &the_index
, pathspec
);
888 for (i
= 0; i
< dir
.nr
; i
++) {
889 if (!dir_path_match(dir
.entries
[i
], pathspec
, 0, NULL
))
891 hit
|= grep_file(opt
, dir
.entries
[i
]->name
);
892 if (hit
&& opt
->status_only
)
898 static int context_callback(const struct option
*opt
, const char *arg
,
901 struct grep_opt
*grep_opt
= opt
->value
;
906 grep_opt
->pre_context
= grep_opt
->post_context
= 0;
909 value
= strtol(arg
, (char **)&endp
, 10);
911 return error(_("switch `%c' expects a numerical value"),
914 grep_opt
->pre_context
= grep_opt
->post_context
= value
;
918 static int file_callback(const struct option
*opt
, const char *arg
, int unset
)
920 struct grep_opt
*grep_opt
= opt
->value
;
921 int from_stdin
= !strcmp(arg
, "-");
924 struct strbuf sb
= STRBUF_INIT
;
926 patterns
= from_stdin
? stdin
: fopen(arg
, "r");
928 die_errno(_("cannot open '%s'"), arg
);
929 while (strbuf_getline(&sb
, patterns
) == 0) {
930 /* ignore empty line like grep does */
934 append_grep_pat(grep_opt
, sb
.buf
, sb
.len
, arg
, ++lno
,
943 static int not_callback(const struct option
*opt
, const char *arg
, int unset
)
945 struct grep_opt
*grep_opt
= opt
->value
;
946 append_grep_pattern(grep_opt
, "--not", "command line", 0, GREP_NOT
);
950 static int and_callback(const struct option
*opt
, const char *arg
, int unset
)
952 struct grep_opt
*grep_opt
= opt
->value
;
953 append_grep_pattern(grep_opt
, "--and", "command line", 0, GREP_AND
);
957 static int open_callback(const struct option
*opt
, const char *arg
, int unset
)
959 struct grep_opt
*grep_opt
= opt
->value
;
960 append_grep_pattern(grep_opt
, "(", "command line", 0, GREP_OPEN_PAREN
);
964 static int close_callback(const struct option
*opt
, const char *arg
, int unset
)
966 struct grep_opt
*grep_opt
= opt
->value
;
967 append_grep_pattern(grep_opt
, ")", "command line", 0, GREP_CLOSE_PAREN
);
971 static int pattern_callback(const struct option
*opt
, const char *arg
,
974 struct grep_opt
*grep_opt
= opt
->value
;
975 append_grep_pattern(grep_opt
, arg
, "-e option", 0, GREP_PATTERN
);
979 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
982 int cached
= 0, untracked
= 0, opt_exclude
= -1;
983 int seen_dashdash
= 0;
984 int external_grep_allowed__ignored
;
985 const char *show_in_pager
= NULL
, *default_pager
= "dummy";
987 struct object_array list
= OBJECT_ARRAY_INIT
;
988 struct pathspec pathspec
;
989 struct string_list path_list
= STRING_LIST_INIT_NODUP
;
993 int pattern_type_arg
= GREP_PATTERN_TYPE_UNSPECIFIED
;
996 struct option options
[] = {
997 OPT_BOOL(0, "cached", &cached
,
998 N_("search in index instead of in the work tree")),
999 OPT_NEGBIT(0, "no-index", &use_index
,
1000 N_("find in contents not managed by git"), 1),
1001 OPT_BOOL(0, "untracked", &untracked
,
1002 N_("search in both tracked and untracked files")),
1003 OPT_SET_INT(0, "exclude-standard", &opt_exclude
,
1004 N_("ignore files specified via '.gitignore'"), 1),
1005 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
1006 N_("recursively search in each submodule")),
1007 OPT_STRING(0, "parent-basename", &parent_basename
,
1009 N_("prepend parent project's basename to output")),
1011 OPT_BOOL('v', "invert-match", &opt
.invert
,
1012 N_("show non-matching lines")),
1013 OPT_BOOL('i', "ignore-case", &opt
.ignore_case
,
1014 N_("case insensitive matching")),
1015 OPT_BOOL('w', "word-regexp", &opt
.word_regexp
,
1016 N_("match patterns only at word boundaries")),
1017 OPT_SET_INT('a', "text", &opt
.binary
,
1018 N_("process binary files as text"), GREP_BINARY_TEXT
),
1019 OPT_SET_INT('I', NULL
, &opt
.binary
,
1020 N_("don't match patterns in binary files"),
1021 GREP_BINARY_NOMATCH
),
1022 OPT_BOOL(0, "textconv", &opt
.allow_textconv
,
1023 N_("process binary files with textconv filters")),
1024 { OPTION_INTEGER
, 0, "max-depth", &opt
.max_depth
, N_("depth"),
1025 N_("descend at most <depth> levels"), PARSE_OPT_NONEG
,
1028 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg
,
1029 N_("use extended POSIX regular expressions"),
1030 GREP_PATTERN_TYPE_ERE
),
1031 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg
,
1032 N_("use basic POSIX regular expressions (default)"),
1033 GREP_PATTERN_TYPE_BRE
),
1034 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg
,
1035 N_("interpret patterns as fixed strings"),
1036 GREP_PATTERN_TYPE_FIXED
),
1037 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg
,
1038 N_("use Perl-compatible regular expressions"),
1039 GREP_PATTERN_TYPE_PCRE
),
1041 OPT_BOOL('n', "line-number", &opt
.linenum
, N_("show line numbers")),
1042 OPT_NEGBIT('h', NULL
, &opt
.pathname
, N_("don't show filenames"), 1),
1043 OPT_BIT('H', NULL
, &opt
.pathname
, N_("show filenames"), 1),
1044 OPT_NEGBIT(0, "full-name", &opt
.relative
,
1045 N_("show filenames relative to top directory"), 1),
1046 OPT_BOOL('l', "files-with-matches", &opt
.name_only
,
1047 N_("show only filenames instead of matching lines")),
1048 OPT_BOOL(0, "name-only", &opt
.name_only
,
1049 N_("synonym for --files-with-matches")),
1050 OPT_BOOL('L', "files-without-match",
1051 &opt
.unmatch_name_only
,
1052 N_("show only the names of files without match")),
1053 OPT_BOOL('z', "null", &opt
.null_following_name
,
1054 N_("print NUL after filenames")),
1055 OPT_BOOL('c', "count", &opt
.count
,
1056 N_("show the number of matches instead of matching lines")),
1057 OPT__COLOR(&opt
.color
, N_("highlight matches")),
1058 OPT_BOOL(0, "break", &opt
.file_break
,
1059 N_("print empty line between matches from different files")),
1060 OPT_BOOL(0, "heading", &opt
.heading
,
1061 N_("show filename only once above matches from same file")),
1063 OPT_CALLBACK('C', "context", &opt
, N_("n"),
1064 N_("show <n> context lines before and after matches"),
1066 OPT_INTEGER('B', "before-context", &opt
.pre_context
,
1067 N_("show <n> context lines before matches")),
1068 OPT_INTEGER('A', "after-context", &opt
.post_context
,
1069 N_("show <n> context lines after matches")),
1070 OPT_INTEGER(0, "threads", &num_threads
,
1071 N_("use <n> worker threads")),
1072 OPT_NUMBER_CALLBACK(&opt
, N_("shortcut for -C NUM"),
1074 OPT_BOOL('p', "show-function", &opt
.funcname
,
1075 N_("show a line with the function name before matches")),
1076 OPT_BOOL('W', "function-context", &opt
.funcbody
,
1077 N_("show the surrounding function")),
1079 OPT_CALLBACK('f', NULL
, &opt
, N_("file"),
1080 N_("read patterns from file"), file_callback
),
1081 { OPTION_CALLBACK
, 'e', NULL
, &opt
, N_("pattern"),
1082 N_("match <pattern>"), PARSE_OPT_NONEG
, pattern_callback
},
1083 { OPTION_CALLBACK
, 0, "and", &opt
, NULL
,
1084 N_("combine patterns specified with -e"),
1085 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, and_callback
},
1086 OPT_BOOL(0, "or", &dummy
, ""),
1087 { OPTION_CALLBACK
, 0, "not", &opt
, NULL
, "",
1088 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, not_callback
},
1089 { OPTION_CALLBACK
, '(', NULL
, &opt
, NULL
, "",
1090 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
1092 { OPTION_CALLBACK
, ')', NULL
, &opt
, NULL
, "",
1093 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
1095 OPT__QUIET(&opt
.status_only
,
1096 N_("indicate hit with exit status without output")),
1097 OPT_BOOL(0, "all-match", &opt
.all_match
,
1098 N_("show only matches from files that match all patterns")),
1099 { OPTION_SET_INT
, 0, "debug", &opt
.debug
, NULL
,
1100 N_("show parse tree for grep expression"),
1101 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
, NULL
, 1 },
1103 { OPTION_STRING
, 'O', "open-files-in-pager", &show_in_pager
,
1104 N_("pager"), N_("show matching files in the pager"),
1105 PARSE_OPT_OPTARG
, NULL
, (intptr_t)default_pager
},
1106 OPT_BOOL(0, "ext-grep", &external_grep_allowed__ignored
,
1107 N_("allow calling of grep(1) (ignored by this build)")),
1111 init_grep_defaults();
1112 git_config(grep_cmd_config
, NULL
);
1113 grep_init(&opt
, prefix
);
1114 super_prefix
= get_super_prefix();
1117 * If there is no -- then the paths must exist in the working
1118 * tree. If there is no explicit pattern specified with -e or
1119 * -f, we take the first unrecognized non option to be the
1120 * pattern, but then what follows it must be zero or more
1121 * valid refs up to the -- (if exists), and then existing
1122 * paths. If there is an explicit pattern, then the first
1123 * unrecognized non option is the beginning of the refs list
1124 * that continues up to the -- (if exists), and then paths.
1126 argc
= parse_options(argc
, argv
, prefix
, options
, grep_usage
,
1127 PARSE_OPT_KEEP_DASHDASH
|
1128 PARSE_OPT_STOP_AT_NON_OPTION
);
1129 grep_commit_pattern_type(pattern_type_arg
, &opt
);
1131 if (use_index
&& !startup_info
->have_repository
) {
1133 git_config_get_bool("grep.fallbacktonoindex", &fallback
);
1137 /* die the same way as if we did it at the beginning */
1138 setup_git_directory();
1142 * skip a -- separator; we know it cannot be
1143 * separating revisions from pathnames if
1144 * we haven't even had any patterns yet
1146 if (argc
> 0 && !opt
.pattern_list
&& !strcmp(argv
[0], "--")) {
1151 /* First unrecognized non-option token */
1152 if (argc
> 0 && !opt
.pattern_list
) {
1153 append_grep_pattern(&opt
, argv
[0], "command line", 0,
1159 if (show_in_pager
== default_pager
)
1160 show_in_pager
= git_pager(1);
1161 if (show_in_pager
) {
1164 opt
.null_following_name
= 1;
1165 opt
.output_priv
= &path_list
;
1166 opt
.output
= append_path
;
1167 string_list_append(&path_list
, show_in_pager
);
1170 if (!opt
.pattern_list
)
1171 die(_("no pattern given."));
1172 if (!opt
.fixed
&& opt
.ignore_case
)
1173 opt
.regflags
|= REG_ICASE
;
1176 * We have to find "--" in a separate pass, because its presence
1177 * influences how we will parse arguments that come before it.
1179 for (i
= 0; i
< argc
; i
++) {
1180 if (!strcmp(argv
[i
], "--")) {
1187 * Resolve any rev arguments. If we have a dashdash, then everything up
1188 * to it must resolve as a rev. If not, then we stop at the first
1189 * non-rev and assume everything else is a path.
1191 allow_revs
= use_index
&& !untracked
;
1192 for (i
= 0; i
< argc
; i
++) {
1193 const char *arg
= argv
[i
];
1194 struct object_id oid
;
1195 struct object_context oc
;
1196 struct object
*object
;
1198 if (!strcmp(arg
, "--")) {
1205 die(_("--no-index or --untracked cannot be used with revs"));
1209 if (get_sha1_with_context(arg
, GET_SHA1_RECORD_PATH
,
1212 die(_("unable to resolve revision: %s"), arg
);
1216 object
= parse_object_or_die(&oid
, arg
);
1218 verify_non_filename(prefix
, arg
);
1219 add_object_array_with_path(object
, arg
, &list
, oc
.mode
, oc
.path
);
1224 * Anything left over is presumed to be a path. But in the non-dashdash
1225 * "do what I mean" case, we verify and complain when that isn't true.
1227 if (!seen_dashdash
) {
1229 for (j
= i
; j
< argc
; j
++)
1230 verify_filename(prefix
, argv
[j
], j
== i
&& allow_revs
);
1233 parse_pathspec(&pathspec
, 0,
1234 PATHSPEC_PREFER_CWD
|
1235 (opt
.max_depth
!= -1 ? PATHSPEC_MAXDEPTH_VALID
: 0),
1237 pathspec
.max_depth
= opt
.max_depth
;
1238 pathspec
.recursive
= 1;
1241 if (list
.nr
|| cached
|| show_in_pager
)
1243 else if (num_threads
== 0)
1244 num_threads
= GREP_NUM_THREADS_DEFAULT
;
1245 else if (num_threads
< 0)
1246 die(_("invalid number of threads specified (%d)"), num_threads
);
1247 if (num_threads
== 1)
1251 warning(_("no threads support, ignoring --threads"));
1257 * The compiled patterns on the main path are only
1258 * used when not using threading. Otherwise
1259 * start_threads() below calls compile_grep_patterns()
1262 compile_grep_patterns(&opt
);
1266 if (!(opt
.name_only
|| opt
.unmatch_name_only
|| opt
.count
)
1267 && (opt
.pre_context
|| opt
.post_context
||
1268 opt
.file_break
|| opt
.funcbody
))
1269 skip_first_line
= 1;
1270 start_threads(&opt
);
1274 if (recurse_submodules
) {
1275 gitmodules_config();
1276 compile_submodule_options(&opt
, argv
+ i
, cached
, untracked
,
1277 opt_exclude
, use_index
,
1281 if (show_in_pager
&& (cached
|| list
.nr
))
1282 die(_("--open-files-in-pager only works on the worktree"));
1284 if (show_in_pager
&& opt
.pattern_list
&& !opt
.pattern_list
->next
) {
1285 const char *pager
= path_list
.items
[0].string
;
1286 int len
= strlen(pager
);
1288 if (len
> 4 && is_dir_sep(pager
[len
- 5]))
1291 if (opt
.ignore_case
&& !strcmp("less", pager
))
1292 string_list_append(&path_list
, "-I");
1294 if (!strcmp("less", pager
) || !strcmp("vi", pager
)) {
1295 struct strbuf buf
= STRBUF_INIT
;
1296 strbuf_addf(&buf
, "+/%s%s",
1297 strcmp("less", pager
) ? "" : "*",
1298 opt
.pattern_list
->pattern
);
1299 string_list_append(&path_list
, buf
.buf
);
1300 strbuf_detach(&buf
, NULL
);
1304 if (recurse_submodules
&& (!use_index
|| untracked
))
1305 die(_("option not supported with --recurse-submodules."));
1307 if (!show_in_pager
&& !opt
.status_only
)
1310 if (!use_index
&& (untracked
|| cached
))
1311 die(_("--cached or --untracked cannot be used with --no-index."));
1313 if (!use_index
|| untracked
) {
1314 int use_exclude
= (opt_exclude
< 0) ? use_index
: !!opt_exclude
;
1315 hit
= grep_directory(&opt
, &pathspec
, use_exclude
, use_index
);
1316 } else if (0 <= opt_exclude
) {
1317 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1318 } else if (!list
.nr
) {
1322 hit
= grep_cache(&opt
, &pathspec
, cached
);
1325 die(_("both --cached and trees are given."));
1326 hit
= grep_objects(&opt
, &pathspec
, &list
);
1331 if (hit
&& show_in_pager
)
1332 run_pager(&opt
, prefix
);
1333 clear_pathspec(&pathspec
);
1334 free_grep_patterns(&opt
);