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