1 // SPDX-License-Identifier: LGPL-2.1
3 * Copyright (C) 2010 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
11 #include <sys/types.h>
13 #include "event-parse.h"
14 #include "event-parse-local.h"
15 #include "event-utils.h"
20 static struct tep_format_field comm = {
24 static struct tep_format_field cpu = {
29 struct event_list *next;
30 struct tep_event *event;
33 static void show_error(char *error_buf, const char *fmt, ...)
35 unsigned long long index;
41 input = tep_get_input_buf();
42 index = tep_get_input_buf_ptr();
43 len = input ? strlen(input) : 0;
46 strcpy(error_buf, input);
47 error_buf[len] = '\n';
48 for (i = 1; i < len && i < index; i++)
49 error_buf[len+i] = ' ';
50 error_buf[len + i] = '^';
51 error_buf[len + i + 1] = '\n';
56 vsnprintf(error_buf + len, TEP_FILTER_ERROR_BUFSZ - len, fmt, ap);
60 static void free_token(char *token)
62 tep_free_token(token);
65 static enum tep_event_type read_token(char **tok)
67 enum tep_event_type type;
72 type = tep_read_token(&token);
73 } while (type == TEP_EVENT_NEWLINE || type == TEP_EVENT_SPACE);
75 /* If token is = or ! check to see if the next char is ~ */
77 (strcmp(token, "=") == 0 || strcmp(token, "!") == 0) &&
78 tep_peek_char() == '~') {
83 return TEP_EVENT_ERROR;
85 sprintf(*tok, "%c%c", *token, '~');
87 /* Now remove the '~' from the buffer */
88 tep_read_token(&token);
96 static int filter_cmp(const void *a, const void *b)
98 const struct tep_filter_type *ea = a;
99 const struct tep_filter_type *eb = b;
101 if (ea->event_id < eb->event_id)
104 if (ea->event_id > eb->event_id)
110 static struct tep_filter_type *
111 find_filter_type(struct tep_event_filter *filter, int id)
113 struct tep_filter_type *filter_type;
114 struct tep_filter_type key;
118 filter_type = bsearch(&key, filter->event_filters,
120 sizeof(*filter->event_filters),
126 static struct tep_filter_type *
127 add_filter_type(struct tep_event_filter *filter, int id)
129 struct tep_filter_type *filter_type;
132 filter_type = find_filter_type(filter, id);
136 filter_type = realloc(filter->event_filters,
137 sizeof(*filter->event_filters) *
138 (filter->filters + 1));
142 filter->event_filters = filter_type;
144 for (i = 0; i < filter->filters; i++) {
145 if (filter->event_filters[i].event_id > id)
149 if (i < filter->filters)
150 memmove(&filter->event_filters[i+1],
151 &filter->event_filters[i],
152 sizeof(*filter->event_filters) *
153 (filter->filters - i));
155 filter_type = &filter->event_filters[i];
156 filter_type->event_id = id;
157 filter_type->event = tep_find_event(filter->tep, id);
158 filter_type->filter = NULL;
166 * tep_filter_alloc - create a new event filter
167 * @tep: The tep that this filter is associated with
169 struct tep_event_filter *tep_filter_alloc(struct tep_handle *tep)
171 struct tep_event_filter *filter;
173 filter = malloc(sizeof(*filter));
177 memset(filter, 0, sizeof(*filter));
184 static struct tep_filter_arg *allocate_arg(void)
186 return calloc(1, sizeof(struct tep_filter_arg));
189 static void free_arg(struct tep_filter_arg *arg)
195 case TEP_FILTER_ARG_NONE:
196 case TEP_FILTER_ARG_BOOLEAN:
199 case TEP_FILTER_ARG_NUM:
200 free_arg(arg->num.left);
201 free_arg(arg->num.right);
204 case TEP_FILTER_ARG_EXP:
205 free_arg(arg->exp.left);
206 free_arg(arg->exp.right);
209 case TEP_FILTER_ARG_STR:
211 regfree(&arg->str.reg);
212 free(arg->str.buffer);
215 case TEP_FILTER_ARG_VALUE:
216 if (arg->value.type == TEP_FILTER_STRING ||
217 arg->value.type == TEP_FILTER_CHAR)
218 free(arg->value.str);
221 case TEP_FILTER_ARG_OP:
222 free_arg(arg->op.left);
223 free_arg(arg->op.right);
231 static int add_event(struct event_list **events,
232 struct tep_event *event)
234 struct event_list *list;
236 list = malloc(sizeof(*list));
240 list->next = *events;
246 static int event_match(struct tep_event *event,
247 regex_t *sreg, regex_t *ereg)
250 return !regexec(sreg, event->system, 0, NULL, 0) &&
251 !regexec(ereg, event->name, 0, NULL, 0);
254 return !regexec(ereg, event->system, 0, NULL, 0) ||
255 !regexec(ereg, event->name, 0, NULL, 0);
258 static enum tep_errno
259 find_event(struct tep_handle *tep, struct event_list **events,
260 char *sys_name, char *event_name)
262 struct tep_event *event;
272 /* if no name is given, then swap sys and name */
273 event_name = sys_name;
277 ret = asprintf(®, "^%s$", event_name);
279 return TEP_ERRNO__MEM_ALLOC_FAILED;
281 ret = regcomp(&ereg, reg, REG_ICASE|REG_NOSUB);
285 return TEP_ERRNO__INVALID_EVENT_NAME;
288 ret = asprintf(®, "^%s$", sys_name);
291 return TEP_ERRNO__MEM_ALLOC_FAILED;
294 ret = regcomp(&sreg, reg, REG_ICASE|REG_NOSUB);
298 return TEP_ERRNO__INVALID_EVENT_NAME;
302 for (i = 0; i < tep->nr_events; i++) {
303 event = tep->events[i];
304 if (event_match(event, sys_name ? &sreg : NULL, &ereg)) {
306 if (add_event(events, event) < 0) {
318 return TEP_ERRNO__EVENT_NOT_FOUND;
320 return TEP_ERRNO__MEM_ALLOC_FAILED;
325 static void free_events(struct event_list *events)
327 struct event_list *event;
331 events = events->next;
336 static enum tep_errno
337 create_arg_item(struct tep_event *event, const char *token,
338 enum tep_event_type type, struct tep_filter_arg **parg, char *error_str)
340 struct tep_format_field *field;
341 struct tep_filter_arg *arg;
343 arg = allocate_arg();
345 show_error(error_str, "failed to allocate filter arg");
346 return TEP_ERRNO__MEM_ALLOC_FAILED;
351 case TEP_EVENT_SQUOTE:
352 case TEP_EVENT_DQUOTE:
353 arg->type = TEP_FILTER_ARG_VALUE;
355 type == TEP_EVENT_DQUOTE ? TEP_FILTER_STRING : TEP_FILTER_CHAR;
356 arg->value.str = strdup(token);
357 if (!arg->value.str) {
359 show_error(error_str, "failed to allocate string filter arg");
360 return TEP_ERRNO__MEM_ALLOC_FAILED;
364 /* if it is a number, then convert it */
365 if (isdigit(token[0])) {
366 arg->type = TEP_FILTER_ARG_VALUE;
367 arg->value.type = TEP_FILTER_NUMBER;
368 arg->value.val = strtoull(token, NULL, 0);
371 /* Consider this a field */
372 field = tep_find_any_field(event, token);
374 /* If token is 'COMM' or 'CPU' then it is special */
375 if (strcmp(token, COMM) == 0) {
377 } else if (strcmp(token, CPU) == 0) {
380 /* not a field, Make it false */
381 arg->type = TEP_FILTER_ARG_BOOLEAN;
382 arg->boolean.value = TEP_FILTER_FALSE;
386 arg->type = TEP_FILTER_ARG_FIELD;
387 arg->field.field = field;
391 show_error(error_str, "expected a value but found %s", token);
392 return TEP_ERRNO__UNEXPECTED_TYPE;
398 static struct tep_filter_arg *
399 create_arg_op(enum tep_filter_op_type btype)
401 struct tep_filter_arg *arg;
403 arg = allocate_arg();
407 arg->type = TEP_FILTER_ARG_OP;
408 arg->op.type = btype;
413 static struct tep_filter_arg *
414 create_arg_exp(enum tep_filter_exp_type etype)
416 struct tep_filter_arg *arg;
418 arg = allocate_arg();
422 arg->type = TEP_FILTER_ARG_EXP;
423 arg->exp.type = etype;
428 static struct tep_filter_arg *
429 create_arg_cmp(enum tep_filter_cmp_type ctype)
431 struct tep_filter_arg *arg;
433 arg = allocate_arg();
437 /* Use NUM and change if necessary */
438 arg->type = TEP_FILTER_ARG_NUM;
439 arg->num.type = ctype;
444 static enum tep_errno
445 add_right(struct tep_filter_arg *op, struct tep_filter_arg *arg, char *error_str)
447 struct tep_filter_arg *left;
453 case TEP_FILTER_ARG_EXP:
459 case TEP_FILTER_ARG_OP:
465 case TEP_FILTER_ARG_NUM:
469 * The arg must be num, str, or field
472 case TEP_FILTER_ARG_VALUE:
473 case TEP_FILTER_ARG_FIELD:
476 show_error(error_str, "Illegal rvalue");
477 return TEP_ERRNO__ILLEGAL_RVALUE;
481 * Depending on the type, we may need to
482 * convert this to a string or regex.
484 switch (arg->value.type) {
485 case TEP_FILTER_CHAR:
487 * A char should be converted to number if
488 * the string is 1 byte, and the compare
491 if (strlen(arg->value.str) == 1 &&
492 op->num.type != TEP_FILTER_CMP_REGEX &&
493 op->num.type != TEP_FILTER_CMP_NOT_REGEX) {
494 arg->value.type = TEP_FILTER_NUMBER;
498 case TEP_FILTER_STRING:
500 /* convert op to a string arg */
501 op_type = op->num.type;
503 str = arg->value.str;
505 /* reset the op for the new field */
506 memset(op, 0, sizeof(*op));
509 * If left arg was a field not found then
510 * NULL the entire op.
512 if (left->type == TEP_FILTER_ARG_BOOLEAN) {
515 op->type = TEP_FILTER_ARG_BOOLEAN;
516 op->boolean.value = TEP_FILTER_FALSE;
520 /* Left arg must be a field */
521 if (left->type != TEP_FILTER_ARG_FIELD) {
522 show_error(error_str,
523 "Illegal lvalue for string comparison");
524 return TEP_ERRNO__ILLEGAL_LVALUE;
527 /* Make sure this is a valid string compare */
529 case TEP_FILTER_CMP_EQ:
530 op_type = TEP_FILTER_CMP_MATCH;
532 case TEP_FILTER_CMP_NE:
533 op_type = TEP_FILTER_CMP_NOT_MATCH;
536 case TEP_FILTER_CMP_REGEX:
537 case TEP_FILTER_CMP_NOT_REGEX:
538 ret = regcomp(&op->str.reg, str, REG_ICASE|REG_NOSUB);
540 show_error(error_str,
541 "RegEx '%s' did not compute",
543 return TEP_ERRNO__INVALID_REGEX;
547 show_error(error_str,
548 "Illegal comparison for string");
549 return TEP_ERRNO__ILLEGAL_STRING_CMP;
552 op->type = TEP_FILTER_ARG_STR;
553 op->str.type = op_type;
554 op->str.field = left->field.field;
555 op->str.val = strdup(str);
557 show_error(error_str, "Failed to allocate string filter");
558 return TEP_ERRNO__MEM_ALLOC_FAILED;
561 * Need a buffer to copy data for tests
563 op->str.buffer = malloc(op->str.field->size + 1);
564 if (!op->str.buffer) {
565 show_error(error_str, "Failed to allocate string filter");
566 return TEP_ERRNO__MEM_ALLOC_FAILED;
568 /* Null terminate this buffer */
569 op->str.buffer[op->str.field->size] = 0;
571 /* We no longer have left or right args */
577 case TEP_FILTER_NUMBER:
580 switch (op->num.type) {
581 case TEP_FILTER_CMP_REGEX:
582 case TEP_FILTER_CMP_NOT_REGEX:
583 show_error(error_str,
584 "Op not allowed with integers");
585 return TEP_ERRNO__ILLEGAL_INTEGER_CMP;
591 /* numeric compare */
605 show_error(error_str, "Syntax error");
606 return TEP_ERRNO__SYNTAX_ERROR;
609 static struct tep_filter_arg *
610 rotate_op_right(struct tep_filter_arg *a, struct tep_filter_arg *b)
612 struct tep_filter_arg *arg;
619 static enum tep_errno add_left(struct tep_filter_arg *op, struct tep_filter_arg *arg)
622 case TEP_FILTER_ARG_EXP:
623 if (arg->type == TEP_FILTER_ARG_OP)
624 arg = rotate_op_right(arg, op);
628 case TEP_FILTER_ARG_OP:
631 case TEP_FILTER_ARG_NUM:
632 if (arg->type == TEP_FILTER_ARG_OP)
633 arg = rotate_op_right(arg, op);
635 /* left arg of compares must be a field */
636 if (arg->type != TEP_FILTER_ARG_FIELD &&
637 arg->type != TEP_FILTER_ARG_BOOLEAN)
638 return TEP_ERRNO__INVALID_ARG_TYPE;
642 return TEP_ERRNO__INVALID_ARG_TYPE;
655 static enum op_type process_op(const char *token,
656 enum tep_filter_op_type *btype,
657 enum tep_filter_cmp_type *ctype,
658 enum tep_filter_exp_type *etype)
660 *btype = TEP_FILTER_OP_NOT;
661 *etype = TEP_FILTER_EXP_NONE;
662 *ctype = TEP_FILTER_CMP_NONE;
664 if (strcmp(token, "&&") == 0)
665 *btype = TEP_FILTER_OP_AND;
666 else if (strcmp(token, "||") == 0)
667 *btype = TEP_FILTER_OP_OR;
668 else if (strcmp(token, "!") == 0)
671 if (*btype != TEP_FILTER_OP_NOT)
674 /* Check for value expressions */
675 if (strcmp(token, "+") == 0) {
676 *etype = TEP_FILTER_EXP_ADD;
677 } else if (strcmp(token, "-") == 0) {
678 *etype = TEP_FILTER_EXP_SUB;
679 } else if (strcmp(token, "*") == 0) {
680 *etype = TEP_FILTER_EXP_MUL;
681 } else if (strcmp(token, "/") == 0) {
682 *etype = TEP_FILTER_EXP_DIV;
683 } else if (strcmp(token, "%") == 0) {
684 *etype = TEP_FILTER_EXP_MOD;
685 } else if (strcmp(token, ">>") == 0) {
686 *etype = TEP_FILTER_EXP_RSHIFT;
687 } else if (strcmp(token, "<<") == 0) {
688 *etype = TEP_FILTER_EXP_LSHIFT;
689 } else if (strcmp(token, "&") == 0) {
690 *etype = TEP_FILTER_EXP_AND;
691 } else if (strcmp(token, "|") == 0) {
692 *etype = TEP_FILTER_EXP_OR;
693 } else if (strcmp(token, "^") == 0) {
694 *etype = TEP_FILTER_EXP_XOR;
695 } else if (strcmp(token, "~") == 0)
696 *etype = TEP_FILTER_EXP_NOT;
698 if (*etype != TEP_FILTER_EXP_NONE)
701 /* Check for compares */
702 if (strcmp(token, "==") == 0)
703 *ctype = TEP_FILTER_CMP_EQ;
704 else if (strcmp(token, "!=") == 0)
705 *ctype = TEP_FILTER_CMP_NE;
706 else if (strcmp(token, "<") == 0)
707 *ctype = TEP_FILTER_CMP_LT;
708 else if (strcmp(token, ">") == 0)
709 *ctype = TEP_FILTER_CMP_GT;
710 else if (strcmp(token, "<=") == 0)
711 *ctype = TEP_FILTER_CMP_LE;
712 else if (strcmp(token, ">=") == 0)
713 *ctype = TEP_FILTER_CMP_GE;
714 else if (strcmp(token, "=~") == 0)
715 *ctype = TEP_FILTER_CMP_REGEX;
716 else if (strcmp(token, "!~") == 0)
717 *ctype = TEP_FILTER_CMP_NOT_REGEX;
724 static int check_op_done(struct tep_filter_arg *arg)
727 case TEP_FILTER_ARG_EXP:
728 return arg->exp.right != NULL;
730 case TEP_FILTER_ARG_OP:
731 return arg->op.right != NULL;
733 case TEP_FILTER_ARG_NUM:
734 return arg->num.right != NULL;
736 case TEP_FILTER_ARG_STR:
737 /* A string conversion is always done */
740 case TEP_FILTER_ARG_BOOLEAN:
741 /* field not found, is ok */
755 static enum tep_errno
756 reparent_op_arg(struct tep_filter_arg *parent, struct tep_filter_arg *old_child,
757 struct tep_filter_arg *arg, char *error_str)
759 struct tep_filter_arg *other_child;
760 struct tep_filter_arg **ptr;
762 if (parent->type != TEP_FILTER_ARG_OP &&
763 arg->type != TEP_FILTER_ARG_OP) {
764 show_error(error_str, "can not reparent other than OP");
765 return TEP_ERRNO__REPARENT_NOT_OP;
768 /* Get the sibling */
769 if (old_child->op.right == arg) {
770 ptr = &old_child->op.right;
771 other_child = old_child->op.left;
772 } else if (old_child->op.left == arg) {
773 ptr = &old_child->op.left;
774 other_child = old_child->op.right;
776 show_error(error_str, "Error in reparent op, find other child");
777 return TEP_ERRNO__REPARENT_FAILED;
780 /* Detach arg from old_child */
784 if (parent == old_child) {
785 free_arg(other_child);
787 /* Free arg without recussion */
792 if (parent->op.right == old_child)
793 ptr = &parent->op.right;
794 else if (parent->op.left == old_child)
795 ptr = &parent->op.left;
797 show_error(error_str, "Error in reparent op");
798 return TEP_ERRNO__REPARENT_FAILED;
807 /* Returns either filter_vals (success) or tep_errno (failfure) */
808 static int test_arg(struct tep_filter_arg *parent, struct tep_filter_arg *arg,
816 case TEP_FILTER_ARG_BOOLEAN:
817 return FILTER_VAL_FALSE + arg->boolean.value;
820 case TEP_FILTER_ARG_STR:
821 case TEP_FILTER_ARG_VALUE:
822 case TEP_FILTER_ARG_FIELD:
823 return FILTER_VAL_NORM;
825 case TEP_FILTER_ARG_EXP:
826 lval = test_arg(arg, arg->exp.left, error_str);
827 if (lval != FILTER_VAL_NORM)
829 rval = test_arg(arg, arg->exp.right, error_str);
830 if (rval != FILTER_VAL_NORM)
832 return FILTER_VAL_NORM;
834 case TEP_FILTER_ARG_NUM:
835 lval = test_arg(arg, arg->num.left, error_str);
836 if (lval != FILTER_VAL_NORM)
838 rval = test_arg(arg, arg->num.right, error_str);
839 if (rval != FILTER_VAL_NORM)
841 return FILTER_VAL_NORM;
843 case TEP_FILTER_ARG_OP:
844 if (arg->op.type != TEP_FILTER_OP_NOT) {
845 lval = test_arg(arg, arg->op.left, error_str);
847 case FILTER_VAL_NORM:
849 case FILTER_VAL_TRUE:
850 if (arg->op.type == TEP_FILTER_OP_OR)
851 return FILTER_VAL_TRUE;
852 rval = test_arg(arg, arg->op.right, error_str);
853 if (rval != FILTER_VAL_NORM)
856 return reparent_op_arg(parent, arg, arg->op.right,
859 case FILTER_VAL_FALSE:
860 if (arg->op.type == TEP_FILTER_OP_AND)
861 return FILTER_VAL_FALSE;
862 rval = test_arg(arg, arg->op.right, error_str);
863 if (rval != FILTER_VAL_NORM)
866 return reparent_op_arg(parent, arg, arg->op.right,
874 rval = test_arg(arg, arg->op.right, error_str);
876 case FILTER_VAL_NORM:
880 case FILTER_VAL_TRUE:
881 if (arg->op.type == TEP_FILTER_OP_OR)
882 return FILTER_VAL_TRUE;
883 if (arg->op.type == TEP_FILTER_OP_NOT)
884 return FILTER_VAL_FALSE;
886 return reparent_op_arg(parent, arg, arg->op.left,
889 case FILTER_VAL_FALSE:
890 if (arg->op.type == TEP_FILTER_OP_AND)
891 return FILTER_VAL_FALSE;
892 if (arg->op.type == TEP_FILTER_OP_NOT)
893 return FILTER_VAL_TRUE;
895 return reparent_op_arg(parent, arg, arg->op.left,
901 show_error(error_str, "bad arg in filter tree");
902 return TEP_ERRNO__BAD_FILTER_ARG;
904 return FILTER_VAL_NORM;
907 /* Remove any unknown event fields */
908 static int collapse_tree(struct tep_filter_arg *arg,
909 struct tep_filter_arg **arg_collapsed, char *error_str)
913 ret = test_arg(arg, arg, error_str);
915 case FILTER_VAL_NORM:
918 case FILTER_VAL_TRUE:
919 case FILTER_VAL_FALSE:
921 arg = allocate_arg();
923 arg->type = TEP_FILTER_ARG_BOOLEAN;
924 arg->boolean.value = ret == FILTER_VAL_TRUE;
926 show_error(error_str, "Failed to allocate filter arg");
927 ret = TEP_ERRNO__MEM_ALLOC_FAILED;
932 /* test_arg() already set the error_str */
938 *arg_collapsed = arg;
942 static enum tep_errno
943 process_filter(struct tep_event *event, struct tep_filter_arg **parg,
944 char *error_str, int not)
946 enum tep_event_type type;
948 struct tep_filter_arg *current_op = NULL;
949 struct tep_filter_arg *current_exp = NULL;
950 struct tep_filter_arg *left_item = NULL;
951 struct tep_filter_arg *arg = NULL;
952 enum op_type op_type;
953 enum tep_filter_op_type btype;
954 enum tep_filter_exp_type etype;
955 enum tep_filter_cmp_type ctype;
962 type = read_token(&token);
964 case TEP_EVENT_SQUOTE:
965 case TEP_EVENT_DQUOTE:
967 ret = create_arg_item(event, token, type, &arg, error_str);
972 else if (current_exp) {
973 ret = add_right(current_exp, arg, error_str);
977 /* Not's only one one expression */
991 case TEP_EVENT_DELIM:
993 show_error(error_str, "Illegal token ','");
994 ret = TEP_ERRNO__ILLEGAL_TOKEN;
1000 show_error(error_str,
1001 "Open paren can not come after item");
1002 ret = TEP_ERRNO__INVALID_PAREN;
1006 show_error(error_str,
1007 "Open paren can not come after expression");
1008 ret = TEP_ERRNO__INVALID_PAREN;
1012 ret = process_filter(event, &arg, error_str, 0);
1013 if (ret != TEP_ERRNO__UNBALANCED_PAREN) {
1015 show_error(error_str,
1016 "Unbalanced number of '('");
1017 ret = TEP_ERRNO__UNBALANCED_PAREN;
1023 /* A not wants just one expression */
1032 ret = add_right(current_op, arg, error_str);
1040 if (!current_op && !current_exp)
1043 /* Make sure everything is finished at this level */
1044 if (current_exp && !check_op_done(current_exp))
1046 if (current_op && !check_op_done(current_op))
1052 *parg = current_exp;
1054 return TEP_ERRNO__UNBALANCED_PAREN;
1059 op_type = process_op(token, &btype, &ctype, &etype);
1061 /* All expect a left arg except for NOT */
1064 /* Logic ops need a left expression */
1065 if (!current_exp && !current_op)
1069 /* logic only processes ops and exp */
1079 show_error(error_str,
1080 "Unknown op token %s", token);
1081 ret = TEP_ERRNO__UNKNOWN_TOKEN;
1088 arg = create_arg_op(btype);
1092 ret = add_left(arg, current_op);
1094 ret = add_left(arg, current_exp);
1100 arg = create_arg_op(btype);
1104 ret = add_right(current_op, arg, error_str);
1108 ret = process_filter(event, &arg, error_str, 1);
1111 ret = add_right(current_exp, arg, error_str);
1118 if (op_type == OP_EXP)
1119 arg = create_arg_exp(etype);
1121 arg = create_arg_cmp(ctype);
1126 ret = add_right(current_op, arg, error_str);
1129 ret = add_left(arg, left_item);
1143 case TEP_EVENT_NONE:
1145 case TEP_EVENT_ERROR:
1150 } while (type != TEP_EVENT_NONE);
1152 if (!current_op && !current_exp)
1156 current_op = current_exp;
1158 ret = collapse_tree(current_op, parg, error_str);
1159 /* collapse_tree() may free current_op, and updates parg accordingly */
1168 show_error(error_str, "failed to allocate filter arg");
1169 ret = TEP_ERRNO__MEM_ALLOC_FAILED;
1172 show_error(error_str, "Syntax error");
1173 ret = TEP_ERRNO__SYNTAX_ERROR;
1175 free_arg(current_op);
1176 free_arg(current_exp);
1182 static enum tep_errno
1183 process_event(struct tep_event *event, const char *filter_str,
1184 struct tep_filter_arg **parg, char *error_str)
1188 tep_buffer_init(filter_str, strlen(filter_str));
1190 ret = process_filter(event, parg, error_str, 0);
1194 /* If parg is NULL, then make it into FALSE */
1196 *parg = allocate_arg();
1198 return TEP_ERRNO__MEM_ALLOC_FAILED;
1200 (*parg)->type = TEP_FILTER_ARG_BOOLEAN;
1201 (*parg)->boolean.value = TEP_FILTER_FALSE;
1207 static enum tep_errno
1208 filter_event(struct tep_event_filter *filter, struct tep_event *event,
1209 const char *filter_str, char *error_str)
1211 struct tep_filter_type *filter_type;
1212 struct tep_filter_arg *arg;
1216 ret = process_event(event, filter_str, &arg, error_str);
1221 /* just add a TRUE arg */
1222 arg = allocate_arg();
1224 return TEP_ERRNO__MEM_ALLOC_FAILED;
1226 arg->type = TEP_FILTER_ARG_BOOLEAN;
1227 arg->boolean.value = TEP_FILTER_TRUE;
1230 filter_type = add_filter_type(filter, event->id);
1231 if (filter_type == NULL) {
1233 return TEP_ERRNO__MEM_ALLOC_FAILED;
1236 if (filter_type->filter)
1237 free_arg(filter_type->filter);
1238 filter_type->filter = arg;
1243 static void filter_init_error_buf(struct tep_event_filter *filter)
1245 /* clear buffer to reset show error */
1246 tep_buffer_init("", 0);
1247 filter->error_buffer[0] = '\0';
1251 * tep_filter_add_filter_str - add a new filter
1252 * @filter: the event filter to add to
1253 * @filter_str: the filter string that contains the filter
1255 * Returns 0 if the filter was successfully added or a
1256 * negative error code. Use tep_filter_strerror() to see
1257 * actual error message in case of error.
1259 enum tep_errno tep_filter_add_filter_str(struct tep_event_filter *filter,
1260 const char *filter_str)
1262 struct tep_handle *tep = filter->tep;
1263 struct event_list *event;
1264 struct event_list *events = NULL;
1265 const char *filter_start;
1266 const char *next_event;
1268 char *event_name = NULL;
1269 char *sys_name = NULL;
1271 enum tep_errno rtn = 0; /* TEP_ERRNO__SUCCESS */
1275 filter_init_error_buf(filter);
1277 filter_start = strchr(filter_str, ':');
1279 len = filter_start - filter_str;
1281 len = strlen(filter_str);
1284 next_event = strchr(filter_str, ',');
1286 (!filter_start || next_event < filter_start))
1287 len = next_event - filter_str;
1288 else if (filter_start)
1289 len = filter_start - filter_str;
1291 len = strlen(filter_str);
1293 this_event = malloc(len + 1);
1294 if (this_event == NULL) {
1295 /* This can only happen when events is NULL, but still */
1296 free_events(events);
1297 return TEP_ERRNO__MEM_ALLOC_FAILED;
1299 memcpy(this_event, filter_str, len);
1300 this_event[len] = 0;
1305 filter_str = next_event;
1307 sys_name = strtok_r(this_event, "/", &sp);
1308 event_name = strtok_r(NULL, "/", &sp);
1311 /* This can only happen when events is NULL, but still */
1312 free_events(events);
1314 return TEP_ERRNO__FILTER_NOT_FOUND;
1317 /* Find this event */
1318 ret = find_event(tep, &events, strim(sys_name), strim(event_name));
1320 free_events(events);
1325 } while (filter_str);
1331 /* filter starts here */
1332 for (event = events; event; event = event->next) {
1333 ret = filter_event(filter, event->event, filter_start,
1334 filter->error_buffer);
1335 /* Failures are returned if a parse error happened */
1339 if (ret >= 0 && tep->test_filters) {
1341 test = tep_filter_make_string(filter, event->event->id);
1343 printf(" '%s: %s'\n", event->event->name, test);
1349 free_events(events);
1354 static void free_filter_type(struct tep_filter_type *filter_type)
1356 free_arg(filter_type->filter);
1360 * tep_filter_strerror - fill error message in a buffer
1361 * @filter: the event filter contains error
1362 * @err: the error code
1363 * @buf: the buffer to be filled in
1364 * @buflen: the size of the buffer
1366 * Returns 0 if message was filled successfully, -1 if error
1368 int tep_filter_strerror(struct tep_event_filter *filter, enum tep_errno err,
1369 char *buf, size_t buflen)
1371 if (err <= __TEP_ERRNO__START || err >= __TEP_ERRNO__END)
1374 if (strlen(filter->error_buffer) > 0) {
1375 size_t len = snprintf(buf, buflen, "%s", filter->error_buffer);
1382 return tep_strerror(filter->tep, err, buf, buflen);
1386 * tep_filter_remove_event - remove a filter for an event
1387 * @filter: the event filter to remove from
1388 * @event_id: the event to remove a filter for
1390 * Removes the filter saved for an event defined by @event_id
1393 * Returns 1: if an event was removed
1394 * 0: if the event was not found
1396 int tep_filter_remove_event(struct tep_event_filter *filter,
1399 struct tep_filter_type *filter_type;
1402 if (!filter->filters)
1405 filter_type = find_filter_type(filter, event_id);
1410 free_filter_type(filter_type);
1412 /* The filter_type points into the event_filters array */
1413 len = (unsigned long)(filter->event_filters + filter->filters) -
1414 (unsigned long)(filter_type + 1);
1416 memmove(filter_type, filter_type + 1, len);
1419 memset(&filter->event_filters[filter->filters], 0,
1420 sizeof(*filter_type));
1426 * tep_filter_reset - clear all filters in a filter
1427 * @filter: the event filter to reset
1429 * Removes all filters from a filter and resets it.
1431 void tep_filter_reset(struct tep_event_filter *filter)
1435 for (i = 0; i < filter->filters; i++)
1436 free_filter_type(&filter->event_filters[i]);
1438 free(filter->event_filters);
1439 filter->filters = 0;
1440 filter->event_filters = NULL;
1443 void tep_filter_free(struct tep_event_filter *filter)
1445 tep_unref(filter->tep);
1447 tep_filter_reset(filter);
1452 static char *arg_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg);
1454 static int copy_filter_type(struct tep_event_filter *filter,
1455 struct tep_event_filter *source,
1456 struct tep_filter_type *filter_type)
1458 struct tep_filter_arg *arg;
1459 struct tep_event *event;
1464 /* Can't assume that the tep's are the same */
1465 sys = filter_type->event->system;
1466 name = filter_type->event->name;
1467 event = tep_find_event_by_name(filter->tep, sys, name);
1471 str = arg_to_str(source, filter_type->filter);
1475 if (strcmp(str, "TRUE") == 0 || strcmp(str, "FALSE") == 0) {
1476 /* Add trivial event */
1477 arg = allocate_arg();
1483 arg->type = TEP_FILTER_ARG_BOOLEAN;
1484 if (strcmp(str, "TRUE") == 0)
1485 arg->boolean.value = 1;
1487 arg->boolean.value = 0;
1489 filter_type = add_filter_type(filter, event->id);
1490 if (filter_type == NULL) {
1496 filter_type->filter = arg;
1502 filter_event(filter, event, str, NULL);
1509 * tep_filter_copy - copy a filter using another filter
1510 * @dest - the filter to copy to
1511 * @source - the filter to copy from
1513 * Returns 0 on success and -1 if not all filters were copied
1515 int tep_filter_copy(struct tep_event_filter *dest, struct tep_event_filter *source)
1520 tep_filter_reset(dest);
1522 for (i = 0; i < source->filters; i++) {
1523 if (copy_filter_type(dest, source, &source->event_filters[i]))
1529 static int test_filter(struct tep_event *event, struct tep_filter_arg *arg,
1530 struct tep_record *record, enum tep_errno *err);
1533 get_comm(struct tep_event *event, struct tep_record *record)
1538 pid = tep_data_pid(event->tep, record);
1539 comm = tep_data_comm_from_pid(event->tep, pid);
1543 static unsigned long long
1544 get_value(struct tep_event *event,
1545 struct tep_format_field *field, struct tep_record *record)
1547 unsigned long long val;
1549 /* Handle our dummy "comm" field */
1550 if (field == &comm) {
1553 name = get_comm(event, record);
1554 return (unsigned long)name;
1557 /* Handle our dummy "cpu" field */
1561 tep_read_number_field(field, record->data, &val);
1563 if (!(field->flags & TEP_FIELD_IS_SIGNED))
1566 switch (field->size) {
1574 return (long long)val;
1579 static unsigned long long
1580 get_arg_value(struct tep_event *event, struct tep_filter_arg *arg,
1581 struct tep_record *record, enum tep_errno *err);
1583 static unsigned long long
1584 get_exp_value(struct tep_event *event, struct tep_filter_arg *arg,
1585 struct tep_record *record, enum tep_errno *err)
1587 unsigned long long lval, rval;
1589 lval = get_arg_value(event, arg->exp.left, record, err);
1590 rval = get_arg_value(event, arg->exp.right, record, err);
1594 * There was an error, no need to process anymore.
1599 switch (arg->exp.type) {
1600 case TEP_FILTER_EXP_ADD:
1603 case TEP_FILTER_EXP_SUB:
1606 case TEP_FILTER_EXP_MUL:
1609 case TEP_FILTER_EXP_DIV:
1612 case TEP_FILTER_EXP_MOD:
1615 case TEP_FILTER_EXP_RSHIFT:
1616 return lval >> rval;
1618 case TEP_FILTER_EXP_LSHIFT:
1619 return lval << rval;
1621 case TEP_FILTER_EXP_AND:
1624 case TEP_FILTER_EXP_OR:
1627 case TEP_FILTER_EXP_XOR:
1630 case TEP_FILTER_EXP_NOT:
1633 *err = TEP_ERRNO__INVALID_EXP_TYPE;
1638 static unsigned long long
1639 get_arg_value(struct tep_event *event, struct tep_filter_arg *arg,
1640 struct tep_record *record, enum tep_errno *err)
1642 switch (arg->type) {
1643 case TEP_FILTER_ARG_FIELD:
1644 return get_value(event, arg->field.field, record);
1646 case TEP_FILTER_ARG_VALUE:
1647 if (arg->value.type != TEP_FILTER_NUMBER) {
1649 *err = TEP_ERRNO__NOT_A_NUMBER;
1651 return arg->value.val;
1653 case TEP_FILTER_ARG_EXP:
1654 return get_exp_value(event, arg, record, err);
1658 *err = TEP_ERRNO__INVALID_ARG_TYPE;
1663 static int test_num(struct tep_event *event, struct tep_filter_arg *arg,
1664 struct tep_record *record, enum tep_errno *err)
1666 unsigned long long lval, rval;
1668 lval = get_arg_value(event, arg->num.left, record, err);
1669 rval = get_arg_value(event, arg->num.right, record, err);
1673 * There was an error, no need to process anymore.
1678 switch (arg->num.type) {
1679 case TEP_FILTER_CMP_EQ:
1680 return lval == rval;
1682 case TEP_FILTER_CMP_NE:
1683 return lval != rval;
1685 case TEP_FILTER_CMP_GT:
1688 case TEP_FILTER_CMP_LT:
1691 case TEP_FILTER_CMP_GE:
1692 return lval >= rval;
1694 case TEP_FILTER_CMP_LE:
1695 return lval <= rval;
1699 *err = TEP_ERRNO__ILLEGAL_INTEGER_CMP;
1704 static const char *get_field_str(struct tep_filter_arg *arg, struct tep_record *record)
1706 struct tep_event *event;
1707 struct tep_handle *tep;
1708 unsigned long long addr;
1709 const char *val = NULL;
1713 /* If the field is not a string convert it */
1714 if (arg->str.field->flags & TEP_FIELD_IS_STRING) {
1715 val = record->data + arg->str.field->offset;
1716 size = arg->str.field->size;
1718 if (arg->str.field->flags & TEP_FIELD_IS_DYNAMIC) {
1719 addr = *(unsigned int *)val;
1720 val = record->data + (addr & 0xffff);
1725 * We need to copy the data since we can't be sure the field
1726 * is null terminated.
1728 if (*(val + size - 1)) {
1730 memcpy(arg->str.buffer, val, arg->str.field->size);
1731 /* the buffer is already NULL terminated */
1732 val = arg->str.buffer;
1736 event = arg->str.field->event;
1738 addr = get_value(event, arg->str.field, record);
1740 if (arg->str.field->flags & (TEP_FIELD_IS_POINTER | TEP_FIELD_IS_LONG))
1741 /* convert to a kernel symbol */
1742 val = tep_find_function(tep, addr);
1745 /* just use the hex of the string name */
1746 snprintf(hex, 64, "0x%llx", addr);
1754 static int test_str(struct tep_event *event, struct tep_filter_arg *arg,
1755 struct tep_record *record, enum tep_errno *err)
1759 if (arg->str.field == &comm)
1760 val = get_comm(event, record);
1762 val = get_field_str(arg, record);
1764 switch (arg->str.type) {
1765 case TEP_FILTER_CMP_MATCH:
1766 return strcmp(val, arg->str.val) == 0;
1768 case TEP_FILTER_CMP_NOT_MATCH:
1769 return strcmp(val, arg->str.val) != 0;
1771 case TEP_FILTER_CMP_REGEX:
1772 /* Returns zero on match */
1773 return !regexec(&arg->str.reg, val, 0, NULL, 0);
1775 case TEP_FILTER_CMP_NOT_REGEX:
1776 return regexec(&arg->str.reg, val, 0, NULL, 0);
1780 *err = TEP_ERRNO__ILLEGAL_STRING_CMP;
1785 static int test_op(struct tep_event *event, struct tep_filter_arg *arg,
1786 struct tep_record *record, enum tep_errno *err)
1788 switch (arg->op.type) {
1789 case TEP_FILTER_OP_AND:
1790 return test_filter(event, arg->op.left, record, err) &&
1791 test_filter(event, arg->op.right, record, err);
1793 case TEP_FILTER_OP_OR:
1794 return test_filter(event, arg->op.left, record, err) ||
1795 test_filter(event, arg->op.right, record, err);
1797 case TEP_FILTER_OP_NOT:
1798 return !test_filter(event, arg->op.right, record, err);
1802 *err = TEP_ERRNO__INVALID_OP_TYPE;
1807 static int test_filter(struct tep_event *event, struct tep_filter_arg *arg,
1808 struct tep_record *record, enum tep_errno *err)
1812 * There was an error, no need to process anymore.
1817 switch (arg->type) {
1818 case TEP_FILTER_ARG_BOOLEAN:
1820 return arg->boolean.value;
1822 case TEP_FILTER_ARG_OP:
1823 return test_op(event, arg, record, err);
1825 case TEP_FILTER_ARG_NUM:
1826 return test_num(event, arg, record, err);
1828 case TEP_FILTER_ARG_STR:
1829 return test_str(event, arg, record, err);
1831 case TEP_FILTER_ARG_EXP:
1832 case TEP_FILTER_ARG_VALUE:
1833 case TEP_FILTER_ARG_FIELD:
1835 * Expressions, fields and values evaluate
1836 * to true if they return non zero
1838 return !!get_arg_value(event, arg, record, err);
1842 *err = TEP_ERRNO__INVALID_ARG_TYPE;
1848 * tep_event_filtered - return true if event has filter
1849 * @filter: filter struct with filter information
1850 * @event_id: event id to test if filter exists
1852 * Returns 1 if filter found for @event_id
1855 int tep_event_filtered(struct tep_event_filter *filter, int event_id)
1857 struct tep_filter_type *filter_type;
1859 if (!filter->filters)
1862 filter_type = find_filter_type(filter, event_id);
1864 return filter_type ? 1 : 0;
1868 * tep_filter_match - test if a record matches a filter
1869 * @filter: filter struct with filter information
1870 * @record: the record to test against the filter
1872 * Returns: match result or error code (prefixed with TEP_ERRNO__)
1873 * FILTER_MATCH - filter found for event and @record matches
1874 * FILTER_MISS - filter found for event and @record does not match
1875 * FILTER_NOT_FOUND - no filter found for @record's event
1876 * NO_FILTER - if no filters exist
1877 * otherwise - error occurred during test
1879 enum tep_errno tep_filter_match(struct tep_event_filter *filter,
1880 struct tep_record *record)
1882 struct tep_handle *tep = filter->tep;
1883 struct tep_filter_type *filter_type;
1886 enum tep_errno err = 0;
1888 filter_init_error_buf(filter);
1890 if (!filter->filters)
1891 return TEP_ERRNO__NO_FILTER;
1893 event_id = tep_data_type(tep, record);
1895 filter_type = find_filter_type(filter, event_id);
1897 return TEP_ERRNO__FILTER_NOT_FOUND;
1899 ret = test_filter(filter_type->event, filter_type->filter, record, &err);
1903 return ret ? TEP_ERRNO__FILTER_MATCH : TEP_ERRNO__FILTER_MISS;
1906 static char *op_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
1916 switch (arg->op.type) {
1917 case TEP_FILTER_OP_AND:
1920 case TEP_FILTER_OP_OR:
1924 left = arg_to_str(filter, arg->op.left);
1925 right = arg_to_str(filter, arg->op.right);
1926 if (!left || !right)
1929 /* Try to consolidate boolean values */
1930 if (strcmp(left, "TRUE") == 0)
1932 else if (strcmp(left, "FALSE") == 0)
1935 if (strcmp(right, "TRUE") == 0)
1937 else if (strcmp(right, "FALSE") == 0)
1940 if (left_val >= 0) {
1941 if ((arg->op.type == TEP_FILTER_OP_AND && !left_val) ||
1942 (arg->op.type == TEP_FILTER_OP_OR && left_val)) {
1943 /* Just return left value */
1948 if (right_val >= 0) {
1949 /* just evaluate this. */
1951 switch (arg->op.type) {
1952 case TEP_FILTER_OP_AND:
1953 val = left_val && right_val;
1955 case TEP_FILTER_OP_OR:
1956 val = left_val || right_val;
1961 asprintf(&str, val ? "TRUE" : "FALSE");
1965 if (right_val >= 0) {
1966 if ((arg->op.type == TEP_FILTER_OP_AND && !right_val) ||
1967 (arg->op.type == TEP_FILTER_OP_OR && right_val)) {
1968 /* Just return right value */
1973 /* The right value is meaningless */
1979 asprintf(&str, "(%s) %s (%s)", left, op, right);
1982 case TEP_FILTER_OP_NOT:
1984 right = arg_to_str(filter, arg->op.right);
1988 /* See if we can consolidate */
1989 if (strcmp(right, "TRUE") == 0)
1991 else if (strcmp(right, "FALSE") == 0)
1993 if (right_val >= 0) {
1994 /* just return the opposite */
1995 asprintf(&str, right_val ? "FALSE" : "TRUE");
1998 asprintf(&str, "%s(%s)", op, right);
2010 static char *val_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2014 asprintf(&str, "%lld", arg->value.val);
2019 static char *field_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2021 return strdup(arg->field.field->name);
2024 static char *exp_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2031 lstr = arg_to_str(filter, arg->exp.left);
2032 rstr = arg_to_str(filter, arg->exp.right);
2036 switch (arg->exp.type) {
2037 case TEP_FILTER_EXP_ADD:
2040 case TEP_FILTER_EXP_SUB:
2043 case TEP_FILTER_EXP_MUL:
2046 case TEP_FILTER_EXP_DIV:
2049 case TEP_FILTER_EXP_MOD:
2052 case TEP_FILTER_EXP_RSHIFT:
2055 case TEP_FILTER_EXP_LSHIFT:
2058 case TEP_FILTER_EXP_AND:
2061 case TEP_FILTER_EXP_OR:
2064 case TEP_FILTER_EXP_XOR:
2068 op = "[ERROR IN EXPRESSION TYPE]";
2072 asprintf(&str, "%s %s %s", lstr, op, rstr);
2080 static char *num_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2087 lstr = arg_to_str(filter, arg->num.left);
2088 rstr = arg_to_str(filter, arg->num.right);
2092 switch (arg->num.type) {
2093 case TEP_FILTER_CMP_EQ:
2096 case TEP_FILTER_CMP_NE:
2100 case TEP_FILTER_CMP_GT:
2104 case TEP_FILTER_CMP_LT:
2108 case TEP_FILTER_CMP_GE:
2112 case TEP_FILTER_CMP_LE:
2116 asprintf(&str, "%s %s %s", lstr, op, rstr);
2130 static char *str_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2135 switch (arg->str.type) {
2136 case TEP_FILTER_CMP_MATCH:
2139 case TEP_FILTER_CMP_NOT_MATCH:
2143 case TEP_FILTER_CMP_REGEX:
2147 case TEP_FILTER_CMP_NOT_REGEX:
2151 asprintf(&str, "%s %s \"%s\"",
2152 arg->str.field->name, op, arg->str.val);
2162 static char *arg_to_str(struct tep_event_filter *filter, struct tep_filter_arg *arg)
2166 switch (arg->type) {
2167 case TEP_FILTER_ARG_BOOLEAN:
2168 asprintf(&str, arg->boolean.value ? "TRUE" : "FALSE");
2171 case TEP_FILTER_ARG_OP:
2172 return op_to_str(filter, arg);
2174 case TEP_FILTER_ARG_NUM:
2175 return num_to_str(filter, arg);
2177 case TEP_FILTER_ARG_STR:
2178 return str_to_str(filter, arg);
2180 case TEP_FILTER_ARG_VALUE:
2181 return val_to_str(filter, arg);
2183 case TEP_FILTER_ARG_FIELD:
2184 return field_to_str(filter, arg);
2186 case TEP_FILTER_ARG_EXP:
2187 return exp_to_str(filter, arg);
2197 * tep_filter_make_string - return a string showing the filter
2198 * @filter: filter struct with filter information
2199 * @event_id: the event id to return the filter string with
2201 * Returns a string that displays the filter contents.
2202 * This string must be freed with free(str).
2203 * NULL is returned if no filter is found or allocation failed.
2206 tep_filter_make_string(struct tep_event_filter *filter, int event_id)
2208 struct tep_filter_type *filter_type;
2210 if (!filter->filters)
2213 filter_type = find_filter_type(filter, event_id);
2218 return arg_to_str(filter, filter_type->filter);
2222 * tep_filter_compare - compare two filters and return if they are the same
2223 * @filter1: Filter to compare with @filter2
2224 * @filter2: Filter to compare with @filter1
2227 * 1 if the two filters hold the same content.
2230 int tep_filter_compare(struct tep_event_filter *filter1, struct tep_event_filter *filter2)
2232 struct tep_filter_type *filter_type1;
2233 struct tep_filter_type *filter_type2;
2238 /* Do the easy checks first */
2239 if (filter1->filters != filter2->filters)
2241 if (!filter1->filters && !filter2->filters)
2245 * Now take a look at each of the events to see if they have the same
2248 for (i = 0; i < filter1->filters; i++) {
2249 filter_type1 = &filter1->event_filters[i];
2250 filter_type2 = find_filter_type(filter2, filter_type1->event_id);
2253 if (filter_type1->filter->type != filter_type2->filter->type)
2255 /* The best way to compare complex filters is with strings */
2256 str1 = arg_to_str(filter1, filter_type1->filter);
2257 str2 = arg_to_str(filter2, filter_type2->filter);
2259 result = strcmp(str1, str2) != 0;
2261 /* bail out if allocation fails */
2270 if (i < filter1->filters)