1 /* $NetBSD: util.c,v 1.9 2011/02/27 17:33:37 joerg Exp $ */
2 /* $OpenBSD: util.c,v 1.39 2010/07/02 22:18:03 tedu Exp $ */
5 * SPDX-License-Identifier: BSD-2-Clause
7 * Copyright (c) 1999 James Howard and Dag-Erling Smørgrav
8 * Copyright (C) 2008-2010 Gabor Kovesdan <gabor@FreeBSD.org>
9 * Copyright (C) 2017 Kyle Evans <kevans@FreeBSD.org>
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
36 #include <sys/types.h>
54 static bool first_match = true;
57 * Match printing context
60 long long tail; /* Number of trailing lines to record */
61 int last_outed; /* Number of lines since last output */
62 bool doctx; /* Printing context? */
63 bool printmatch; /* Printing matches? */
64 bool same_file; /* Same file as previously printed? */
67 static void procmatch_match(struct mprintc *mc, struct parsec *pc);
68 static void procmatch_nomatch(struct mprintc *mc, struct parsec *pc);
69 static bool procmatches(struct mprintc *mc, struct parsec *pc, bool matched);
70 #ifdef WITH_INTERNAL_NOSPEC
71 static int litexec(const struct pat *pat, const char *string,
72 size_t nmatch, regmatch_t pmatch[]);
74 static bool procline(struct parsec *pc);
75 static void printline(struct parsec *pc, int sep);
76 static void printline_metadata(struct str *line, int sep);
79 file_matching(const char *fname)
81 char *fname_base, *fname_buf;
84 ret = finclude ? false : true;
85 fname_buf = strdup(fname);
86 if (fname_buf == NULL)
88 fname_base = basename(fname_buf);
90 for (unsigned int i = 0; i < fpatterns; ++i) {
91 if (fnmatch(fpattern[i].pat, fname, 0) == 0 ||
92 fnmatch(fpattern[i].pat, fname_base, 0) == 0)
94 * The last pattern matched wins exclusion/inclusion
95 * rights, so we can't reasonably bail out early here.
97 ret = (fpattern[i].mode != EXCL_PAT);
104 dir_matching(const char *dname)
108 ret = dinclude ? false : true;
110 for (unsigned int i = 0; i < dpatterns; ++i) {
111 if (dname != NULL && fnmatch(dpattern[i].pat, dname, 0) == 0)
113 * The last pattern matched wins exclusion/inclusion
114 * rights, so we can't reasonably bail out early here.
116 ret = (dpattern[i].mode != EXCL_PAT);
122 * Processes a directory when a recursive search is performed with
123 * the -R option. Each appropriate file is passed to procfile().
126 grep_tree(char **argv)
132 const char *wd[] = { ".", NULL };
136 /* This switch effectively initializes 'fts_flags' */
139 fts_flags = FTS_COMFOLLOW;
142 fts_flags = FTS_PHYSICAL;
145 fts_flags = FTS_LOGICAL;
148 fts_flags |= FTS_NOSTAT | FTS_NOCHDIR;
150 fts = fts_open((argv[0] == NULL) ?
151 __DECONST(char * const *, wd) : argv, fts_flags, NULL);
154 while (errno = 0, (p = fts_read(fts)) != NULL) {
155 switch (p->fts_info) {
161 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
166 if (dexclude || dinclude)
167 if (!dir_matching(p->fts_name) ||
168 !dir_matching(p->fts_path))
169 fts_set(fts, p, FTS_SKIP);
172 /* Print a warning for recursive directory loop */
173 warnx("warning: %s: recursive directory loop",
177 /* Check for file exclusion/inclusion */
179 if (fexclude || finclude)
180 ok &= file_matching(p->fts_path);
182 if (ok && procfile(p->fts_path))
195 procmatch_match(struct mprintc *mc, struct parsec *pc)
199 if (!first_match && (!mc->same_file || mc->last_outed > 0))
206 /* Print the matching line, but only if not quiet/binary */
207 if (mc->printmatch) {
209 while (pc->matchidx >= MAX_MATCHES) {
210 /* Reset matchidx and try again */
212 if (procline(pc) == !vflag)
218 mc->same_file = true;
224 procmatch_nomatch(struct mprintc *mc, struct parsec *pc)
227 /* Deal with any -A context as needed */
229 grep_printline(&pc->ln, '-');
233 } else if (Bflag == 0 || (Bflag > 0 && enqueue(&pc->ln)))
235 * Enqueue non-matching lines for -B context. If we're not
236 * actually doing -B context or if the enqueue resulted in a
237 * line being rotated out, then go ahead and increment
238 * last_outed to signify a gap between context/match.
244 * Process any matches in the current parsing context, return a boolean
245 * indicating whether we should halt any further processing or not. 'true' to
246 * continue processing, 'false' to halt.
249 procmatches(struct mprintc *mc, struct parsec *pc, bool matched)
252 if (mflag && mcount <= 0) {
254 * We already hit our match count, but we need to keep dumping
255 * lines until we've lost our tail.
257 grep_printline(&pc->ln, '-');
259 return (mc->tail != 0);
263 * XXX TODO: This should loop over pc->matches and handle things on a
264 * line-by-line basis, setting up a `struct str` as needed.
266 /* Deal with any -B context or context separators */
268 procmatch_match(mc, pc);
270 /* Count the matches if we have a match limit */
272 /* XXX TODO: Decrement by number of matched lines */
275 return (mc->tail != 0);
277 } else if (mc->doctx)
278 procmatch_nomatch(mc, pc);
284 * Opens a file and processes it. Each file is processed line-by-line
285 * passing the lines to procline().
288 procfile(const char *fn)
298 if (strcmp(fn, "-") == 0) {
299 fn = label != NULL ? label : errstr[1];
302 if (stat(fn, &sb) == 0) {
303 /* Check if we need to process the file */
304 s = sb.st_mode & S_IFMT;
305 if (dirbehave == DIR_SKIP && s == S_IFDIR)
307 if (devbehave == DEV_SKIP && (s == S_IFIFO ||
308 s == S_IFCHR || s == S_IFBLK || s == S_IFSOCK))
320 pc.ln.file = grep_strdup(fn);
325 pc.binary = f->binary;
327 memset(&mc, 0, sizeof(mc));
328 mc.printmatch = true;
329 if ((pc.binary && binbehave == BINFILE_BIN) || cflag || qflag ||
331 mc.printmatch = false;
332 if (mc.printmatch && (Aflag != 0 || Bflag != 0))
334 if (mc.printmatch && (Aflag != 0 || Bflag != 0 || mflag || nflag))
338 for (lines = 0; lines == 0 || !(lflag || qflag); ) {
340 * XXX TODO: We need to revisit this in a chunking world. We're
341 * not going to be doing per-line statistics because of the
342 * overhead involved. procmatches can figure that stuff out as
344 /* Reset per-line statistics */
349 pc.ln.off += pc.ln.len + 1;
350 /* XXX TODO: Grab a chunk */
351 if ((pc.ln.dat = grep_fgetln(f, &pc)) == NULL ||
355 if (pc.ln.len > 0 && pc.ln.dat[pc.ln.len - 1] == fileeol)
359 /* Return if we need to skip a binary file */
360 if (pc.binary && binbehave == BINFILE_SKIP) {
367 if (mflag && mcount <= 0) {
369 * Short-circuit, already hit match count and now we're
370 * just picking up any remaining pieces.
372 if (!procmatches(&mc, &pc, false))
376 line_matched = procline(&pc) == !vflag;
380 /* Halt processing if we hit our match limit */
381 if (!procmatches(&mc, &pc, line_matched))
388 if (cflag && !qflag) {
390 printf("%s:", pc.ln.file);
391 printf("%u\n", lines);
393 if (lflag && !qflag && lines != 0)
394 printf("%s%c", fn, nullflag ? 0 : '\n');
395 if (Lflag && !qflag && lines == 0)
396 printf("%s%c", fn, nullflag ? 0 : '\n');
397 if (lines != 0 && !cflag && !lflag && !Lflag &&
398 binbehave == BINFILE_BIN && f->binary && !qflag)
399 printf(errstr[7], fn);
406 #ifdef WITH_INTERNAL_NOSPEC
408 * Internal implementation of literal string search within a string, modeled
409 * after regexec(3), for use when the regex(3) implementation doesn't offer
410 * either REG_NOSPEC or REG_LITERAL. This does not apply in the default FreeBSD
411 * config, but in other scenarios such as building against libgnuregex or on
412 * some non-FreeBSD OSes.
415 litexec(const struct pat *pat, const char *string, size_t nmatch,
418 char *(*strstr_fn)(const char *, const char *);
421 size_t idx, n, ofs, stringlen;
423 if (cflags & REG_ICASE)
424 strstr_fn = strcasestr;
428 ofs = pmatch[0].rm_so;
429 stringlen = pmatch[0].rm_eo;
430 if (ofs >= stringlen)
431 return (REG_NOMATCH);
432 subject = strndup(string, stringlen);
435 for (n = 0; ofs < stringlen;) {
436 search = (subject + ofs);
437 if ((unsigned long)pat->len > strlen(search))
439 sub = strstr_fn(search, pat->pat);
441 * Ignoring the empty string possibility due to context: grep optimizes
442 * for empty patterns and will never reach this point.
447 /* Fill in pmatch if necessary */
449 pmatch[idx].rm_so = ofs + (sub - search);
450 pmatch[idx].rm_eo = pmatch[idx].rm_so + pat->len;
453 ofs = pmatch[idx].rm_so + 1;
455 /* We only needed to know if we match or not */
459 if (n > 0 && nmatch > 0)
460 for (n = idx; n < nmatch; ++n)
461 pmatch[n].rm_so = pmatch[n].rm_eo = -1;
463 return (n > 0 ? 0 : REG_NOMATCH);
465 #endif /* WITH_INTERNAL_NOSPEC */
467 #define iswword(x) (iswalnum((x)) || (x) == L'_')
470 * Processes a line comparing it with the specified patterns. Each pattern
471 * is looped to be compared along with the full string, saving each and every
472 * match, which is necessary to colorize the output and to count the
473 * matches. The matching lines are passed to printline() to display the
474 * appropriate output.
477 procline(struct parsec *pc)
479 regmatch_t pmatch, lastmatch, chkmatch;
480 wchar_t wbegin, wend;
483 int r = 0, leflags = eflags;
484 size_t startm = 0, matchidx;
486 bool lastmatched, matched;
488 matchidx = pc->matchidx;
490 /* Null pattern shortcuts. */
492 if (xflag && pc->ln.len == 0) {
493 /* Matches empty lines (-x). */
495 } else if (!wflag && !xflag) {
496 /* Matches every line (no -w or -x). */
501 * If we only have the NULL pattern, whether we match or not
502 * depends on if we got here with -w or -x. If either is set,
503 * the answer is no. If we have other patterns, we'll defer
507 return (!(wflag || xflag));
509 } else if (patterns == 0) {
510 /* Pattern file with no patterns. */
517 /* Initialize to avoid a false positive warning from GCC. */
518 lastmatch.rm_so = lastmatch.rm_eo = 0;
520 /* Loop to process the whole line */
521 while (st <= pc->ln.len) {
525 if (st > 0 && pc->ln.dat[st - 1] != fileeol)
526 leflags |= REG_NOTBOL;
527 /* Loop to compare with all the patterns */
528 for (i = 0; i < patterns; i++) {
530 pmatch.rm_eo = pc->ln.len;
531 #ifdef WITH_INTERNAL_NOSPEC
532 if (grepbehave == GREP_FIXED)
533 r = litexec(&pattern[i], pc->ln.dat, 1, &pmatch);
536 r = regexec(&r_pattern[i], pc->ln.dat, 1, &pmatch,
540 /* Check for full match */
541 if (xflag && (pmatch.rm_so != 0 ||
542 (size_t)pmatch.rm_eo != pc->ln.len))
544 /* Check for whole word match */
546 wbegin = wend = L' ';
547 if (pmatch.rm_so != 0 &&
548 sscanf(&pc->ln.dat[pmatch.rm_so - 1],
549 "%lc", &wbegin) != 1)
551 else if ((size_t)pmatch.rm_eo !=
553 sscanf(&pc->ln.dat[pmatch.rm_eo],
556 else if (iswword(wbegin) ||
560 * If we're doing whole word matching and we
561 * matched once, then we should try the pattern
562 * again after advancing just past the start of
563 * the earliest match. This allows the pattern
564 * to match later on in the line and possibly
565 * still match a whole word.
567 if (r == REG_NOMATCH &&
568 (retry == pc->lnstart ||
569 (unsigned int)pmatch.rm_so + 1 < retry))
570 retry = pmatch.rm_so + 1;
571 if (r == REG_NOMATCH)
581 * Replace previous match if the new one is earlier
582 * and/or longer. This will lead to some amount of
583 * extra work if -o/--color are specified, but it's
584 * worth it from a correctness point of view.
586 if (matchidx > startm) {
587 chkmatch = pc->matches[matchidx - 1];
588 if (pmatch.rm_so < chkmatch.rm_so ||
589 (pmatch.rm_so == chkmatch.rm_so &&
590 (pmatch.rm_eo - pmatch.rm_so) >
591 (chkmatch.rm_eo - chkmatch.rm_so))) {
592 pc->matches[matchidx - 1] = pmatch;
596 /* Advance as normal if not */
597 pc->matches[matchidx++] = pmatch;
600 /* avoid excessive matching - skip further patterns */
601 if ((color == NULL && !oflag) || qflag || lflag ||
602 matchidx >= MAX_MATCHES) {
610 * Advance to just past the start of the earliest match, try
611 * again just in case we still have a chance to match later in
614 if (!lastmatched && retry > pc->lnstart) {
619 /* XXX TODO: We will need to keep going, since we're chunky */
620 /* One pass if we are not recording matches */
621 if (!wflag && ((color == NULL && !oflag) || qflag || lflag || Lflag))
624 /* If we didn't have any matches or REG_NOSUB set */
625 if (!lastmatched || (cflags & REG_NOSUB))
631 else if (st == nst && lastmatch.rm_so == lastmatch.rm_eo)
632 /* Zero-length match -- advance one more so we don't get stuck */
635 /* Advance st based on previous matches */
640 /* Reflect the new matchidx in the context */
641 pc->matchidx = matchidx;
646 * Safe malloc() for internal use.
649 grep_malloc(size_t size)
655 if ((ptr = malloc(size)) == NULL)
661 * Safe calloc() for internal use.
664 grep_calloc(size_t nmemb, size_t size)
668 if (nmemb == 0 || size == 0)
670 if ((ptr = calloc(nmemb, size)) == NULL)
676 * Safe realloc() for internal use.
679 grep_realloc(void *ptr, size_t size)
682 if ((ptr = realloc(ptr, size)) == NULL)
688 * Safe strdup() for internal use.
691 grep_strdup(const char *str)
695 if ((ret = strdup(str)) == NULL)
701 * Print an entire line as-is, there are no inline matches to consider. This is
702 * used for printing context.
704 void grep_printline(struct str *line, int sep) {
705 printline_metadata(line, sep);
706 fwrite(line->dat, line->len, 1, stdout);
711 printline_metadata(struct str *line, int sep)
718 fputs(line->file, stdout);
721 printf("%s", line->file);
728 printf("%d", line->line_no);
734 printf("%lld", (long long)(line->off + line->boff));
742 * Prints a matching line according to the command line options.
745 printline(struct parsec *pc, int sep)
751 /* If matchall, everything matches but don't actually print for -o */
752 if (oflag && matchall)
755 matchidx = pc->matchidx;
758 if ((oflag || color) && matchidx > 0) {
759 /* Only print metadata once per line if --color */
760 if (!oflag && pc->printed == 0)
761 printline_metadata(&pc->ln, sep);
762 for (i = 0; i < matchidx; i++) {
763 match = pc->matches[i];
764 /* Don't output zero length matches */
765 if (match.rm_so == match.rm_eo)
768 * Metadata is printed on a per-line basis, so every
769 * match gets file metadata with the -o flag.
772 pc->ln.boff = match.rm_so;
773 printline_metadata(&pc->ln, sep);
775 fwrite(pc->ln.dat + a, match.rm_so - a, 1,
778 fprintf(stdout, "\33[%sm\33[K", color);
779 fwrite(pc->ln.dat + match.rm_so,
780 match.rm_eo - match.rm_so, 1, stdout);
782 fprintf(stdout, "\33[m\33[K");
788 if (pc->ln.len - a > 0)
789 fwrite(pc->ln.dat + a, pc->ln.len - a, 1,
794 grep_printline(&pc->ln, sep);