sha1-name.c: remove implicit dependency on the_index
[git/git.git] / builtin / grep.c
1 /*
2 * Builtin "git grep"
3 *
4 * Copyright (c) 2006 Junio C Hamano
5 */
6 #include "cache.h"
7 #include "repository.h"
8 #include "config.h"
9 #include "blob.h"
10 #include "tree.h"
11 #include "commit.h"
12 #include "tag.h"
13 #include "tree-walk.h"
14 #include "builtin.h"
15 #include "parse-options.h"
16 #include "string-list.h"
17 #include "run-command.h"
18 #include "userdiff.h"
19 #include "grep.h"
20 #include "quote.h"
21 #include "dir.h"
22 #include "pathspec.h"
23 #include "submodule.h"
24 #include "submodule-config.h"
25 #include "object-store.h"
26
27 static char const * const grep_usage[] = {
28 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
29 NULL
30 };
31
32 static int recurse_submodules;
33
34 #define GREP_NUM_THREADS_DEFAULT 8
35 static int num_threads;
36
37 static pthread_t *threads;
38
39 /* We use one producer thread and THREADS consumer
40 * threads. The producer adds struct work_items to 'todo' and the
41 * consumers pick work items from the same array.
42 */
43 struct work_item {
44 struct grep_source source;
45 char done;
46 struct strbuf out;
47 };
48
49 /* In the range [todo_done, todo_start) in 'todo' we have work_items
50 * that have been or are processed by a consumer thread. We haven't
51 * written the result for these to stdout yet.
52 *
53 * The work_items in [todo_start, todo_end) are waiting to be picked
54 * up by a consumer thread.
55 *
56 * The ranges are modulo TODO_SIZE.
57 */
58 #define TODO_SIZE 128
59 static struct work_item todo[TODO_SIZE];
60 static int todo_start;
61 static int todo_end;
62 static int todo_done;
63
64 /* Has all work items been added? */
65 static int all_work_added;
66
67 /* This lock protects all the variables above. */
68 static pthread_mutex_t grep_mutex;
69
70 static inline void grep_lock(void)
71 {
72 pthread_mutex_lock(&grep_mutex);
73 }
74
75 static inline void grep_unlock(void)
76 {
77 pthread_mutex_unlock(&grep_mutex);
78 }
79
80 /* Signalled when a new work_item is added to todo. */
81 static pthread_cond_t cond_add;
82
83 /* Signalled when the result from one work_item is written to
84 * stdout.
85 */
86 static pthread_cond_t cond_write;
87
88 /* Signalled when we are finished with everything. */
89 static pthread_cond_t cond_result;
90
91 static int skip_first_line;
92
93 static void add_work(struct grep_opt *opt, const struct grep_source *gs)
94 {
95 grep_lock();
96
97 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
98 pthread_cond_wait(&cond_write, &grep_mutex);
99 }
100
101 todo[todo_end].source = *gs;
102 if (opt->binary != GREP_BINARY_TEXT)
103 grep_source_load_driver(&todo[todo_end].source,
104 opt->repo->index);
105 todo[todo_end].done = 0;
106 strbuf_reset(&todo[todo_end].out);
107 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
108
109 pthread_cond_signal(&cond_add);
110 grep_unlock();
111 }
112
113 static struct work_item *get_work(void)
114 {
115 struct work_item *ret;
116
117 grep_lock();
118 while (todo_start == todo_end && !all_work_added) {
119 pthread_cond_wait(&cond_add, &grep_mutex);
120 }
121
122 if (todo_start == todo_end && all_work_added) {
123 ret = NULL;
124 } else {
125 ret = &todo[todo_start];
126 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
127 }
128 grep_unlock();
129 return ret;
130 }
131
132 static void work_done(struct work_item *w)
133 {
134 int old_done;
135
136 grep_lock();
137 w->done = 1;
138 old_done = todo_done;
139 for(; todo[todo_done].done && todo_done != todo_start;
140 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
141 w = &todo[todo_done];
142 if (w->out.len) {
143 const char *p = w->out.buf;
144 size_t len = w->out.len;
145
146 /* Skip the leading hunk mark of the first file. */
147 if (skip_first_line) {
148 while (len) {
149 len--;
150 if (*p++ == '\n')
151 break;
152 }
153 skip_first_line = 0;
154 }
155
156 write_or_die(1, p, len);
157 }
158 grep_source_clear(&w->source);
159 }
160
161 if (old_done != todo_done)
162 pthread_cond_signal(&cond_write);
163
164 if (all_work_added && todo_done == todo_end)
165 pthread_cond_signal(&cond_result);
166
167 grep_unlock();
168 }
169
170 static void *run(void *arg)
171 {
172 int hit = 0;
173 struct grep_opt *opt = arg;
174
175 while (1) {
176 struct work_item *w = get_work();
177 if (!w)
178 break;
179
180 opt->output_priv = w;
181 hit |= grep_source(opt, &w->source);
182 grep_source_clear_data(&w->source);
183 work_done(w);
184 }
185 free_grep_patterns(arg);
186 free(arg);
187
188 return (void*) (intptr_t) hit;
189 }
190
191 static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
192 {
193 struct work_item *w = opt->output_priv;
194 strbuf_add(&w->out, buf, size);
195 }
196
197 static void start_threads(struct grep_opt *opt)
198 {
199 int i;
200
201 pthread_mutex_init(&grep_mutex, NULL);
202 pthread_mutex_init(&grep_read_mutex, NULL);
203 pthread_mutex_init(&grep_attr_mutex, NULL);
204 pthread_cond_init(&cond_add, NULL);
205 pthread_cond_init(&cond_write, NULL);
206 pthread_cond_init(&cond_result, NULL);
207 grep_use_locks = 1;
208
209 for (i = 0; i < ARRAY_SIZE(todo); i++) {
210 strbuf_init(&todo[i].out, 0);
211 }
212
213 threads = xcalloc(num_threads, sizeof(*threads));
214 for (i = 0; i < num_threads; i++) {
215 int err;
216 struct grep_opt *o = grep_opt_dup(opt);
217 o->output = strbuf_out;
218 if (i)
219 o->debug = 0;
220 compile_grep_patterns(o);
221 err = pthread_create(&threads[i], NULL, run, o);
222
223 if (err)
224 die(_("grep: failed to create thread: %s"),
225 strerror(err));
226 }
227 }
228
229 static int wait_all(void)
230 {
231 int hit = 0;
232 int i;
233
234 if (!HAVE_THREADS)
235 BUG("Never call this function unless you have started threads");
236
237 grep_lock();
238 all_work_added = 1;
239
240 /* Wait until all work is done. */
241 while (todo_done != todo_end)
242 pthread_cond_wait(&cond_result, &grep_mutex);
243
244 /* Wake up all the consumer threads so they can see that there
245 * is no more work to do.
246 */
247 pthread_cond_broadcast(&cond_add);
248 grep_unlock();
249
250 for (i = 0; i < num_threads; i++) {
251 void *h;
252 pthread_join(threads[i], &h);
253 hit |= (int) (intptr_t) h;
254 }
255
256 free(threads);
257
258 pthread_mutex_destroy(&grep_mutex);
259 pthread_mutex_destroy(&grep_read_mutex);
260 pthread_mutex_destroy(&grep_attr_mutex);
261 pthread_cond_destroy(&cond_add);
262 pthread_cond_destroy(&cond_write);
263 pthread_cond_destroy(&cond_result);
264 grep_use_locks = 0;
265
266 return hit;
267 }
268
269 static int grep_cmd_config(const char *var, const char *value, void *cb)
270 {
271 int st = grep_config(var, value, cb);
272 if (git_color_default_config(var, value, cb) < 0)
273 st = -1;
274
275 if (!strcmp(var, "grep.threads")) {
276 num_threads = git_config_int(var, value);
277 if (num_threads < 0)
278 die(_("invalid number of threads specified (%d) for %s"),
279 num_threads, var);
280 else if (!HAVE_THREADS && num_threads > 1) {
281 /*
282 * TRANSLATORS: %s is the configuration
283 * variable for tweaking threads, currently
284 * grep.threads
285 */
286 warning(_("no threads support, ignoring %s"), var);
287 num_threads = 1;
288 }
289 }
290
291 if (!strcmp(var, "submodule.recurse"))
292 recurse_submodules = git_config_bool(var, value);
293
294 return st;
295 }
296
297 static void *lock_and_read_oid_file(const struct object_id *oid, enum object_type *type, unsigned long *size)
298 {
299 void *data;
300
301 grep_read_lock();
302 data = read_object_file(oid, type, size);
303 grep_read_unlock();
304 return data;
305 }
306
307 static int grep_oid(struct grep_opt *opt, const struct object_id *oid,
308 const char *filename, int tree_name_len,
309 const char *path)
310 {
311 struct strbuf pathbuf = STRBUF_INIT;
312 struct grep_source gs;
313
314 if (opt->relative && opt->prefix_length) {
315 quote_path_relative(filename + tree_name_len, opt->prefix, &pathbuf);
316 strbuf_insert(&pathbuf, 0, filename, tree_name_len);
317 } else {
318 strbuf_addstr(&pathbuf, filename);
319 }
320
321 grep_source_init(&gs, GREP_SOURCE_OID, pathbuf.buf, path, oid);
322 strbuf_release(&pathbuf);
323
324 if (num_threads > 1) {
325 /*
326 * add_work() copies gs and thus assumes ownership of
327 * its fields, so do not call grep_source_clear()
328 */
329 add_work(opt, &gs);
330 return 0;
331 } else {
332 int hit;
333
334 hit = grep_source(opt, &gs);
335
336 grep_source_clear(&gs);
337 return hit;
338 }
339 }
340
341 static int grep_file(struct grep_opt *opt, const char *filename)
342 {
343 struct strbuf buf = STRBUF_INIT;
344 struct grep_source gs;
345
346 if (opt->relative && opt->prefix_length)
347 quote_path_relative(filename, opt->prefix, &buf);
348 else
349 strbuf_addstr(&buf, filename);
350
351 grep_source_init(&gs, GREP_SOURCE_FILE, buf.buf, filename, filename);
352 strbuf_release(&buf);
353
354 if (num_threads > 1) {
355 /*
356 * add_work() copies gs and thus assumes ownership of
357 * its fields, so do not call grep_source_clear()
358 */
359 add_work(opt, &gs);
360 return 0;
361 } else {
362 int hit;
363
364 hit = grep_source(opt, &gs);
365
366 grep_source_clear(&gs);
367 return hit;
368 }
369 }
370
371 static void append_path(struct grep_opt *opt, const void *data, size_t len)
372 {
373 struct string_list *path_list = opt->output_priv;
374
375 if (len == 1 && *(const char *)data == '\0')
376 return;
377 string_list_append(path_list, xstrndup(data, len));
378 }
379
380 static void run_pager(struct grep_opt *opt, const char *prefix)
381 {
382 struct string_list *path_list = opt->output_priv;
383 struct child_process child = CHILD_PROCESS_INIT;
384 int i, status;
385
386 for (i = 0; i < path_list->nr; i++)
387 argv_array_push(&child.args, path_list->items[i].string);
388 child.dir = prefix;
389 child.use_shell = 1;
390
391 status = run_command(&child);
392 if (status)
393 exit(status);
394 }
395
396 static int grep_cache(struct grep_opt *opt,
397 const struct pathspec *pathspec, int cached);
398 static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
399 struct tree_desc *tree, struct strbuf *base, int tn_len,
400 int check_attr);
401
402 static int grep_submodule(struct grep_opt *opt,
403 const struct pathspec *pathspec,
404 const struct object_id *oid,
405 const char *filename, const char *path)
406 {
407 struct repository *superproject = opt->repo;
408 struct repository submodule;
409 struct grep_opt subopt;
410 int hit;
411
412 /*
413 * NEEDSWORK: submodules functions need to be protected because they
414 * access the object store via config_from_gitmodules(): the latter
415 * uses get_oid() which, for now, relies on the global the_repository
416 * object.
417 */
418 grep_read_lock();
419
420 if (!is_submodule_active(superproject, path)) {
421 grep_read_unlock();
422 return 0;
423 }
424
425 if (repo_submodule_init(&submodule, superproject, path)) {
426 grep_read_unlock();
427 return 0;
428 }
429
430 repo_read_gitmodules(&submodule);
431
432 /*
433 * NEEDSWORK: This adds the submodule's object directory to the list of
434 * alternates for the single in-memory object store. This has some bad
435 * consequences for memory (processed objects will never be freed) and
436 * performance (this increases the number of pack files git has to pay
437 * attention to, to the sum of the number of pack files in all the
438 * repositories processed so far). This can be removed once the object
439 * store is no longer global and instead is a member of the repository
440 * object.
441 */
442 add_to_alternates_memory(submodule.objects->odb->path);
443 grep_read_unlock();
444
445 memcpy(&subopt, opt, sizeof(subopt));
446 subopt.repo = &submodule;
447
448 if (oid) {
449 struct object *object;
450 struct tree_desc tree;
451 void *data;
452 unsigned long size;
453 struct strbuf base = STRBUF_INIT;
454
455 object = parse_object_or_die(oid, oid_to_hex(oid));
456
457 grep_read_lock();
458 data = read_object_with_reference(&object->oid, tree_type,
459 &size, NULL);
460 grep_read_unlock();
461
462 if (!data)
463 die(_("unable to read tree (%s)"), oid_to_hex(&object->oid));
464
465 strbuf_addstr(&base, filename);
466 strbuf_addch(&base, '/');
467
468 init_tree_desc(&tree, data, size);
469 hit = grep_tree(&subopt, pathspec, &tree, &base, base.len,
470 object->type == OBJ_COMMIT);
471 strbuf_release(&base);
472 free(data);
473 } else {
474 hit = grep_cache(&subopt, pathspec, 1);
475 }
476
477 repo_clear(&submodule);
478 return hit;
479 }
480
481 static int grep_cache(struct grep_opt *opt,
482 const struct pathspec *pathspec, int cached)
483 {
484 struct repository *repo = opt->repo;
485 int hit = 0;
486 int nr;
487 struct strbuf name = STRBUF_INIT;
488 int name_base_len = 0;
489 if (repo->submodule_prefix) {
490 name_base_len = strlen(repo->submodule_prefix);
491 strbuf_addstr(&name, repo->submodule_prefix);
492 }
493
494 if (repo_read_index(repo) < 0)
495 die(_("index file corrupt"));
496
497 for (nr = 0; nr < repo->index->cache_nr; nr++) {
498 const struct cache_entry *ce = repo->index->cache[nr];
499 strbuf_setlen(&name, name_base_len);
500 strbuf_addstr(&name, ce->name);
501
502 if (S_ISREG(ce->ce_mode) &&
503 match_pathspec(repo->index, pathspec, name.buf, name.len, 0, NULL,
504 S_ISDIR(ce->ce_mode) ||
505 S_ISGITLINK(ce->ce_mode))) {
506 /*
507 * If CE_VALID is on, we assume worktree file and its
508 * cache entry are identical, even if worktree file has
509 * been modified, so use cache version instead
510 */
511 if (cached || (ce->ce_flags & CE_VALID) ||
512 ce_skip_worktree(ce)) {
513 if (ce_stage(ce) || ce_intent_to_add(ce))
514 continue;
515 hit |= grep_oid(opt, &ce->oid, name.buf,
516 0, name.buf);
517 } else {
518 hit |= grep_file(opt, name.buf);
519 }
520 } else if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
521 submodule_path_match(repo->index, pathspec, name.buf, NULL)) {
522 hit |= grep_submodule(opt, pathspec, NULL, ce->name, ce->name);
523 } else {
524 continue;
525 }
526
527 if (ce_stage(ce)) {
528 do {
529 nr++;
530 } while (nr < repo->index->cache_nr &&
531 !strcmp(ce->name, repo->index->cache[nr]->name));
532 nr--; /* compensate for loop control */
533 }
534 if (hit && opt->status_only)
535 break;
536 }
537
538 strbuf_release(&name);
539 return hit;
540 }
541
542 static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
543 struct tree_desc *tree, struct strbuf *base, int tn_len,
544 int check_attr)
545 {
546 struct repository *repo = opt->repo;
547 int hit = 0;
548 enum interesting match = entry_not_interesting;
549 struct name_entry entry;
550 int old_baselen = base->len;
551 struct strbuf name = STRBUF_INIT;
552 int name_base_len = 0;
553 if (repo->submodule_prefix) {
554 strbuf_addstr(&name, repo->submodule_prefix);
555 name_base_len = name.len;
556 }
557
558 while (tree_entry(tree, &entry)) {
559 int te_len = tree_entry_len(&entry);
560
561 if (match != all_entries_interesting) {
562 strbuf_addstr(&name, base->buf + tn_len);
563 match = tree_entry_interesting(&entry, &name,
564 0, pathspec);
565 strbuf_setlen(&name, name_base_len);
566
567 if (match == all_entries_not_interesting)
568 break;
569 if (match == entry_not_interesting)
570 continue;
571 }
572
573 strbuf_add(base, entry.path, te_len);
574
575 if (S_ISREG(entry.mode)) {
576 hit |= grep_oid(opt, entry.oid, base->buf, tn_len,
577 check_attr ? base->buf + tn_len : NULL);
578 } else if (S_ISDIR(entry.mode)) {
579 enum object_type type;
580 struct tree_desc sub;
581 void *data;
582 unsigned long size;
583
584 data = lock_and_read_oid_file(entry.oid, &type, &size);
585 if (!data)
586 die(_("unable to read tree (%s)"),
587 oid_to_hex(entry.oid));
588
589 strbuf_addch(base, '/');
590 init_tree_desc(&sub, data, size);
591 hit |= grep_tree(opt, pathspec, &sub, base, tn_len,
592 check_attr);
593 free(data);
594 } else if (recurse_submodules && S_ISGITLINK(entry.mode)) {
595 hit |= grep_submodule(opt, pathspec, entry.oid,
596 base->buf, base->buf + tn_len);
597 }
598
599 strbuf_setlen(base, old_baselen);
600
601 if (hit && opt->status_only)
602 break;
603 }
604
605 strbuf_release(&name);
606 return hit;
607 }
608
609 static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
610 struct object *obj, const char *name, const char *path)
611 {
612 if (obj->type == OBJ_BLOB)
613 return grep_oid(opt, &obj->oid, name, 0, path);
614 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
615 struct tree_desc tree;
616 void *data;
617 unsigned long size;
618 struct strbuf base;
619 int hit, len;
620
621 grep_read_lock();
622 data = read_object_with_reference(&obj->oid, tree_type,
623 &size, NULL);
624 grep_read_unlock();
625
626 if (!data)
627 die(_("unable to read tree (%s)"), oid_to_hex(&obj->oid));
628
629 len = name ? strlen(name) : 0;
630 strbuf_init(&base, PATH_MAX + len + 1);
631 if (len) {
632 strbuf_add(&base, name, len);
633 strbuf_addch(&base, ':');
634 }
635 init_tree_desc(&tree, data, size);
636 hit = grep_tree(opt, pathspec, &tree, &base, base.len,
637 obj->type == OBJ_COMMIT);
638 strbuf_release(&base);
639 free(data);
640 return hit;
641 }
642 die(_("unable to grep from object of type %s"), type_name(obj->type));
643 }
644
645 static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
646 const struct object_array *list)
647 {
648 unsigned int i;
649 int hit = 0;
650 const unsigned int nr = list->nr;
651
652 for (i = 0; i < nr; i++) {
653 struct object *real_obj;
654 real_obj = deref_tag(opt->repo, list->objects[i].item,
655 NULL, 0);
656
657 /* load the gitmodules file for this rev */
658 if (recurse_submodules) {
659 submodule_free(opt->repo);
660 gitmodules_config_oid(&real_obj->oid);
661 }
662 if (grep_object(opt, pathspec, real_obj, list->objects[i].name,
663 list->objects[i].path)) {
664 hit = 1;
665 if (opt->status_only)
666 break;
667 }
668 }
669 return hit;
670 }
671
672 static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
673 int exc_std, int use_index)
674 {
675 struct dir_struct dir;
676 int i, hit = 0;
677
678 memset(&dir, 0, sizeof(dir));
679 if (!use_index)
680 dir.flags |= DIR_NO_GITLINKS;
681 if (exc_std)
682 setup_standard_excludes(&dir);
683
684 fill_directory(&dir, opt->repo->index, pathspec);
685 for (i = 0; i < dir.nr; i++) {
686 if (!dir_path_match(opt->repo->index, dir.entries[i], pathspec, 0, NULL))
687 continue;
688 hit |= grep_file(opt, dir.entries[i]->name);
689 if (hit && opt->status_only)
690 break;
691 }
692 return hit;
693 }
694
695 static int context_callback(const struct option *opt, const char *arg,
696 int unset)
697 {
698 struct grep_opt *grep_opt = opt->value;
699 int value;
700 const char *endp;
701
702 if (unset) {
703 grep_opt->pre_context = grep_opt->post_context = 0;
704 return 0;
705 }
706 value = strtol(arg, (char **)&endp, 10);
707 if (*endp) {
708 return error(_("switch `%c' expects a numerical value"),
709 opt->short_name);
710 }
711 grep_opt->pre_context = grep_opt->post_context = value;
712 return 0;
713 }
714
715 static int file_callback(const struct option *opt, const char *arg, int unset)
716 {
717 struct grep_opt *grep_opt = opt->value;
718 int from_stdin;
719 FILE *patterns;
720 int lno = 0;
721 struct strbuf sb = STRBUF_INIT;
722
723 BUG_ON_OPT_NEG(unset);
724
725 from_stdin = !strcmp(arg, "-");
726 patterns = from_stdin ? stdin : fopen(arg, "r");
727 if (!patterns)
728 die_errno(_("cannot open '%s'"), arg);
729 while (strbuf_getline(&sb, patterns) == 0) {
730 /* ignore empty line like grep does */
731 if (sb.len == 0)
732 continue;
733
734 append_grep_pat(grep_opt, sb.buf, sb.len, arg, ++lno,
735 GREP_PATTERN);
736 }
737 if (!from_stdin)
738 fclose(patterns);
739 strbuf_release(&sb);
740 return 0;
741 }
742
743 static int not_callback(const struct option *opt, const char *arg, int unset)
744 {
745 struct grep_opt *grep_opt = opt->value;
746 BUG_ON_OPT_NEG(unset);
747 BUG_ON_OPT_ARG(arg);
748 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
749 return 0;
750 }
751
752 static int and_callback(const struct option *opt, const char *arg, int unset)
753 {
754 struct grep_opt *grep_opt = opt->value;
755 BUG_ON_OPT_NEG(unset);
756 BUG_ON_OPT_ARG(arg);
757 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
758 return 0;
759 }
760
761 static int open_callback(const struct option *opt, const char *arg, int unset)
762 {
763 struct grep_opt *grep_opt = opt->value;
764 BUG_ON_OPT_NEG(unset);
765 BUG_ON_OPT_ARG(arg);
766 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
767 return 0;
768 }
769
770 static int close_callback(const struct option *opt, const char *arg, int unset)
771 {
772 struct grep_opt *grep_opt = opt->value;
773 BUG_ON_OPT_NEG(unset);
774 BUG_ON_OPT_ARG(arg);
775 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
776 return 0;
777 }
778
779 static int pattern_callback(const struct option *opt, const char *arg,
780 int unset)
781 {
782 struct grep_opt *grep_opt = opt->value;
783 BUG_ON_OPT_NEG(unset);
784 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
785 return 0;
786 }
787
788 int cmd_grep(int argc, const char **argv, const char *prefix)
789 {
790 int hit = 0;
791 int cached = 0, untracked = 0, opt_exclude = -1;
792 int seen_dashdash = 0;
793 int external_grep_allowed__ignored;
794 const char *show_in_pager = NULL, *default_pager = "dummy";
795 struct grep_opt opt;
796 struct object_array list = OBJECT_ARRAY_INIT;
797 struct pathspec pathspec;
798 struct string_list path_list = STRING_LIST_INIT_NODUP;
799 int i;
800 int dummy;
801 int use_index = 1;
802 int pattern_type_arg = GREP_PATTERN_TYPE_UNSPECIFIED;
803 int allow_revs;
804
805 struct option options[] = {
806 OPT_BOOL(0, "cached", &cached,
807 N_("search in index instead of in the work tree")),
808 OPT_NEGBIT(0, "no-index", &use_index,
809 N_("find in contents not managed by git"), 1),
810 OPT_BOOL(0, "untracked", &untracked,
811 N_("search in both tracked and untracked files")),
812 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
813 N_("ignore files specified via '.gitignore'"), 1),
814 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
815 N_("recursively search in each submodule")),
816 OPT_GROUP(""),
817 OPT_BOOL('v', "invert-match", &opt.invert,
818 N_("show non-matching lines")),
819 OPT_BOOL('i', "ignore-case", &opt.ignore_case,
820 N_("case insensitive matching")),
821 OPT_BOOL('w', "word-regexp", &opt.word_regexp,
822 N_("match patterns only at word boundaries")),
823 OPT_SET_INT('a', "text", &opt.binary,
824 N_("process binary files as text"), GREP_BINARY_TEXT),
825 OPT_SET_INT('I', NULL, &opt.binary,
826 N_("don't match patterns in binary files"),
827 GREP_BINARY_NOMATCH),
828 OPT_BOOL(0, "textconv", &opt.allow_textconv,
829 N_("process binary files with textconv filters")),
830 OPT_SET_INT('r', "recursive", &opt.max_depth,
831 N_("search in subdirectories (default)"), -1),
832 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, N_("depth"),
833 N_("descend at most <depth> levels"), PARSE_OPT_NONEG,
834 NULL, 1 },
835 OPT_GROUP(""),
836 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg,
837 N_("use extended POSIX regular expressions"),
838 GREP_PATTERN_TYPE_ERE),
839 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg,
840 N_("use basic POSIX regular expressions (default)"),
841 GREP_PATTERN_TYPE_BRE),
842 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg,
843 N_("interpret patterns as fixed strings"),
844 GREP_PATTERN_TYPE_FIXED),
845 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg,
846 N_("use Perl-compatible regular expressions"),
847 GREP_PATTERN_TYPE_PCRE),
848 OPT_GROUP(""),
849 OPT_BOOL('n', "line-number", &opt.linenum, N_("show line numbers")),
850 OPT_BOOL(0, "column", &opt.columnnum, N_("show column number of first match")),
851 OPT_NEGBIT('h', NULL, &opt.pathname, N_("don't show filenames"), 1),
852 OPT_BIT('H', NULL, &opt.pathname, N_("show filenames"), 1),
853 OPT_NEGBIT(0, "full-name", &opt.relative,
854 N_("show filenames relative to top directory"), 1),
855 OPT_BOOL('l', "files-with-matches", &opt.name_only,
856 N_("show only filenames instead of matching lines")),
857 OPT_BOOL(0, "name-only", &opt.name_only,
858 N_("synonym for --files-with-matches")),
859 OPT_BOOL('L', "files-without-match",
860 &opt.unmatch_name_only,
861 N_("show only the names of files without match")),
862 OPT_BOOL_F('z', "null", &opt.null_following_name,
863 N_("print NUL after filenames"),
864 PARSE_OPT_NOCOMPLETE),
865 OPT_BOOL('o', "only-matching", &opt.only_matching,
866 N_("show only matching parts of a line")),
867 OPT_BOOL('c', "count", &opt.count,
868 N_("show the number of matches instead of matching lines")),
869 OPT__COLOR(&opt.color, N_("highlight matches")),
870 OPT_BOOL(0, "break", &opt.file_break,
871 N_("print empty line between matches from different files")),
872 OPT_BOOL(0, "heading", &opt.heading,
873 N_("show filename only once above matches from same file")),
874 OPT_GROUP(""),
875 OPT_CALLBACK('C', "context", &opt, N_("n"),
876 N_("show <n> context lines before and after matches"),
877 context_callback),
878 OPT_INTEGER('B', "before-context", &opt.pre_context,
879 N_("show <n> context lines before matches")),
880 OPT_INTEGER('A', "after-context", &opt.post_context,
881 N_("show <n> context lines after matches")),
882 OPT_INTEGER(0, "threads", &num_threads,
883 N_("use <n> worker threads")),
884 OPT_NUMBER_CALLBACK(&opt, N_("shortcut for -C NUM"),
885 context_callback),
886 OPT_BOOL('p', "show-function", &opt.funcname,
887 N_("show a line with the function name before matches")),
888 OPT_BOOL('W', "function-context", &opt.funcbody,
889 N_("show the surrounding function")),
890 OPT_GROUP(""),
891 OPT_CALLBACK('f', NULL, &opt, N_("file"),
892 N_("read patterns from file"), file_callback),
893 { OPTION_CALLBACK, 'e', NULL, &opt, N_("pattern"),
894 N_("match <pattern>"), PARSE_OPT_NONEG, pattern_callback },
895 { OPTION_CALLBACK, 0, "and", &opt, NULL,
896 N_("combine patterns specified with -e"),
897 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
898 OPT_BOOL(0, "or", &dummy, ""),
899 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
900 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
901 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
902 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
903 open_callback },
904 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
905 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
906 close_callback },
907 OPT__QUIET(&opt.status_only,
908 N_("indicate hit with exit status without output")),
909 OPT_BOOL(0, "all-match", &opt.all_match,
910 N_("show only matches from files that match all patterns")),
911 OPT_SET_INT_F(0, "debug", &opt.debug,
912 N_("show parse tree for grep expression"),
913 1, PARSE_OPT_HIDDEN),
914 OPT_GROUP(""),
915 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
916 N_("pager"), N_("show matching files in the pager"),
917 PARSE_OPT_OPTARG | PARSE_OPT_NOCOMPLETE,
918 NULL, (intptr_t)default_pager },
919 OPT_BOOL_F(0, "ext-grep", &external_grep_allowed__ignored,
920 N_("allow calling of grep(1) (ignored by this build)"),
921 PARSE_OPT_NOCOMPLETE),
922 OPT_END()
923 };
924
925 init_grep_defaults(the_repository);
926 git_config(grep_cmd_config, NULL);
927 grep_init(&opt, the_repository, prefix);
928
929 /*
930 * If there is no -- then the paths must exist in the working
931 * tree. If there is no explicit pattern specified with -e or
932 * -f, we take the first unrecognized non option to be the
933 * pattern, but then what follows it must be zero or more
934 * valid refs up to the -- (if exists), and then existing
935 * paths. If there is an explicit pattern, then the first
936 * unrecognized non option is the beginning of the refs list
937 * that continues up to the -- (if exists), and then paths.
938 */
939 argc = parse_options(argc, argv, prefix, options, grep_usage,
940 PARSE_OPT_KEEP_DASHDASH |
941 PARSE_OPT_STOP_AT_NON_OPTION);
942 grep_commit_pattern_type(pattern_type_arg, &opt);
943
944 if (use_index && !startup_info->have_repository) {
945 int fallback = 0;
946 git_config_get_bool("grep.fallbacktonoindex", &fallback);
947 if (fallback)
948 use_index = 0;
949 else
950 /* die the same way as if we did it at the beginning */
951 setup_git_directory();
952 }
953
954 /*
955 * skip a -- separator; we know it cannot be
956 * separating revisions from pathnames if
957 * we haven't even had any patterns yet
958 */
959 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
960 argv++;
961 argc--;
962 }
963
964 /* First unrecognized non-option token */
965 if (argc > 0 && !opt.pattern_list) {
966 append_grep_pattern(&opt, argv[0], "command line", 0,
967 GREP_PATTERN);
968 argv++;
969 argc--;
970 }
971
972 if (show_in_pager == default_pager)
973 show_in_pager = git_pager(1);
974 if (show_in_pager) {
975 opt.color = 0;
976 opt.name_only = 1;
977 opt.null_following_name = 1;
978 opt.output_priv = &path_list;
979 opt.output = append_path;
980 string_list_append(&path_list, show_in_pager);
981 }
982
983 if (!opt.pattern_list)
984 die(_("no pattern given"));
985
986 /* --only-matching has no effect with --invert. */
987 if (opt.invert)
988 opt.only_matching = 0;
989
990 /*
991 * We have to find "--" in a separate pass, because its presence
992 * influences how we will parse arguments that come before it.
993 */
994 for (i = 0; i < argc; i++) {
995 if (!strcmp(argv[i], "--")) {
996 seen_dashdash = 1;
997 break;
998 }
999 }
1000
1001 /*
1002 * Resolve any rev arguments. If we have a dashdash, then everything up
1003 * to it must resolve as a rev. If not, then we stop at the first
1004 * non-rev and assume everything else is a path.
1005 */
1006 allow_revs = use_index && !untracked;
1007 for (i = 0; i < argc; i++) {
1008 const char *arg = argv[i];
1009 struct object_id oid;
1010 struct object_context oc;
1011 struct object *object;
1012
1013 if (!strcmp(arg, "--")) {
1014 i++;
1015 break;
1016 }
1017
1018 if (!allow_revs) {
1019 if (seen_dashdash)
1020 die(_("--no-index or --untracked cannot be used with revs"));
1021 break;
1022 }
1023
1024 if (get_oid_with_context(the_repository, arg,
1025 GET_OID_RECORD_PATH,
1026 &oid, &oc)) {
1027 if (seen_dashdash)
1028 die(_("unable to resolve revision: %s"), arg);
1029 break;
1030 }
1031
1032 object = parse_object_or_die(&oid, arg);
1033 if (!seen_dashdash)
1034 verify_non_filename(prefix, arg);
1035 add_object_array_with_path(object, arg, &list, oc.mode, oc.path);
1036 free(oc.path);
1037 }
1038
1039 /*
1040 * Anything left over is presumed to be a path. But in the non-dashdash
1041 * "do what I mean" case, we verify and complain when that isn't true.
1042 */
1043 if (!seen_dashdash) {
1044 int j;
1045 for (j = i; j < argc; j++)
1046 verify_filename(prefix, argv[j], j == i && allow_revs);
1047 }
1048
1049 parse_pathspec(&pathspec, 0,
1050 PATHSPEC_PREFER_CWD |
1051 (opt.max_depth != -1 ? PATHSPEC_MAXDEPTH_VALID : 0),
1052 prefix, argv + i);
1053 pathspec.max_depth = opt.max_depth;
1054 pathspec.recursive = 1;
1055 pathspec.recurse_submodules = !!recurse_submodules;
1056
1057 if (list.nr || cached || show_in_pager) {
1058 if (num_threads > 1)
1059 warning(_("invalid option combination, ignoring --threads"));
1060 num_threads = 1;
1061 } else if (!HAVE_THREADS && num_threads > 1) {
1062 warning(_("no threads support, ignoring --threads"));
1063 num_threads = 1;
1064 } else if (num_threads < 0)
1065 die(_("invalid number of threads specified (%d)"), num_threads);
1066 else if (num_threads == 0)
1067 num_threads = HAVE_THREADS ? GREP_NUM_THREADS_DEFAULT : 1;
1068
1069 if (num_threads > 1) {
1070 if (!HAVE_THREADS)
1071 BUG("Somebody got num_threads calculation wrong!");
1072 if (!(opt.name_only || opt.unmatch_name_only || opt.count)
1073 && (opt.pre_context || opt.post_context ||
1074 opt.file_break || opt.funcbody))
1075 skip_first_line = 1;
1076 start_threads(&opt);
1077 } else {
1078 /*
1079 * The compiled patterns on the main path are only
1080 * used when not using threading. Otherwise
1081 * start_threads() above calls compile_grep_patterns()
1082 * for each thread.
1083 */
1084 compile_grep_patterns(&opt);
1085 }
1086
1087 if (show_in_pager && (cached || list.nr))
1088 die(_("--open-files-in-pager only works on the worktree"));
1089
1090 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
1091 const char *pager = path_list.items[0].string;
1092 int len = strlen(pager);
1093
1094 if (len > 4 && is_dir_sep(pager[len - 5]))
1095 pager += len - 4;
1096
1097 if (opt.ignore_case && !strcmp("less", pager))
1098 string_list_append(&path_list, "-I");
1099
1100 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
1101 struct strbuf buf = STRBUF_INIT;
1102 strbuf_addf(&buf, "+/%s%s",
1103 strcmp("less", pager) ? "" : "*",
1104 opt.pattern_list->pattern);
1105 string_list_append(&path_list, buf.buf);
1106 strbuf_detach(&buf, NULL);
1107 }
1108 }
1109
1110 if (recurse_submodules && (!use_index || untracked))
1111 die(_("option not supported with --recurse-submodules"));
1112
1113 if (!show_in_pager && !opt.status_only)
1114 setup_pager();
1115
1116 if (!use_index && (untracked || cached))
1117 die(_("--cached or --untracked cannot be used with --no-index"));
1118
1119 if (!use_index || untracked) {
1120 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
1121 hit = grep_directory(&opt, &pathspec, use_exclude, use_index);
1122 } else if (0 <= opt_exclude) {
1123 die(_("--[no-]exclude-standard cannot be used for tracked contents"));
1124 } else if (!list.nr) {
1125 if (!cached)
1126 setup_work_tree();
1127
1128 hit = grep_cache(&opt, &pathspec, cached);
1129 } else {
1130 if (cached)
1131 die(_("both --cached and trees are given"));
1132
1133 hit = grep_objects(&opt, &pathspec, &list);
1134 }
1135
1136 if (num_threads > 1)
1137 hit |= wait_all();
1138 if (hit && show_in_pager)
1139 run_pager(&opt, prefix);
1140 clear_pathspec(&pathspec);
1141 free_grep_patterns(&opt);
1142 return !hit;
1143 }