builtin/grep.c

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