1 /* vi: set sw=4 ts=4: */
3 * Mini grep implementation for busybox using libc regex.
5 * Copyright (C) 1999,2000,2001 by Lineo, inc. and Mark Whitley
6 * Copyright (C) 1999,2000,2001 by Mark Whitley <markw@codepoet.org>
8 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
10 /* BB_AUDIT SUSv3 defects - unsupported option -x. */
11 /* BB_AUDIT GNU defects - always acts as -a. */
12 /* http://www.opengroup.org/onlinepubs/007904975/utilities/grep.html */
14 * 2004,2006 (C) Vladimir Oleynik <dzo@simtreas.ru> -
15 * correction "-e pattern1 -e pattern2" logic and more optimizations.
19 * (C) 2006 Jac Goudsmit added -o option
27 "lnqvscFiHhe:f:Lorm:" \
28 USE_FEATURE_GREP_CONTEXT("A:B:C:") \
29 USE_FEATURE_GREP_EGREP_ALIAS("E") \
32 /* ignored: -a "assume all files to be text" */
33 /* ignored: -I "assume binary files have no matches" */
36 OPTBIT_l, /* list matched file names only */
37 OPTBIT_n, /* print line# */
38 OPTBIT_q, /* quiet - exit(0) of first match */
39 OPTBIT_v, /* invert the match, to select non-matching lines */
40 OPTBIT_s, /* suppress errors about file open errors */
41 OPTBIT_c, /* count matches per file (suppresses normal output) */
42 OPTBIT_F, /* literal match */
43 OPTBIT_i, /* case-insensitive */
44 OPTBIT_H, /* force filename display */
45 OPTBIT_h, /* inhibit filename display */
46 OPTBIT_e, /* -e PATTERN */
47 OPTBIT_f, /* -f FILE_WITH_PATTERNS */
48 OPTBIT_L, /* list unmatched file names only */
49 OPTBIT_o, /* show only matching parts of lines */
50 OPTBIT_r, /* recurse dirs */
51 OPTBIT_m, /* -m MAX_MATCHES */
52 USE_FEATURE_GREP_CONTEXT( OPTBIT_A ,) /* -A NUM: after-match context */
53 USE_FEATURE_GREP_CONTEXT( OPTBIT_B ,) /* -B NUM: before-match context */
54 USE_FEATURE_GREP_CONTEXT( OPTBIT_C ,) /* -C NUM: -A and -B combined */
55 USE_FEATURE_GREP_EGREP_ALIAS(OPTBIT_E ,) /* extended regexp */
56 USE_DESKTOP( OPTBIT_w ,) /* whole word match */
57 OPT_l = 1 << OPTBIT_l,
58 OPT_n = 1 << OPTBIT_n,
59 OPT_q = 1 << OPTBIT_q,
60 OPT_v = 1 << OPTBIT_v,
61 OPT_s = 1 << OPTBIT_s,
62 OPT_c = 1 << OPTBIT_c,
63 OPT_F = 1 << OPTBIT_F,
64 OPT_i = 1 << OPTBIT_i,
65 OPT_H = 1 << OPTBIT_H,
66 OPT_h = 1 << OPTBIT_h,
67 OPT_e = 1 << OPTBIT_e,
68 OPT_f = 1 << OPTBIT_f,
69 OPT_L = 1 << OPTBIT_L,
70 OPT_o = 1 << OPTBIT_o,
71 OPT_r = 1 << OPTBIT_r,
72 OPT_m = 1 << OPTBIT_m,
73 OPT_A = USE_FEATURE_GREP_CONTEXT( (1 << OPTBIT_A)) + 0,
74 OPT_B = USE_FEATURE_GREP_CONTEXT( (1 << OPTBIT_B)) + 0,
75 OPT_C = USE_FEATURE_GREP_CONTEXT( (1 << OPTBIT_C)) + 0,
76 OPT_E = USE_FEATURE_GREP_EGREP_ALIAS((1 << OPTBIT_E)) + 0,
77 OPT_w = USE_DESKTOP( (1 << OPTBIT_w)) + 0,
80 #define PRINT_FILES_WITH_MATCHES (option_mask32 & OPT_l)
81 #define PRINT_LINE_NUM (option_mask32 & OPT_n)
82 #define BE_QUIET (option_mask32 & OPT_q)
83 #define SUPPRESS_ERR_MSGS (option_mask32 & OPT_s)
84 #define PRINT_MATCH_COUNTS (option_mask32 & OPT_c)
85 #define FGREP_FLAG (option_mask32 & OPT_F)
86 #define PRINT_FILES_WITHOUT_MATCHES (option_mask32 & OPT_L)
91 smalluint invert_search;
92 smalluint print_filename;
93 smalluint open_errors;
94 #if ENABLE_FEATURE_GREP_CONTEXT
95 smalluint did_print_line;
99 int last_line_printed;
101 /* globals used internally */
102 llist_t *pattern_head; /* growable list of patterns to match */
103 const char *cur_file; /* the current file we are reading */
105 #define G (*(struct globals*)&bb_common_bufsiz1)
108 struct G_sizecheck { \
109 char G_sizecheck[sizeof(G) > COMMON_BUFSIZE ? -1 : 1]; \
112 #define max_matches (G.max_matches )
113 #define reflags (G.reflags )
114 #define invert_search (G.invert_search )
115 #define print_filename (G.print_filename )
116 #define open_errors (G.open_errors )
117 #define did_print_line (G.did_print_line )
118 #define lines_before (G.lines_before )
119 #define lines_after (G.lines_after )
120 #define before_buf (G.before_buf )
121 #define last_line_printed (G.last_line_printed )
122 #define pattern_head (G.pattern_head )
123 #define cur_file (G.cur_file )
126 typedef struct grep_list_data_t {
129 #define PATTERN_MEM_A 1
131 int flg_mem_alocated_compiled;
135 static void print_line(const char *line, int linenum, char decoration)
137 #if ENABLE_FEATURE_GREP_CONTEXT
138 /* Happens when we go to next file, immediately hit match
139 * and try to print prev context... from prev file! Don't do it */
142 /* possibly print the little '--' separator */
143 if ((lines_before || lines_after) && did_print_line &&
144 last_line_printed != linenum - 1) {
147 /* guard against printing "--" before first line of first file */
149 last_line_printed = linenum;
152 printf("%s%c", cur_file, decoration);
154 printf("%i%c", linenum, decoration);
155 /* Emulate weird GNU grep behavior with -ov */
156 if ((option_mask32 & (OPT_v|OPT_o)) != (OPT_v|OPT_o))
160 static int grep_file(FILE *file)
167 #if ENABLE_FEATURE_GREP_CONTEXT
168 int print_n_lines_after = 0;
169 int curpos = 0; /* track where we are in the circular 'before' buffer */
170 int idx = 0; /* used for iteration through the circular buffer */
172 enum { print_n_lines_after = 0 };
173 #endif /* ENABLE_FEATURE_GREP_CONTEXT */
175 while ((line = xmalloc_getline(file)) != NULL) {
176 llist_t *pattern_ptr = pattern_head;
177 grep_list_data_t *gl;
181 while (pattern_ptr) {
182 gl = (grep_list_data_t *)pattern_ptr->data;
184 found |= strstr(line, gl->pattern) != NULL;
187 * test for a postitive-assertion match (regexec returns success (0)
188 * and the user did not specify invert search), or a negative-assertion
189 * match (regexec returns failure (REG_NOMATCH) and the user specified
192 if (!(gl->flg_mem_alocated_compiled & COMPILED)) {
193 gl->flg_mem_alocated_compiled |= COMPILED;
194 xregcomp(&(gl->preg), gl->pattern, reflags);
198 if (regexec(&(gl->preg), line, 1, ®match, 0) == 0) {
199 if (!(option_mask32 & OPT_w))
204 c = line[regmatch.rm_so - 1];
205 if (!isalnum(c) && c != '_') {
206 c = line[regmatch.rm_eo];
207 if (!c || (!isalnum(c) && c != '_'))
213 /* If it's non-inverted search, we can stop
215 if (found && !invert_search)
217 pattern_ptr = pattern_ptr->link;
218 } /* while (pattern_ptr) */
220 if (found ^ invert_search) {
222 /* keep track of matches */
225 /* quiet/print (non)matching file names only? */
226 if (option_mask32 & (OPT_q|OPT_l|OPT_L)) {
227 free(line); /* we don't need line anymore */
229 /* manpage says about -q:
230 * "exit immediately with zero status
231 * if any match is found,
232 * even if errors were detected" */
235 /* if we're just printing filenames, we stop after the first match */
236 if (PRINT_FILES_WITH_MATCHES) {
238 /* fall thru to "return 1" */
240 /* OPT_L aka PRINT_FILES_WITHOUT_MATCHES: return early */
241 return 1; /* one match */
244 #if ENABLE_FEATURE_GREP_CONTEXT
245 /* Were we printing context and saw next (unwanted) match? */
246 if ((option_mask32 & OPT_m) && nmatches > max_matches)
250 /* print the matched line */
251 if (PRINT_MATCH_COUNTS == 0) {
252 #if ENABLE_FEATURE_GREP_CONTEXT
253 int prevpos = (curpos == 0) ? lines_before - 1 : curpos - 1;
255 /* if we were told to print 'before' lines and there is at least
256 * one line in the circular buffer, print them */
257 if (lines_before && before_buf[prevpos] != NULL) {
258 int first_buf_entry_line_num = linenum - lines_before;
260 /* advance to the first entry in the circular buffer, and
261 * figure out the line number is of the first line in the
264 while (before_buf[idx] == NULL) {
265 idx = (idx + 1) % lines_before;
266 first_buf_entry_line_num++;
269 /* now print each line in the buffer, clearing them as we go */
270 while (before_buf[idx] != NULL) {
271 print_line(before_buf[idx], first_buf_entry_line_num, '-');
272 free(before_buf[idx]);
273 before_buf[idx] = NULL;
274 idx = (idx + 1) % lines_before;
275 first_buf_entry_line_num++;
279 /* make a note that we need to print 'after' lines */
280 print_n_lines_after = lines_after;
282 if (option_mask32 & OPT_o) {
283 line[regmatch.rm_eo] = '\0';
284 print_line(line + regmatch.rm_so, linenum, ':');
286 print_line(line, linenum, ':');
290 #if ENABLE_FEATURE_GREP_CONTEXT
291 else { /* no match */
292 /* if we need to print some context lines after the last match, do so */
293 if (print_n_lines_after) {
294 print_line(line, linenum, '-');
295 print_n_lines_after--;
296 } else if (lines_before) {
297 /* Add the line to the circular 'before' buffer */
298 free(before_buf[curpos]);
299 before_buf[curpos] = line;
300 curpos = (curpos + 1) % lines_before;
301 /* avoid free(line) - we took line */
306 #endif /* ENABLE_FEATURE_GREP_CONTEXT */
309 /* Did we print all context after last requested match? */
310 if ((option_mask32 & OPT_m)
311 && !print_n_lines_after && nmatches == max_matches)
315 /* special-case file post-processing for options where we don't print line
316 * matches, just filenames and possibly match counts */
318 /* grep -c: print [filename:]count, even if count is zero */
319 if (PRINT_MATCH_COUNTS) {
321 printf("%s:", cur_file);
322 printf("%d\n", nmatches);
325 /* grep -L: print just the filename */
326 if (PRINT_FILES_WITHOUT_MATCHES) {
327 /* nmatches is zero, no need to check it:
328 * we return 1 early if we detected a match
329 * and PRINT_FILES_WITHOUT_MATCHES is set */
336 #if ENABLE_FEATURE_CLEAN_UP
337 #define new_grep_list_data(p, m) add_grep_list_data(p, m)
338 static char *add_grep_list_data(char *pattern, int flg_used_mem)
340 #define new_grep_list_data(p, m) add_grep_list_data(p)
341 static char *add_grep_list_data(char *pattern)
344 grep_list_data_t *gl = xzalloc(sizeof(*gl));
345 gl->pattern = pattern;
346 #if ENABLE_FEATURE_CLEAN_UP
347 gl->flg_mem_alocated_compiled = flg_used_mem;
349 /*gl->flg_mem_alocated_compiled = 0;*/
354 static void load_regexes_from_file(llist_t *fopt)
361 char *ffile = cur->data;
365 f = xfopen(ffile, "r");
366 while ((line = xmalloc_getline(f)) != NULL) {
367 llist_add_to(&pattern_head,
368 new_grep_list_data(line, PATTERN_MEM_A));
373 static int file_action_grep(const char *filename, struct stat *statbuf, void* matched, int depth)
375 FILE *file = fopen(filename, "r");
377 if (!SUPPRESS_ERR_MSGS)
378 bb_perror_msg("%s", cur_file);
383 *(int*)matched += grep_file(file);
388 static int grep_dir(const char *dir)
391 recursive_action(dir,
392 /* recurse=yes */ ACTION_RECURSE |
394 /* depthFirst=yes */ ACTION_DEPTHFIRST,
395 /* fileAction= */ file_action_grep,
396 /* dirAction= */ NULL,
397 /* userData= */ &matched,
402 int grep_main(int argc, char **argv);
403 int grep_main(int argc, char **argv)
408 llist_t *fopt = NULL;
410 /* do normal option parsing */
411 #if ENABLE_FEATURE_GREP_CONTEXT
416 opt_complementary = "H-h:e::f::C-AB";
419 &pattern_head, &fopt, &mopt,
420 &slines_after, &slines_before, &Copt);
422 if (option_mask32 & OPT_C) {
423 /* -C unsets prev -A and -B, but following -A or -B
425 if (!(option_mask32 & OPT_A)) /* not overridden */
427 if (!(option_mask32 & OPT_B)) /* not overridden */
428 slines_before = Copt;
429 option_mask32 |= OPT_A|OPT_B; /* for parser */
431 if (option_mask32 & OPT_A) {
432 lines_after = xatoi_u(slines_after);
434 if (option_mask32 & OPT_B) {
435 lines_before = xatoi_u(slines_before);
438 if (option_mask32 & (OPT_c|OPT_q|OPT_l|OPT_L)) {
439 option_mask32 &= ~OPT_n;
442 } else if (lines_before > 0)
443 before_buf = xzalloc(lines_before * sizeof(char *));
445 /* with auto sanity checks */
446 opt_complementary = "H-h:e::f::c-n:q-n:l-n";
447 getopt32(argv, OPTSTR_GREP,
448 &pattern_head, &fopt, &mopt);
450 if (option_mask32 & OPT_m) {
451 max_matches = xatoi_u(mopt);
453 invert_search = ((option_mask32 & OPT_v) != 0); /* 0 | 1 */
455 if (pattern_head != NULL) {
456 /* convert char **argv to grep_list_data_t */
459 for (cur = pattern_head; cur; cur = cur->link)
460 cur->data = new_grep_list_data(cur->data, 0);
462 if (option_mask32 & OPT_f)
463 load_regexes_from_file(fopt);
465 if (ENABLE_FEATURE_GREP_FGREP_ALIAS && applet_name[0] == 'f')
466 option_mask32 |= OPT_F;
468 if (!(option_mask32 & (OPT_o | OPT_w)))
471 if (ENABLE_FEATURE_GREP_EGREP_ALIAS
472 && (applet_name[0] == 'e' || (option_mask32 & OPT_E))
474 reflags |= REG_EXTENDED;
477 if (option_mask32 & OPT_i)
478 reflags |= REG_ICASE;
483 /* if we didn't get a pattern from a -e and no command file was specified,
484 * argv[optind] should be the pattern. no pattern, no worky */
485 if (pattern_head == NULL) {
489 pattern = new_grep_list_data(*argv++, 0);
490 llist_add_to(&pattern_head, pattern);
494 /* argv[(optind)..(argc-1)] should be names of file to grep through. If
495 * there is more than one file to grep, we will print the filenames. */
498 /* -H / -h of course override */
499 if (option_mask32 & OPT_H)
501 if (option_mask32 & OPT_h)
504 /* If no files were specified, or '-' was specified, take input from
505 * stdin. Otherwise, we grep through all the files specified. */
510 if (!cur_file || (*cur_file == '-' && !cur_file[1])) {
511 cur_file = "(standard input)";
513 if (option_mask32 & OPT_r) {
515 if (stat(cur_file, &st) == 0 && S_ISDIR(st.st_mode)) {
516 if (!(option_mask32 & OPT_h))
518 matched += grep_dir(cur_file);
522 /* else: fopen(dir) will succeed, but reading won't */
523 file = fopen(cur_file, "r");
525 if (!SUPPRESS_ERR_MSGS)
526 bb_perror_msg("%s", cur_file);
531 matched += grep_file(file);
532 fclose_if_not_stdin(file);
534 } while (--argc > 0);
536 /* destroy all the elments in the pattern list */
537 if (ENABLE_FEATURE_CLEAN_UP) {
538 while (pattern_head) {
539 llist_t *pattern_head_ptr = pattern_head;
540 grep_list_data_t *gl = (grep_list_data_t *)pattern_head_ptr->data;
542 pattern_head = pattern_head->link;
543 if ((gl->flg_mem_alocated_compiled & PATTERN_MEM_A))
545 if ((gl->flg_mem_alocated_compiled & COMPILED))
546 regfree(&(gl->preg));
548 free(pattern_head_ptr);
551 /* 0 = success, 1 = failed, 2 = error */
554 return !matched; /* invert return value: 0 = success, 1 = failed */