1 /* $NetBSD: util.c,v 1.9 2011/02/27 17:33:37 joerg Exp $ */
3 /* $OpenBSD: util.c,v 1.39 2010/07/02 22:18:03 tedu Exp $ */
6 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
8 * Copyright (c) 1999 James Howard and Dag-Erling Coïdan Smørgrav
9 * Copyright (C) 2008-2010 Gabor Kovesdan <gabor@FreeBSD.org>
10 * Copyright (C) 2017 Kyle Evans <kevans@FreeBSD.org>
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
39 #include <sys/types.h>
57 static bool first_match = true;
60 * Match printing context
63 long long tail; /* Number of trailing lines to record */
64 int last_outed; /* Number of lines since last output */
65 bool doctx; /* Printing context? */
66 bool printmatch; /* Printing matches? */
67 bool same_file; /* Same file as previously printed? */
70 static void procmatch_match(struct mprintc *mc, struct parsec *pc);
71 static void procmatch_nomatch(struct mprintc *mc, struct parsec *pc);
72 static bool procmatches(struct mprintc *mc, struct parsec *pc, bool matched);
73 #ifdef WITH_INTERNAL_NOSPEC
74 static int litexec(const struct pat *pat, const char *string,
75 size_t nmatch, regmatch_t pmatch[]);
77 static bool procline(struct parsec *pc);
78 static void printline(struct parsec *pc, int sep);
79 static void printline_metadata(struct str *line, int sep);
82 file_matching(const char *fname)
84 char *fname_base, *fname_buf;
87 ret = finclude ? false : true;
88 fname_buf = strdup(fname);
89 if (fname_buf == NULL)
91 fname_base = basename(fname_buf);
93 for (unsigned int i = 0; i < fpatterns; ++i) {
94 if (fnmatch(fpattern[i].pat, fname, 0) == 0 ||
95 fnmatch(fpattern[i].pat, fname_base, 0) == 0)
97 * The last pattern matched wins exclusion/inclusion
98 * rights, so we can't reasonably bail out early here.
100 ret = (fpattern[i].mode != EXCL_PAT);
107 dir_matching(const char *dname)
111 ret = dinclude ? false : true;
113 for (unsigned int i = 0; i < dpatterns; ++i) {
114 if (dname != NULL && fnmatch(dpattern[i].pat, dname, 0) == 0)
116 * The last pattern matched wins exclusion/inclusion
117 * rights, so we can't reasonably bail out early here.
119 ret = (dpattern[i].mode != EXCL_PAT);
125 * Processes a directory when a recursive search is performed with
126 * the -R option. Each appropriate file is passed to procfile().
129 grep_tree(char **argv)
135 const char *wd[] = { ".", NULL };
139 /* This switch effectively initializes 'fts_flags' */
142 fts_flags = FTS_COMFOLLOW;
145 fts_flags = FTS_PHYSICAL;
148 fts_flags = FTS_LOGICAL;
151 fts_flags |= FTS_NOSTAT | FTS_NOCHDIR;
153 fts = fts_open((argv[0] == NULL) ?
154 __DECONST(char * const *, wd) : argv, fts_flags, NULL);
157 while (errno = 0, (p = fts_read(fts)) != NULL) {
158 switch (p->fts_info) {
164 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
169 if (dexclude || dinclude)
170 if (!dir_matching(p->fts_name) ||
171 !dir_matching(p->fts_path))
172 fts_set(fts, p, FTS_SKIP);
175 /* Print a warning for recursive directory loop */
176 warnx("warning: %s: recursive directory loop",
180 /* Check for file exclusion/inclusion */
182 if (fexclude || finclude)
183 ok &= file_matching(p->fts_path);
185 if (ok && procfile(p->fts_path))
198 procmatch_match(struct mprintc *mc, struct parsec *pc)
202 if (!first_match && (!mc->same_file || mc->last_outed > 0))
209 /* Print the matching line, but only if not quiet/binary */
210 if (mc->printmatch) {
212 while (pc->matchidx >= MAX_MATCHES) {
213 /* Reset matchidx and try again */
215 if (procline(pc) == !vflag)
221 mc->same_file = true;
227 procmatch_nomatch(struct mprintc *mc, struct parsec *pc)
230 /* Deal with any -A context as needed */
232 grep_printline(&pc->ln, '-');
236 } else if (Bflag == 0 || (Bflag > 0 && enqueue(&pc->ln)))
238 * Enqueue non-matching lines for -B context. If we're not
239 * actually doing -B context or if the enqueue resulted in a
240 * line being rotated out, then go ahead and increment
241 * last_outed to signify a gap between context/match.
247 * Process any matches in the current parsing context, return a boolean
248 * indicating whether we should halt any further processing or not. 'true' to
249 * continue processing, 'false' to halt.
252 procmatches(struct mprintc *mc, struct parsec *pc, bool matched)
255 if (mflag && mcount <= 0) {
257 * We already hit our match count, but we need to keep dumping
258 * lines until we've lost our tail.
260 grep_printline(&pc->ln, '-');
262 return (mc->tail != 0);
266 * XXX TODO: This should loop over pc->matches and handle things on a
267 * line-by-line basis, setting up a `struct str` as needed.
269 /* Deal with any -B context or context separators */
271 procmatch_match(mc, pc);
273 /* Count the matches if we have a match limit */
275 /* XXX TODO: Decrement by number of matched lines */
278 return (mc->tail != 0);
280 } else if (mc->doctx)
281 procmatch_nomatch(mc, pc);
287 * Opens a file and processes it. Each file is processed line-by-line
288 * passing the lines to procline().
291 procfile(const char *fn)
301 if (strcmp(fn, "-") == 0) {
302 fn = label != NULL ? label : errstr[1];
305 if (stat(fn, &sb) == 0) {
306 /* Check if we need to process the file */
307 s = sb.st_mode & S_IFMT;
308 if (dirbehave == DIR_SKIP && s == S_IFDIR)
310 if (devbehave == DEV_SKIP && (s == S_IFIFO ||
311 s == S_IFCHR || s == S_IFBLK || s == S_IFSOCK))
323 pc.ln.file = grep_strdup(fn);
328 pc.binary = f->binary;
330 memset(&mc, 0, sizeof(mc));
331 mc.printmatch = true;
332 if ((pc.binary && binbehave == BINFILE_BIN) || cflag || qflag ||
334 mc.printmatch = false;
335 if (mc.printmatch && (Aflag != 0 || Bflag != 0))
337 if (mc.printmatch && (Aflag != 0 || Bflag != 0 || mflag || nflag))
341 for (lines = 0; lines == 0 || !(lflag || qflag); ) {
343 * XXX TODO: We need to revisit this in a chunking world. We're
344 * not going to be doing per-line statistics because of the
345 * overhead involved. procmatches can figure that stuff out as
347 /* Reset per-line statistics */
352 pc.ln.off += pc.ln.len + 1;
353 /* XXX TODO: Grab a chunk */
354 if ((pc.ln.dat = grep_fgetln(f, &pc)) == NULL ||
358 if (pc.ln.len > 0 && pc.ln.dat[pc.ln.len - 1] == fileeol)
362 /* Return if we need to skip a binary file */
363 if (pc.binary && binbehave == BINFILE_SKIP) {
370 if (mflag && mcount <= 0) {
372 * Short-circuit, already hit match count and now we're
373 * just picking up any remaining pieces.
375 if (!procmatches(&mc, &pc, false))
379 line_matched = procline(&pc) == !vflag;
383 /* Halt processing if we hit our match limit */
384 if (!procmatches(&mc, &pc, line_matched))
393 printf("%s:", pc.ln.file);
394 printf("%u\n", lines);
396 if (lflag && !qflag && lines != 0)
397 printf("%s%c", fn, nullflag ? 0 : '\n');
398 if (Lflag && !qflag && lines == 0)
399 printf("%s%c", fn, nullflag ? 0 : '\n');
400 if (lines != 0 && !cflag && !lflag && !Lflag &&
401 binbehave == BINFILE_BIN && f->binary && !qflag)
402 printf(errstr[7], fn);
409 #ifdef WITH_INTERNAL_NOSPEC
411 * Internal implementation of literal string search within a string, modeled
412 * after regexec(3), for use when the regex(3) implementation doesn't offer
413 * either REG_NOSPEC or REG_LITERAL. This does not apply in the default FreeBSD
414 * config, but in other scenarios such as building against libgnuregex or on
415 * some non-FreeBSD OSes.
418 litexec(const struct pat *pat, const char *string, size_t nmatch,
421 char *(*strstr_fn)(const char *, const char *);
424 size_t idx, n, ofs, stringlen;
426 if (cflags & REG_ICASE)
427 strstr_fn = strcasestr;
431 ofs = pmatch[0].rm_so;
432 stringlen = pmatch[0].rm_eo;
433 if (ofs >= stringlen)
434 return (REG_NOMATCH);
435 subject = strndup(string, stringlen);
438 for (n = 0; ofs < stringlen;) {
439 search = (subject + ofs);
440 if ((unsigned long)pat->len > strlen(search))
442 sub = strstr_fn(search, pat->pat);
444 * Ignoring the empty string possibility due to context: grep optimizes
445 * for empty patterns and will never reach this point.
450 /* Fill in pmatch if necessary */
452 pmatch[idx].rm_so = ofs + (sub - search);
453 pmatch[idx].rm_eo = pmatch[idx].rm_so + pat->len;
456 ofs = pmatch[idx].rm_so + 1;
458 /* We only needed to know if we match or not */
462 if (n > 0 && nmatch > 0)
463 for (n = idx; n < nmatch; ++n)
464 pmatch[n].rm_so = pmatch[n].rm_eo = -1;
466 return (n > 0 ? 0 : REG_NOMATCH);
468 #endif /* WITH_INTERNAL_NOSPEC */
470 #define iswword(x) (iswalnum((x)) || (x) == L'_')
473 * Processes a line comparing it with the specified patterns. Each pattern
474 * is looped to be compared along with the full string, saving each and every
475 * match, which is necessary to colorize the output and to count the
476 * matches. The matching lines are passed to printline() to display the
477 * appropriate output.
480 procline(struct parsec *pc)
482 regmatch_t pmatch, lastmatch, chkmatch;
483 wchar_t wbegin, wend;
486 int r = 0, leflags = eflags;
487 size_t startm = 0, matchidx;
489 bool lastmatched, matched;
491 matchidx = pc->matchidx;
493 /* Null pattern shortcuts. */
495 if (xflag && pc->ln.len == 0) {
496 /* Matches empty lines (-x). */
498 } else if (!wflag && !xflag) {
499 /* Matches every line (no -w or -x). */
504 * If we only have the NULL pattern, whether we match or not
505 * depends on if we got here with -w or -x. If either is set,
506 * the answer is no. If we have other patterns, we'll defer
510 return (!(wflag || xflag));
512 } else if (patterns == 0) {
513 /* Pattern file with no patterns. */
520 /* Initialize to avoid a false positive warning from GCC. */
521 lastmatch.rm_so = lastmatch.rm_eo = 0;
523 /* Loop to process the whole line */
524 while (st <= pc->ln.len) {
528 if (st > 0 && pc->ln.dat[st - 1] != fileeol)
529 leflags |= REG_NOTBOL;
530 /* Loop to compare with all the patterns */
531 for (i = 0; i < patterns; i++) {
533 pmatch.rm_eo = pc->ln.len;
534 #ifdef WITH_INTERNAL_NOSPEC
535 if (grepbehave == GREP_FIXED)
536 r = litexec(&pattern[i], pc->ln.dat, 1, &pmatch);
539 r = regexec(&r_pattern[i], pc->ln.dat, 1, &pmatch,
543 /* Check for full match */
544 if (xflag && (pmatch.rm_so != 0 ||
545 (size_t)pmatch.rm_eo != pc->ln.len))
547 /* Check for whole word match */
549 wbegin = wend = L' ';
550 if (pmatch.rm_so != 0 &&
551 sscanf(&pc->ln.dat[pmatch.rm_so - 1],
552 "%lc", &wbegin) != 1)
554 else if ((size_t)pmatch.rm_eo !=
556 sscanf(&pc->ln.dat[pmatch.rm_eo],
559 else if (iswword(wbegin) ||
563 * If we're doing whole word matching and we
564 * matched once, then we should try the pattern
565 * again after advancing just past the start of
566 * the earliest match. This allows the pattern
567 * to match later on in the line and possibly
568 * still match a whole word.
570 if (r == REG_NOMATCH &&
571 (retry == pc->lnstart ||
572 (unsigned int)pmatch.rm_so + 1 < retry))
573 retry = pmatch.rm_so + 1;
574 if (r == REG_NOMATCH)
584 * Replace previous match if the new one is earlier
585 * and/or longer. This will lead to some amount of
586 * extra work if -o/--color are specified, but it's
587 * worth it from a correctness point of view.
589 if (matchidx > startm) {
590 chkmatch = pc->matches[matchidx - 1];
591 if (pmatch.rm_so < chkmatch.rm_so ||
592 (pmatch.rm_so == chkmatch.rm_so &&
593 (pmatch.rm_eo - pmatch.rm_so) >
594 (chkmatch.rm_eo - chkmatch.rm_so))) {
595 pc->matches[matchidx - 1] = pmatch;
599 /* Advance as normal if not */
600 pc->matches[matchidx++] = pmatch;
603 /* avoid excessive matching - skip further patterns */
604 if ((color == NULL && !oflag) || qflag || lflag ||
605 matchidx >= MAX_MATCHES) {
613 * Advance to just past the start of the earliest match, try
614 * again just in case we still have a chance to match later in
617 if (!lastmatched && retry > pc->lnstart) {
622 /* XXX TODO: We will need to keep going, since we're chunky */
623 /* One pass if we are not recording matches */
624 if (!wflag && ((color == NULL && !oflag) || qflag || lflag || Lflag))
627 /* If we didn't have any matches or REG_NOSUB set */
628 if (!lastmatched || (cflags & REG_NOSUB))
634 else if (st == nst && lastmatch.rm_so == lastmatch.rm_eo)
635 /* Zero-length match -- advance one more so we don't get stuck */
638 /* Advance st based on previous matches */
643 /* Reflect the new matchidx in the context */
644 pc->matchidx = matchidx;
649 * Safe malloc() for internal use.
652 grep_malloc(size_t size)
656 if ((ptr = malloc(size)) == NULL)
662 * Safe calloc() for internal use.
665 grep_calloc(size_t nmemb, size_t size)
669 if ((ptr = calloc(nmemb, size)) == NULL)
675 * Safe realloc() for internal use.
678 grep_realloc(void *ptr, size_t size)
681 if ((ptr = realloc(ptr, size)) == NULL)
687 * Safe strdup() for internal use.
690 grep_strdup(const char *str)
694 if ((ret = strdup(str)) == NULL)
700 * Print an entire line as-is, there are no inline matches to consider. This is
701 * used for printing context.
703 void grep_printline(struct str *line, int sep) {
704 printline_metadata(line, sep);
705 fwrite(line->dat, line->len, 1, stdout);
710 printline_metadata(struct str *line, int sep)
717 fputs(line->file, stdout);
720 printf("%s", line->file);
727 printf("%d", line->line_no);
733 printf("%lld", (long long)(line->off + line->boff));
741 * Prints a matching line according to the command line options.
744 printline(struct parsec *pc, int sep)
750 /* If matchall, everything matches but don't actually print for -o */
751 if (oflag && matchall)
754 matchidx = pc->matchidx;
757 if ((oflag || color) && matchidx > 0) {
758 /* Only print metadata once per line if --color */
759 if (!oflag && pc->printed == 0)
760 printline_metadata(&pc->ln, sep);
761 for (i = 0; i < matchidx; i++) {
762 match = pc->matches[i];
763 /* Don't output zero length matches */
764 if (match.rm_so == match.rm_eo)
767 * Metadata is printed on a per-line basis, so every
768 * match gets file metadata with the -o flag.
771 pc->ln.boff = match.rm_so;
772 printline_metadata(&pc->ln, sep);
774 fwrite(pc->ln.dat + a, match.rm_so - a, 1,
777 fprintf(stdout, "\33[%sm\33[K", color);
778 fwrite(pc->ln.dat + match.rm_so,
779 match.rm_eo - match.rm_so, 1, stdout);
781 fprintf(stdout, "\33[m\33[K");
787 if (pc->ln.len - a > 0)
788 fwrite(pc->ln.dat + a, pc->ln.len - a, 1,
793 grep_printline(&pc->ln, sep);