1 /*
2 * Builtin "git grep"
3 *
4 * Copyright (c) 2006 Junio C Hamano
5 */
6 #include "cache.h"
7 #include "blob.h"
8 #include "tree.h"
9 #include "commit.h"
10 #include "tag.h"
11 #include "tree-walk.h"
12 #include "builtin.h"
13 #include "parse-options.h"
14 #include "string-list.h"
15 #include "run-command.h"
16 #include "userdiff.h"
17 #include "grep.h"
18 #include "quote.h"
19 #include "dir.h"
21 static char const * const grep_usage[] = {
22 "git grep [options] [-e] <pattern> [<rev>...] [[--] <path>...]",
23 NULL
24 };
26 static int use_threads = 1;
28 #ifndef NO_PTHREADS
29 #define THREADS 8
30 static pthread_t threads[THREADS];
32 static void *load_sha1(const unsigned char *sha1, unsigned long *size,
33 const char *name);
34 static void *load_file(const char *filename, size_t *sz);
36 enum work_type {WORK_SHA1, WORK_FILE};
38 /* We use one producer thread and THREADS consumer
39 * threads. The producer adds struct work_items to 'todo' and the
40 * consumers pick work items from the same array.
41 */
42 struct work_item {
43 enum work_type type;
44 char *name;
46 /* if type == WORK_SHA1, then 'identifier' is a SHA1,
47 * otherwise type == WORK_FILE, and 'identifier' is a NUL
48 * terminated filename.
49 */
50 void *identifier;
51 char done;
52 struct strbuf out;
53 };
55 /* In the range [todo_done, todo_start) in 'todo' we have work_items
56 * that have been or are processed by a consumer thread. We haven't
57 * written the result for these to stdout yet.
58 *
59 * The work_items in [todo_start, todo_end) are waiting to be picked
60 * up by a consumer thread.
61 *
62 * The ranges are modulo TODO_SIZE.
63 */
64 #define TODO_SIZE 128
65 static struct work_item todo[TODO_SIZE];
66 static int todo_start;
67 static int todo_end;
68 static int todo_done;
70 /* Has all work items been added? */
71 static int all_work_added;
73 /* This lock protects all the variables above. */
74 static pthread_mutex_t grep_mutex;
76 static inline void grep_lock(void)
77 {
78 if (use_threads)
79 pthread_mutex_lock(&grep_mutex);
80 }
82 static inline void grep_unlock(void)
83 {
84 if (use_threads)
85 pthread_mutex_unlock(&grep_mutex);
86 }
88 /* Used to serialize calls to read_sha1_file. */
89 static pthread_mutex_t read_sha1_mutex;
91 static inline void read_sha1_lock(void)
92 {
93 if (use_threads)
94 pthread_mutex_lock(&read_sha1_mutex);
95 }
97 static inline void read_sha1_unlock(void)
98 {
99 if (use_threads)
100 pthread_mutex_unlock(&read_sha1_mutex);
101 }
103 /* Signalled when a new work_item is added to todo. */
104 static pthread_cond_t cond_add;
106 /* Signalled when the result from one work_item is written to
107 * stdout.
108 */
109 static pthread_cond_t cond_write;
111 /* Signalled when we are finished with everything. */
112 static pthread_cond_t cond_result;
114 static int skip_first_line;
116 static void add_work(enum work_type type, char *name, void *id)
117 {
118 grep_lock();
120 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
121 pthread_cond_wait(&cond_write, &grep_mutex);
122 }
124 todo[todo_end].type = type;
125 todo[todo_end].name = name;
126 todo[todo_end].identifier = id;
127 todo[todo_end].done = 0;
128 strbuf_reset(&todo[todo_end].out);
129 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
131 pthread_cond_signal(&cond_add);
132 grep_unlock();
133 }
135 static struct work_item *get_work(void)
136 {
137 struct work_item *ret;
139 grep_lock();
140 while (todo_start == todo_end && !all_work_added) {
141 pthread_cond_wait(&cond_add, &grep_mutex);
142 }
144 if (todo_start == todo_end && all_work_added) {
145 ret = NULL;
146 } else {
147 ret = &todo[todo_start];
148 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
149 }
150 grep_unlock();
151 return ret;
152 }
154 static void grep_sha1_async(struct grep_opt *opt, char *name,
155 const unsigned char *sha1)
156 {
157 unsigned char *s;
158 s = xmalloc(20);
159 memcpy(s, sha1, 20);
160 add_work(WORK_SHA1, name, s);
161 }
163 static void grep_file_async(struct grep_opt *opt, char *name,
164 const char *filename)
165 {
166 add_work(WORK_FILE, name, xstrdup(filename));
167 }
169 static void work_done(struct work_item *w)
170 {
171 int old_done;
173 grep_lock();
174 w->done = 1;
175 old_done = todo_done;
176 for(; todo[todo_done].done && todo_done != todo_start;
177 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
178 w = &todo[todo_done];
179 if (w->out.len) {
180 const char *p = w->out.buf;
181 size_t len = w->out.len;
183 /* Skip the leading hunk mark of the first file. */
184 if (skip_first_line) {
185 while (len) {
186 len--;
187 if (*p++ == '\n')
188 break;
189 }
190 skip_first_line = 0;
191 }
193 write_or_die(1, p, len);
194 }
195 free(w->name);
196 free(w->identifier);
197 }
199 if (old_done != todo_done)
200 pthread_cond_signal(&cond_write);
202 if (all_work_added && todo_done == todo_end)
203 pthread_cond_signal(&cond_result);
205 grep_unlock();
206 }
208 static void *run(void *arg)
209 {
210 int hit = 0;
211 struct grep_opt *opt = arg;
213 while (1) {
214 struct work_item *w = get_work();
215 if (!w)
216 break;
218 opt->output_priv = w;
219 if (w->type == WORK_SHA1) {
220 unsigned long sz;
221 void* data = load_sha1(w->identifier, &sz, w->name);
223 if (data) {
224 hit |= grep_buffer(opt, w->name, data, sz);
225 free(data);
226 }
227 } else if (w->type == WORK_FILE) {
228 size_t sz;
229 void* data = load_file(w->identifier, &sz);
230 if (data) {
231 hit |= grep_buffer(opt, w->name, data, sz);
232 free(data);
233 }
234 } else {
235 assert(0);
236 }
238 work_done(w);
239 }
240 free_grep_patterns(arg);
241 free(arg);
243 return (void*) (intptr_t) hit;
244 }
246 static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
247 {
248 struct work_item *w = opt->output_priv;
249 strbuf_add(&w->out, buf, size);
250 }
252 static void start_threads(struct grep_opt *opt)
253 {
254 int i;
256 pthread_mutex_init(&grep_mutex, NULL);
257 pthread_mutex_init(&read_sha1_mutex, NULL);
258 pthread_mutex_init(&grep_attr_mutex, NULL);
259 pthread_cond_init(&cond_add, NULL);
260 pthread_cond_init(&cond_write, NULL);
261 pthread_cond_init(&cond_result, NULL);
262 grep_use_locks = 1;
264 for (i = 0; i < ARRAY_SIZE(todo); i++) {
265 strbuf_init(&todo[i].out, 0);
266 }
268 for (i = 0; i < ARRAY_SIZE(threads); i++) {
269 int err;
270 struct grep_opt *o = grep_opt_dup(opt);
271 o->output = strbuf_out;
272 compile_grep_patterns(o);
273 err = pthread_create(&threads[i], NULL, run, o);
275 if (err)
276 die(_("grep: failed to create thread: %s"),
277 strerror(err));
278 }
279 }
281 static int wait_all(void)
282 {
283 int hit = 0;
284 int i;
286 grep_lock();
287 all_work_added = 1;
289 /* Wait until all work is done. */
290 while (todo_done != todo_end)
291 pthread_cond_wait(&cond_result, &grep_mutex);
293 /* Wake up all the consumer threads so they can see that there
294 * is no more work to do.
295 */
296 pthread_cond_broadcast(&cond_add);
297 grep_unlock();
299 for (i = 0; i < ARRAY_SIZE(threads); i++) {
300 void *h;
301 pthread_join(threads[i], &h);
302 hit |= (int) (intptr_t) h;
303 }
305 pthread_mutex_destroy(&grep_mutex);
306 pthread_mutex_destroy(&read_sha1_mutex);
307 pthread_mutex_destroy(&grep_attr_mutex);
308 pthread_cond_destroy(&cond_add);
309 pthread_cond_destroy(&cond_write);
310 pthread_cond_destroy(&cond_result);
311 grep_use_locks = 0;
313 return hit;
314 }
315 #else /* !NO_PTHREADS */
316 #define read_sha1_lock()
317 #define read_sha1_unlock()
319 static int wait_all(void)
320 {
321 return 0;
322 }
323 #endif
325 static int grep_config(const char *var, const char *value, void *cb)
326 {
327 struct grep_opt *opt = cb;
328 char *color = NULL;
330 switch (userdiff_config(var, value)) {
331 case 0: break;
332 case -1: return -1;
333 default: return 0;
334 }
336 if (!strcmp(var, "grep.extendedregexp")) {
337 if (git_config_bool(var, value))
338 opt->regflags |= REG_EXTENDED;
339 else
340 opt->regflags &= ~REG_EXTENDED;
341 return 0;
342 }
344 if (!strcmp(var, "grep.linenumber")) {
345 opt->linenum = git_config_bool(var, value);
346 return 0;
347 }
349 if (!strcmp(var, "color.grep"))
350 opt->color = git_config_colorbool(var, value);
351 else if (!strcmp(var, "color.grep.context"))
352 color = opt->color_context;
353 else if (!strcmp(var, "color.grep.filename"))
354 color = opt->color_filename;
355 else if (!strcmp(var, "color.grep.function"))
356 color = opt->color_function;
357 else if (!strcmp(var, "color.grep.linenumber"))
358 color = opt->color_lineno;
359 else if (!strcmp(var, "color.grep.match"))
360 color = opt->color_match;
361 else if (!strcmp(var, "color.grep.selected"))
362 color = opt->color_selected;
363 else if (!strcmp(var, "color.grep.separator"))
364 color = opt->color_sep;
365 else
366 return git_color_default_config(var, value, cb);
367 if (color) {
368 if (!value)
369 return config_error_nonbool(var);
370 color_parse(value, var, color);
371 }
372 return 0;
373 }
375 static void *lock_and_read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
376 {
377 void *data;
379 read_sha1_lock();
380 data = read_sha1_file(sha1, type, size);
381 read_sha1_unlock();
382 return data;
383 }
385 static void *load_sha1(const unsigned char *sha1, unsigned long *size,
386 const char *name)
387 {
388 enum object_type type;
389 void *data = lock_and_read_sha1_file(sha1, &type, size);
391 if (!data)
392 error(_("'%s': unable to read %s"), name, sha1_to_hex(sha1));
394 return data;
395 }
397 static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1,
398 const char *filename, int tree_name_len)
399 {
400 struct strbuf pathbuf = STRBUF_INIT;
401 char *name;
403 if (opt->relative && opt->prefix_length) {
404 quote_path_relative(filename + tree_name_len, -1, &pathbuf,
405 opt->prefix);
406 strbuf_insert(&pathbuf, 0, filename, tree_name_len);
407 } else {
408 strbuf_addstr(&pathbuf, filename);
409 }
411 name = strbuf_detach(&pathbuf, NULL);
413 #ifndef NO_PTHREADS
414 if (use_threads) {
415 grep_sha1_async(opt, name, sha1);
416 return 0;
417 } else
418 #endif
419 {
420 int hit;
421 unsigned long sz;
422 void *data = load_sha1(sha1, &sz, name);
423 if (!data)
424 hit = 0;
425 else
426 hit = grep_buffer(opt, name, data, sz);
428 free(data);
429 free(name);
430 return hit;
431 }
432 }
434 static void *load_file(const char *filename, size_t *sz)
435 {
436 struct stat st;
437 char *data;
438 int i;
440 if (lstat(filename, &st) < 0) {
441 err_ret:
442 if (errno != ENOENT)
443 error(_("'%s': %s"), filename, strerror(errno));
444 return NULL;
445 }
446 if (!S_ISREG(st.st_mode))
447 return NULL;
448 *sz = xsize_t(st.st_size);
449 i = open(filename, O_RDONLY);
450 if (i < 0)
451 goto err_ret;
452 data = xmalloc(*sz + 1);
453 if (st.st_size != read_in_full(i, data, *sz)) {
454 error(_("'%s': short read %s"), filename, strerror(errno));
455 close(i);
456 free(data);
457 return NULL;
458 }
459 close(i);
460 data[*sz] = 0;
461 return data;
462 }
464 static int grep_file(struct grep_opt *opt, const char *filename)
465 {
466 struct strbuf buf = STRBUF_INIT;
467 char *name;
469 if (opt->relative && opt->prefix_length)
470 quote_path_relative(filename, -1, &buf, opt->prefix);
471 else
472 strbuf_addstr(&buf, filename);
473 name = strbuf_detach(&buf, NULL);
475 #ifndef NO_PTHREADS
476 if (use_threads) {
477 grep_file_async(opt, name, filename);
478 return 0;
479 } else
480 #endif
481 {
482 int hit;
483 size_t sz;
484 void *data = load_file(filename, &sz);
485 if (!data)
486 hit = 0;
487 else
488 hit = grep_buffer(opt, name, data, sz);
490 free(data);
491 free(name);
492 return hit;
493 }
494 }
496 static void append_path(struct grep_opt *opt, const void *data, size_t len)
497 {
498 struct string_list *path_list = opt->output_priv;
500 if (len == 1 && *(const char *)data == '\0')
501 return;
502 string_list_append(path_list, xstrndup(data, len));
503 }
505 static void run_pager(struct grep_opt *opt, const char *prefix)
506 {
507 struct string_list *path_list = opt->output_priv;
508 const char **argv = xmalloc(sizeof(const char *) * (path_list->nr + 1));
509 int i, status;
511 for (i = 0; i < path_list->nr; i++)
512 argv[i] = path_list->items[i].string;
513 argv[path_list->nr] = NULL;
515 if (prefix && chdir(prefix))
516 die(_("Failed to chdir: %s"), prefix);
517 status = run_command_v_opt(argv, RUN_USING_SHELL);
518 if (status)
519 exit(status);
520 free(argv);
521 }
523 static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec, int cached)
524 {
525 int hit = 0;
526 int nr;
527 read_cache();
529 for (nr = 0; nr < active_nr; nr++) {
530 struct cache_entry *ce = active_cache[nr];
531 if (!S_ISREG(ce->ce_mode))
532 continue;
533 if (!match_pathspec_depth(pathspec, ce->name, ce_namelen(ce), 0, NULL))
534 continue;
535 /*
536 * If CE_VALID is on, we assume worktree file and its cache entry
537 * are identical, even if worktree file has been modified, so use
538 * cache version instead
539 */
540 if (cached || (ce->ce_flags & CE_VALID) || ce_skip_worktree(ce)) {
541 if (ce_stage(ce))
542 continue;
543 hit |= grep_sha1(opt, ce->sha1, ce->name, 0);
544 }
545 else
546 hit |= grep_file(opt, ce->name);
547 if (ce_stage(ce)) {
548 do {
549 nr++;
550 } while (nr < active_nr &&
551 !strcmp(ce->name, active_cache[nr]->name));
552 nr--; /* compensate for loop control */
553 }
554 if (hit && opt->status_only)
555 break;
556 }
557 return hit;
558 }
560 static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
561 struct tree_desc *tree, struct strbuf *base, int tn_len)
562 {
563 int hit = 0;
564 enum interesting match = entry_not_interesting;
565 struct name_entry entry;
566 int old_baselen = base->len;
568 while (tree_entry(tree, &entry)) {
569 int te_len = tree_entry_len(&entry);
571 if (match != all_entries_interesting) {
572 match = tree_entry_interesting(&entry, base, tn_len, pathspec);
573 if (match == all_entries_not_interesting)
574 break;
575 if (match == entry_not_interesting)
576 continue;
577 }
579 strbuf_add(base, entry.path, te_len);
581 if (S_ISREG(entry.mode)) {
582 hit |= grep_sha1(opt, entry.sha1, base->buf, tn_len);
583 }
584 else if (S_ISDIR(entry.mode)) {
585 enum object_type type;
586 struct tree_desc sub;
587 void *data;
588 unsigned long size;
590 data = lock_and_read_sha1_file(entry.sha1, &type, &size);
591 if (!data)
592 die(_("unable to read tree (%s)"),
593 sha1_to_hex(entry.sha1));
595 strbuf_addch(base, '/');
596 init_tree_desc(&sub, data, size);
597 hit |= grep_tree(opt, pathspec, &sub, base, tn_len);
598 free(data);
599 }
600 strbuf_setlen(base, old_baselen);
602 if (hit && opt->status_only)
603 break;
604 }
605 return hit;
606 }
608 static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
609 struct object *obj, const char *name)
610 {
611 if (obj->type == OBJ_BLOB)
612 return grep_sha1(opt, obj->sha1, name, 0);
613 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
614 struct tree_desc tree;
615 void *data;
616 unsigned long size;
617 struct strbuf base;
618 int hit, len;
620 read_sha1_lock();
621 data = read_object_with_reference(obj->sha1, tree_type,
622 &size, NULL);
623 read_sha1_unlock();
625 if (!data)
626 die(_("unable to read tree (%s)"), sha1_to_hex(obj->sha1));
628 len = name ? strlen(name) : 0;
629 strbuf_init(&base, PATH_MAX + len + 1);
630 if (len) {
631 strbuf_add(&base, name, len);
632 strbuf_addch(&base, ':');
633 }
634 init_tree_desc(&tree, data, size);
635 hit = grep_tree(opt, pathspec, &tree, &base, base.len);
636 strbuf_release(&base);
637 free(data);
638 return hit;
639 }
640 die(_("unable to grep from object of type %s"), typename(obj->type));
641 }
643 static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
644 const struct object_array *list)
645 {
646 unsigned int i;
647 int hit = 0;
648 const unsigned int nr = list->nr;
650 for (i = 0; i < nr; i++) {
651 struct object *real_obj;
652 real_obj = deref_tag(list->objects[i].item, NULL, 0);
653 if (grep_object(opt, pathspec, real_obj, list->objects[i].name)) {
654 hit = 1;
655 if (opt->status_only)
656 break;
657 }
658 }
659 return hit;
660 }
662 static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
663 int exc_std)
664 {
665 struct dir_struct dir;
666 int i, hit = 0;
668 memset(&dir, 0, sizeof(dir));
669 if (exc_std)
670 setup_standard_excludes(&dir);
672 fill_directory(&dir, pathspec->raw);
673 for (i = 0; i < dir.nr; i++) {
674 const char *name = dir.entries[i]->name;
675 int namelen = strlen(name);
676 if (!match_pathspec_depth(pathspec, name, namelen, 0, NULL))
677 continue;
678 hit |= grep_file(opt, dir.entries[i]->name);
679 if (hit && opt->status_only)
680 break;
681 }
682 return hit;
683 }
685 static int context_callback(const struct option *opt, const char *arg,
686 int unset)
687 {
688 struct grep_opt *grep_opt = opt->value;
689 int value;
690 const char *endp;
692 if (unset) {
693 grep_opt->pre_context = grep_opt->post_context = 0;
694 return 0;
695 }
696 value = strtol(arg, (char **)&endp, 10);
697 if (*endp) {
698 return error(_("switch `%c' expects a numerical value"),
699 opt->short_name);
700 }
701 grep_opt->pre_context = grep_opt->post_context = value;
702 return 0;
703 }
705 static int file_callback(const struct option *opt, const char *arg, int unset)
706 {
707 struct grep_opt *grep_opt = opt->value;
708 int from_stdin = !strcmp(arg, "-");
709 FILE *patterns;
710 int lno = 0;
711 struct strbuf sb = STRBUF_INIT;
713 patterns = from_stdin ? stdin : fopen(arg, "r");
714 if (!patterns)
715 die_errno(_("cannot open '%s'"), arg);
716 while (strbuf_getline(&sb, patterns, '\n') == 0) {
717 char *s;
718 size_t len;
720 /* ignore empty line like grep does */
721 if (sb.len == 0)
722 continue;
724 s = strbuf_detach(&sb, &len);
725 append_grep_pat(grep_opt, s, len, arg, ++lno, GREP_PATTERN);
726 }
727 if (!from_stdin)
728 fclose(patterns);
729 strbuf_release(&sb);
730 return 0;
731 }
733 static int not_callback(const struct option *opt, const char *arg, int unset)
734 {
735 struct grep_opt *grep_opt = opt->value;
736 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
737 return 0;
738 }
740 static int and_callback(const struct option *opt, const char *arg, int unset)
741 {
742 struct grep_opt *grep_opt = opt->value;
743 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
744 return 0;
745 }
747 static int open_callback(const struct option *opt, const char *arg, int unset)
748 {
749 struct grep_opt *grep_opt = opt->value;
750 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
751 return 0;
752 }
754 static int close_callback(const struct option *opt, const char *arg, int unset)
755 {
756 struct grep_opt *grep_opt = opt->value;
757 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
758 return 0;
759 }
761 static int pattern_callback(const struct option *opt, const char *arg,
762 int unset)
763 {
764 struct grep_opt *grep_opt = opt->value;
765 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
766 return 0;
767 }
769 static int help_callback(const struct option *opt, const char *arg, int unset)
770 {
771 return -1;
772 }
774 int cmd_grep(int argc, const char **argv, const char *prefix)
775 {
776 int hit = 0;
777 int cached = 0, untracked = 0, opt_exclude = -1;
778 int seen_dashdash = 0;
779 int external_grep_allowed__ignored;
780 const char *show_in_pager = NULL, *default_pager = "dummy";
781 struct grep_opt opt;
782 struct object_array list = OBJECT_ARRAY_INIT;
783 const char **paths = NULL;
784 struct pathspec pathspec;
785 struct string_list path_list = STRING_LIST_INIT_NODUP;
786 int i;
787 int dummy;
788 int use_index = 1;
789 enum {
790 pattern_type_unspecified = 0,
791 pattern_type_bre,
792 pattern_type_ere,
793 pattern_type_fixed,
794 pattern_type_pcre,
795 };
796 int pattern_type = pattern_type_unspecified;
798 struct option options[] = {
799 OPT_BOOLEAN(0, "cached", &cached,
800 "search in index instead of in the work tree"),
801 { OPTION_BOOLEAN, 0, "index", &use_index, NULL,
802 "finds in contents not managed by git",
803 PARSE_OPT_NOARG | PARSE_OPT_NEGHELP },
804 OPT_BOOLEAN(0, "untracked", &untracked,
805 "search in both tracked and untracked files"),
806 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
807 "search also in ignored files", 1),
808 OPT_GROUP(""),
809 OPT_BOOLEAN('v', "invert-match", &opt.invert,
810 "show non-matching lines"),
811 OPT_BOOLEAN('i', "ignore-case", &opt.ignore_case,
812 "case insensitive matching"),
813 OPT_BOOLEAN('w', "word-regexp", &opt.word_regexp,
814 "match patterns only at word boundaries"),
815 OPT_SET_INT('a', "text", &opt.binary,
816 "process binary files as text", GREP_BINARY_TEXT),
817 OPT_SET_INT('I', NULL, &opt.binary,
818 "don't match patterns in binary files",
819 GREP_BINARY_NOMATCH),
820 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, "depth",
821 "descend at most <depth> levels", PARSE_OPT_NONEG,
822 NULL, 1 },
823 OPT_GROUP(""),
824 OPT_SET_INT('E', "extended-regexp", &pattern_type,
825 "use extended POSIX regular expressions",
826 pattern_type_ere),
827 OPT_SET_INT('G', "basic-regexp", &pattern_type,
828 "use basic POSIX regular expressions (default)",
829 pattern_type_bre),
830 OPT_SET_INT('F', "fixed-strings", &pattern_type,
831 "interpret patterns as fixed strings",
832 pattern_type_fixed),
833 OPT_SET_INT('P', "perl-regexp", &pattern_type,
834 "use Perl-compatible regular expressions",
835 pattern_type_pcre),
836 OPT_GROUP(""),
837 OPT_BOOLEAN('n', "line-number", &opt.linenum, "show line numbers"),
838 OPT_NEGBIT('h', NULL, &opt.pathname, "don't show filenames", 1),
839 OPT_BIT('H', NULL, &opt.pathname, "show filenames", 1),
840 OPT_NEGBIT(0, "full-name", &opt.relative,
841 "show filenames relative to top directory", 1),
842 OPT_BOOLEAN('l', "files-with-matches", &opt.name_only,
843 "show only filenames instead of matching lines"),
844 OPT_BOOLEAN(0, "name-only", &opt.name_only,
845 "synonym for --files-with-matches"),
846 OPT_BOOLEAN('L', "files-without-match",
847 &opt.unmatch_name_only,
848 "show only the names of files without match"),
849 OPT_BOOLEAN('z', "null", &opt.null_following_name,
850 "print NUL after filenames"),
851 OPT_BOOLEAN('c', "count", &opt.count,
852 "show the number of matches instead of matching lines"),
853 OPT__COLOR(&opt.color, "highlight matches"),
854 OPT_BOOLEAN(0, "break", &opt.file_break,
855 "print empty line between matches from different files"),
856 OPT_BOOLEAN(0, "heading", &opt.heading,
857 "show filename only once above matches from same file"),
858 OPT_GROUP(""),
859 OPT_CALLBACK('C', "context", &opt, "n",
860 "show <n> context lines before and after matches",
861 context_callback),
862 OPT_INTEGER('B', "before-context", &opt.pre_context,
863 "show <n> context lines before matches"),
864 OPT_INTEGER('A', "after-context", &opt.post_context,
865 "show <n> context lines after matches"),
866 OPT_NUMBER_CALLBACK(&opt, "shortcut for -C NUM",
867 context_callback),
868 OPT_BOOLEAN('p', "show-function", &opt.funcname,
869 "show a line with the function name before matches"),
870 OPT_BOOLEAN('W', "function-context", &opt.funcbody,
871 "show the surrounding function"),
872 OPT_GROUP(""),
873 OPT_CALLBACK('f', NULL, &opt, "file",
874 "read patterns from file", file_callback),
875 { OPTION_CALLBACK, 'e', NULL, &opt, "pattern",
876 "match <pattern>", PARSE_OPT_NONEG, pattern_callback },
877 { OPTION_CALLBACK, 0, "and", &opt, NULL,
878 "combine patterns specified with -e",
879 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
880 OPT_BOOLEAN(0, "or", &dummy, ""),
881 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
882 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
883 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
884 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
885 open_callback },
886 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
887 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
888 close_callback },
889 OPT__QUIET(&opt.status_only,
890 "indicate hit with exit status without output"),
891 OPT_BOOLEAN(0, "all-match", &opt.all_match,
892 "show only matches from files that match all patterns"),
893 OPT_GROUP(""),
894 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
895 "pager", "show matching files in the pager",
896 PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
897 OPT_BOOLEAN(0, "ext-grep", &external_grep_allowed__ignored,
898 "allow calling of grep(1) (ignored by this build)"),
899 { OPTION_CALLBACK, 0, "help-all", &options, NULL, "show usage",
900 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
901 OPT_END()
902 };
904 /*
905 * 'git grep -h', unlike 'git grep -h <pattern>', is a request
906 * to show usage information and exit.
907 */
908 if (argc == 2 && !strcmp(argv[1], "-h"))
909 usage_with_options(grep_usage, options);
911 memset(&opt, 0, sizeof(opt));
912 opt.prefix = prefix;
913 opt.prefix_length = (prefix && *prefix) ? strlen(prefix) : 0;
914 opt.relative = 1;
915 opt.pathname = 1;
916 opt.pattern_tail = &opt.pattern_list;
917 opt.header_tail = &opt.header_list;
918 opt.regflags = REG_NEWLINE;
919 opt.max_depth = -1;
921 strcpy(opt.color_context, "");
922 strcpy(opt.color_filename, "");
923 strcpy(opt.color_function, "");
924 strcpy(opt.color_lineno, "");
925 strcpy(opt.color_match, GIT_COLOR_BOLD_RED);
926 strcpy(opt.color_selected, "");
927 strcpy(opt.color_sep, GIT_COLOR_CYAN);
928 opt.color = -1;
929 git_config(grep_config, &opt);
931 /*
932 * If there is no -- then the paths must exist in the working
933 * tree. If there is no explicit pattern specified with -e or
934 * -f, we take the first unrecognized non option to be the
935 * pattern, but then what follows it must be zero or more
936 * valid refs up to the -- (if exists), and then existing
937 * paths. If there is an explicit pattern, then the first
938 * unrecognized non option is the beginning of the refs list
939 * that continues up to the -- (if exists), and then paths.
940 */
941 argc = parse_options(argc, argv, prefix, options, grep_usage,
942 PARSE_OPT_KEEP_DASHDASH |
943 PARSE_OPT_STOP_AT_NON_OPTION |
944 PARSE_OPT_NO_INTERNAL_HELP);
945 switch (pattern_type) {
946 case pattern_type_fixed:
947 opt.fixed = 1;
948 opt.pcre = 0;
949 break;
950 case pattern_type_bre:
951 opt.fixed = 0;
952 opt.pcre = 0;
953 opt.regflags &= ~REG_EXTENDED;
954 break;
955 case pattern_type_ere:
956 opt.fixed = 0;
957 opt.pcre = 0;
958 opt.regflags |= REG_EXTENDED;
959 break;
960 case pattern_type_pcre:
961 opt.fixed = 0;
962 opt.pcre = 1;
963 break;
964 default:
965 break; /* nothing */
966 }
968 if (use_index && !startup_info->have_repository)
969 /* die the same way as if we did it at the beginning */
970 setup_git_directory();
972 /*
973 * skip a -- separator; we know it cannot be
974 * separating revisions from pathnames if
975 * we haven't even had any patterns yet
976 */
977 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
978 argv++;
979 argc--;
980 }
982 /* First unrecognized non-option token */
983 if (argc > 0 && !opt.pattern_list) {
984 append_grep_pattern(&opt, argv[0], "command line", 0,
985 GREP_PATTERN);
986 argv++;
987 argc--;
988 }
990 if (show_in_pager == default_pager)
991 show_in_pager = git_pager(1);
992 if (show_in_pager) {
993 opt.color = 0;
994 opt.name_only = 1;
995 opt.null_following_name = 1;
996 opt.output_priv = &path_list;
997 opt.output = append_path;
998 string_list_append(&path_list, show_in_pager);
999 use_threads = 0;
1000 }
1002 if (!opt.pattern_list)
1003 die(_("no pattern given."));
1004 if (!opt.fixed && opt.ignore_case)
1005 opt.regflags |= REG_ICASE;
1007 compile_grep_patterns(&opt);
1009 /* Check revs and then paths */
1010 for (i = 0; i < argc; i++) {
1011 const char *arg = argv[i];
1012 unsigned char sha1[20];
1013 /* Is it a rev? */
1014 if (!get_sha1(arg, sha1)) {
1015 struct object *object = parse_object(sha1);
1016 if (!object)
1017 die(_("bad object %s"), arg);
1018 add_object_array(object, arg, &list);
1019 continue;
1020 }
1021 if (!strcmp(arg, "--")) {
1022 i++;
1023 seen_dashdash = 1;
1024 }
1025 break;
1026 }
1028 #ifndef NO_PTHREADS
1029 if (list.nr || cached || online_cpus() == 1)
1030 use_threads = 0;
1031 #else
1032 use_threads = 0;
1033 #endif
1035 #ifndef NO_PTHREADS
1036 if (use_threads) {
1037 if (opt.pre_context || opt.post_context || opt.file_break ||
1038 opt.funcbody)
1039 skip_first_line = 1;
1040 start_threads(&opt);
1041 }
1042 #endif
1044 /* The rest are paths */
1045 if (!seen_dashdash) {
1046 int j;
1047 for (j = i; j < argc; j++)
1048 verify_filename(prefix, argv[j]);
1049 }
1051 paths = get_pathspec(prefix, argv + i);
1052 init_pathspec(&pathspec, paths);
1053 pathspec.max_depth = opt.max_depth;
1054 pathspec.recursive = 1;
1056 if (show_in_pager && (cached || list.nr))
1057 die(_("--open-files-in-pager only works on the worktree"));
1059 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
1060 const char *pager = path_list.items[0].string;
1061 int len = strlen(pager);
1063 if (len > 4 && is_dir_sep(pager[len - 5]))
1064 pager += len - 4;
1066 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
1067 struct strbuf buf = STRBUF_INIT;
1068 strbuf_addf(&buf, "+/%s%s",
1069 strcmp("less", pager) ? "" : "*",
1070 opt.pattern_list->pattern);
1071 string_list_append(&path_list, buf.buf);
1072 strbuf_detach(&buf, NULL);
1073 }
1074 }
1076 if (!show_in_pager)
1077 setup_pager();
1079 if (!use_index && (untracked || cached))
1080 die(_("--cached or --untracked cannot be used with --no-index."));
1082 if (!use_index || untracked) {
1083 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
1084 if (list.nr)
1085 die(_("--no-index or --untracked cannot be used with revs."));
1086 hit = grep_directory(&opt, &pathspec, use_exclude);
1087 } else if (0 <= opt_exclude) {
1088 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1089 } else if (!list.nr) {
1090 if (!cached)
1091 setup_work_tree();
1093 hit = grep_cache(&opt, &pathspec, cached);
1094 } else {
1095 if (cached)
1096 die(_("both --cached and trees are given."));
1097 hit = grep_objects(&opt, &pathspec, &list);
1098 }
1100 if (use_threads)
1101 hit |= wait_all();
1102 if (hit && show_in_pager)
1103 run_pager(&opt, prefix);
1104 free_grep_patterns(&opt);
1105 return !hit;
1106 }