1 // SPDX-License-Identifier: GPL-2.0
3 * trace_events_filter - generic event filtering
5 * Copyright (C) 2009 Tom Zanussi <tzanussi@gmail.com>
8 #include <linux/module.h>
9 #include <linux/ctype.h>
10 #include <linux/mutex.h>
11 #include <linux/perf_event.h>
12 #include <linux/slab.h>
15 #include "trace_output.h"
17 #define DEFAULT_SYS_FILTER_MESSAGE \
18 "### global filter ###\n" \
19 "# Use this to set filters for multiple events.\n" \
20 "# Only events with the given fields will be affected.\n" \
21 "# If no events are modified, an error message will be displayed here"
23 /* Due to token parsing '<=' must be before '<' and '>=' must be before '>' */
38 enum filter_op_ids { OPS };
43 static const char * ops[] = { OPS };
46 * pred functions are OP_LE, OP_LT, OP_GE, OP_GT, and OP_BAND
47 * pred_funcs_##type below must match the order of them above.
49 #define PRED_FUNC_START OP_LE
50 #define PRED_FUNC_MAX (OP_BAND - PRED_FUNC_START)
53 C(NONE, "No error"), \
54 C(INVALID_OP, "Invalid operator"), \
55 C(TOO_MANY_OPEN, "Too many '('"), \
56 C(TOO_MANY_CLOSE, "Too few '('"), \
57 C(MISSING_QUOTE, "Missing matching quote"), \
58 C(OPERAND_TOO_LONG, "Operand too long"), \
59 C(EXPECT_STRING, "Expecting string field"), \
60 C(EXPECT_DIGIT, "Expecting numeric field"), \
61 C(ILLEGAL_FIELD_OP, "Illegal operation for field type"), \
62 C(FIELD_NOT_FOUND, "Field not found"), \
63 C(ILLEGAL_INTVAL, "Illegal integer value"), \
64 C(BAD_SUBSYS_FILTER, "Couldn't find or set field in one of a subsystem's events"), \
65 C(TOO_MANY_PREDS, "Too many terms in predicate expression"), \
66 C(INVALID_FILTER, "Meaningless filter expression"), \
67 C(IP_FIELD_ONLY, "Only 'ip' field is supported for function trace"), \
68 C(INVALID_VALUE, "Invalid value (did you forget quotes)?"), \
69 C(NO_FILTER, "No filter found"),
72 #define C(a, b) FILT_ERR_##a
79 static char *err_text[] = { ERRORS };
81 /* Called after a '!' character but "!=" and "!~" are not "not"s */
82 static bool is_not(const char *str)
93 * prog_entry - a singe entry in the filter program
94 * @target: Index to jump to on a branch (actually one minus the index)
95 * @when_to_branch: The value of the result of the predicate to do a branch
96 * @pred: The predicate to execute.
101 struct filter_pred *pred;
105 * update_preds- assign a program entry a label target
106 * @prog: The program array
107 * @N: The index of the current entry in @prog
108 * @when_to_branch: What to assign a program entry for its branch condition
110 * The program entry at @N has a target that points to the index of a program
111 * entry that can have its target and when_to_branch fields updated.
112 * Update the current program entry denoted by index @N target field to be
113 * that of the updated entry. This will denote the entry to update if
114 * we are processing an "||" after an "&&"
116 static void update_preds(struct prog_entry *prog, int N, int invert)
122 prog[t].when_to_branch = invert;
127 struct filter_parse_error {
132 static void parse_error(struct filter_parse_error *pe, int err, int pos)
135 pe->lasterr_pos = pos;
138 typedef int (*parse_pred_fn)(const char *str, void *data, int pos,
139 struct filter_parse_error *pe,
140 struct filter_pred **pred);
149 * Without going into a formal proof, this explains the method that is used in
150 * parsing the logical expressions.
152 * For example, if we have: "a && !(!b || (c && g)) || d || e && !f"
153 * The first pass will convert it into the following program:
155 * n1: r=a; l1: if (!r) goto l4;
156 * n2: r=b; l2: if (!r) goto l4;
157 * n3: r=c; r=!r; l3: if (r) goto l4;
158 * n4: r=g; r=!r; l4: if (r) goto l5;
159 * n5: r=d; l5: if (r) goto T
160 * n6: r=e; l6: if (!r) goto l7;
161 * n7: r=f; r=!r; l7: if (!r) goto F
165 * To do this, we use a data structure to represent each of the above
166 * predicate and conditions that has:
168 * predicate, when_to_branch, invert, target
170 * The "predicate" will hold the function to determine the result "r".
171 * The "when_to_branch" denotes what "r" should be if a branch is to be taken
172 * "&&" would contain "!r" or (0) and "||" would contain "r" or (1).
173 * The "invert" holds whether the value should be reversed before testing.
174 * The "target" contains the label "l#" to jump to.
176 * A stack is created to hold values when parentheses are used.
178 * To simplify the logic, the labels will start at 0 and not 1.
180 * The possible invert values are 1 and 0. The number of "!"s that are in scope
181 * before the predicate determines the invert value, if the number is odd then
182 * the invert value is 1 and 0 otherwise. This means the invert value only
183 * needs to be toggled when a new "!" is introduced compared to what is stored
184 * on the stack, where parentheses were used.
186 * The top of the stack and "invert" are initialized to zero.
190 * #1 A loop through all the tokens is done:
192 * #2 If the token is an "(", the stack is push, and the current stack value
193 * gets the current invert value, and the loop continues to the next token.
194 * The top of the stack saves the "invert" value to keep track of what
195 * the current inversion is. As "!(a && !b || c)" would require all
196 * predicates being affected separately by the "!" before the parentheses.
197 * And that would end up being equivalent to "(!a || b) && !c"
199 * #3 If the token is an "!", the current "invert" value gets inverted, and
200 * the loop continues. Note, if the next token is a predicate, then
201 * this "invert" value is only valid for the current program entry,
202 * and does not affect other predicates later on.
204 * The only other acceptable token is the predicate string.
206 * #4 A new entry into the program is added saving: the predicate and the
207 * current value of "invert". The target is currently assigned to the
208 * previous program index (this will not be its final value).
210 * #5 We now enter another loop and look at the next token. The only valid
211 * tokens are ")", "&&", "||" or end of the input string "\0".
213 * #6 The invert variable is reset to the current value saved on the top of
216 * #7 The top of the stack holds not only the current invert value, but also
217 * if a "&&" or "||" needs to be processed. Note, the "&&" takes higher
218 * precedence than "||". That is "a && b || c && d" is equivalent to
219 * "(a && b) || (c && d)". Thus the first thing to do is to see if "&&" needs
220 * to be processed. This is the case if an "&&" was the last token. If it was
221 * then we call update_preds(). This takes the program, the current index in
222 * the program, and the current value of "invert". More will be described
223 * below about this function.
225 * #8 If the next token is "&&" then we set a flag in the top of the stack
226 * that denotes that "&&" needs to be processed, break out of this loop
227 * and continue with the outer loop.
229 * #9 Otherwise, if a "||" needs to be processed then update_preds() is called.
230 * This is called with the program, the current index in the program, but
231 * this time with an inverted value of "invert" (that is !invert). This is
232 * because the value taken will become the "when_to_branch" value of the
234 * Note, this is called when the next token is not an "&&". As stated before,
235 * "&&" takes higher precedence, and "||" should not be processed yet if the
236 * next logical operation is "&&".
238 * #10 If the next token is "||" then we set a flag in the top of the stack
239 * that denotes that "||" needs to be processed, break out of this loop
240 * and continue with the outer loop.
242 * #11 If this is the end of the input string "\0" then we break out of both
245 * #12 Otherwise, the next token is ")", where we pop the stack and continue
248 * Now to discuss the update_pred() function, as that is key to the setting up
249 * of the program. Remember the "target" of the program is initialized to the
250 * previous index and not the "l" label. The target holds the index into the
251 * program that gets affected by the operand. Thus if we have something like
252 * "a || b && c", when we process "a" the target will be "-1" (undefined).
253 * When we process "b", its target is "0", which is the index of "a", as that's
254 * the predicate that is affected by "||". But because the next token after "b"
255 * is "&&" we don't call update_preds(). Instead continue to "c". As the
256 * next token after "c" is not "&&" but the end of input, we first process the
257 * "&&" by calling update_preds() for the "&&" then we process the "||" by
258 * callin updates_preds() with the values for processing "||".
260 * What does that mean? What update_preds() does is to first save the "target"
261 * of the program entry indexed by the current program entry's "target"
262 * (remember the "target" is initialized to previous program entry), and then
263 * sets that "target" to the current index which represents the label "l#".
264 * That entry's "when_to_branch" is set to the value passed in (the "invert"
265 * or "!invert"). Then it sets the current program entry's target to the saved
266 * "target" value (the old value of the program that had its "target" updated
269 * Looking back at "a || b && c", we have the following steps:
270 * "a" - prog[0] = { "a", X, -1 } // pred, when_to_branch, target
271 * "||" - flag that we need to process "||"; continue outer loop
272 * "b" - prog[1] = { "b", X, 0 }
273 * "&&" - flag that we need to process "&&"; continue outer loop
274 * (Notice we did not process "||")
275 * "c" - prog[2] = { "c", X, 1 }
276 * update_preds(prog, 2, 0); // invert = 0 as we are processing "&&"
277 * t = prog[2].target; // t = 1
278 * s = prog[t].target; // s = 0
279 * prog[t].target = 2; // Set target to "l2"
280 * prog[t].when_to_branch = 0;
281 * prog[2].target = s;
282 * update_preds(prog, 2, 1); // invert = 1 as we are now processing "||"
283 * t = prog[2].target; // t = 0
284 * s = prog[t].target; // s = -1
285 * prog[t].target = 2; // Set target to "l2"
286 * prog[t].when_to_branch = 1;
287 * prog[2].target = s;
289 * #13 Which brings us to the final step of the first pass, which is to set
290 * the last program entry's when_to_branch and target, which will be
291 * when_to_branch = 0; target = N; ( the label after the program entry after
292 * the last program entry processed above).
294 * If we denote "TRUE" to be the entry after the last program entry processed,
295 * and "FALSE" the program entry after that, we are now done with the first
298 * Making the above "a || b && c" have a progam of:
299 * prog[0] = { "a", 1, 2 }
300 * prog[1] = { "b", 0, 2 }
301 * prog[2] = { "c", 0, 3 }
303 * Which translates into:
304 * n0: r = a; l0: if (r) goto l2;
305 * n1: r = b; l1: if (!r) goto l2;
306 * n2: r = c; l2: if (!r) goto l3; // Which is the same as "goto F;"
307 * T: return TRUE; l3:
310 * Although, after the first pass, the program is correct, it is
311 * inefficient. The simple sample of "a || b && c" could be easily been
313 * n0: r = a; if (r) goto T
314 * n1: r = b; if (!r) goto F
315 * n2: r = c; if (!r) goto F
319 * The First Pass is over the input string. The next too passes are over
320 * the program itself.
324 * Which brings us to the second pass. If a jump to a label has the
325 * same condition as that label, it can instead jump to its target.
326 * The original example of "a && !(!b || (c && g)) || d || e && !f"
327 * where the first pass gives us:
329 * n1: r=a; l1: if (!r) goto l4;
330 * n2: r=b; l2: if (!r) goto l4;
331 * n3: r=c; r=!r; l3: if (r) goto l4;
332 * n4: r=g; r=!r; l4: if (r) goto l5;
333 * n5: r=d; l5: if (r) goto T
334 * n6: r=e; l6: if (!r) goto l7;
335 * n7: r=f; r=!r; l7: if (!r) goto F:
339 * We can see that "l3: if (r) goto l4;" and at l4, we have "if (r) goto l5;".
340 * And "l5: if (r) goto T", we could optimize this by converting l3 and l4
341 * to go directly to T. To accomplish this, we start from the last
342 * entry in the program and work our way back. If the target of the entry
343 * has the same "when_to_branch" then we could use that entry's target.
344 * Doing this, the above would end up as:
346 * n1: r=a; l1: if (!r) goto l4;
347 * n2: r=b; l2: if (!r) goto l4;
348 * n3: r=c; r=!r; l3: if (r) goto T;
349 * n4: r=g; r=!r; l4: if (r) goto T;
350 * n5: r=d; l5: if (r) goto T;
351 * n6: r=e; l6: if (!r) goto F;
352 * n7: r=f; r=!r; l7: if (!r) goto F;
356 * In that same pass, if the "when_to_branch" doesn't match, we can simply
357 * go to the program entry after the label. That is, "l2: if (!r) goto l4;"
358 * where "l4: if (r) goto T;", then we can convert l2 to be:
359 * "l2: if (!r) goto n5;".
361 * This will have the second pass give us:
362 * n1: r=a; l1: if (!r) goto n5;
363 * n2: r=b; l2: if (!r) goto n5;
364 * n3: r=c; r=!r; l3: if (r) goto T;
365 * n4: r=g; r=!r; l4: if (r) goto T;
366 * n5: r=d; l5: if (r) goto T
367 * n6: r=e; l6: if (!r) goto F;
368 * n7: r=f; r=!r; l7: if (!r) goto F
372 * Notice, all the "l#" labels are no longer used, and they can now
377 * For the third pass we deal with the inverts. As they simply just
378 * make the "when_to_branch" get inverted, a simple loop over the
379 * program to that does: "when_to_branch ^= invert;" will do the
380 * job, leaving us with:
381 * n1: r=a; if (!r) goto n5;
382 * n2: r=b; if (!r) goto n5;
383 * n3: r=c: if (!r) goto T;
384 * n4: r=g; if (!r) goto T;
385 * n5: r=d; if (r) goto T
386 * n6: r=e; if (!r) goto F;
387 * n7: r=f; if (r) goto F
391 * As "r = a; if (!r) goto n5;" is obviously the same as
392 * "if (!a) goto n5;" without doing anything we can interperate the
394 * n1: if (!a) goto n5;
395 * n2: if (!b) goto n5;
396 * n3: if (!c) goto T;
397 * n4: if (!g) goto T;
399 * n6: if (!e) goto F;
404 * Since the inverts are discarded at the end, there's no reason to store
405 * them in the program array (and waste memory). A separate array to hold
406 * the inverts is used and freed at the end.
408 static struct prog_entry *
409 predicate_parse(const char *str, int nr_parens, int nr_preds,
410 parse_pred_fn parse_pred, void *data,
411 struct filter_parse_error *pe)
413 struct prog_entry *prog_stack;
414 struct prog_entry *prog;
415 const char *ptr = str;
416 char *inverts = NULL;
425 nr_preds += 2; /* For TRUE and FALSE */
427 op_stack = kmalloc_array(nr_parens, sizeof(*op_stack), GFP_KERNEL);
429 return ERR_PTR(-ENOMEM);
430 prog_stack = kmalloc_array(nr_preds, sizeof(*prog_stack), GFP_KERNEL);
432 parse_error(pe, -ENOMEM, 0);
435 inverts = kmalloc_array(nr_preds, sizeof(*inverts), GFP_KERNEL);
437 parse_error(pe, -ENOMEM, 0);
446 while (*ptr) { /* #1 */
447 const char *next = ptr++;
454 if (top - op_stack > nr_parens)
455 return ERR_PTR(-EINVAL);
466 parse_error(pe, FILT_ERR_TOO_MANY_PREDS, next - str);
470 inverts[N] = invert; /* #4 */
471 prog[N].target = N-1;
473 len = parse_pred(next, data, ptr - str, pe, &prog[N].pred);
494 if (next[1] == next[0]) {
500 parse_error(pe, FILT_ERR_TOO_MANY_PREDS,
505 invert = *top & INVERT;
507 if (*top & PROCESS_AND) { /* #7 */
508 update_preds(prog, N - 1, invert);
509 *top &= ~PROCESS_AND;
511 if (*next == '&') { /* #8 */
515 if (*top & PROCESS_OR) { /* #9 */
516 update_preds(prog, N - 1, !invert);
519 if (*next == '|') { /* #10 */
523 if (!*next) /* #11 */
526 if (top == op_stack) {
529 parse_error(pe, FILT_ERR_TOO_MANY_CLOSE, ptr - str);
536 if (top != op_stack) {
538 parse_error(pe, FILT_ERR_TOO_MANY_OPEN, ptr - str);
545 parse_error(pe, FILT_ERR_NO_FILTER, ptr - str);
549 prog[N].pred = NULL; /* #13 */
550 prog[N].target = 1; /* TRUE */
551 prog[N+1].pred = NULL;
552 prog[N+1].target = 0; /* FALSE */
553 prog[N-1].target = N;
554 prog[N-1].when_to_branch = false;
557 for (i = N-1 ; i--; ) {
558 int target = prog[i].target;
559 if (prog[i].when_to_branch == prog[target].when_to_branch)
560 prog[i].target = prog[target].target;
564 for (i = 0; i < N; i++) {
565 invert = inverts[i] ^ prog[i].when_to_branch;
566 prog[i].when_to_branch = invert;
567 /* Make sure the program always moves forward */
568 if (WARN_ON(prog[i].target <= i)) {
584 #define DEFINE_COMPARISON_PRED(type) \
585 static int filter_pred_LT_##type(struct filter_pred *pred, void *event) \
587 type *addr = (type *)(event + pred->offset); \
588 type val = (type)pred->val; \
589 return *addr < val; \
591 static int filter_pred_LE_##type(struct filter_pred *pred, void *event) \
593 type *addr = (type *)(event + pred->offset); \
594 type val = (type)pred->val; \
595 return *addr <= val; \
597 static int filter_pred_GT_##type(struct filter_pred *pred, void *event) \
599 type *addr = (type *)(event + pred->offset); \
600 type val = (type)pred->val; \
601 return *addr > val; \
603 static int filter_pred_GE_##type(struct filter_pred *pred, void *event) \
605 type *addr = (type *)(event + pred->offset); \
606 type val = (type)pred->val; \
607 return *addr >= val; \
609 static int filter_pred_BAND_##type(struct filter_pred *pred, void *event) \
611 type *addr = (type *)(event + pred->offset); \
612 type val = (type)pred->val; \
613 return !!(*addr & val); \
615 static const filter_pred_fn_t pred_funcs_##type[] = { \
616 filter_pred_LE_##type, \
617 filter_pred_LT_##type, \
618 filter_pred_GE_##type, \
619 filter_pred_GT_##type, \
620 filter_pred_BAND_##type, \
623 #define DEFINE_EQUALITY_PRED(size) \
624 static int filter_pred_##size(struct filter_pred *pred, void *event) \
626 u##size *addr = (u##size *)(event + pred->offset); \
627 u##size val = (u##size)pred->val; \
630 match = (val == *addr) ^ pred->not; \
635 DEFINE_COMPARISON_PRED(s64);
636 DEFINE_COMPARISON_PRED(u64);
637 DEFINE_COMPARISON_PRED(s32);
638 DEFINE_COMPARISON_PRED(u32);
639 DEFINE_COMPARISON_PRED(s16);
640 DEFINE_COMPARISON_PRED(u16);
641 DEFINE_COMPARISON_PRED(s8);
642 DEFINE_COMPARISON_PRED(u8);
644 DEFINE_EQUALITY_PRED(64);
645 DEFINE_EQUALITY_PRED(32);
646 DEFINE_EQUALITY_PRED(16);
647 DEFINE_EQUALITY_PRED(8);
649 /* Filter predicate for fixed sized arrays of characters */
650 static int filter_pred_string(struct filter_pred *pred, void *event)
652 char *addr = (char *)(event + pred->offset);
655 cmp = pred->regex.match(addr, &pred->regex, pred->regex.field_len);
657 match = cmp ^ pred->not;
662 /* Filter predicate for char * pointers */
663 static int filter_pred_pchar(struct filter_pred *pred, void *event)
665 char **addr = (char **)(event + pred->offset);
667 int len = strlen(*addr) + 1; /* including tailing '\0' */
669 cmp = pred->regex.match(*addr, &pred->regex, len);
671 match = cmp ^ pred->not;
677 * Filter predicate for dynamic sized arrays of characters.
678 * These are implemented through a list of strings at the end
680 * Also each of these strings have a field in the entry which
681 * contains its offset from the beginning of the entry.
682 * We have then first to get this field, dereference it
683 * and add it to the address of the entry, and at last we have
684 * the address of the string.
686 static int filter_pred_strloc(struct filter_pred *pred, void *event)
688 u32 str_item = *(u32 *)(event + pred->offset);
689 int str_loc = str_item & 0xffff;
690 int str_len = str_item >> 16;
691 char *addr = (char *)(event + str_loc);
694 cmp = pred->regex.match(addr, &pred->regex, str_len);
696 match = cmp ^ pred->not;
701 /* Filter predicate for CPUs. */
702 static int filter_pred_cpu(struct filter_pred *pred, void *event)
706 cpu = raw_smp_processor_id();
727 /* Filter predicate for COMM. */
728 static int filter_pred_comm(struct filter_pred *pred, void *event)
732 cmp = pred->regex.match(current->comm, &pred->regex,
734 return cmp ^ pred->not;
737 static int filter_pred_none(struct filter_pred *pred, void *event)
743 * regex_match_foo - Basic regex callbacks
745 * @str: the string to be searched
746 * @r: the regex structure containing the pattern string
747 * @len: the length of the string to be searched (including '\0')
750 * - @str might not be NULL-terminated if it's of type DYN_STRING
751 * or STATIC_STRING, unless @len is zero.
754 static int regex_match_full(char *str, struct regex *r, int len)
756 /* len of zero means str is dynamic and ends with '\0' */
758 return strcmp(str, r->pattern) == 0;
760 return strncmp(str, r->pattern, len) == 0;
763 static int regex_match_front(char *str, struct regex *r, int len)
765 if (len && len < r->len)
768 return strncmp(str, r->pattern, r->len) == 0;
771 static int regex_match_middle(char *str, struct regex *r, int len)
774 return strstr(str, r->pattern) != NULL;
776 return strnstr(str, r->pattern, len) != NULL;
779 static int regex_match_end(char *str, struct regex *r, int len)
781 int strlen = len - 1;
783 if (strlen >= r->len &&
784 memcmp(str + strlen - r->len, r->pattern, r->len) == 0)
789 static int regex_match_glob(char *str, struct regex *r, int len __maybe_unused)
791 if (glob_match(r->pattern, str))
797 * filter_parse_regex - parse a basic regex
798 * @buff: the raw regex
799 * @len: length of the regex
800 * @search: will point to the beginning of the string to compare
801 * @not: tell whether the match will have to be inverted
803 * This passes in a buffer containing a regex and this function will
804 * set search to point to the search part of the buffer and
805 * return the type of search it is (see enum above).
806 * This does modify buff.
809 * search returns the pointer to use for comparison.
810 * not returns 1 if buff started with a '!'
813 enum regex_type filter_parse_regex(char *buff, int len, char **search, int *not)
815 int type = MATCH_FULL;
818 if (buff[0] == '!') {
827 for (i = 0; i < len; i++) {
828 if (buff[i] == '*') {
830 type = MATCH_END_ONLY;
831 } else if (i == len - 1) {
832 if (type == MATCH_END_ONLY)
833 type = MATCH_MIDDLE_ONLY;
835 type = MATCH_FRONT_ONLY;
838 } else { /* pattern continues, use full glob */
841 } else if (strchr("[?\\", buff[i])) {
851 static void filter_build_regex(struct filter_pred *pred)
853 struct regex *r = &pred->regex;
855 enum regex_type type = MATCH_FULL;
857 if (pred->op == OP_GLOB) {
858 type = filter_parse_regex(r->pattern, r->len, &search, &pred->not);
859 r->len = strlen(search);
860 memmove(r->pattern, search, r->len+1);
865 r->match = regex_match_full;
867 case MATCH_FRONT_ONLY:
868 r->match = regex_match_front;
870 case MATCH_MIDDLE_ONLY:
871 r->match = regex_match_middle;
874 r->match = regex_match_end;
877 r->match = regex_match_glob;
882 /* return 1 if event matches, 0 otherwise (discard) */
883 int filter_match_preds(struct event_filter *filter, void *rec)
885 struct prog_entry *prog;
888 /* no filter is considered a match */
892 /* Protected by either SRCU(tracepoint_srcu) or preempt_disable */
893 prog = rcu_dereference_raw(filter->prog);
897 for (i = 0; prog[i].pred; i++) {
898 struct filter_pred *pred = prog[i].pred;
899 int match = pred->fn(pred, rec);
900 if (match == prog[i].when_to_branch)
903 return prog[i].target;
905 EXPORT_SYMBOL_GPL(filter_match_preds);
907 static void remove_filter_string(struct event_filter *filter)
912 kfree(filter->filter_string);
913 filter->filter_string = NULL;
916 static void append_filter_err(struct filter_parse_error *pe,
917 struct event_filter *filter)
920 int pos = pe->lasterr_pos;
924 if (WARN_ON(!filter->filter_string))
927 s = kmalloc(sizeof(*s), GFP_KERNEL);
932 len = strlen(filter->filter_string);
936 /* indexing is off by one */
940 trace_seq_puts(s, filter->filter_string);
941 if (pe->lasterr > 0) {
942 trace_seq_printf(s, "\n%*s", pos, "^");
943 trace_seq_printf(s, "\nparse_error: %s\n", err_text[pe->lasterr]);
945 trace_seq_printf(s, "\nError: (%d)\n", pe->lasterr);
947 trace_seq_putc(s, 0);
948 buf = kmemdup_nul(s->buffer, s->seq.len, GFP_KERNEL);
950 kfree(filter->filter_string);
951 filter->filter_string = buf;
956 static inline struct event_filter *event_filter(struct trace_event_file *file)
961 /* caller must hold event_mutex */
962 void print_event_filter(struct trace_event_file *file, struct trace_seq *s)
964 struct event_filter *filter = event_filter(file);
966 if (filter && filter->filter_string)
967 trace_seq_printf(s, "%s\n", filter->filter_string);
969 trace_seq_puts(s, "none\n");
972 void print_subsystem_event_filter(struct event_subsystem *system,
975 struct event_filter *filter;
977 mutex_lock(&event_mutex);
978 filter = system->filter;
979 if (filter && filter->filter_string)
980 trace_seq_printf(s, "%s\n", filter->filter_string);
982 trace_seq_puts(s, DEFAULT_SYS_FILTER_MESSAGE "\n");
983 mutex_unlock(&event_mutex);
986 static void free_prog(struct event_filter *filter)
988 struct prog_entry *prog;
991 prog = rcu_access_pointer(filter->prog);
995 for (i = 0; prog[i].pred; i++)
1000 static void filter_disable(struct trace_event_file *file)
1002 unsigned long old_flags = file->flags;
1004 file->flags &= ~EVENT_FILE_FL_FILTERED;
1006 if (old_flags != file->flags)
1007 trace_buffered_event_disable();
1010 static void __free_filter(struct event_filter *filter)
1016 kfree(filter->filter_string);
1020 void free_event_filter(struct event_filter *filter)
1022 __free_filter(filter);
1025 static inline void __remove_filter(struct trace_event_file *file)
1027 filter_disable(file);
1028 remove_filter_string(file->filter);
1031 static void filter_free_subsystem_preds(struct trace_subsystem_dir *dir,
1032 struct trace_array *tr)
1034 struct trace_event_file *file;
1036 list_for_each_entry(file, &tr->events, list) {
1037 if (file->system != dir)
1039 __remove_filter(file);
1043 static inline void __free_subsystem_filter(struct trace_event_file *file)
1045 __free_filter(file->filter);
1046 file->filter = NULL;
1049 static void filter_free_subsystem_filters(struct trace_subsystem_dir *dir,
1050 struct trace_array *tr)
1052 struct trace_event_file *file;
1054 list_for_each_entry(file, &tr->events, list) {
1055 if (file->system != dir)
1057 __free_subsystem_filter(file);
1061 int filter_assign_type(const char *type)
1063 if (strstr(type, "__data_loc") && strstr(type, "char"))
1064 return FILTER_DYN_STRING;
1066 if (strchr(type, '[') && strstr(type, "char"))
1067 return FILTER_STATIC_STRING;
1069 return FILTER_OTHER;
1072 static filter_pred_fn_t select_comparison_fn(enum filter_op_ids op,
1073 int field_size, int field_is_signed)
1075 filter_pred_fn_t fn = NULL;
1076 int pred_func_index = -1;
1083 if (WARN_ON_ONCE(op < PRED_FUNC_START))
1085 pred_func_index = op - PRED_FUNC_START;
1086 if (WARN_ON_ONCE(pred_func_index > PRED_FUNC_MAX))
1090 switch (field_size) {
1092 if (pred_func_index < 0)
1093 fn = filter_pred_64;
1094 else if (field_is_signed)
1095 fn = pred_funcs_s64[pred_func_index];
1097 fn = pred_funcs_u64[pred_func_index];
1100 if (pred_func_index < 0)
1101 fn = filter_pred_32;
1102 else if (field_is_signed)
1103 fn = pred_funcs_s32[pred_func_index];
1105 fn = pred_funcs_u32[pred_func_index];
1108 if (pred_func_index < 0)
1109 fn = filter_pred_16;
1110 else if (field_is_signed)
1111 fn = pred_funcs_s16[pred_func_index];
1113 fn = pred_funcs_u16[pred_func_index];
1116 if (pred_func_index < 0)
1118 else if (field_is_signed)
1119 fn = pred_funcs_s8[pred_func_index];
1121 fn = pred_funcs_u8[pred_func_index];
1128 /* Called when a predicate is encountered by predicate_parse() */
1129 static int parse_pred(const char *str, void *data,
1130 int pos, struct filter_parse_error *pe,
1131 struct filter_pred **pred_ptr)
1133 struct trace_event_call *call = data;
1134 struct ftrace_event_field *field;
1135 struct filter_pred *pred = NULL;
1136 char num_buf[24]; /* Big enough to hold an address */
1146 /* First find the field to associate to */
1147 while (isspace(str[i]))
1151 while (isalnum(str[i]) || str[i] == '_')
1159 field_name = kmemdup_nul(str + s, len, GFP_KERNEL);
1163 /* Make sure that the field exists */
1165 field = trace_find_event_field(call, field_name);
1168 parse_error(pe, FILT_ERR_FIELD_NOT_FOUND, pos + i);
1172 while (isspace(str[i]))
1175 /* Make sure this op is supported */
1176 for (op = 0; ops[op]; op++) {
1177 /* This is why '<=' must come before '<' in ops[] */
1178 if (strncmp(str + i, ops[op], strlen(ops[op])) == 0)
1183 parse_error(pe, FILT_ERR_INVALID_OP, pos + i);
1187 i += strlen(ops[op]);
1189 while (isspace(str[i]))
1194 pred = kzalloc(sizeof(*pred), GFP_KERNEL);
1198 pred->field = field;
1199 pred->offset = field->offset;
1202 if (ftrace_event_is_function(call)) {
1204 * Perf does things different with function events.
1205 * It only allows an "ip" field, and expects a string.
1206 * But the string does not need to be surrounded by quotes.
1207 * If it is a string, the assigned function as a nop,
1208 * (perf doesn't use it) and grab everything.
1210 if (strcmp(field->name, "ip") != 0) {
1211 parse_error(pe, FILT_ERR_IP_FIELD_ONLY, pos + i);
1214 pred->fn = filter_pred_none;
1217 * Quotes are not required, but if they exist then we need
1218 * to read them till we hit a matching one.
1220 if (str[i] == '\'' || str[i] == '"')
1225 for (i++; str[i]; i++) {
1226 if (q && str[i] == q)
1228 if (!q && (str[i] == ')' || str[i] == '&' ||
1236 if (len >= MAX_FILTER_STR_VAL) {
1237 parse_error(pe, FILT_ERR_OPERAND_TOO_LONG, pos + i);
1241 pred->regex.len = len;
1242 strncpy(pred->regex.pattern, str + s, len);
1243 pred->regex.pattern[len] = 0;
1245 /* This is either a string, or an integer */
1246 } else if (str[i] == '\'' || str[i] == '"') {
1249 /* Make sure the op is OK for strings */
1258 parse_error(pe, FILT_ERR_ILLEGAL_FIELD_OP, pos + i);
1262 /* Make sure the field is OK for strings */
1263 if (!is_string_field(field)) {
1264 parse_error(pe, FILT_ERR_EXPECT_DIGIT, pos + i);
1268 for (i++; str[i]; i++) {
1273 parse_error(pe, FILT_ERR_MISSING_QUOTE, pos + i);
1280 if (len >= MAX_FILTER_STR_VAL) {
1281 parse_error(pe, FILT_ERR_OPERAND_TOO_LONG, pos + i);
1285 pred->regex.len = len;
1286 strncpy(pred->regex.pattern, str + s, len);
1287 pred->regex.pattern[len] = 0;
1289 filter_build_regex(pred);
1291 if (field->filter_type == FILTER_COMM) {
1292 pred->fn = filter_pred_comm;
1294 } else if (field->filter_type == FILTER_STATIC_STRING) {
1295 pred->fn = filter_pred_string;
1296 pred->regex.field_len = field->size;
1298 } else if (field->filter_type == FILTER_DYN_STRING)
1299 pred->fn = filter_pred_strloc;
1301 pred->fn = filter_pred_pchar;
1302 /* go past the last quote */
1305 } else if (isdigit(str[i])) {
1307 /* Make sure the field is not a string */
1308 if (is_string_field(field)) {
1309 parse_error(pe, FILT_ERR_EXPECT_STRING, pos + i);
1313 if (op == OP_GLOB) {
1314 parse_error(pe, FILT_ERR_ILLEGAL_FIELD_OP, pos + i);
1318 /* We allow 0xDEADBEEF */
1319 while (isalnum(str[i]))
1323 /* 0xfeedfacedeadbeef is 18 chars max */
1324 if (len >= sizeof(num_buf)) {
1325 parse_error(pe, FILT_ERR_OPERAND_TOO_LONG, pos + i);
1329 strncpy(num_buf, str + s, len);
1332 /* Make sure it is a value */
1333 if (field->is_signed)
1334 ret = kstrtoll(num_buf, 0, &val);
1336 ret = kstrtoull(num_buf, 0, &val);
1338 parse_error(pe, FILT_ERR_ILLEGAL_INTVAL, pos + s);
1344 if (field->filter_type == FILTER_CPU)
1345 pred->fn = filter_pred_cpu;
1347 pred->fn = select_comparison_fn(pred->op, field->size,
1349 if (pred->op == OP_NE)
1354 parse_error(pe, FILT_ERR_INVALID_VALUE, pos + i);
1367 TOO_MANY_CLOSE = -1,
1373 * Read the filter string once to calculate the number of predicates
1374 * as well as how deep the parentheses go.
1377 * 0 - everything is fine (err is undefined)
1380 * -3 - No matching quote
1382 static int calc_stack(const char *str, int *parens, int *preds, int *err)
1384 bool is_pred = false;
1386 int open = 1; /* Count the expression as "(E)" */
1394 for (i = 0; str[i]; i++) {
1395 if (isspace(str[i]))
1398 if (str[i] == quote)
1411 if (str[i+1] != str[i])
1418 if (open > max_open)
1425 return TOO_MANY_CLOSE;
1438 return MISSING_QUOTE;
1444 /* find the bad open */
1447 if (str[i] == quote)
1453 if (level == open) {
1455 return TOO_MANY_OPEN;
1468 /* First character is the '(' with missing ')' */
1470 return TOO_MANY_OPEN;
1473 /* Set the size of the required stacks */
1479 static int process_preds(struct trace_event_call *call,
1480 const char *filter_string,
1481 struct event_filter *filter,
1482 struct filter_parse_error *pe)
1484 struct prog_entry *prog;
1490 ret = calc_stack(filter_string, &nr_parens, &nr_preds, &index);
1494 parse_error(pe, FILT_ERR_MISSING_QUOTE, index);
1497 parse_error(pe, FILT_ERR_TOO_MANY_OPEN, index);
1500 parse_error(pe, FILT_ERR_TOO_MANY_CLOSE, index);
1508 prog = predicate_parse(filter_string, nr_parens, nr_preds,
1509 parse_pred, call, pe);
1511 return PTR_ERR(prog);
1513 rcu_assign_pointer(filter->prog, prog);
1517 static inline void event_set_filtered_flag(struct trace_event_file *file)
1519 unsigned long old_flags = file->flags;
1521 file->flags |= EVENT_FILE_FL_FILTERED;
1523 if (old_flags != file->flags)
1524 trace_buffered_event_enable();
1527 static inline void event_set_filter(struct trace_event_file *file,
1528 struct event_filter *filter)
1530 rcu_assign_pointer(file->filter, filter);
1533 static inline void event_clear_filter(struct trace_event_file *file)
1535 RCU_INIT_POINTER(file->filter, NULL);
1539 event_set_no_set_filter_flag(struct trace_event_file *file)
1541 file->flags |= EVENT_FILE_FL_NO_SET_FILTER;
1545 event_clear_no_set_filter_flag(struct trace_event_file *file)
1547 file->flags &= ~EVENT_FILE_FL_NO_SET_FILTER;
1551 event_no_set_filter_flag(struct trace_event_file *file)
1553 if (file->flags & EVENT_FILE_FL_NO_SET_FILTER)
1559 struct filter_list {
1560 struct list_head list;
1561 struct event_filter *filter;
1564 static int process_system_preds(struct trace_subsystem_dir *dir,
1565 struct trace_array *tr,
1566 struct filter_parse_error *pe,
1567 char *filter_string)
1569 struct trace_event_file *file;
1570 struct filter_list *filter_item;
1571 struct event_filter *filter = NULL;
1572 struct filter_list *tmp;
1573 LIST_HEAD(filter_list);
1577 list_for_each_entry(file, &tr->events, list) {
1579 if (file->system != dir)
1582 filter = kzalloc(sizeof(*filter), GFP_KERNEL);
1586 filter->filter_string = kstrdup(filter_string, GFP_KERNEL);
1587 if (!filter->filter_string)
1590 err = process_preds(file->event_call, filter_string, filter, pe);
1592 filter_disable(file);
1593 parse_error(pe, FILT_ERR_BAD_SUBSYS_FILTER, 0);
1594 append_filter_err(pe, filter);
1596 event_set_filtered_flag(file);
1599 filter_item = kzalloc(sizeof(*filter_item), GFP_KERNEL);
1603 list_add_tail(&filter_item->list, &filter_list);
1605 * Regardless of if this returned an error, we still
1606 * replace the filter for the call.
1608 filter_item->filter = event_filter(file);
1609 event_set_filter(file, filter);
1619 * The calls can still be using the old filters.
1620 * Do a synchronize_rcu() and to ensure all calls are
1621 * done with them before we free them.
1623 tracepoint_synchronize_unregister();
1624 list_for_each_entry_safe(filter_item, tmp, &filter_list, list) {
1625 __free_filter(filter_item->filter);
1626 list_del(&filter_item->list);
1631 /* No call succeeded */
1632 list_for_each_entry_safe(filter_item, tmp, &filter_list, list) {
1633 list_del(&filter_item->list);
1636 parse_error(pe, FILT_ERR_BAD_SUBSYS_FILTER, 0);
1640 /* If any call succeeded, we still need to sync */
1642 tracepoint_synchronize_unregister();
1643 list_for_each_entry_safe(filter_item, tmp, &filter_list, list) {
1644 __free_filter(filter_item->filter);
1645 list_del(&filter_item->list);
1651 static int create_filter_start(char *filter_string, bool set_str,
1652 struct filter_parse_error **pse,
1653 struct event_filter **filterp)
1655 struct event_filter *filter;
1656 struct filter_parse_error *pe = NULL;
1659 if (WARN_ON_ONCE(*pse || *filterp))
1662 filter = kzalloc(sizeof(*filter), GFP_KERNEL);
1663 if (filter && set_str) {
1664 filter->filter_string = kstrdup(filter_string, GFP_KERNEL);
1665 if (!filter->filter_string)
1669 pe = kzalloc(sizeof(*pe), GFP_KERNEL);
1671 if (!filter || !pe || err) {
1673 __free_filter(filter);
1677 /* we're committed to creating a new filter */
1684 static void create_filter_finish(struct filter_parse_error *pe)
1690 * create_filter - create a filter for a trace_event_call
1691 * @call: trace_event_call to create a filter for
1692 * @filter_str: filter string
1693 * @set_str: remember @filter_str and enable detailed error in filter
1694 * @filterp: out param for created filter (always updated on return)
1695 * Must be a pointer that references a NULL pointer.
1697 * Creates a filter for @call with @filter_str. If @set_str is %true,
1698 * @filter_str is copied and recorded in the new filter.
1700 * On success, returns 0 and *@filterp points to the new filter. On
1701 * failure, returns -errno and *@filterp may point to %NULL or to a new
1702 * filter. In the latter case, the returned filter contains error
1703 * information if @set_str is %true and the caller is responsible for
1706 static int create_filter(struct trace_event_call *call,
1707 char *filter_string, bool set_str,
1708 struct event_filter **filterp)
1710 struct filter_parse_error *pe = NULL;
1713 /* filterp must point to NULL */
1714 if (WARN_ON(*filterp))
1717 err = create_filter_start(filter_string, set_str, &pe, filterp);
1721 err = process_preds(call, filter_string, *filterp, pe);
1723 append_filter_err(pe, *filterp);
1724 create_filter_finish(pe);
1729 int create_event_filter(struct trace_event_call *call,
1730 char *filter_str, bool set_str,
1731 struct event_filter **filterp)
1733 return create_filter(call, filter_str, set_str, filterp);
1737 * create_system_filter - create a filter for an event_subsystem
1738 * @system: event_subsystem to create a filter for
1739 * @filter_str: filter string
1740 * @filterp: out param for created filter (always updated on return)
1742 * Identical to create_filter() except that it creates a subsystem filter
1743 * and always remembers @filter_str.
1745 static int create_system_filter(struct trace_subsystem_dir *dir,
1746 struct trace_array *tr,
1747 char *filter_str, struct event_filter **filterp)
1749 struct filter_parse_error *pe = NULL;
1752 err = create_filter_start(filter_str, true, &pe, filterp);
1754 err = process_system_preds(dir, tr, pe, filter_str);
1756 /* System filters just show a default message */
1757 kfree((*filterp)->filter_string);
1758 (*filterp)->filter_string = NULL;
1760 append_filter_err(pe, *filterp);
1763 create_filter_finish(pe);
1768 /* caller must hold event_mutex */
1769 int apply_event_filter(struct trace_event_file *file, char *filter_string)
1771 struct trace_event_call *call = file->event_call;
1772 struct event_filter *filter = NULL;
1775 if (!strcmp(strstrip(filter_string), "0")) {
1776 filter_disable(file);
1777 filter = event_filter(file);
1782 event_clear_filter(file);
1784 /* Make sure the filter is not being used */
1785 tracepoint_synchronize_unregister();
1786 __free_filter(filter);
1791 err = create_filter(call, filter_string, true, &filter);
1794 * Always swap the call filter with the new filter
1795 * even if there was an error. If there was an error
1796 * in the filter, we disable the filter and show the error
1800 struct event_filter *tmp;
1802 tmp = event_filter(file);
1804 event_set_filtered_flag(file);
1806 filter_disable(file);
1808 event_set_filter(file, filter);
1811 /* Make sure the call is done with the filter */
1812 tracepoint_synchronize_unregister();
1820 int apply_subsystem_event_filter(struct trace_subsystem_dir *dir,
1821 char *filter_string)
1823 struct event_subsystem *system = dir->subsystem;
1824 struct trace_array *tr = dir->tr;
1825 struct event_filter *filter = NULL;
1828 mutex_lock(&event_mutex);
1830 /* Make sure the system still has events */
1831 if (!dir->nr_events) {
1836 if (!strcmp(strstrip(filter_string), "0")) {
1837 filter_free_subsystem_preds(dir, tr);
1838 remove_filter_string(system->filter);
1839 filter = system->filter;
1840 system->filter = NULL;
1841 /* Ensure all filters are no longer used */
1842 tracepoint_synchronize_unregister();
1843 filter_free_subsystem_filters(dir, tr);
1844 __free_filter(filter);
1848 err = create_system_filter(dir, tr, filter_string, &filter);
1851 * No event actually uses the system filter
1852 * we can free it without synchronize_rcu().
1854 __free_filter(system->filter);
1855 system->filter = filter;
1858 mutex_unlock(&event_mutex);
1863 #ifdef CONFIG_PERF_EVENTS
1865 void ftrace_profile_free_filter(struct perf_event *event)
1867 struct event_filter *filter = event->filter;
1869 event->filter = NULL;
1870 __free_filter(filter);
1873 struct function_filter_data {
1874 struct ftrace_ops *ops;
1879 #ifdef CONFIG_FUNCTION_TRACER
1881 ftrace_function_filter_re(char *buf, int len, int *count)
1885 str = kstrndup(buf, len, GFP_KERNEL);
1890 * The argv_split function takes white space
1891 * as a separator, so convert ',' into spaces.
1893 strreplace(str, ',', ' ');
1895 re = argv_split(GFP_KERNEL, str, count);
1900 static int ftrace_function_set_regexp(struct ftrace_ops *ops, int filter,
1901 int reset, char *re, int len)
1906 ret = ftrace_set_filter(ops, re, len, reset);
1908 ret = ftrace_set_notrace(ops, re, len, reset);
1913 static int __ftrace_function_set_filter(int filter, char *buf, int len,
1914 struct function_filter_data *data)
1916 int i, re_cnt, ret = -EINVAL;
1920 reset = filter ? &data->first_filter : &data->first_notrace;
1923 * The 'ip' field could have multiple filters set, separated
1924 * either by space or comma. We first cut the filter and apply
1925 * all pieces separatelly.
1927 re = ftrace_function_filter_re(buf, len, &re_cnt);
1931 for (i = 0; i < re_cnt; i++) {
1932 ret = ftrace_function_set_regexp(data->ops, filter, *reset,
1933 re[i], strlen(re[i]));
1945 static int ftrace_function_check_pred(struct filter_pred *pred)
1947 struct ftrace_event_field *field = pred->field;
1950 * Check the predicate for function trace, verify:
1951 * - only '==' and '!=' is used
1952 * - the 'ip' field is used
1954 if ((pred->op != OP_EQ) && (pred->op != OP_NE))
1957 if (strcmp(field->name, "ip"))
1963 static int ftrace_function_set_filter_pred(struct filter_pred *pred,
1964 struct function_filter_data *data)
1968 /* Checking the node is valid for function trace. */
1969 ret = ftrace_function_check_pred(pred);
1973 return __ftrace_function_set_filter(pred->op == OP_EQ,
1974 pred->regex.pattern,
1979 static bool is_or(struct prog_entry *prog, int i)
1984 * Only "||" is allowed for function events, thus,
1985 * all true branches should jump to true, and any
1986 * false branch should jump to false.
1988 target = prog[i].target + 1;
1989 /* True and false have NULL preds (all prog entries should jump to one */
1990 if (prog[target].pred)
1993 /* prog[target].target is 1 for TRUE, 0 for FALSE */
1994 return prog[i].when_to_branch == prog[target].target;
1997 static int ftrace_function_set_filter(struct perf_event *event,
1998 struct event_filter *filter)
2000 struct prog_entry *prog = rcu_dereference_protected(filter->prog,
2001 lockdep_is_held(&event_mutex));
2002 struct function_filter_data data = {
2005 .ops = &event->ftrace_ops,
2009 for (i = 0; prog[i].pred; i++) {
2010 struct filter_pred *pred = prog[i].pred;
2012 if (!is_or(prog, i))
2015 if (ftrace_function_set_filter_pred(pred, &data) < 0)
2021 static int ftrace_function_set_filter(struct perf_event *event,
2022 struct event_filter *filter)
2026 #endif /* CONFIG_FUNCTION_TRACER */
2028 int ftrace_profile_set_filter(struct perf_event *event, int event_id,
2032 struct event_filter *filter = NULL;
2033 struct trace_event_call *call;
2035 mutex_lock(&event_mutex);
2037 call = event->tp_event;
2047 err = create_filter(call, filter_str, false, &filter);
2051 if (ftrace_event_is_function(call))
2052 err = ftrace_function_set_filter(event, filter);
2054 event->filter = filter;
2057 if (err || ftrace_event_is_function(call))
2058 __free_filter(filter);
2061 mutex_unlock(&event_mutex);
2066 #endif /* CONFIG_PERF_EVENTS */
2068 #ifdef CONFIG_FTRACE_STARTUP_TEST
2070 #include <linux/types.h>
2071 #include <linux/tracepoint.h>
2073 #define CREATE_TRACE_POINTS
2074 #include "trace_events_filter_test.h"
2076 #define DATA_REC(m, va, vb, vc, vd, ve, vf, vg, vh, nvisit) \
2079 .rec = { .a = va, .b = vb, .c = vc, .d = vd, \
2080 .e = ve, .f = vf, .g = vg, .h = vh }, \
2082 .not_visited = nvisit, \
2087 static struct test_filter_data_t {
2089 struct trace_event_raw_ftrace_test_filter rec;
2092 } test_filter_data[] = {
2093 #define FILTER "a == 1 && b == 1 && c == 1 && d == 1 && " \
2094 "e == 1 && f == 1 && g == 1 && h == 1"
2095 DATA_REC(YES, 1, 1, 1, 1, 1, 1, 1, 1, ""),
2096 DATA_REC(NO, 0, 1, 1, 1, 1, 1, 1, 1, "bcdefgh"),
2097 DATA_REC(NO, 1, 1, 1, 1, 1, 1, 1, 0, ""),
2099 #define FILTER "a == 1 || b == 1 || c == 1 || d == 1 || " \
2100 "e == 1 || f == 1 || g == 1 || h == 1"
2101 DATA_REC(NO, 0, 0, 0, 0, 0, 0, 0, 0, ""),
2102 DATA_REC(YES, 0, 0, 0, 0, 0, 0, 0, 1, ""),
2103 DATA_REC(YES, 1, 0, 0, 0, 0, 0, 0, 0, "bcdefgh"),
2105 #define FILTER "(a == 1 || b == 1) && (c == 1 || d == 1) && " \
2106 "(e == 1 || f == 1) && (g == 1 || h == 1)"
2107 DATA_REC(NO, 0, 0, 1, 1, 1, 1, 1, 1, "dfh"),
2108 DATA_REC(YES, 0, 1, 0, 1, 0, 1, 0, 1, ""),
2109 DATA_REC(YES, 1, 0, 1, 0, 0, 1, 0, 1, "bd"),
2110 DATA_REC(NO, 1, 0, 1, 0, 0, 1, 0, 0, "bd"),
2112 #define FILTER "(a == 1 && b == 1) || (c == 1 && d == 1) || " \
2113 "(e == 1 && f == 1) || (g == 1 && h == 1)"
2114 DATA_REC(YES, 1, 0, 1, 1, 1, 1, 1, 1, "efgh"),
2115 DATA_REC(YES, 0, 0, 0, 0, 0, 0, 1, 1, ""),
2116 DATA_REC(NO, 0, 0, 0, 0, 0, 0, 0, 1, ""),
2118 #define FILTER "(a == 1 && b == 1) && (c == 1 && d == 1) && " \
2119 "(e == 1 && f == 1) || (g == 1 && h == 1)"
2120 DATA_REC(YES, 1, 1, 1, 1, 1, 1, 0, 0, "gh"),
2121 DATA_REC(NO, 0, 0, 0, 0, 0, 0, 0, 1, ""),
2122 DATA_REC(YES, 1, 1, 1, 1, 1, 0, 1, 1, ""),
2124 #define FILTER "((a == 1 || b == 1) || (c == 1 || d == 1) || " \
2125 "(e == 1 || f == 1)) && (g == 1 || h == 1)"
2126 DATA_REC(YES, 1, 1, 1, 1, 1, 1, 0, 1, "bcdef"),
2127 DATA_REC(NO, 0, 0, 0, 0, 0, 0, 0, 0, ""),
2128 DATA_REC(YES, 1, 1, 1, 1, 1, 0, 1, 1, "h"),
2130 #define FILTER "((((((((a == 1) && (b == 1)) || (c == 1)) && (d == 1)) || " \
2131 "(e == 1)) && (f == 1)) || (g == 1)) && (h == 1))"
2132 DATA_REC(YES, 1, 1, 1, 1, 1, 1, 1, 1, "ceg"),
2133 DATA_REC(NO, 0, 1, 0, 1, 0, 1, 0, 1, ""),
2134 DATA_REC(NO, 1, 0, 1, 0, 1, 0, 1, 0, ""),
2136 #define FILTER "((((((((a == 1) || (b == 1)) && (c == 1)) || (d == 1)) && " \
2137 "(e == 1)) || (f == 1)) && (g == 1)) || (h == 1))"
2138 DATA_REC(YES, 1, 1, 1, 1, 1, 1, 1, 1, "bdfh"),
2139 DATA_REC(YES, 0, 1, 0, 1, 0, 1, 0, 1, ""),
2140 DATA_REC(YES, 1, 0, 1, 0, 1, 0, 1, 0, "bdfh"),
2148 #define DATA_CNT ARRAY_SIZE(test_filter_data)
2150 static int test_pred_visited;
2152 static int test_pred_visited_fn(struct filter_pred *pred, void *event)
2154 struct ftrace_event_field *field = pred->field;
2156 test_pred_visited = 1;
2157 printk(KERN_INFO "\npred visited %s\n", field->name);
2161 static void update_pred_fn(struct event_filter *filter, char *fields)
2163 struct prog_entry *prog = rcu_dereference_protected(filter->prog,
2164 lockdep_is_held(&event_mutex));
2167 for (i = 0; prog[i].pred; i++) {
2168 struct filter_pred *pred = prog[i].pred;
2169 struct ftrace_event_field *field = pred->field;
2171 WARN_ON_ONCE(!pred->fn);
2174 WARN_ONCE(1, "all leafs should have field defined %d", i);
2178 if (!strchr(fields, *field->name))
2181 pred->fn = test_pred_visited_fn;
2185 static __init int ftrace_test_event_filter(void)
2189 printk(KERN_INFO "Testing ftrace filter: ");
2191 for (i = 0; i < DATA_CNT; i++) {
2192 struct event_filter *filter = NULL;
2193 struct test_filter_data_t *d = &test_filter_data[i];
2196 err = create_filter(&event_ftrace_test_filter, d->filter,
2200 "Failed to get filter for '%s', err %d\n",
2202 __free_filter(filter);
2206 /* Needed to dereference filter->prog */
2207 mutex_lock(&event_mutex);
2209 * The preemption disabling is not really needed for self
2210 * tests, but the rcu dereference will complain without it.
2213 if (*d->not_visited)
2214 update_pred_fn(filter, d->not_visited);
2216 test_pred_visited = 0;
2217 err = filter_match_preds(filter, &d->rec);
2220 mutex_unlock(&event_mutex);
2222 __free_filter(filter);
2224 if (test_pred_visited) {
2226 "Failed, unwanted pred visited for filter %s\n",
2231 if (err != d->match) {
2233 "Failed to match filter '%s', expected %d\n",
2234 d->filter, d->match);
2240 printk(KERN_CONT "OK\n");
2245 late_initcall(ftrace_test_event_filter);
2247 #endif /* CONFIG_FTRACE_STARTUP_TEST */