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 ((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))
196 procmatch_match(struct mprintc *mc, struct parsec *pc)
200 if (!first_match && (!mc->same_file || mc->last_outed > 0))
207 /* Print the matching line, but only if not quiet/binary */
208 if (mc->printmatch) {
210 while (pc->matchidx >= MAX_MATCHES) {
211 /* Reset matchidx and try again */
213 if (procline(pc) == !vflag)
219 mc->same_file = true;
225 procmatch_nomatch(struct mprintc *mc, struct parsec *pc)
228 /* Deal with any -A context as needed */
230 grep_printline(&pc->ln, '-');
234 } else if (Bflag == 0 || (Bflag > 0 && enqueue(&pc->ln)))
236 * Enqueue non-matching lines for -B context. If we're not
237 * actually doing -B context or if the enqueue resulted in a
238 * line being rotated out, then go ahead and increment
239 * last_outed to signify a gap between context/match.
245 * Process any matches in the current parsing context, return a boolean
246 * indicating whether we should halt any further processing or not. 'true' to
247 * continue processing, 'false' to halt.
250 procmatches(struct mprintc *mc, struct parsec *pc, bool matched)
254 * XXX TODO: This should loop over pc->matches and handle things on a
255 * line-by-line basis, setting up a `struct str` as needed.
257 /* Deal with any -B context or context separators */
259 procmatch_match(mc, pc);
261 /* Count the matches if we have a match limit */
263 /* XXX TODO: Decrement by number of matched lines */
268 } else if (mc->doctx)
269 procmatch_nomatch(mc, pc);
275 * Opens a file and processes it. Each file is processed line-by-line
276 * passing the lines to procline().
279 procfile(const char *fn)
289 if (strcmp(fn, "-") == 0) {
290 fn = label != NULL ? label : errstr[1];
293 if (stat(fn, &sb) == 0) {
294 /* Check if we need to process the file */
295 s = sb.st_mode & S_IFMT;
296 if (dirbehave == DIR_SKIP && s == S_IFDIR)
298 if (devbehave == DEV_SKIP && (s == S_IFIFO ||
299 s == S_IFCHR || s == S_IFBLK || s == S_IFSOCK))
311 pc.ln.file = grep_strdup(fn);
316 pc.binary = f->binary;
318 memset(&mc, 0, sizeof(mc));
319 mc.printmatch = true;
320 if ((pc.binary && binbehave == BINFILE_BIN) || cflag || qflag ||
322 mc.printmatch = false;
323 if (mc.printmatch && (Aflag != 0 || Bflag != 0))
325 if (mc.printmatch && (Aflag != 0 || Bflag != 0 || mflag || nflag))
329 for (lines = 0; lines == 0 || !(lflag || qflag); ) {
331 * XXX TODO: We need to revisit this in a chunking world. We're
332 * not going to be doing per-line statistics because of the
333 * overhead involved. procmatches can figure that stuff out as
335 /* Reset per-line statistics */
340 pc.ln.off += pc.ln.len + 1;
341 /* XXX TODO: Grab a chunk */
342 if ((pc.ln.dat = grep_fgetln(f, &pc)) == NULL ||
346 if (pc.ln.len > 0 && pc.ln.dat[pc.ln.len - 1] == fileeol)
350 /* Return if we need to skip a binary file */
351 if (pc.binary && binbehave == BINFILE_SKIP) {
358 line_matched = procline(&pc) == !vflag;
362 /* Halt processing if we hit our match limit */
363 if (!procmatches(&mc, &pc, line_matched))
372 printf("%s:", pc.ln.file);
373 printf("%u\n", lines);
375 if (lflag && !qflag && lines != 0)
376 printf("%s%c", fn, nullflag ? 0 : '\n');
377 if (Lflag && !qflag && lines == 0)
378 printf("%s%c", fn, nullflag ? 0 : '\n');
379 if (lines != 0 && !cflag && !lflag && !Lflag &&
380 binbehave == BINFILE_BIN && f->binary && !qflag)
381 printf(errstr[7], fn);
388 #ifdef WITH_INTERNAL_NOSPEC
390 * Internal implementation of literal string search within a string, modeled
391 * after regexec(3), for use when the regex(3) implementation doesn't offer
392 * either REG_NOSPEC or REG_LITERAL. This does not apply in the default FreeBSD
393 * config, but in other scenarios such as building against libgnuregex or on
394 * some non-FreeBSD OSes.
397 litexec(const struct pat *pat, const char *string, size_t nmatch,
400 char *(*strstr_fn)(const char *, const char *);
403 size_t idx, n, ofs, stringlen;
405 if (cflags & REG_ICASE)
406 strstr_fn = strcasestr;
410 ofs = pmatch[0].rm_so;
411 stringlen = pmatch[0].rm_eo;
412 if (ofs >= stringlen)
413 return (REG_NOMATCH);
414 subject = strndup(string, stringlen);
417 for (n = 0; ofs < stringlen;) {
418 search = (subject + ofs);
419 if ((unsigned long)pat->len > strlen(search))
421 sub = strstr_fn(search, pat->pat);
423 * Ignoring the empty string possibility due to context: grep optimizes
424 * for empty patterns and will never reach this point.
429 /* Fill in pmatch if necessary */
431 pmatch[idx].rm_so = ofs + (sub - search);
432 pmatch[idx].rm_eo = pmatch[idx].rm_so + pat->len;
435 ofs = pmatch[idx].rm_so + 1;
437 /* We only needed to know if we match or not */
441 if (n > 0 && nmatch > 0)
442 for (n = idx; n < nmatch; ++n)
443 pmatch[n].rm_so = pmatch[n].rm_eo = -1;
445 return (n > 0 ? 0 : REG_NOMATCH);
447 #endif /* WITH_INTERNAL_NOSPEC */
449 #define iswword(x) (iswalnum((x)) || (x) == L'_')
452 * Processes a line comparing it with the specified patterns. Each pattern
453 * is looped to be compared along with the full string, saving each and every
454 * match, which is necessary to colorize the output and to count the
455 * matches. The matching lines are passed to printline() to display the
456 * appropriate output.
459 procline(struct parsec *pc)
461 regmatch_t pmatch, lastmatch, chkmatch;
462 wchar_t wbegin, wend;
465 int r = 0, leflags = eflags;
466 size_t startm = 0, matchidx;
468 bool lastmatched, matched;
470 matchidx = pc->matchidx;
473 * With matchall (empty pattern), we can try to take some shortcuts.
474 * Emtpy patterns trivially match every line except in the -w and -x
475 * cases. For -w (whole-word) cases, we only match if the first
476 * character isn't a word-character. For -x (whole-line) cases, we only
477 * match if the line is empty.
484 if (sscanf(&pc->ln.dat[0], "%lc", &wend) == 1 &&
491 * If we don't have any other patterns, we really don't match.
492 * If we do have other patterns, we must fall through and check
502 /* Initialize to avoid a false positive warning from GCC. */
503 lastmatch.rm_so = lastmatch.rm_eo = 0;
505 /* Loop to process the whole line */
506 while (st <= pc->ln.len) {
510 if (st > 0 && pc->ln.dat[st - 1] != fileeol)
511 leflags |= REG_NOTBOL;
512 /* Loop to compare with all the patterns */
513 for (i = 0; i < patterns; i++) {
515 pmatch.rm_eo = pc->ln.len;
516 #ifdef WITH_INTERNAL_NOSPEC
517 if (grepbehave == GREP_FIXED)
518 r = litexec(&pattern[i], pc->ln.dat, 1, &pmatch);
521 r = regexec(&r_pattern[i], pc->ln.dat, 1, &pmatch,
525 /* Check for full match */
526 if (xflag && (pmatch.rm_so != 0 ||
527 (size_t)pmatch.rm_eo != pc->ln.len))
529 /* Check for whole word match */
531 wbegin = wend = L' ';
532 if (pmatch.rm_so != 0 &&
533 sscanf(&pc->ln.dat[pmatch.rm_so - 1],
534 "%lc", &wbegin) != 1)
536 else if ((size_t)pmatch.rm_eo !=
538 sscanf(&pc->ln.dat[pmatch.rm_eo],
541 else if (iswword(wbegin) ||
545 * If we're doing whole word matching and we
546 * matched once, then we should try the pattern
547 * again after advancing just past the start of
548 * the earliest match. This allows the pattern
549 * to match later on in the line and possibly
550 * still match a whole word.
552 if (r == REG_NOMATCH &&
553 (retry == pc->lnstart ||
554 (unsigned int)pmatch.rm_so + 1 < retry))
555 retry = pmatch.rm_so + 1;
556 if (r == REG_NOMATCH)
566 * Replace previous match if the new one is earlier
567 * and/or longer. This will lead to some amount of
568 * extra work if -o/--color are specified, but it's
569 * worth it from a correctness point of view.
571 if (matchidx > startm) {
572 chkmatch = pc->matches[matchidx - 1];
573 if (pmatch.rm_so < chkmatch.rm_so ||
574 (pmatch.rm_so == chkmatch.rm_so &&
575 (pmatch.rm_eo - pmatch.rm_so) >
576 (chkmatch.rm_eo - chkmatch.rm_so))) {
577 pc->matches[matchidx - 1] = pmatch;
581 /* Advance as normal if not */
582 pc->matches[matchidx++] = pmatch;
585 /* avoid excessive matching - skip further patterns */
586 if ((color == NULL && !oflag) || qflag || lflag ||
587 matchidx >= MAX_MATCHES) {
595 * Advance to just past the start of the earliest match, try
596 * again just in case we still have a chance to match later in
599 if (!lastmatched && retry > pc->lnstart) {
604 /* XXX TODO: We will need to keep going, since we're chunky */
605 /* One pass if we are not recording matches */
606 if (!wflag && ((color == NULL && !oflag) || qflag || lflag || Lflag))
609 /* If we didn't have any matches or REG_NOSUB set */
610 if (!lastmatched || (cflags & REG_NOSUB))
616 else if (st == nst && lastmatch.rm_so == lastmatch.rm_eo)
617 /* Zero-length match -- advance one more so we don't get stuck */
620 /* Advance st based on previous matches */
625 /* Reflect the new matchidx in the context */
626 pc->matchidx = matchidx;
631 * Safe malloc() for internal use.
634 grep_malloc(size_t size)
638 if ((ptr = malloc(size)) == NULL)
644 * Safe calloc() for internal use.
647 grep_calloc(size_t nmemb, size_t size)
651 if ((ptr = calloc(nmemb, size)) == NULL)
657 * Safe realloc() for internal use.
660 grep_realloc(void *ptr, size_t size)
663 if ((ptr = realloc(ptr, size)) == NULL)
669 * Safe strdup() for internal use.
672 grep_strdup(const char *str)
676 if ((ret = strdup(str)) == NULL)
682 * Print an entire line as-is, there are no inline matches to consider. This is
683 * used for printing context.
685 void grep_printline(struct str *line, int sep) {
686 printline_metadata(line, sep);
687 fwrite(line->dat, line->len, 1, stdout);
692 printline_metadata(struct str *line, int sep)
699 fputs(line->file, stdout);
702 printf("%s", line->file);
709 printf("%d", line->line_no);
715 printf("%lld", (long long)(line->off + line->boff));
723 * Prints a matching line according to the command line options.
726 printline(struct parsec *pc, int sep)
732 /* If matchall, everything matches but don't actually print for -o */
733 if (oflag && matchall)
736 matchidx = pc->matchidx;
739 if ((oflag || color) && matchidx > 0) {
740 /* Only print metadata once per line if --color */
741 if (!oflag && pc->printed == 0)
742 printline_metadata(&pc->ln, sep);
743 for (i = 0; i < matchidx; i++) {
744 match = pc->matches[i];
745 /* Don't output zero length matches */
746 if (match.rm_so == match.rm_eo)
749 * Metadata is printed on a per-line basis, so every
750 * match gets file metadata with the -o flag.
753 pc->ln.boff = match.rm_so;
754 printline_metadata(&pc->ln, sep);
756 fwrite(pc->ln.dat + a, match.rm_so - a, 1,
759 fprintf(stdout, "\33[%sm\33[K", color);
760 fwrite(pc->ln.dat + match.rm_so,
761 match.rm_eo - match.rm_so, 1, stdout);
763 fprintf(stdout, "\33[m\33[K");
769 if (pc->ln.len - a > 0)
770 fwrite(pc->ln.dat + a, pc->ln.len - a, 1,
775 grep_printline(&pc->ln, sep);