4 * Copyright (c) 2006 Junio C Hamano
9 #include "repository.h"
15 #include "tree-walk.h"
16 #include "parse-options.h"
17 #include "string-list.h"
18 #include "run-command.h"
25 #include "submodule.h"
26 #include "submodule-config.h"
27 #include "object-file.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
33 #include "read-cache-ll.h"
34 #include "write-or-die.h"
36 static const char *grep_prefix
;
38 static char const * const grep_usage
[] = {
39 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
43 static int recurse_submodules
;
45 static int num_threads
;
47 static pthread_t
*threads
;
49 /* We use one producer thread and THREADS consumer
50 * threads. The producer adds struct work_items to 'todo' and the
51 * consumers pick work items from the same array.
54 struct grep_source source
;
59 /* In the range [todo_done, todo_start) in 'todo' we have work_items
60 * that have been or are processed by a consumer thread. We haven't
61 * written the result for these to stdout yet.
63 * The work_items in [todo_start, todo_end) are waiting to be picked
64 * up by a consumer thread.
66 * The ranges are modulo TODO_SIZE.
69 static struct work_item todo
[TODO_SIZE
];
70 static int todo_start
;
74 /* Has all work items been added? */
75 static int all_work_added
;
77 static struct repository
**repos_to_free
;
78 static size_t repos_to_free_nr
, repos_to_free_alloc
;
80 /* This lock protects all the variables above. */
81 static pthread_mutex_t grep_mutex
;
83 static inline void grep_lock(void)
85 pthread_mutex_lock(&grep_mutex
);
88 static inline void grep_unlock(void)
90 pthread_mutex_unlock(&grep_mutex
);
93 /* Signalled when a new work_item is added to todo. */
94 static pthread_cond_t cond_add
;
96 /* Signalled when the result from one work_item is written to
99 static pthread_cond_t cond_write
;
101 /* Signalled when we are finished with everything. */
102 static pthread_cond_t cond_result
;
104 static int skip_first_line
;
106 static void add_work(struct grep_opt
*opt
, struct grep_source
*gs
)
108 if (opt
->binary
!= GREP_BINARY_TEXT
)
109 grep_source_load_driver(gs
, opt
->repo
->index
);
113 while ((todo_end
+1) % ARRAY_SIZE(todo
) == todo_done
) {
114 pthread_cond_wait(&cond_write
, &grep_mutex
);
117 todo
[todo_end
].source
= *gs
;
118 todo
[todo_end
].done
= 0;
119 strbuf_reset(&todo
[todo_end
].out
);
120 todo_end
= (todo_end
+ 1) % ARRAY_SIZE(todo
);
122 pthread_cond_signal(&cond_add
);
126 static struct work_item
*get_work(void)
128 struct work_item
*ret
;
131 while (todo_start
== todo_end
&& !all_work_added
) {
132 pthread_cond_wait(&cond_add
, &grep_mutex
);
135 if (todo_start
== todo_end
&& all_work_added
) {
138 ret
= &todo
[todo_start
];
139 todo_start
= (todo_start
+ 1) % ARRAY_SIZE(todo
);
145 static void work_done(struct work_item
*w
)
151 old_done
= todo_done
;
152 for(; todo
[todo_done
].done
&& todo_done
!= todo_start
;
153 todo_done
= (todo_done
+1) % ARRAY_SIZE(todo
)) {
154 w
= &todo
[todo_done
];
156 const char *p
= w
->out
.buf
;
157 size_t len
= w
->out
.len
;
159 /* Skip the leading hunk mark of the first file. */
160 if (skip_first_line
) {
169 write_or_die(1, p
, len
);
171 grep_source_clear(&w
->source
);
174 if (old_done
!= todo_done
)
175 pthread_cond_signal(&cond_write
);
177 if (all_work_added
&& todo_done
== todo_end
)
178 pthread_cond_signal(&cond_result
);
183 static void free_repos(void)
187 for (i
= 0; i
< repos_to_free_nr
; i
++) {
188 repo_clear(repos_to_free
[i
]);
189 free(repos_to_free
[i
]);
191 FREE_AND_NULL(repos_to_free
);
192 repos_to_free_nr
= 0;
193 repos_to_free_alloc
= 0;
196 static void *run(void *arg
)
199 struct grep_opt
*opt
= arg
;
202 struct work_item
*w
= get_work();
206 opt
->output_priv
= w
;
207 hit
|= grep_source(opt
, &w
->source
);
208 grep_source_clear_data(&w
->source
);
211 free_grep_patterns(opt
);
214 return (void*) (intptr_t) hit
;
217 static void strbuf_out(struct grep_opt
*opt
, const void *buf
, size_t size
)
219 struct work_item
*w
= opt
->output_priv
;
220 strbuf_add(&w
->out
, buf
, size
);
223 static void start_threads(struct grep_opt
*opt
)
227 pthread_mutex_init(&grep_mutex
, NULL
);
228 pthread_mutex_init(&grep_attr_mutex
, NULL
);
229 pthread_cond_init(&cond_add
, NULL
);
230 pthread_cond_init(&cond_write
, NULL
);
231 pthread_cond_init(&cond_result
, NULL
);
233 enable_obj_read_lock();
235 for (i
= 0; i
< ARRAY_SIZE(todo
); i
++) {
236 strbuf_init(&todo
[i
].out
, 0);
239 CALLOC_ARRAY(threads
, num_threads
);
240 for (i
= 0; i
< num_threads
; i
++) {
242 struct grep_opt
*o
= grep_opt_dup(opt
);
243 o
->output
= strbuf_out
;
244 compile_grep_patterns(o
);
245 err
= pthread_create(&threads
[i
], NULL
, run
, o
);
248 die(_("grep: failed to create thread: %s"),
253 static int wait_all(void)
259 BUG("Never call this function unless you have started threads");
264 /* Wait until all work is done. */
265 while (todo_done
!= todo_end
)
266 pthread_cond_wait(&cond_result
, &grep_mutex
);
268 /* Wake up all the consumer threads so they can see that there
269 * is no more work to do.
271 pthread_cond_broadcast(&cond_add
);
274 for (i
= 0; i
< num_threads
; i
++) {
276 pthread_join(threads
[i
], &h
);
277 hit
|= (int) (intptr_t) h
;
282 pthread_mutex_destroy(&grep_mutex
);
283 pthread_mutex_destroy(&grep_attr_mutex
);
284 pthread_cond_destroy(&cond_add
);
285 pthread_cond_destroy(&cond_write
);
286 pthread_cond_destroy(&cond_result
);
288 disable_obj_read_lock();
293 static int grep_cmd_config(const char *var
, const char *value
,
294 const struct config_context
*ctx
, void *cb
)
296 int st
= grep_config(var
, value
, ctx
, cb
);
298 if (git_color_config(var
, value
, cb
) < 0)
300 else if (git_default_config(var
, value
, ctx
, cb
) < 0)
303 if (!strcmp(var
, "grep.threads")) {
304 num_threads
= git_config_int(var
, value
, ctx
->kvi
);
306 die(_("invalid number of threads specified (%d) for %s"),
308 else if (!HAVE_THREADS
&& num_threads
> 1) {
310 * TRANSLATORS: %s is the configuration
311 * variable for tweaking threads, currently
314 warning(_("no threads support, ignoring %s"), var
);
319 if (!strcmp(var
, "submodule.recurse"))
320 recurse_submodules
= git_config_bool(var
, value
);
325 static void grep_source_name(struct grep_opt
*opt
, const char *filename
,
326 int tree_name_len
, struct strbuf
*out
)
330 if (opt
->null_following_name
) {
331 if (opt
->relative
&& grep_prefix
) {
332 struct strbuf rel_buf
= STRBUF_INIT
;
333 const char *rel_name
=
334 relative_path(filename
+ tree_name_len
,
335 grep_prefix
, &rel_buf
);
338 strbuf_add(out
, filename
, tree_name_len
);
340 strbuf_addstr(out
, rel_name
);
341 strbuf_release(&rel_buf
);
343 strbuf_addstr(out
, filename
);
348 if (opt
->relative
&& grep_prefix
)
349 quote_path(filename
+ tree_name_len
, grep_prefix
, out
, 0);
351 quote_c_style(filename
+ tree_name_len
, out
, NULL
, 0);
354 strbuf_insert(out
, 0, filename
, tree_name_len
);
357 static int grep_oid(struct grep_opt
*opt
, const struct object_id
*oid
,
358 const char *filename
, int tree_name_len
,
361 struct strbuf pathbuf
= STRBUF_INIT
;
362 struct grep_source gs
;
364 grep_source_name(opt
, filename
, tree_name_len
, &pathbuf
);
365 grep_source_init_oid(&gs
, pathbuf
.buf
, path
, oid
, opt
->repo
);
366 strbuf_release(&pathbuf
);
368 if (num_threads
> 1) {
370 * add_work() copies gs and thus assumes ownership of
371 * its fields, so do not call grep_source_clear()
378 hit
= grep_source(opt
, &gs
);
380 grep_source_clear(&gs
);
385 static int grep_file(struct grep_opt
*opt
, const char *filename
)
387 struct strbuf buf
= STRBUF_INIT
;
388 struct grep_source gs
;
390 grep_source_name(opt
, filename
, 0, &buf
);
391 grep_source_init_file(&gs
, buf
.buf
, filename
);
392 strbuf_release(&buf
);
394 if (num_threads
> 1) {
396 * add_work() copies gs and thus assumes ownership of
397 * its fields, so do not call grep_source_clear()
404 hit
= grep_source(opt
, &gs
);
406 grep_source_clear(&gs
);
411 static void append_path(struct grep_opt
*opt
, const void *data
, size_t len
)
413 struct string_list
*path_list
= opt
->output_priv
;
415 if (len
== 1 && *(const char *)data
== '\0')
417 string_list_append_nodup(path_list
, xstrndup(data
, len
));
420 static void run_pager(struct grep_opt
*opt
, const char *prefix
)
422 struct string_list
*path_list
= opt
->output_priv
;
423 struct child_process child
= CHILD_PROCESS_INIT
;
426 for (i
= 0; i
< path_list
->nr
; i
++)
427 strvec_push(&child
.args
, path_list
->items
[i
].string
);
431 status
= run_command(&child
);
436 static int grep_cache(struct grep_opt
*opt
,
437 const struct pathspec
*pathspec
, int cached
);
438 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
439 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
442 static int grep_submodule(struct grep_opt
*opt
,
443 const struct pathspec
*pathspec
,
444 const struct object_id
*oid
,
445 const char *filename
, const char *path
, int cached
)
447 struct repository
*subrepo
;
448 struct repository
*superproject
= opt
->repo
;
449 struct grep_opt subopt
;
452 if (!is_submodule_active(superproject
, path
))
455 subrepo
= xmalloc(sizeof(*subrepo
));
456 if (repo_submodule_init(subrepo
, superproject
, path
, null_oid())) {
460 ALLOC_GROW(repos_to_free
, repos_to_free_nr
+ 1, repos_to_free_alloc
);
461 repos_to_free
[repos_to_free_nr
++] = subrepo
;
464 * NEEDSWORK: repo_read_gitmodules() might call
465 * add_to_alternates_memory() via config_from_gitmodules(). This
466 * operation causes a race condition with concurrent object readings
467 * performed by the worker threads. That's why we need obj_read_lock()
468 * here. It should be removed once it's no longer necessary to add the
469 * subrepo's odbs to the in-memory alternates list.
474 * NEEDSWORK: when reading a submodule, the sparsity settings in the
475 * superproject are incorrectly forgotten or misused. For example:
477 * 1. "command_requires_full_index"
478 * When this setting is turned on for `grep`, only the superproject
479 * knows it. All the submodules are read with their own configs
480 * and get prepare_repo_settings()'d. Therefore, these submodules
481 * "forget" the sparse-index feature switch. As a result, the index
482 * of these submodules are expanded unexpectedly.
484 * 2. "core_apply_sparse_checkout"
485 * When running `grep` in the superproject, this setting is
486 * populated using the superproject's configs. However, once
487 * initialized, this config is globally accessible and is read by
488 * prepare_repo_settings() for the submodules. For instance, if a
489 * submodule is using a sparse-checkout, however, the superproject
490 * is not, the result is that the config from the superproject will
491 * dictate the behavior for the submodule, making it "forget" its
492 * sparse-checkout state.
494 * 3. "core_sparse_checkout_cone"
497 * Note that this list is not exhaustive.
499 repo_read_gitmodules(subrepo
, 0);
502 * All code paths tested by test code no longer need submodule ODBs to
503 * be added as alternates, but add it to the list just in case.
504 * Submodule ODBs added through add_submodule_odb_by_path() will be
505 * lazily registered as alternates when needed (and except in an
506 * unexpected code interaction, it won't be needed).
508 add_submodule_odb_by_path(subrepo
->objects
->odb
->path
);
511 memcpy(&subopt
, opt
, sizeof(subopt
));
512 subopt
.repo
= subrepo
;
515 enum object_type object_type
;
516 struct tree_desc tree
;
519 struct strbuf base
= STRBUF_INIT
;
522 object_type
= oid_object_info(subrepo
, oid
, NULL
);
524 data
= read_object_with_reference(subrepo
,
528 die(_("unable to read tree (%s)"), oid_to_hex(oid
));
530 strbuf_addstr(&base
, filename
);
531 strbuf_addch(&base
, '/');
533 init_tree_desc(&tree
, data
, size
);
534 hit
= grep_tree(&subopt
, pathspec
, &tree
, &base
, base
.len
,
535 object_type
== OBJ_COMMIT
);
536 strbuf_release(&base
);
539 hit
= grep_cache(&subopt
, pathspec
, cached
);
545 static int grep_cache(struct grep_opt
*opt
,
546 const struct pathspec
*pathspec
, int cached
)
548 struct repository
*repo
= opt
->repo
;
551 struct strbuf name
= STRBUF_INIT
;
552 int name_base_len
= 0;
553 if (repo
->submodule_prefix
) {
554 name_base_len
= strlen(repo
->submodule_prefix
);
555 strbuf_addstr(&name
, repo
->submodule_prefix
);
558 if (repo_read_index(repo
) < 0)
559 die(_("index file corrupt"));
561 for (nr
= 0; nr
< repo
->index
->cache_nr
; nr
++) {
562 const struct cache_entry
*ce
= repo
->index
->cache
[nr
];
564 if (!cached
&& ce_skip_worktree(ce
))
567 strbuf_setlen(&name
, name_base_len
);
568 strbuf_addstr(&name
, ce
->name
);
569 if (S_ISSPARSEDIR(ce
->ce_mode
)) {
570 enum object_type type
;
571 struct tree_desc tree
;
575 data
= repo_read_object_file(the_repository
, &ce
->oid
,
577 init_tree_desc(&tree
, data
, size
);
579 hit
|= grep_tree(opt
, pathspec
, &tree
, &name
, 0, 0);
580 strbuf_setlen(&name
, name_base_len
);
581 strbuf_addstr(&name
, ce
->name
);
583 } else if (S_ISREG(ce
->ce_mode
) &&
584 match_pathspec(repo
->index
, pathspec
, name
.buf
, name
.len
, 0, NULL
,
585 S_ISDIR(ce
->ce_mode
) ||
586 S_ISGITLINK(ce
->ce_mode
))) {
588 * If CE_VALID is on, we assume worktree file and its
589 * cache entry are identical, even if worktree file has
590 * been modified, so use cache version instead
592 if (cached
|| (ce
->ce_flags
& CE_VALID
)) {
593 if (ce_stage(ce
) || ce_intent_to_add(ce
))
595 hit
|= grep_oid(opt
, &ce
->oid
, name
.buf
,
598 hit
|= grep_file(opt
, name
.buf
);
600 } else if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
601 submodule_path_match(repo
->index
, pathspec
, name
.buf
, NULL
)) {
602 hit
|= grep_submodule(opt
, pathspec
, NULL
, ce
->name
,
611 } while (nr
< repo
->index
->cache_nr
&&
612 !strcmp(ce
->name
, repo
->index
->cache
[nr
]->name
));
613 nr
--; /* compensate for loop control */
615 if (hit
&& opt
->status_only
)
619 strbuf_release(&name
);
623 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
624 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
627 struct repository
*repo
= opt
->repo
;
629 enum interesting match
= entry_not_interesting
;
630 struct name_entry entry
;
631 int old_baselen
= base
->len
;
632 struct strbuf name
= STRBUF_INIT
;
633 int name_base_len
= 0;
634 if (repo
->submodule_prefix
) {
635 strbuf_addstr(&name
, repo
->submodule_prefix
);
636 name_base_len
= name
.len
;
639 while (tree_entry(tree
, &entry
)) {
640 int te_len
= tree_entry_len(&entry
);
642 if (match
!= all_entries_interesting
) {
643 strbuf_addstr(&name
, base
->buf
+ tn_len
);
644 match
= tree_entry_interesting(repo
->index
,
647 strbuf_setlen(&name
, name_base_len
);
649 if (match
== all_entries_not_interesting
)
651 if (match
== entry_not_interesting
)
655 strbuf_add(base
, entry
.path
, te_len
);
657 if (S_ISREG(entry
.mode
)) {
658 hit
|= grep_oid(opt
, &entry
.oid
, base
->buf
, tn_len
,
659 check_attr
? base
->buf
+ tn_len
: NULL
);
660 } else if (S_ISDIR(entry
.mode
)) {
661 enum object_type type
;
662 struct tree_desc sub
;
666 data
= repo_read_object_file(the_repository
,
667 &entry
.oid
, &type
, &size
);
669 die(_("unable to read tree (%s)"),
670 oid_to_hex(&entry
.oid
));
672 strbuf_addch(base
, '/');
673 init_tree_desc(&sub
, data
, size
);
674 hit
|= grep_tree(opt
, pathspec
, &sub
, base
, tn_len
,
677 } else if (recurse_submodules
&& S_ISGITLINK(entry
.mode
)) {
678 hit
|= grep_submodule(opt
, pathspec
, &entry
.oid
,
679 base
->buf
, base
->buf
+ tn_len
,
683 strbuf_setlen(base
, old_baselen
);
685 if (hit
&& opt
->status_only
)
689 strbuf_release(&name
);
693 static int grep_object(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
694 struct object
*obj
, const char *name
, const char *path
)
696 if (obj
->type
== OBJ_BLOB
)
697 return grep_oid(opt
, &obj
->oid
, name
, 0, path
);
698 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
699 struct tree_desc tree
;
705 data
= read_object_with_reference(opt
->repo
,
709 die(_("unable to read tree (%s)"), oid_to_hex(&obj
->oid
));
711 len
= name
? strlen(name
) : 0;
712 strbuf_init(&base
, PATH_MAX
+ len
+ 1);
714 strbuf_add(&base
, name
, len
);
715 strbuf_addch(&base
, ':');
717 init_tree_desc(&tree
, data
, size
);
718 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
,
719 obj
->type
== OBJ_COMMIT
);
720 strbuf_release(&base
);
724 die(_("unable to grep from object of type %s"), type_name(obj
->type
));
727 static int grep_objects(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
728 const struct object_array
*list
)
732 const unsigned int nr
= list
->nr
;
734 for (i
= 0; i
< nr
; i
++) {
735 struct object
*real_obj
;
738 real_obj
= deref_tag(opt
->repo
, list
->objects
[i
].item
,
743 char hex
[GIT_MAX_HEXSZ
+ 1];
744 const char *name
= list
->objects
[i
].name
;
747 oid_to_hex_r(hex
, &list
->objects
[i
].item
->oid
);
750 die(_("invalid object '%s' given."), name
);
753 /* load the gitmodules file for this rev */
754 if (recurse_submodules
) {
755 submodule_free(opt
->repo
);
757 gitmodules_config_oid(&real_obj
->oid
);
760 if (grep_object(opt
, pathspec
, real_obj
, list
->objects
[i
].name
,
761 list
->objects
[i
].path
)) {
763 if (opt
->status_only
)
770 static int grep_directory(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
771 int exc_std
, int use_index
)
773 struct dir_struct dir
= DIR_INIT
;
777 dir
.flags
|= DIR_NO_GITLINKS
;
779 setup_standard_excludes(&dir
);
781 fill_directory(&dir
, opt
->repo
->index
, pathspec
);
782 for (i
= 0; i
< dir
.nr
; i
++) {
783 hit
|= grep_file(opt
, dir
.entries
[i
]->name
);
784 if (hit
&& opt
->status_only
)
791 static int context_callback(const struct option
*opt
, const char *arg
,
794 struct grep_opt
*grep_opt
= opt
->value
;
799 grep_opt
->pre_context
= grep_opt
->post_context
= 0;
802 value
= strtol(arg
, (char **)&endp
, 10);
804 return error(_("switch `%c' expects a numerical value"),
807 grep_opt
->pre_context
= grep_opt
->post_context
= value
;
811 static int file_callback(const struct option
*opt
, const char *arg
, int unset
)
813 struct grep_opt
*grep_opt
= opt
->value
;
817 struct strbuf sb
= STRBUF_INIT
;
819 BUG_ON_OPT_NEG(unset
);
821 from_stdin
= !strcmp(arg
, "-");
822 patterns
= from_stdin
? stdin
: fopen(arg
, "r");
824 die_errno(_("cannot open '%s'"), arg
);
825 while (strbuf_getline(&sb
, patterns
) == 0) {
826 /* ignore empty line like grep does */
830 append_grep_pat(grep_opt
, sb
.buf
, sb
.len
, arg
, ++lno
,
839 static int not_callback(const struct option
*opt
, const char *arg
, int unset
)
841 struct grep_opt
*grep_opt
= opt
->value
;
842 BUG_ON_OPT_NEG(unset
);
844 append_grep_pattern(grep_opt
, "--not", "command line", 0, GREP_NOT
);
848 static int and_callback(const struct option
*opt
, const char *arg
, int unset
)
850 struct grep_opt
*grep_opt
= opt
->value
;
851 BUG_ON_OPT_NEG(unset
);
853 append_grep_pattern(grep_opt
, "--and", "command line", 0, GREP_AND
);
857 static int open_callback(const struct option
*opt
, const char *arg
, int unset
)
859 struct grep_opt
*grep_opt
= opt
->value
;
860 BUG_ON_OPT_NEG(unset
);
862 append_grep_pattern(grep_opt
, "(", "command line", 0, GREP_OPEN_PAREN
);
866 static int close_callback(const struct option
*opt
, const char *arg
, int unset
)
868 struct grep_opt
*grep_opt
= opt
->value
;
869 BUG_ON_OPT_NEG(unset
);
871 append_grep_pattern(grep_opt
, ")", "command line", 0, GREP_CLOSE_PAREN
);
875 static int pattern_callback(const struct option
*opt
, const char *arg
,
878 struct grep_opt
*grep_opt
= opt
->value
;
879 BUG_ON_OPT_NEG(unset
);
880 append_grep_pattern(grep_opt
, arg
, "-e option", 0, GREP_PATTERN
);
884 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
887 int cached
= 0, untracked
= 0, opt_exclude
= -1;
888 int seen_dashdash
= 0;
889 int external_grep_allowed__ignored
;
890 const char *show_in_pager
= NULL
, *default_pager
= "dummy";
892 struct object_array list
= OBJECT_ARRAY_INIT
;
893 struct pathspec pathspec
;
894 struct string_list path_list
= STRING_LIST_INIT_DUP
;
900 struct option options
[] = {
901 OPT_BOOL(0, "cached", &cached
,
902 N_("search in index instead of in the work tree")),
903 OPT_NEGBIT(0, "no-index", &use_index
,
904 N_("find in contents not managed by git"), 1),
905 OPT_BOOL(0, "untracked", &untracked
,
906 N_("search in both tracked and untracked files")),
907 OPT_SET_INT(0, "exclude-standard", &opt_exclude
,
908 N_("ignore files specified via '.gitignore'"), 1),
909 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
910 N_("recursively search in each submodule")),
912 OPT_BOOL('v', "invert-match", &opt
.invert
,
913 N_("show non-matching lines")),
914 OPT_BOOL('i', "ignore-case", &opt
.ignore_case
,
915 N_("case insensitive matching")),
916 OPT_BOOL('w', "word-regexp", &opt
.word_regexp
,
917 N_("match patterns only at word boundaries")),
918 OPT_SET_INT('a', "text", &opt
.binary
,
919 N_("process binary files as text"), GREP_BINARY_TEXT
),
920 OPT_SET_INT('I', NULL
, &opt
.binary
,
921 N_("don't match patterns in binary files"),
922 GREP_BINARY_NOMATCH
),
923 OPT_BOOL(0, "textconv", &opt
.allow_textconv
,
924 N_("process binary files with textconv filters")),
925 OPT_SET_INT('r', "recursive", &opt
.max_depth
,
926 N_("search in subdirectories (default)"), -1),
927 { OPTION_INTEGER
, 0, "max-depth", &opt
.max_depth
, N_("depth"),
928 N_("descend at most <depth> levels"), PARSE_OPT_NONEG
,
931 OPT_SET_INT('E', "extended-regexp", &opt
.pattern_type_option
,
932 N_("use extended POSIX regular expressions"),
933 GREP_PATTERN_TYPE_ERE
),
934 OPT_SET_INT('G', "basic-regexp", &opt
.pattern_type_option
,
935 N_("use basic POSIX regular expressions (default)"),
936 GREP_PATTERN_TYPE_BRE
),
937 OPT_SET_INT('F', "fixed-strings", &opt
.pattern_type_option
,
938 N_("interpret patterns as fixed strings"),
939 GREP_PATTERN_TYPE_FIXED
),
940 OPT_SET_INT('P', "perl-regexp", &opt
.pattern_type_option
,
941 N_("use Perl-compatible regular expressions"),
942 GREP_PATTERN_TYPE_PCRE
),
944 OPT_BOOL('n', "line-number", &opt
.linenum
, N_("show line numbers")),
945 OPT_BOOL(0, "column", &opt
.columnnum
, N_("show column number of first match")),
946 OPT_NEGBIT('h', NULL
, &opt
.pathname
, N_("don't show filenames"), 1),
947 OPT_BIT('H', NULL
, &opt
.pathname
, N_("show filenames"), 1),
948 OPT_NEGBIT(0, "full-name", &opt
.relative
,
949 N_("show filenames relative to top directory"), 1),
950 OPT_BOOL('l', "files-with-matches", &opt
.name_only
,
951 N_("show only filenames instead of matching lines")),
952 OPT_BOOL(0, "name-only", &opt
.name_only
,
953 N_("synonym for --files-with-matches")),
954 OPT_BOOL('L', "files-without-match",
955 &opt
.unmatch_name_only
,
956 N_("show only the names of files without match")),
957 OPT_BOOL_F('z', "null", &opt
.null_following_name
,
958 N_("print NUL after filenames"),
959 PARSE_OPT_NOCOMPLETE
),
960 OPT_BOOL('o', "only-matching", &opt
.only_matching
,
961 N_("show only matching parts of a line")),
962 OPT_BOOL('c', "count", &opt
.count
,
963 N_("show the number of matches instead of matching lines")),
964 OPT__COLOR(&opt
.color
, N_("highlight matches")),
965 OPT_BOOL(0, "break", &opt
.file_break
,
966 N_("print empty line between matches from different files")),
967 OPT_BOOL(0, "heading", &opt
.heading
,
968 N_("show filename only once above matches from same file")),
970 OPT_CALLBACK('C', "context", &opt
, N_("n"),
971 N_("show <n> context lines before and after matches"),
973 OPT_INTEGER('B', "before-context", &opt
.pre_context
,
974 N_("show <n> context lines before matches")),
975 OPT_INTEGER('A', "after-context", &opt
.post_context
,
976 N_("show <n> context lines after matches")),
977 OPT_INTEGER(0, "threads", &num_threads
,
978 N_("use <n> worker threads")),
979 OPT_NUMBER_CALLBACK(&opt
, N_("shortcut for -C NUM"),
981 OPT_BOOL('p', "show-function", &opt
.funcname
,
982 N_("show a line with the function name before matches")),
983 OPT_BOOL('W', "function-context", &opt
.funcbody
,
984 N_("show the surrounding function")),
986 OPT_CALLBACK('f', NULL
, &opt
, N_("file"),
987 N_("read patterns from file"), file_callback
),
988 OPT_CALLBACK_F('e', NULL
, &opt
, N_("pattern"),
989 N_("match <pattern>"), PARSE_OPT_NONEG
, pattern_callback
),
990 OPT_CALLBACK_F(0, "and", &opt
, NULL
,
991 N_("combine patterns specified with -e"),
992 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, and_callback
),
993 OPT_BOOL(0, "or", &dummy
, ""),
994 OPT_CALLBACK_F(0, "not", &opt
, NULL
, "",
995 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, not_callback
),
996 OPT_CALLBACK_F('(', NULL
, &opt
, NULL
, "",
997 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
999 OPT_CALLBACK_F(')', NULL
, &opt
, NULL
, "",
1000 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
1002 OPT__QUIET(&opt
.status_only
,
1003 N_("indicate hit with exit status without output")),
1004 OPT_BOOL(0, "all-match", &opt
.all_match
,
1005 N_("show only matches from files that match all patterns")),
1007 { OPTION_STRING
, 'O', "open-files-in-pager", &show_in_pager
,
1008 N_("pager"), N_("show matching files in the pager"),
1009 PARSE_OPT_OPTARG
| PARSE_OPT_NOCOMPLETE
,
1010 NULL
, (intptr_t)default_pager
},
1011 OPT_BOOL_F(0, "ext-grep", &external_grep_allowed__ignored
,
1012 N_("allow calling of grep(1) (ignored by this build)"),
1013 PARSE_OPT_NOCOMPLETE
),
1014 OPT_INTEGER('m', "max-count", &opt
.max_count
,
1015 N_("maximum number of results per file")),
1018 grep_prefix
= prefix
;
1020 grep_init(&opt
, the_repository
);
1021 git_config(grep_cmd_config
, &opt
);
1024 * If there is no -- then the paths must exist in the working
1025 * tree. If there is no explicit pattern specified with -e or
1026 * -f, we take the first unrecognized non option to be the
1027 * pattern, but then what follows it must be zero or more
1028 * valid refs up to the -- (if exists), and then existing
1029 * paths. If there is an explicit pattern, then the first
1030 * unrecognized non option is the beginning of the refs list
1031 * that continues up to the -- (if exists), and then paths.
1033 argc
= parse_options(argc
, argv
, prefix
, options
, grep_usage
,
1034 PARSE_OPT_KEEP_DASHDASH
|
1035 PARSE_OPT_STOP_AT_NON_OPTION
);
1037 if (the_repository
->gitdir
) {
1038 prepare_repo_settings(the_repository
);
1039 the_repository
->settings
.command_requires_full_index
= 0;
1042 if (use_index
&& !startup_info
->have_repository
) {
1044 git_config_get_bool("grep.fallbacktonoindex", &fallback
);
1048 /* die the same way as if we did it at the beginning */
1049 setup_git_directory();
1051 /* Ignore --recurse-submodules if --no-index is given or implied */
1053 recurse_submodules
= 0;
1056 * skip a -- separator; we know it cannot be
1057 * separating revisions from pathnames if
1058 * we haven't even had any patterns yet
1060 if (argc
> 0 && !opt
.pattern_list
&& !strcmp(argv
[0], "--")) {
1065 /* First unrecognized non-option token */
1066 if (argc
> 0 && !opt
.pattern_list
) {
1067 append_grep_pattern(&opt
, argv
[0], "command line", 0,
1073 if (show_in_pager
== default_pager
)
1074 show_in_pager
= git_pager(1);
1075 if (show_in_pager
) {
1078 opt
.null_following_name
= 1;
1079 opt
.output_priv
= &path_list
;
1080 opt
.output
= append_path
;
1081 string_list_append(&path_list
, show_in_pager
);
1084 if (!opt
.pattern_list
)
1085 die(_("no pattern given"));
1087 /* --only-matching has no effect with --invert. */
1089 opt
.only_matching
= 0;
1092 * We have to find "--" in a separate pass, because its presence
1093 * influences how we will parse arguments that come before it.
1095 for (i
= 0; i
< argc
; i
++) {
1096 if (!strcmp(argv
[i
], "--")) {
1103 * Resolve any rev arguments. If we have a dashdash, then everything up
1104 * to it must resolve as a rev. If not, then we stop at the first
1105 * non-rev and assume everything else is a path.
1107 allow_revs
= use_index
&& !untracked
;
1108 for (i
= 0; i
< argc
; i
++) {
1109 const char *arg
= argv
[i
];
1110 struct object_id oid
;
1111 struct object_context oc
;
1112 struct object
*object
;
1114 if (!strcmp(arg
, "--")) {
1121 die(_("--no-index or --untracked cannot be used with revs"));
1125 if (get_oid_with_context(the_repository
, arg
,
1126 GET_OID_RECORD_PATH
,
1129 die(_("unable to resolve revision: %s"), arg
);
1133 object
= parse_object_or_die(&oid
, arg
);
1135 verify_non_filename(prefix
, arg
);
1136 add_object_array_with_path(object
, arg
, &list
, oc
.mode
, oc
.path
);
1141 * Anything left over is presumed to be a path. But in the non-dashdash
1142 * "do what I mean" case, we verify and complain when that isn't true.
1144 if (!seen_dashdash
) {
1146 for (j
= i
; j
< argc
; j
++)
1147 verify_filename(prefix
, argv
[j
], j
== i
&& allow_revs
);
1150 parse_pathspec(&pathspec
, 0,
1151 PATHSPEC_PREFER_CWD
|
1152 (opt
.max_depth
!= -1 ? PATHSPEC_MAXDEPTH_VALID
: 0),
1154 pathspec
.max_depth
= opt
.max_depth
;
1155 pathspec
.recursive
= 1;
1156 pathspec
.recurse_submodules
= !!recurse_submodules
;
1158 if (recurse_submodules
&& untracked
)
1159 die(_("--untracked not supported with --recurse-submodules"));
1162 * Optimize out the case where the amount of matches is limited to zero.
1163 * We do this to keep results consistent with GNU grep(1).
1165 if (opt
.max_count
== 0)
1168 if (show_in_pager
) {
1169 if (num_threads
> 1)
1170 warning(_("invalid option combination, ignoring --threads"));
1172 } else if (!HAVE_THREADS
&& num_threads
> 1) {
1173 warning(_("no threads support, ignoring --threads"));
1175 } else if (num_threads
< 0)
1176 die(_("invalid number of threads specified (%d)"), num_threads
);
1177 else if (num_threads
== 0)
1178 num_threads
= HAVE_THREADS
? online_cpus() : 1;
1180 if (num_threads
> 1) {
1182 BUG("Somebody got num_threads calculation wrong!");
1183 if (!(opt
.name_only
|| opt
.unmatch_name_only
|| opt
.count
)
1184 && (opt
.pre_context
|| opt
.post_context
||
1185 opt
.file_break
|| opt
.funcbody
))
1186 skip_first_line
= 1;
1189 * Pre-read gitmodules (if not read already) and force eager
1190 * initialization of packed_git to prevent racy lazy
1191 * reading/initialization once worker threads are started.
1193 if (recurse_submodules
)
1194 repo_read_gitmodules(the_repository
, 1);
1195 if (startup_info
->have_repository
)
1196 (void)get_packed_git(the_repository
);
1198 start_threads(&opt
);
1201 * The compiled patterns on the main path are only
1202 * used when not using threading. Otherwise
1203 * start_threads() above calls compile_grep_patterns()
1206 compile_grep_patterns(&opt
);
1209 if (show_in_pager
&& (cached
|| list
.nr
))
1210 die(_("--open-files-in-pager only works on the worktree"));
1212 if (show_in_pager
&& opt
.pattern_list
&& !opt
.pattern_list
->next
) {
1213 const char *pager
= path_list
.items
[0].string
;
1214 int len
= strlen(pager
);
1216 if (len
> 4 && is_dir_sep(pager
[len
- 5]))
1219 if (opt
.ignore_case
&& !strcmp("less", pager
))
1220 string_list_append(&path_list
, "-I");
1222 if (!strcmp("less", pager
) || !strcmp("vi", pager
)) {
1223 struct strbuf buf
= STRBUF_INIT
;
1224 strbuf_addf(&buf
, "+/%s%s",
1225 strcmp("less", pager
) ? "" : "*",
1226 opt
.pattern_list
->pattern
);
1227 string_list_append_nodup(&path_list
,
1228 strbuf_detach(&buf
, NULL
));
1232 if (!show_in_pager
&& !opt
.status_only
)
1235 die_for_incompatible_opt3(!use_index
, "--no-index",
1236 untracked
, "--untracked",
1237 cached
, "--cached");
1239 if (!use_index
|| untracked
) {
1240 int use_exclude
= (opt_exclude
< 0) ? use_index
: !!opt_exclude
;
1241 hit
= grep_directory(&opt
, &pathspec
, use_exclude
, use_index
);
1242 } else if (0 <= opt_exclude
) {
1243 die(_("--[no-]exclude-standard cannot be used for tracked contents"));
1244 } else if (!list
.nr
) {
1248 hit
= grep_cache(&opt
, &pathspec
, cached
);
1251 die(_("both --cached and trees are given"));
1253 hit
= grep_objects(&opt
, &pathspec
, &list
);
1256 if (num_threads
> 1)
1258 if (hit
&& show_in_pager
)
1259 run_pager(&opt
, prefix
);
1260 clear_pathspec(&pathspec
);
1261 string_list_clear(&path_list
, 0);
1262 free_grep_patterns(&opt
);
1263 object_array_clear(&list
);