4 * Copyright (c) 2006 Junio C Hamano
10 #include "repository.h"
13 #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"
24 #include "object-file.h"
25 #include "object-name.h"
26 #include "object-store-ll.h"
30 #include "read-cache-ll.h"
31 #include "write-or-die.h"
33 static const char *grep_prefix
;
35 static char const * const grep_usage
[] = {
36 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
40 static int recurse_submodules
;
42 static int num_threads
;
44 static pthread_t
*threads
;
46 /* We use one producer thread and THREADS consumer
47 * threads. The producer adds struct work_items to 'todo' and the
48 * consumers pick work items from the same array.
51 struct grep_source source
;
56 /* In the range [todo_done, todo_start) in 'todo' we have work_items
57 * that have been or are processed by a consumer thread. We haven't
58 * written the result for these to stdout yet.
60 * The work_items in [todo_start, todo_end) are waiting to be picked
61 * up by a consumer thread.
63 * The ranges are modulo TODO_SIZE.
66 static struct work_item todo
[TODO_SIZE
];
67 static int todo_start
;
71 /* Has all work items been added? */
72 static int all_work_added
;
74 static struct repository
**repos_to_free
;
75 static size_t repos_to_free_nr
, repos_to_free_alloc
;
77 /* This lock protects all the variables above. */
78 static pthread_mutex_t grep_mutex
;
80 static inline void grep_lock(void)
82 pthread_mutex_lock(&grep_mutex
);
85 static inline void grep_unlock(void)
87 pthread_mutex_unlock(&grep_mutex
);
90 /* Signalled when a new work_item is added to todo. */
91 static pthread_cond_t cond_add
;
93 /* Signalled when the result from one work_item is written to
96 static pthread_cond_t cond_write
;
98 /* Signalled when we are finished with everything. */
99 static pthread_cond_t cond_result
;
101 static int skip_first_line
;
103 static void add_work(struct grep_opt
*opt
, struct grep_source
*gs
)
105 if (opt
->binary
!= GREP_BINARY_TEXT
)
106 grep_source_load_driver(gs
, opt
->repo
->index
);
110 while ((todo_end
+1) % ARRAY_SIZE(todo
) == todo_done
) {
111 pthread_cond_wait(&cond_write
, &grep_mutex
);
114 todo
[todo_end
].source
= *gs
;
115 todo
[todo_end
].done
= 0;
116 strbuf_reset(&todo
[todo_end
].out
);
117 todo_end
= (todo_end
+ 1) % ARRAY_SIZE(todo
);
119 pthread_cond_signal(&cond_add
);
123 static struct work_item
*get_work(void)
125 struct work_item
*ret
;
128 while (todo_start
== todo_end
&& !all_work_added
) {
129 pthread_cond_wait(&cond_add
, &grep_mutex
);
132 if (todo_start
== todo_end
&& all_work_added
) {
135 ret
= &todo
[todo_start
];
136 todo_start
= (todo_start
+ 1) % ARRAY_SIZE(todo
);
142 static void work_done(struct work_item
*w
)
148 old_done
= todo_done
;
149 for(; todo
[todo_done
].done
&& todo_done
!= todo_start
;
150 todo_done
= (todo_done
+1) % ARRAY_SIZE(todo
)) {
151 w
= &todo
[todo_done
];
153 const char *p
= w
->out
.buf
;
154 size_t len
= w
->out
.len
;
156 /* Skip the leading hunk mark of the first file. */
157 if (skip_first_line
) {
166 write_or_die(1, p
, len
);
168 grep_source_clear(&w
->source
);
171 if (old_done
!= todo_done
)
172 pthread_cond_signal(&cond_write
);
174 if (all_work_added
&& todo_done
== todo_end
)
175 pthread_cond_signal(&cond_result
);
180 static void free_repos(void)
184 for (i
= 0; i
< repos_to_free_nr
; i
++) {
185 repo_clear(repos_to_free
[i
]);
186 free(repos_to_free
[i
]);
188 FREE_AND_NULL(repos_to_free
);
189 repos_to_free_nr
= 0;
190 repos_to_free_alloc
= 0;
193 static void *run(void *arg
)
196 struct grep_opt
*opt
= arg
;
199 struct work_item
*w
= get_work();
203 opt
->output_priv
= w
;
204 hit
|= grep_source(opt
, &w
->source
);
205 grep_source_clear_data(&w
->source
);
208 free_grep_patterns(opt
);
211 return (void*) (intptr_t) hit
;
214 static void strbuf_out(struct grep_opt
*opt
, const void *buf
, size_t size
)
216 struct work_item
*w
= opt
->output_priv
;
217 strbuf_add(&w
->out
, buf
, size
);
220 static void start_threads(struct grep_opt
*opt
)
224 pthread_mutex_init(&grep_mutex
, NULL
);
225 pthread_mutex_init(&grep_attr_mutex
, NULL
);
226 pthread_cond_init(&cond_add
, NULL
);
227 pthread_cond_init(&cond_write
, NULL
);
228 pthread_cond_init(&cond_result
, NULL
);
230 enable_obj_read_lock();
232 for (i
= 0; i
< ARRAY_SIZE(todo
); i
++) {
233 strbuf_init(&todo
[i
].out
, 0);
236 CALLOC_ARRAY(threads
, num_threads
);
237 for (i
= 0; i
< num_threads
; i
++) {
239 struct grep_opt
*o
= grep_opt_dup(opt
);
240 o
->output
= strbuf_out
;
241 compile_grep_patterns(o
);
242 err
= pthread_create(&threads
[i
], NULL
, run
, o
);
245 die(_("grep: failed to create thread: %s"),
250 static int wait_all(void)
256 BUG("Never call this function unless you have started threads");
261 /* Wait until all work is done. */
262 while (todo_done
!= todo_end
)
263 pthread_cond_wait(&cond_result
, &grep_mutex
);
265 /* Wake up all the consumer threads so they can see that there
266 * is no more work to do.
268 pthread_cond_broadcast(&cond_add
);
271 for (i
= 0; i
< num_threads
; i
++) {
273 pthread_join(threads
[i
], &h
);
274 hit
|= (int) (intptr_t) h
;
279 pthread_mutex_destroy(&grep_mutex
);
280 pthread_mutex_destroy(&grep_attr_mutex
);
281 pthread_cond_destroy(&cond_add
);
282 pthread_cond_destroy(&cond_write
);
283 pthread_cond_destroy(&cond_result
);
285 disable_obj_read_lock();
290 static int grep_cmd_config(const char *var
, const char *value
,
291 const struct config_context
*ctx
, void *cb
)
293 int st
= grep_config(var
, value
, ctx
, cb
);
295 if (git_color_config(var
, value
, cb
) < 0)
297 else if (git_default_config(var
, value
, ctx
, cb
) < 0)
300 if (!strcmp(var
, "grep.threads")) {
301 num_threads
= git_config_int(var
, value
, ctx
->kvi
);
303 die(_("invalid number of threads specified (%d) for %s"),
305 else if (!HAVE_THREADS
&& num_threads
> 1) {
307 * TRANSLATORS: %s is the configuration
308 * variable for tweaking threads, currently
311 warning(_("no threads support, ignoring %s"), var
);
316 if (!strcmp(var
, "submodule.recurse"))
317 recurse_submodules
= git_config_bool(var
, value
);
322 static void grep_source_name(struct grep_opt
*opt
, const char *filename
,
323 int tree_name_len
, struct strbuf
*out
)
327 if (opt
->null_following_name
) {
328 if (opt
->relative
&& grep_prefix
) {
329 struct strbuf rel_buf
= STRBUF_INIT
;
330 const char *rel_name
=
331 relative_path(filename
+ tree_name_len
,
332 grep_prefix
, &rel_buf
);
335 strbuf_add(out
, filename
, tree_name_len
);
337 strbuf_addstr(out
, rel_name
);
338 strbuf_release(&rel_buf
);
340 strbuf_addstr(out
, filename
);
345 if (opt
->relative
&& grep_prefix
)
346 quote_path(filename
+ tree_name_len
, grep_prefix
, out
, 0);
348 quote_c_style(filename
+ tree_name_len
, out
, NULL
, 0);
351 strbuf_insert(out
, 0, filename
, tree_name_len
);
354 static int grep_oid(struct grep_opt
*opt
, const struct object_id
*oid
,
355 const char *filename
, int tree_name_len
,
358 struct strbuf pathbuf
= STRBUF_INIT
;
359 struct grep_source gs
;
361 grep_source_name(opt
, filename
, tree_name_len
, &pathbuf
);
362 grep_source_init_oid(&gs
, pathbuf
.buf
, path
, oid
, opt
->repo
);
363 strbuf_release(&pathbuf
);
365 if (num_threads
> 1) {
367 * add_work() copies gs and thus assumes ownership of
368 * its fields, so do not call grep_source_clear()
375 hit
= grep_source(opt
, &gs
);
377 grep_source_clear(&gs
);
382 static int grep_file(struct grep_opt
*opt
, const char *filename
)
384 struct strbuf buf
= STRBUF_INIT
;
385 struct grep_source gs
;
387 grep_source_name(opt
, filename
, 0, &buf
);
388 grep_source_init_file(&gs
, buf
.buf
, filename
);
389 strbuf_release(&buf
);
391 if (num_threads
> 1) {
393 * add_work() copies gs and thus assumes ownership of
394 * its fields, so do not call grep_source_clear()
401 hit
= grep_source(opt
, &gs
);
403 grep_source_clear(&gs
);
408 static void append_path(struct grep_opt
*opt
, const void *data
, size_t len
)
410 struct string_list
*path_list
= opt
->output_priv
;
412 if (len
== 1 && *(const char *)data
== '\0')
414 string_list_append_nodup(path_list
, xstrndup(data
, len
));
417 static void run_pager(struct grep_opt
*opt
, const char *prefix
)
419 struct string_list
*path_list
= opt
->output_priv
;
420 struct child_process child
= CHILD_PROCESS_INIT
;
423 for (i
= 0; i
< path_list
->nr
; i
++)
424 strvec_push(&child
.args
, path_list
->items
[i
].string
);
428 status
= run_command(&child
);
433 static int grep_cache(struct grep_opt
*opt
,
434 const struct pathspec
*pathspec
, int cached
);
435 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
436 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
439 static int grep_submodule(struct grep_opt
*opt
,
440 const struct pathspec
*pathspec
,
441 const struct object_id
*oid
,
442 const char *filename
, const char *path
, int cached
)
444 struct repository
*subrepo
;
445 struct repository
*superproject
= opt
->repo
;
446 struct grep_opt subopt
;
449 if (!is_submodule_active(superproject
, path
))
452 subrepo
= xmalloc(sizeof(*subrepo
));
453 if (repo_submodule_init(subrepo
, superproject
, path
, null_oid())) {
457 ALLOC_GROW(repos_to_free
, repos_to_free_nr
+ 1, repos_to_free_alloc
);
458 repos_to_free
[repos_to_free_nr
++] = subrepo
;
461 * NEEDSWORK: repo_read_gitmodules() might call
462 * add_to_alternates_memory() via config_from_gitmodules(). This
463 * operation causes a race condition with concurrent object readings
464 * performed by the worker threads. That's why we need obj_read_lock()
465 * here. It should be removed once it's no longer necessary to add the
466 * subrepo's odbs to the in-memory alternates list.
471 * NEEDSWORK: when reading a submodule, the sparsity settings in the
472 * superproject are incorrectly forgotten or misused. For example:
474 * 1. "command_requires_full_index"
475 * When this setting is turned on for `grep`, only the superproject
476 * knows it. All the submodules are read with their own configs
477 * and get prepare_repo_settings()'d. Therefore, these submodules
478 * "forget" the sparse-index feature switch. As a result, the index
479 * of these submodules are expanded unexpectedly.
481 * 2. "core_apply_sparse_checkout"
482 * When running `grep` in the superproject, this setting is
483 * populated using the superproject's configs. However, once
484 * initialized, this config is globally accessible and is read by
485 * prepare_repo_settings() for the submodules. For instance, if a
486 * submodule is using a sparse-checkout, however, the superproject
487 * is not, the result is that the config from the superproject will
488 * dictate the behavior for the submodule, making it "forget" its
489 * sparse-checkout state.
491 * 3. "core_sparse_checkout_cone"
494 * Note that this list is not exhaustive.
496 repo_read_gitmodules(subrepo
, 0);
499 * All code paths tested by test code no longer need submodule ODBs to
500 * be added as alternates, but add it to the list just in case.
501 * Submodule ODBs added through add_submodule_odb_by_path() will be
502 * lazily registered as alternates when needed (and except in an
503 * unexpected code interaction, it won't be needed).
505 add_submodule_odb_by_path(subrepo
->objects
->odb
->path
);
508 memcpy(&subopt
, opt
, sizeof(subopt
));
509 subopt
.repo
= subrepo
;
512 enum object_type object_type
;
513 struct tree_desc tree
;
516 struct strbuf base
= STRBUF_INIT
;
519 object_type
= oid_object_info(subrepo
, oid
, NULL
);
521 data
= read_object_with_reference(subrepo
,
525 die(_("unable to read tree (%s)"), oid_to_hex(oid
));
527 strbuf_addstr(&base
, filename
);
528 strbuf_addch(&base
, '/');
530 init_tree_desc(&tree
, data
, size
);
531 hit
= grep_tree(&subopt
, pathspec
, &tree
, &base
, base
.len
,
532 object_type
== OBJ_COMMIT
);
533 strbuf_release(&base
);
536 hit
= grep_cache(&subopt
, pathspec
, cached
);
542 static int grep_cache(struct grep_opt
*opt
,
543 const struct pathspec
*pathspec
, int cached
)
545 struct repository
*repo
= opt
->repo
;
548 struct strbuf name
= STRBUF_INIT
;
549 int name_base_len
= 0;
550 if (repo
->submodule_prefix
) {
551 name_base_len
= strlen(repo
->submodule_prefix
);
552 strbuf_addstr(&name
, repo
->submodule_prefix
);
555 if (repo_read_index(repo
) < 0)
556 die(_("index file corrupt"));
558 for (nr
= 0; nr
< repo
->index
->cache_nr
; nr
++) {
559 const struct cache_entry
*ce
= repo
->index
->cache
[nr
];
561 if (!cached
&& ce_skip_worktree(ce
))
564 strbuf_setlen(&name
, name_base_len
);
565 strbuf_addstr(&name
, ce
->name
);
566 if (S_ISSPARSEDIR(ce
->ce_mode
)) {
567 enum object_type type
;
568 struct tree_desc tree
;
572 data
= repo_read_object_file(the_repository
, &ce
->oid
,
574 init_tree_desc(&tree
, data
, size
);
576 hit
|= grep_tree(opt
, pathspec
, &tree
, &name
, 0, 0);
577 strbuf_setlen(&name
, name_base_len
);
578 strbuf_addstr(&name
, ce
->name
);
580 } else if (S_ISREG(ce
->ce_mode
) &&
581 match_pathspec(repo
->index
, pathspec
, name
.buf
, name
.len
, 0, NULL
,
582 S_ISDIR(ce
->ce_mode
) ||
583 S_ISGITLINK(ce
->ce_mode
))) {
585 * If CE_VALID is on, we assume worktree file and its
586 * cache entry are identical, even if worktree file has
587 * been modified, so use cache version instead
589 if (cached
|| (ce
->ce_flags
& CE_VALID
)) {
590 if (ce_stage(ce
) || ce_intent_to_add(ce
))
592 hit
|= grep_oid(opt
, &ce
->oid
, name
.buf
,
595 hit
|= grep_file(opt
, name
.buf
);
597 } else if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
598 submodule_path_match(repo
->index
, pathspec
, name
.buf
, NULL
)) {
599 hit
|= grep_submodule(opt
, pathspec
, NULL
, ce
->name
,
608 } while (nr
< repo
->index
->cache_nr
&&
609 !strcmp(ce
->name
, repo
->index
->cache
[nr
]->name
));
610 nr
--; /* compensate for loop control */
612 if (hit
&& opt
->status_only
)
616 strbuf_release(&name
);
620 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
621 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
624 struct repository
*repo
= opt
->repo
;
626 enum interesting match
= entry_not_interesting
;
627 struct name_entry entry
;
628 int old_baselen
= base
->len
;
629 struct strbuf name
= STRBUF_INIT
;
630 int name_base_len
= 0;
631 if (repo
->submodule_prefix
) {
632 strbuf_addstr(&name
, repo
->submodule_prefix
);
633 name_base_len
= name
.len
;
636 while (tree_entry(tree
, &entry
)) {
637 int te_len
= tree_entry_len(&entry
);
639 if (match
!= all_entries_interesting
) {
640 strbuf_addstr(&name
, base
->buf
+ tn_len
);
641 match
= tree_entry_interesting(repo
->index
,
644 strbuf_setlen(&name
, name_base_len
);
646 if (match
== all_entries_not_interesting
)
648 if (match
== entry_not_interesting
)
652 strbuf_add(base
, entry
.path
, te_len
);
654 if (S_ISREG(entry
.mode
)) {
655 hit
|= grep_oid(opt
, &entry
.oid
, base
->buf
, tn_len
,
656 check_attr
? base
->buf
+ tn_len
: NULL
);
657 } else if (S_ISDIR(entry
.mode
)) {
658 enum object_type type
;
659 struct tree_desc sub
;
663 data
= repo_read_object_file(the_repository
,
664 &entry
.oid
, &type
, &size
);
666 die(_("unable to read tree (%s)"),
667 oid_to_hex(&entry
.oid
));
669 strbuf_addch(base
, '/');
670 init_tree_desc(&sub
, data
, size
);
671 hit
|= grep_tree(opt
, pathspec
, &sub
, base
, tn_len
,
674 } else if (recurse_submodules
&& S_ISGITLINK(entry
.mode
)) {
675 hit
|= grep_submodule(opt
, pathspec
, &entry
.oid
,
676 base
->buf
, base
->buf
+ tn_len
,
680 strbuf_setlen(base
, old_baselen
);
682 if (hit
&& opt
->status_only
)
686 strbuf_release(&name
);
690 static int grep_object(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
691 struct object
*obj
, const char *name
, const char *path
)
693 if (obj
->type
== OBJ_BLOB
)
694 return grep_oid(opt
, &obj
->oid
, name
, 0, path
);
695 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
696 struct tree_desc tree
;
702 data
= read_object_with_reference(opt
->repo
,
706 die(_("unable to read tree (%s)"), oid_to_hex(&obj
->oid
));
708 len
= name
? strlen(name
) : 0;
709 strbuf_init(&base
, PATH_MAX
+ len
+ 1);
711 strbuf_add(&base
, name
, len
);
712 strbuf_addch(&base
, ':');
714 init_tree_desc(&tree
, data
, size
);
715 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
,
716 obj
->type
== OBJ_COMMIT
);
717 strbuf_release(&base
);
721 die(_("unable to grep from object of type %s"), type_name(obj
->type
));
724 static int grep_objects(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
725 const struct object_array
*list
)
729 const unsigned int nr
= list
->nr
;
731 for (i
= 0; i
< nr
; i
++) {
732 struct object
*real_obj
;
735 real_obj
= deref_tag(opt
->repo
, list
->objects
[i
].item
,
740 char hex
[GIT_MAX_HEXSZ
+ 1];
741 const char *name
= list
->objects
[i
].name
;
744 oid_to_hex_r(hex
, &list
->objects
[i
].item
->oid
);
747 die(_("invalid object '%s' given."), name
);
750 /* load the gitmodules file for this rev */
751 if (recurse_submodules
) {
752 submodule_free(opt
->repo
);
754 gitmodules_config_oid(&real_obj
->oid
);
757 if (grep_object(opt
, pathspec
, real_obj
, list
->objects
[i
].name
,
758 list
->objects
[i
].path
)) {
760 if (opt
->status_only
)
767 static int grep_directory(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
768 int exc_std
, int use_index
)
770 struct dir_struct dir
= DIR_INIT
;
774 dir
.flags
|= DIR_NO_GITLINKS
;
776 setup_standard_excludes(&dir
);
778 fill_directory(&dir
, opt
->repo
->index
, pathspec
);
779 for (i
= 0; i
< dir
.nr
; i
++) {
780 hit
|= grep_file(opt
, dir
.entries
[i
]->name
);
781 if (hit
&& opt
->status_only
)
788 static int context_callback(const struct option
*opt
, const char *arg
,
791 struct grep_opt
*grep_opt
= opt
->value
;
796 grep_opt
->pre_context
= grep_opt
->post_context
= 0;
799 value
= strtol(arg
, (char **)&endp
, 10);
801 return error(_("switch `%c' expects a numerical value"),
804 grep_opt
->pre_context
= grep_opt
->post_context
= value
;
808 static int file_callback(const struct option
*opt
, const char *arg
, int unset
)
810 struct grep_opt
*grep_opt
= opt
->value
;
812 const char *filename
= arg
;
815 struct strbuf sb
= STRBUF_INIT
;
817 BUG_ON_OPT_NEG(unset
);
820 ; /* leave it as-is */
822 filename
= prefix_filename_except_for_dash(grep_prefix
, filename
);
824 from_stdin
= !strcmp(filename
, "-");
825 patterns
= from_stdin
? stdin
: fopen(filename
, "r");
827 die_errno(_("cannot open '%s'"), arg
);
828 while (strbuf_getline(&sb
, patterns
) == 0) {
829 /* ignore empty line like grep does */
833 append_grep_pat(grep_opt
, sb
.buf
, sb
.len
, arg
, ++lno
,
840 free((void *)filename
);
844 static int not_callback(const struct option
*opt
, const char *arg
, int unset
)
846 struct grep_opt
*grep_opt
= opt
->value
;
847 BUG_ON_OPT_NEG(unset
);
849 append_grep_pattern(grep_opt
, "--not", "command line", 0, GREP_NOT
);
853 static int and_callback(const struct option
*opt
, const char *arg
, int unset
)
855 struct grep_opt
*grep_opt
= opt
->value
;
856 BUG_ON_OPT_NEG(unset
);
858 append_grep_pattern(grep_opt
, "--and", "command line", 0, GREP_AND
);
862 static int open_callback(const struct option
*opt
, const char *arg
, int unset
)
864 struct grep_opt
*grep_opt
= opt
->value
;
865 BUG_ON_OPT_NEG(unset
);
867 append_grep_pattern(grep_opt
, "(", "command line", 0, GREP_OPEN_PAREN
);
871 static int close_callback(const struct option
*opt
, const char *arg
, int unset
)
873 struct grep_opt
*grep_opt
= opt
->value
;
874 BUG_ON_OPT_NEG(unset
);
876 append_grep_pattern(grep_opt
, ")", "command line", 0, GREP_CLOSE_PAREN
);
880 static int pattern_callback(const struct option
*opt
, const char *arg
,
883 struct grep_opt
*grep_opt
= opt
->value
;
884 BUG_ON_OPT_NEG(unset
);
885 append_grep_pattern(grep_opt
, arg
, "-e option", 0, GREP_PATTERN
);
889 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
892 int cached
= 0, untracked
= 0, opt_exclude
= -1;
893 int seen_dashdash
= 0;
894 int external_grep_allowed__ignored
;
895 const char *show_in_pager
= NULL
, *default_pager
= "dummy";
897 struct object_array list
= OBJECT_ARRAY_INIT
;
898 struct pathspec pathspec
;
899 struct string_list path_list
= STRING_LIST_INIT_DUP
;
905 struct option options
[] = {
906 OPT_BOOL(0, "cached", &cached
,
907 N_("search in index instead of in the work tree")),
908 OPT_NEGBIT(0, "no-index", &use_index
,
909 N_("find in contents not managed by git"), 1),
910 OPT_BOOL(0, "untracked", &untracked
,
911 N_("search in both tracked and untracked files")),
912 OPT_SET_INT(0, "exclude-standard", &opt_exclude
,
913 N_("ignore files specified via '.gitignore'"), 1),
914 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
915 N_("recursively search in each submodule")),
917 OPT_BOOL('v', "invert-match", &opt
.invert
,
918 N_("show non-matching lines")),
919 OPT_BOOL('i', "ignore-case", &opt
.ignore_case
,
920 N_("case insensitive matching")),
921 OPT_BOOL('w', "word-regexp", &opt
.word_regexp
,
922 N_("match patterns only at word boundaries")),
923 OPT_SET_INT('a', "text", &opt
.binary
,
924 N_("process binary files as text"), GREP_BINARY_TEXT
),
925 OPT_SET_INT('I', NULL
, &opt
.binary
,
926 N_("don't match patterns in binary files"),
927 GREP_BINARY_NOMATCH
),
928 OPT_BOOL(0, "textconv", &opt
.allow_textconv
,
929 N_("process binary files with textconv filters")),
930 OPT_SET_INT('r', "recursive", &opt
.max_depth
,
931 N_("search in subdirectories (default)"), -1),
932 OPT_INTEGER_F(0, "max-depth", &opt
.max_depth
,
933 N_("descend at most <n> levels"), PARSE_OPT_NONEG
),
935 OPT_SET_INT('E', "extended-regexp", &opt
.pattern_type_option
,
936 N_("use extended POSIX regular expressions"),
937 GREP_PATTERN_TYPE_ERE
),
938 OPT_SET_INT('G', "basic-regexp", &opt
.pattern_type_option
,
939 N_("use basic POSIX regular expressions (default)"),
940 GREP_PATTERN_TYPE_BRE
),
941 OPT_SET_INT('F', "fixed-strings", &opt
.pattern_type_option
,
942 N_("interpret patterns as fixed strings"),
943 GREP_PATTERN_TYPE_FIXED
),
944 OPT_SET_INT('P', "perl-regexp", &opt
.pattern_type_option
,
945 N_("use Perl-compatible regular expressions"),
946 GREP_PATTERN_TYPE_PCRE
),
948 OPT_BOOL('n', "line-number", &opt
.linenum
, N_("show line numbers")),
949 OPT_BOOL(0, "column", &opt
.columnnum
, N_("show column number of first match")),
950 OPT_NEGBIT('h', NULL
, &opt
.pathname
, N_("don't show filenames"), 1),
951 OPT_BIT('H', NULL
, &opt
.pathname
, N_("show filenames"), 1),
952 OPT_NEGBIT(0, "full-name", &opt
.relative
,
953 N_("show filenames relative to top directory"), 1),
954 OPT_BOOL('l', "files-with-matches", &opt
.name_only
,
955 N_("show only filenames instead of matching lines")),
956 OPT_BOOL(0, "name-only", &opt
.name_only
,
957 N_("synonym for --files-with-matches")),
958 OPT_BOOL('L', "files-without-match",
959 &opt
.unmatch_name_only
,
960 N_("show only the names of files without match")),
961 OPT_BOOL_F('z', "null", &opt
.null_following_name
,
962 N_("print NUL after filenames"),
963 PARSE_OPT_NOCOMPLETE
),
964 OPT_BOOL('o', "only-matching", &opt
.only_matching
,
965 N_("show only matching parts of a line")),
966 OPT_BOOL('c', "count", &opt
.count
,
967 N_("show the number of matches instead of matching lines")),
968 OPT__COLOR(&opt
.color
, N_("highlight matches")),
969 OPT_BOOL(0, "break", &opt
.file_break
,
970 N_("print empty line between matches from different files")),
971 OPT_BOOL(0, "heading", &opt
.heading
,
972 N_("show filename only once above matches from same file")),
974 OPT_CALLBACK('C', "context", &opt
, N_("n"),
975 N_("show <n> context lines before and after matches"),
977 OPT_INTEGER('B', "before-context", &opt
.pre_context
,
978 N_("show <n> context lines before matches")),
979 OPT_INTEGER('A', "after-context", &opt
.post_context
,
980 N_("show <n> context lines after matches")),
981 OPT_INTEGER(0, "threads", &num_threads
,
982 N_("use <n> worker threads")),
983 OPT_NUMBER_CALLBACK(&opt
, N_("shortcut for -C NUM"),
985 OPT_BOOL('p', "show-function", &opt
.funcname
,
986 N_("show a line with the function name before matches")),
987 OPT_BOOL('W', "function-context", &opt
.funcbody
,
988 N_("show the surrounding function")),
990 OPT_CALLBACK('f', NULL
, &opt
, N_("file"),
991 N_("read patterns from file"), file_callback
),
992 OPT_CALLBACK_F('e', NULL
, &opt
, N_("pattern"),
993 N_("match <pattern>"), PARSE_OPT_NONEG
, pattern_callback
),
994 OPT_CALLBACK_F(0, "and", &opt
, NULL
,
995 N_("combine patterns specified with -e"),
996 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, and_callback
),
997 OPT_BOOL_F(0, "or", &dummy
, "", PARSE_OPT_NONEG
),
998 OPT_CALLBACK_F(0, "not", &opt
, NULL
, "",
999 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, not_callback
),
1000 OPT_CALLBACK_F('(', NULL
, &opt
, NULL
, "",
1001 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
1003 OPT_CALLBACK_F(')', NULL
, &opt
, NULL
, "",
1004 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
1006 OPT__QUIET(&opt
.status_only
,
1007 N_("indicate hit with exit status without output")),
1008 OPT_BOOL(0, "all-match", &opt
.all_match
,
1009 N_("show only matches from files that match all patterns")),
1011 { OPTION_STRING
, 'O', "open-files-in-pager", &show_in_pager
,
1012 N_("pager"), N_("show matching files in the pager"),
1013 PARSE_OPT_OPTARG
| PARSE_OPT_NOCOMPLETE
,
1014 NULL
, (intptr_t)default_pager
},
1015 OPT_BOOL_F(0, "ext-grep", &external_grep_allowed__ignored
,
1016 N_("allow calling of grep(1) (ignored by this build)"),
1017 PARSE_OPT_NOCOMPLETE
),
1018 OPT_INTEGER('m', "max-count", &opt
.max_count
,
1019 N_("maximum number of results per file")),
1022 grep_prefix
= prefix
;
1024 grep_init(&opt
, the_repository
);
1025 git_config(grep_cmd_config
, &opt
);
1028 * If there is no -- then the paths must exist in the working
1029 * tree. If there is no explicit pattern specified with -e or
1030 * -f, we take the first unrecognized non option to be the
1031 * pattern, but then what follows it must be zero or more
1032 * valid refs up to the -- (if exists), and then existing
1033 * paths. If there is an explicit pattern, then the first
1034 * unrecognized non option is the beginning of the refs list
1035 * that continues up to the -- (if exists), and then paths.
1037 argc
= parse_options(argc
, argv
, prefix
, options
, grep_usage
,
1038 PARSE_OPT_KEEP_DASHDASH
|
1039 PARSE_OPT_STOP_AT_NON_OPTION
);
1041 if (the_repository
->gitdir
) {
1042 prepare_repo_settings(the_repository
);
1043 the_repository
->settings
.command_requires_full_index
= 0;
1046 if (use_index
&& !startup_info
->have_repository
) {
1048 git_config_get_bool("grep.fallbacktonoindex", &fallback
);
1052 /* die the same way as if we did it at the beginning */
1053 setup_git_directory();
1055 /* Ignore --recurse-submodules if --no-index is given or implied */
1057 recurse_submodules
= 0;
1060 * skip a -- separator; we know it cannot be
1061 * separating revisions from pathnames if
1062 * we haven't even had any patterns yet
1064 if (argc
> 0 && !opt
.pattern_list
&& !strcmp(argv
[0], "--")) {
1069 /* First unrecognized non-option token */
1070 if (argc
> 0 && !opt
.pattern_list
) {
1071 append_grep_pattern(&opt
, argv
[0], "command line", 0,
1077 if (show_in_pager
== default_pager
)
1078 show_in_pager
= git_pager(1);
1079 if (show_in_pager
) {
1082 opt
.null_following_name
= 1;
1083 opt
.output_priv
= &path_list
;
1084 opt
.output
= append_path
;
1085 string_list_append(&path_list
, show_in_pager
);
1088 if (!opt
.pattern_list
)
1089 die(_("no pattern given"));
1091 /* --only-matching has no effect with --invert. */
1093 opt
.only_matching
= 0;
1096 * We have to find "--" in a separate pass, because its presence
1097 * influences how we will parse arguments that come before it.
1099 for (i
= 0; i
< argc
; i
++) {
1100 if (!strcmp(argv
[i
], "--")) {
1107 * Resolve any rev arguments. If we have a dashdash, then everything up
1108 * to it must resolve as a rev. If not, then we stop at the first
1109 * non-rev and assume everything else is a path.
1111 allow_revs
= use_index
&& !untracked
;
1112 for (i
= 0; i
< argc
; i
++) {
1113 const char *arg
= argv
[i
];
1114 struct object_id oid
;
1115 struct object_context oc
;
1116 struct object
*object
;
1118 if (!strcmp(arg
, "--")) {
1125 die(_("--no-index or --untracked cannot be used with revs"));
1129 if (get_oid_with_context(the_repository
, arg
,
1130 GET_OID_RECORD_PATH
,
1133 die(_("unable to resolve revision: %s"), arg
);
1137 object
= parse_object_or_die(&oid
, arg
);
1139 verify_non_filename(prefix
, arg
);
1140 add_object_array_with_path(object
, arg
, &list
, oc
.mode
, oc
.path
);
1145 * Anything left over is presumed to be a path. But in the non-dashdash
1146 * "do what I mean" case, we verify and complain when that isn't true.
1148 if (!seen_dashdash
) {
1150 for (j
= i
; j
< argc
; j
++)
1151 verify_filename(prefix
, argv
[j
], j
== i
&& allow_revs
);
1154 parse_pathspec(&pathspec
, 0,
1155 PATHSPEC_PREFER_CWD
|
1156 (opt
.max_depth
!= -1 ? PATHSPEC_MAXDEPTH_VALID
: 0),
1158 pathspec
.max_depth
= opt
.max_depth
;
1159 pathspec
.recursive
= 1;
1160 pathspec
.recurse_submodules
= !!recurse_submodules
;
1162 if (recurse_submodules
&& untracked
)
1163 die(_("--untracked not supported with --recurse-submodules"));
1166 * Optimize out the case where the amount of matches is limited to zero.
1167 * We do this to keep results consistent with GNU grep(1).
1169 if (opt
.max_count
== 0)
1172 if (show_in_pager
) {
1173 if (num_threads
> 1)
1174 warning(_("invalid option combination, ignoring --threads"));
1176 } else if (!HAVE_THREADS
&& num_threads
> 1) {
1177 warning(_("no threads support, ignoring --threads"));
1179 } else if (num_threads
< 0)
1180 die(_("invalid number of threads specified (%d)"), num_threads
);
1181 else if (num_threads
== 0)
1182 num_threads
= HAVE_THREADS
? online_cpus() : 1;
1184 if (num_threads
> 1) {
1186 BUG("Somebody got num_threads calculation wrong!");
1187 if (!(opt
.name_only
|| opt
.unmatch_name_only
|| opt
.count
)
1188 && (opt
.pre_context
|| opt
.post_context
||
1189 opt
.file_break
|| opt
.funcbody
))
1190 skip_first_line
= 1;
1193 * Pre-read gitmodules (if not read already) and force eager
1194 * initialization of packed_git to prevent racy lazy
1195 * reading/initialization once worker threads are started.
1197 if (recurse_submodules
)
1198 repo_read_gitmodules(the_repository
, 1);
1199 if (startup_info
->have_repository
)
1200 (void)get_packed_git(the_repository
);
1202 start_threads(&opt
);
1205 * The compiled patterns on the main path are only
1206 * used when not using threading. Otherwise
1207 * start_threads() above calls compile_grep_patterns()
1210 compile_grep_patterns(&opt
);
1213 if (show_in_pager
&& (cached
|| list
.nr
))
1214 die(_("--open-files-in-pager only works on the worktree"));
1216 if (show_in_pager
&& opt
.pattern_list
&& !opt
.pattern_list
->next
) {
1217 const char *pager
= path_list
.items
[0].string
;
1218 int len
= strlen(pager
);
1220 if (len
> 4 && is_dir_sep(pager
[len
- 5]))
1223 if (opt
.ignore_case
&& !strcmp("less", pager
))
1224 string_list_append(&path_list
, "-I");
1226 if (!strcmp("less", pager
) || !strcmp("vi", pager
)) {
1227 struct strbuf buf
= STRBUF_INIT
;
1228 strbuf_addf(&buf
, "+/%s%s",
1229 strcmp("less", pager
) ? "" : "*",
1230 opt
.pattern_list
->pattern
);
1231 string_list_append_nodup(&path_list
,
1232 strbuf_detach(&buf
, NULL
));
1236 if (!show_in_pager
&& !opt
.status_only
)
1239 die_for_incompatible_opt3(!use_index
, "--no-index",
1240 untracked
, "--untracked",
1241 cached
, "--cached");
1243 if (!use_index
|| untracked
) {
1244 int use_exclude
= (opt_exclude
< 0) ? use_index
: !!opt_exclude
;
1245 hit
= grep_directory(&opt
, &pathspec
, use_exclude
, use_index
);
1246 } else if (0 <= opt_exclude
) {
1247 die(_("--[no-]exclude-standard cannot be used for tracked contents"));
1248 } else if (!list
.nr
) {
1252 hit
= grep_cache(&opt
, &pathspec
, cached
);
1255 die(_("both --cached and trees are given"));
1257 hit
= grep_objects(&opt
, &pathspec
, &list
);
1260 if (num_threads
> 1)
1262 if (hit
&& show_in_pager
)
1263 run_pager(&opt
, prefix
);
1264 clear_pathspec(&pathspec
);
1265 string_list_clear(&path_list
, 0);
1266 free_grep_patterns(&opt
);
1267 object_array_clear(&list
);