Skip to contentSkip to conversation

Add support for kconfig constraints

PATCH Superseded Cyril Hrubis 2 participants 5 messages Nov 3, 2020 Library code

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v3 cover Add support for kconfig constraints

This patchset adds a support for generic boolean expressions in order to be able to check for a more complex kernel configurations.

The motivation for this is recent rename in kernel config names that cannot be checked for by a simplistic approach we previously implemented.

The boolean expression parser was written as a generic as possible since I do expect that we will reuse it for different types of assertions in the future.

Cyril Hrubis (2):
lib: Add generic boolean expression parser and eval lib/tst_kconfig: Make use of boolean expression eval

 doc/test-writing-guidelines.txt         |  21 +-
 include/tst_bool_expr.h                 |  86 +++++
 include/tst_kconfig.h                   |  34 +-
 lib/newlib_tests/.gitignore             |   2 +
 lib/newlib_tests/config06               |   1 +
 lib/newlib_tests/test_kconfig.c         |   2 +
 lib/newlib_tests/test_kconfig01.c       |  23 ++
 lib/newlib_tests/tst_bool_expr.c        | 128 ++++++++
 lib/tst_bool_expr.c                     | 411 ++++++++++++++++++++++++
 lib/tst_kconfig.c                       | 366 ++++++++++++++-------
 testcases/kernel/syscalls/acct/acct02.c |  14 +-
 11 files changed, 933 insertions(+), 155 deletions(-)
 create mode 100644 include/tst_bool_expr.h
 create mode 100644 lib/newlib_tests/config06
 create mode 100644 lib/newlib_tests/test_kconfig01.c
 create mode 100644 lib/newlib_tests/tst_bool_expr.c
 create mode 100644 lib/tst_bool_expr.c
Signature · 1 line
2.26.2
#1 lore raw

PATCH v3 1/2 lib: Add generic boolean expression parser and eval

Add a simple and generic boolean expression parser and evaluator. This is a first step in order to implement more complex kconfig expressions, but since we are likely to reuse the parser for other purposes in the future it's implemented as a generic boolean parser.

---

v3:
- now we run tokenizer twice and count number of tokens in the first pass then allocate all the tokens in one malloc() which simplifies the code again a bit
- sligtly better formatting for error messages

 include/tst_bool_expr.h          |  86 +++++++
 lib/newlib_tests/.gitignore      |   1 +
 lib/newlib_tests/tst_bool_expr.c | 128 ++++++++++
 lib/tst_bool_expr.c              | 411 +++++++++++++++++++++++++++++++
 4 files changed, 626 insertions(+)
 create mode 100644 include/tst_bool_expr.h
 create mode 100644 lib/newlib_tests/tst_bool_expr.c
 create mode 100644 lib/tst_bool_expr.c
include/tst_bool_expr.h new file +86 -0
new file mode 100644
index 000000000..0e2fcc2e7
@@ -0,0 +1,86 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2020 Cyril Hrubis <[email protected]>
+ */
+
+#ifndef TST_BOOL_EXPR_H__
+#define TST_BOOL_EXPR_H__
+
+enum tst_op {
+	TST_OP_NOT,
+	TST_OP_AND,
+	TST_OP_OR,
+	TST_OP_VAR,
+	/* Used only internally */
+	TST_OP_LPAR,
+	TST_OP_RPAR,
+};
+
+struct tst_expr_tok {
+	enum tst_op op;
+	const char *tok;
+	size_t tok_len;
+	struct tst_expr_tok *next;
+	const void *priv;
+};
+
+struct tst_expr {
+	struct tst_expr_tok *expr;
+	struct tst_expr_tok *buf;
+};
+
+
+/*
+ * Parses an boolean expression and returns a simplified RPN version.
+ *
+ * If expression is not valid the call prints error into stderr and returns
+ * NULL. On success pointer to an expression is returned which can be evaluated
+ * by the tst_bool_expr_eval() function and has to be later freed by the
+ * caller.
+ *
+ * The boolean expression can consists of:
+ *
+ * - unary negation opeartion !
+ * - two binary operations & and |
+ * - correct sequence of parentheses ()
+ * - strings that are treated as boolean variables
+ *
+ *  e.g. '(A | B) & C' or 'Variable_1 & Variable_2' are both a valid boolean
+ *  expressions.
+ *
+ *  @expr String containing a boolean expression to be parsed.
+ *  @return Pointer to an RPN expression.
+ */
+struct tst_expr *tst_bool_expr_parse(const char *expr);
+
+/*
+ * Prints an string representation of the expression into a FILE.
+ *
+ * @param A FILE to print to.
+ * @expr An expression to print.
+ */
+void tst_bool_expr_print(FILE *f, struct tst_expr *expr);
+
+/*
+ * Evaluates an expression given a map for variables.
+ *
+ * The call will fail if:
+ * - map function returns -1 which indicates undefined variable
+ * - the eval function runs out of stack
+ *
+ * @param expr Boolean expression in RPN.
+ * @param map Mapping function for boolean variables.
+ *
+ * @return Returns 0 or 1 if expression was evaluated correctly and -1 on error.
+ */
+int tst_bool_expr_eval(struct tst_expr *expr,
+                       int (*map)(struct tst_expr_tok *var));
+
+/*
+ * Frees the memory allocated by the tst_bool_expr_parse().
+ *
+ * @param Boolean expression.
+ */
+void tst_bool_expr_free(struct tst_expr *expr);
+
+#endif	/* TST_BOOL_EXPR_H__ */
lib/newlib_tests/.gitignore +1 -0
index 44bc6526f..1e96db1da 100644
@@ -33,3 +33,4 @@ test_exec_child
 test_kconfig
 variant
 test_guarded_buf
+tst_bool_expr
lib/newlib_tests/tst_bool_expr.c new file +128 -0

128 lines not on this page · raw message

lib/tst_bool_expr.c new file +411 -0

411 lines not on this page · raw message

Signature · 1 line
2.26.2
#2 lore raw

PATCH v3 1/2 lib: Add generic boolean expression parser and eval

Hello Metan,

Quoted 47 lines · Cyril Hrubis

Add a simple and generic boolean expression parser and evaluator. This is a first step in order to implement more complex kconfig expressions, but since we are likely to reuse the parser for other purposes in the future it's implemented as a generic boolean parser.

---

v3:
- now we run tokenizer twice and count number of tokens in the first pass then allocate all the tokens in one malloc() which simplifies the code again a bit
- sligtly better formatting for error messages

 include/tst_bool_expr.h          |  86 +++++++
 lib/newlib_tests/.gitignore      |   1 +
 lib/newlib_tests/tst_bool_expr.c | 128 ++++++++++
 lib/tst_bool_expr.c              | 411 +++++++++++++++++++++++++++++++
 4 files changed, 626 insertions(+)
 create mode 100644 include/tst_bool_expr.h
 create mode 100644 lib/newlib_tests/tst_bool_expr.c
 create mode 100644 lib/tst_bool_expr.c
include/tst_bool_expr.h new file +18 -0
new file mode 100644
index 000000000..0e2fcc2e7
@@ -0,0 +1,86 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2020 Cyril Hrubis <[email protected]>
+ */
+
+#ifndef TST_BOOL_EXPR_H__
+#define TST_BOOL_EXPR_H__
+
+enum tst_op {
+	TST_OP_NOT,
+	TST_OP_AND,
+	TST_OP_OR,
+	TST_OP_VAR,
+	/* Used only internally */
+	TST_OP_LPAR,
+	TST_OP_RPAR,
+};
+

include/tst_bool_expr.h line 28

Quoted 10 lines
include/tst_bool_expr.h new file +10 -0
+struct tst_expr_tok {
+	enum tst_op op;
+	const char *tok;
+	size_t tok_len;
+	struct tst_expr_tok *next;
+	const void *priv;
+};
+
+struct tst_expr {
+	struct tst_expr_tok *expr;

Maybe call this 'first' or 'head'?

include/tst_bool_expr.h line 29

Quoted 1 line
include/tst_bool_expr.h new file +1 -0
+	struct tst_expr_tok *buf;

I suppose that buf could be a trailing array saving a call to malloc and free :-)

Quoted 506 lines
include/tst_bool_expr.h new file +57 -0
+};
+
+
+/*
+ * Parses an boolean expression and returns a simplified RPN version.
+ *
+ * If expression is not valid the call prints error into stderr and returns
+ * NULL. On success pointer to an expression is returned which can be evaluated
+ * by the tst_bool_expr_eval() function and has to be later freed by the
+ * caller.
+ *
+ * The boolean expression can consists of:
+ *
+ * - unary negation opeartion !
+ * - two binary operations & and |
+ * - correct sequence of parentheses ()
+ * - strings that are treated as boolean variables
+ *
+ *  e.g. '(A | B) & C' or 'Variable_1 & Variable_2' are both a valid boolean
+ *  expressions.
+ *
+ *  @expr String containing a boolean expression to be parsed.
+ *  @return Pointer to an RPN expression.
+ */
+struct tst_expr *tst_bool_expr_parse(const char *expr);
+
+/*
+ * Prints an string representation of the expression into a FILE.
+ *
+ * @param A FILE to print to.
+ * @expr An expression to print.
+ */
+void tst_bool_expr_print(FILE *f, struct tst_expr *expr);
+
+/*
+ * Evaluates an expression given a map for variables.
+ *
+ * The call will fail if:
+ * - map function returns -1 which indicates undefined variable
+ * - the eval function runs out of stack
+ *
+ * @param expr Boolean expression in RPN.
+ * @param map Mapping function for boolean variables.
+ *
+ * @return Returns 0 or 1 if expression was evaluated correctly and -1 on error.
+ */
+int tst_bool_expr_eval(struct tst_expr *expr,
+                       int (*map)(struct tst_expr_tok *var));
+
+/*
+ * Frees the memory allocated by the tst_bool_expr_parse().
+ *
+ * @param Boolean expression.
+ */
+void tst_bool_expr_free(struct tst_expr *expr);
+
+#endif	/* TST_BOOL_EXPR_H__ */
lib/newlib_tests/.gitignore +1 -0
index 44bc6526f..1e96db1da 100644
@@ -33,3 +33,4 @@ test_exec_child
 test_kconfig
 variant
 test_guarded_buf
+tst_bool_expr
lib/newlib_tests/tst_bool_expr.c new file +128 -0
new file mode 100644
index 000000000..f9bb1780d
@@ -0,0 +1,128 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2017 Cyril Hrubis <[email protected]>
+ */
+
+/*
+ * Basic unit test for the bolean expression parser and evaluator.
+ */
+
+#include <string.h>
+#include <stdio.h>
+#include "tst_test.h"
+#include "tst_bool_expr.h"
+
+static int a, b, c;
+
+static int map(struct tst_expr_tok *var)
+{
+	if (!strncmp(var->tok, "A", var->tok_len))
+		return a;
+
+	if (!strncmp(var->tok, "B", var->tok_len))
+		return b;
+
+	if (!strncmp(var->tok, "C", var->tok_len))
+		return c;
+
+	if (!strncmp(var->tok, "True", var->tok_len))
+		return 1;
+
+	if (!strncmp(var->tok, "False", var->tok_len))
+		return 0;
+
+	return -1;
+}
+
+static void parse_fail(const char *expr)
+{
+	struct tst_expr *res;
+
+	tst_res(TINFO, "Parsing '%s'", expr);
+
+	res = tst_bool_expr_parse(expr);
+
+	if (res) {
+		printf("In RPN: ");
+		tst_bool_expr_print(stdout, res);
+		printf("\n");
+		tst_bool_expr_free(res);
+		tst_res(TFAIL, "Expression was parsed");
+	} else {
+		tst_res(TPASS, "Parser returned an error");
+	}
+}
+
+static void do_eval_test(const char *expr_str, int set_a, int set_b, int set_c, int exp_res)
+{
+	struct tst_expr *expr;
+	int res;
+
+	a = set_a;
+	b = set_b;
+	c = set_c;
+
+	tst_res(TINFO, "'%s' A=%i B=%i C=%i == %i", expr_str, a, b, c, exp_res);
+
+	expr = tst_bool_expr_parse(expr_str);
+
+	if (!expr) {
+		tst_res(TFAIL, "Parser returned error");
+		return;
+	}
+
+	printf("In RPN: ");
+	tst_bool_expr_print(stdout, expr);
+	printf("\n");
+
+	res = tst_bool_expr_eval(expr, map);
+
+	if (res == exp_res)
+		tst_res(TPASS, "Got %i", res);
+	else
+		tst_res(TFAIL, "Got %i", res);
+
+	tst_bool_expr_free(expr);
+}
+
+static void do_test(void)
+{
+	do_eval_test("(A | B) & !!C", 0, 0, 0, 0);
+	do_eval_test("(A | B) & !!C", 1, 0, 1, 1);
+	do_eval_test("!A & B", 1, 0, 0, 0);
+	do_eval_test("!A & B", 0, 1, 0, 1);
+	do_eval_test("A & !B", 1, 0, 0, 1);
+	do_eval_test("!!A & !!B", 0, 1, 0, 0);
+	do_eval_test("!!A & !!B", 1, 1, 0, 1);
+	do_eval_test("!(A & B) & C", 1, 1, 0, 0);
+	do_eval_test("A & (B | C)", 1, 1, 0, 1);
+	do_eval_test("A & B | C", 1, 1, 0, 1);
+	do_eval_test("((((A)))&(B))", 1, 1, 0, 1);
+	do_eval_test("   A  \t", 0, 0, 0, 0);
+	do_eval_test("False & A", 1, 0, 0, 0);
+	do_eval_test("! Undefined", 0, 0, 0, -1);
+
+	parse_fail("A!");
+	parse_fail("A &");
+	parse_fail("A B");
+	parse_fail("A ) B");
+	parse_fail("A ( B");
+	parse_fail("A ( B )");
+	parse_fail("A |");
+	parse_fail("A ! B");
+	parse_fail("A! & B");
+	parse_fail("A & | B");
+	parse_fail("A & (B |)");
+	parse_fail("A & ( | B)");
+	parse_fail("A & B &");
+	parse_fail("((A )");
+	parse_fail("& A");
+	parse_fail("! &");
+	parse_fail(")");
+	parse_fail("| A");
+	parse_fail("");
+}
+
+static struct tst_test test = {
+	.test_all = do_test,
+};
lib/tst_bool_expr.c new file +300 -0
new file mode 100644
index 000000000..e4cab1474
@@ -0,0 +1,411 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2020 Cyril Hrubis <[email protected]>
+ */
+/*
+ * Boolean expression is evaluated in three steps.
+ *
+ * First of all the string containing the expression is tokenized. The
+ * tokenizer runs twice and we only count number of tokens in the first pass in
+ * order to simplify the memory allocation.
+ *
+ * Secondly the the expression is transformed to a postfix (RPN) notation by
+ * the shunting yard algorithm and the correctness of the expression is checked
+ * during the transformation as well. The fact that parenthesis are matched is
+ * asserted by the shunting yard algorithm itself while the rest is checked
+ * simply by checking if the preceding token is in a set of allowed tokens.
+ * This could be thought of as a simple open-coded state machine.
+ *
+ * An expression in the RPN form can be evaluated given a variable mapping
+ * function. The evaluation ignores most of errors because invalid expression
+ * will be rejected in the second step.
+ */
+
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include "tst_bool_expr.h"
+
+static int char_to_op(char c)
+{
+	switch (c) {
+	case '(':
+		return TST_OP_LPAR;
+	case ')':
+		return TST_OP_RPAR;
+	case '&':
+		return TST_OP_AND;
+	case '|':
+		return TST_OP_OR;
+	case '!':
+		return TST_OP_NOT;
+	default:
+		return TST_OP_VAR;
+	}
+}
+
+static int new_tok(struct tst_expr_tok **last, const char *tok, size_t tok_len)
+{
+	if (!tok_len)
+		return 0;
+
+	if (!(*last))
+		return 1;
+
+	(*last)->tok = tok;
+	(*last)->tok_len = tok_len;
+	(*last)->op = char_to_op(tok[0]);
+	(*last)++;
+
+	return 1;
+}
+
+static unsigned int tokenize(const char *expr, struct tst_expr *ret)
+{
+	size_t i, j;
+	unsigned int token_cnt = 0;
+	struct tst_expr_tok *last = ret ? ret->buf : NULL;
+
+	for (j = i = 0; expr[i]; i++) {
+		switch (expr[i]) {
+		case '(':
+		case ')':
+		case '!':
+		case '&':
+		case '|':
+			token_cnt += new_tok(&last, &expr[j], i - j);
+			token_cnt += new_tok(&last, &expr[i], 1);
+			j = i+1;
+		break;
+		case '\t':
+		case ' ':
+			token_cnt += new_tok(&last, &expr[j], i - j);
+			j = i+1;
+		break;
+		default:
+		break;
+		}
+	}
+
+	token_cnt += new_tok(&last, &expr[j], i - j);
+
+	return token_cnt;
+}
+
+void tst_bool_expr_print(FILE *f, struct tst_expr *expr)
+{
+	struct tst_expr_tok *i;
+	size_t j;
+
+	for (i = expr->expr; i; i = i->next) {
+		for (j = 0; j < i->tok_len; j++)
+			putc(i->tok[j], f);
+
+		if (i->next)
+			putc(' ', f);
+	}
+}
+
+static void print_spaces(FILE *f, unsigned int spaces)
+{
+	while (spaces--)
+		putc(' ', f);
+}
+
+static void tst_bool_expr_err(FILE *f, struct tst_expr *expr, unsigned int cnt)
+{
+	unsigned int i, spaces, err_len;
+	const char *err;
+
+	fprintf(f, "%s", expr->expr->tok);
+	fprintf(f, "\n");
+
+	for (i = 0; i < cnt; i++) {
+		if (expr->expr[i].priv)
+			break;
+	}
+
+	spaces = expr->expr[i].tok - expr->expr[0].tok;
+	err = expr->expr[i].priv;
+	err_len = strlen(err);
+
+	print_spaces(f, spaces);
+
+	fprintf(f, "^\n");
+
+	if (err_len < spaces)
+		print_spaces(f, spaces - err_len + 1);
+
+	fprintf(f, "%s\n", err);
+}
+
+static inline void stack_push(struct tst_expr_tok *stack[], unsigned int *op_stack_pos,
+                              struct tst_expr_tok *op)
+{
+	stack[(*op_stack_pos)++] = op;
+}
+
+static inline int stack_empty(unsigned int op_stack_pos)
+{
+	return op_stack_pos == 0;
+}
+
+static inline struct tst_expr_tok *stack_pop(struct tst_expr_tok *stack[],
+                                             unsigned int *op_stack_pos)
+{
+	if (stack_empty(*op_stack_pos))
+		return NULL;
+
+	return stack[--(*op_stack_pos)];
+}
+
+#define TST_OP_NONE -1
+
+static inline int stack_peek_op(struct tst_expr_tok *stack[],
+                                unsigned int op_stack_pos)
+{
+	if (stack_empty(op_stack_pos))
+		return TST_OP_NONE;
+
+	return stack[op_stack_pos - 1]->op;
+}
+
+/*
+ * This is a complete list of which tokens can happen before any of:
+ *  - variable
+ *  - left parentesis
+ *  - negation
+ *
+ * The -1 represents start of the expression.
+ */
+static inline int check_one(int op)
+{
+	switch (op) {
+	case TST_OP_AND:
+	case TST_OP_OR:
+	case TST_OP_NOT:
+	case TST_OP_NONE:
+	case TST_OP_LPAR:
+		return 0;
+	default:
+		return 1;
+	}
+}
+
+/*
+ * And this checks for tokens that can happen before any of:
+ * - right parentesis
+ * - and
+ * - or
+ *
+ * This is also used to check that the last token in expression is correct one.
+ */
+static inline int check_two(int op)
+{
+	switch (op) {
+	case TST_OP_VAR:
+	case TST_OP_RPAR:
+		return 1;
+	default:
+		return 0;
+	}
+}
+
+/*
+ * Note that we avoid modifying the list until the end so that the caller can
+ * free memory correctly, which is the reason we have a stack for parentesis
+ * that are just freed at the end.
+ */
+static int shunting_yard(struct tst_expr *expr, unsigned int cnt)
+{
+	struct tst_expr_tok *op_stack[cnt];
+	unsigned int op_stack_pos = 0;
+	struct tst_expr_tok *out[cnt + 1];
+	unsigned int out_pos = 0;
+	struct tst_expr_tok *i;
+	unsigned int j;
+	int prev_op = TST_OP_NONE;
+
+	for (i = expr->expr; i < &(expr->expr[cnt]); i++) {
+		switch (i->op) {
+		case TST_OP_VAR:
+			if (check_one(prev_op)) {
+				i->priv = "Expected operation";
+				goto err;
+			}
+
+			stack_push(out, &out_pos, i);
+
+			while (stack_peek_op(op_stack, op_stack_pos) == TST_OP_NOT)
+				stack_push(out, &out_pos, stack_pop(op_stack, &op_stack_pos));
+		break;
+		case TST_OP_LPAR:
+			if (check_one(prev_op)) {
+				i->priv = "Expected operation";
+				goto err;
+			}
+
+			stack_push(op_stack, &op_stack_pos, i);
+		break;
+		case TST_OP_RPAR:
+			if (!check_two(prev_op)) {
+				i->priv = "Expected variable or )";
+				goto err;
+			}
+
+			/* pop everything till ( */
+			for (;;) {
+				struct tst_expr_tok *op = stack_pop(op_stack, &op_stack_pos);
+
+				if (!op) {
+					i->priv = "Missing (";
+					goto err;
+				}
+
+				if (op->op == TST_OP_LPAR)
+					break;
+
+				stack_push(out, &out_pos, op);
+			}
+
+			while (stack_peek_op(op_stack, op_stack_pos) == TST_OP_NOT)
+				stack_push(out, &out_pos, stack_pop(op_stack, &op_stack_pos));
+		break;
+		case TST_OP_NOT:
+			if (check_one(prev_op)) {
+				i->priv = "Expected operation";
+				goto err;
+			}
+			stack_push(op_stack, &op_stack_pos, i);
+		break;
+		case TST_OP_AND:
+		case TST_OP_OR:
+			if (!check_two(prev_op)) {
+				i->priv = "Expected variable or (";
+				goto err;
+			}
+
+			/*
+			 * There can be at most one binary op on the stack
+			 * since we pop the one present on the stack before we
+			 * attempt to push new one they never accumulate.
+			 */
+			switch (stack_peek_op(op_stack, op_stack_pos)) {
+			case TST_OP_AND:
+			case TST_OP_OR:
+				stack_push(out, &out_pos, stack_pop(op_stack, &op_stack_pos));
+			break;
+			}
+
+			stack_push(op_stack, &op_stack_pos, i);

lib/tst_bool_expr.c line 310

Quoted 10 lines
lib/tst_bool_expr.c new file +10 -0
+		break;
+		}
+
+		prev_op = i->op;
+	}
+
+	if (!check_two(expr->buf[cnt-1].op)) {
+		expr->buf[cnt-1].priv = "Unfinished expression";
+		goto err;
+	}

This looks a bit odd as it is the only place you use buf like this. Why not only use buf until setting expr=out[0] (and only set buf=tok initially) or only use expr until free(expr->buf) and/or do --i and use that?

Quoted 103 lines
lib/tst_bool_expr.c new file +101 -0
+
+	/* pop remaining operations */
+	while ((i = stack_pop(op_stack, &op_stack_pos))) {
+		if (i->op == TST_OP_LPAR) {
+			i->priv = "Missing )";
+			goto err;
+		}
+
+		stack_push(out, &out_pos, i);
+	}
+
+	/* construct the list */
+	out[out_pos] = NULL;
+
+	for (j = 0; j < out_pos; j++)
+		out[j]->next = out[j + 1];
+
+	expr->expr = out[0];
+
+	return 0;
+err:
+	return 1;
+}
+
+struct tst_expr *tst_bool_expr_parse(const char *expr)
+{
+	struct tst_expr *ret;
+	struct tst_expr_tok *tok;
+	unsigned int tok_cnt = tokenize(expr, NULL);
+
+	if (!tok_cnt)
+		return NULL;
+
+	ret = malloc(sizeof(struct tst_expr));
+	tok = malloc(sizeof(struct tst_expr_tok) * tok_cnt);
+	if (!ret || !tok) {
+		free(ret);
+		free(tok);
+		return NULL;
+	}
+
+	ret->expr = ret->buf = tok;
+	tokenize(expr, ret);
+
+	if (shunting_yard(ret, tok_cnt)) {
+		tst_bool_expr_err(stderr, ret, tok_cnt);
+		tst_bool_expr_free(ret);
+		return NULL;
+	}
+
+	return ret;
+}
+
+#define MAX_STACK 16
+
+int tst_bool_expr_eval(struct tst_expr *expr,
+                       int (*map)(struct tst_expr_tok *var))
+{
+	struct tst_expr_tok *i;
+	int stack[MAX_STACK];
+	int pos = -1;
+
+	for (i = expr->expr; i; i = i->next) {
+		switch (i->op) {
+		case TST_OP_NOT:
+			stack[pos] = !stack[pos];
+		break;
+		case TST_OP_OR:
+			stack[pos-1] = stack[pos] || stack[pos-1];
+			pos--;
+		break;
+		case TST_OP_AND:
+			stack[pos-1] = stack[pos] && stack[pos-1];
+			pos--;
+		break;
+		case TST_OP_VAR:
+			if (pos + 1 >= MAX_STACK) {
+				fprintf(stderr, "Eval out of stack!\n");
+				return -1;
+			}
+
+			stack[++pos] = map(i);
+
+			/* map reported undefined variable -> abort */
+			if (stack[pos] == -1)
+				return -1;
+		break;
+		/* does not happen */
+		default:
+		break;
+		}
+	}
+
+	return stack[0];
+}
+
+void tst_bool_expr_free(struct tst_expr *expr)
+{
+	free(expr->buf);
+	free(expr);
+}
Signature · 1 line
2.26.2
Signature · 2 lines
Thank you,
Richard.
#3 lore raw

PATCH v3 1/2 lib: Add generic boolean expression parser and eval

Hi!

Quoted 9 lines

include/tst_bool_expr.h line 28

Quoted 2 lines
include/tst_bool_expr.h new file +2 -0
+struct tst_expr {
+	struct tst_expr_tok *expr;

Maybe call this 'first' or 'head'?

include/tst_bool_expr.h line 29

Quoted 1 line
include/tst_bool_expr.h new file +1 -0
+	struct tst_expr_tok *buf;

I suppose that buf could be a trailing array saving a call to malloc and free :-)

Good point I do not know how I missed the simplest solution here.

Quoted 9 lines

lib/tst_bool_expr.c line 310

Quoted 4 lines
lib/tst_bool_expr.c new file +4 -0
+	if (!check_two(expr->buf[cnt-1].op)) {
+		expr->buf[cnt-1].priv = "Unfinished expression";
+		goto err;
+	}

This looks a bit odd as it is the only place you use buf like this. Why not only use buf until setting expr=out[0] (and only set buf=tok initially) or only use expr until free(expr->buf) and/or do --i and use that?

I guess that makes sense. I will changed that anyways if I convert the structure to a trailing array.

Signature · 2 lines
Cyril Hrubis
[email protected]
#4 lore raw

PATCH v3 2/2 lib/tst_kconfig: Make use of boolean expression eval

In reply to Cyril Hrubis

Now each string in the kconfig[] array in tst_test structure is an boolean expression which is evaluated. All expressions has to be true in order for the test to continue.

This also makes the parser for the kernel config a bit more robust as it was pointed out that there may have been cases where it could be mislead by hand edited config files.

+ Update the docs.

---

v3:
- fix segfaults caused by off-by-one in the map() function
- fix the acct02 test, that uses the kconfig loader in setup()

 doc/test-writing-guidelines.txt         |  21 +-
 include/tst_kconfig.h                   |  34 +--
 lib/newlib_tests/.gitignore             |   1 +
 lib/newlib_tests/config06               |   1 +
 lib/newlib_tests/test_kconfig.c         |   2 +
 lib/newlib_tests/test_kconfig01.c       |  23 ++
 lib/tst_kconfig.c                       | 366 ++++++++++++++++--------
 testcases/kernel/syscalls/acct/acct02.c |  14 +-
 8 files changed, 307 insertions(+), 155 deletions(-)
 create mode 100644 lib/newlib_tests/config06
 create mode 100644 lib/newlib_tests/test_kconfig01.c
doc/test-writing-guidelines.txt +13 -8
index 1a51ef7c7..3c2ab7166 100644
@@ -1643,21 +1643,26 @@ on the system, disabled syscalls can be detected by checking for 'ENOSYS'
 errno etc.
 
 However in rare cases core kernel features couldn't be detected based on the
-kernel userspace API and we have to resort to kernel .config parsing.
+kernel userspace API and we have to resort to parse the kernel .config.
 
-For this cases the test should set the 'NULL' terminated '.needs_kconfigs' array
-of kernel config options required for the test. The config option can be
-specified either as plain "CONFIG_FOO" in which case it's sufficient for the
-test continue if it's set to any value (typically =y or =m). Or with a value
-as "CONFIG_FOO=bar" in which case the value has to match as well. The test is
-aborted with 'TCONF' if any of the required options were not set.
+For this cases the test should set the 'NULL' terminated '.needs_kconfigs'
+array of boolean expressions with constraints on the kconfig variables. The
+boolean expression consits of variables, two binary operations '&' and '|',
+negation '!' and correct sequence of parentesis '()'. Variables are expected
+to be in a form of "CONFIG_FOO[=bar]".
+
+The test will continue to run if all expressions are evaluated to 'True'.
+Missing variable is mapped to 'False' as well as variable with different than
+specified value, e.g. 'CONFIG_FOO=bar' will evaluate to 'False' if the value
+is anything else but 'bar'. If config variable is specified as plain
+'CONFIG_FOO' it's evaluated to true it's set to any value (typically =y or =m).
 
 [source,c]
 -------------------------------------------------------------------------------
 #include "tst_test.h"
 
 static const char *kconfigs[] = {
-	"CONFIG_X86_INTEL_UMIP",
+	"CONFIG_X86_INTEL_UMIP | CONFIG_X86_UMIP",
 	NULL
 };
 
include/tst_kconfig.h +18 -16
index 2d2cfd782..1bb21fea8 100644
@@ -6,27 +6,27 @@
 #ifndef TST_KCONFIG_H__
 #define TST_KCONFIG_H__
 
-struct tst_kconfig_res {
-	char match;
-	char *value;
+struct tst_kconfig_var {
+	char id[64];
+	unsigned int id_len;
+	char choice;
+	char *val;
 };
 
 /**
- * Reads a kernel config and parses it for values defined in kconfigs array.
+ *
+ * Reads a kernel config, parses it and writes results into an array of
+ * tst_kconfig_var structures.
  *
  * The path to the kernel config should be autodetected in most of the cases as
  * the code looks for know locations. It can be explicitely set/overrided with
  * the KCONFIG_PATH environment variable as well.
  *
- * The kcofings array is expected to contain strings in a format "CONFIG_FOO"
- * or "CONFIG_FOO=bar". The result array has to be suitably sized to fit the
- * results.
- *
- * @param kconfigs array of config strings to look for
- * @param results array to store results to
- * @param cnt size of the arrays
+ * The caller has to initialize the tst_kconfig_var structure. The id has to be
+ * filled with config variable name such as 'CONFIG_FOO', the id_len should
+ * hold the id string length and the choice and val has to be zeroed.
  *
- * The match in the tst_kconfig_res structure is set as follows:
+ * After a call to this function each choice be set as follows:
  *
  *  'm' - config option set to m
  *  'y' - config option set to y
@@ -34,11 +34,13 @@ struct tst_kconfig_res {
  *  'n' - config option is not set
  *   0  - config option not found
  *
- * In the case that match is set to 'v' the value points to a newly allocated
- * string that holds the value.
+ * In the case that match is set to 'v' the val pointer points to a newly
+ * allocated string that holds the value.
+ *
+ * @param vars An array of caller initalized tst_kconfig_var structures.
+ * @param vars_len Length of the vars array.
  */
-void tst_kconfig_read(const char *const kconfigs[],
-		      struct tst_kconfig_res results[], size_t cnt);
+void tst_kconfig_read(struct tst_kconfig_var vars[], size_t vars_len);
 
 /**
  * Checks if required kernel configuration options are set in the kernel
lib/newlib_tests/.gitignore +1 -0
index 1e96db1da..89de61cf7 100644
@@ -31,6 +31,7 @@ test_timer
 test_exec
 test_exec_child
 test_kconfig
+test_kconfig01
 variant
 test_guarded_buf
 tst_bool_expr
lib/newlib_tests/config06 new file +1 -0
new file mode 100644
index 000000000..b7db25411
@@ -0,0 +1 @@
+# Empty
lib/newlib_tests/test_kconfig.c +2 -0
index d9c662fc5..1f659b95a 100644
@@ -14,6 +14,8 @@ static const char *kconfigs[] = {
 	"CONFIG_MMU",
 	"CONFIG_EXT4_FS=m",
 	"CONFIG_PGTABLE_LEVELS=4",
+	"CONFIG_MMU & CONFIG_EXT4_FS=m",
+	"CONFIG_EXT4_FS=m | CONFIG_MMU",
 	NULL
 };
 
lib/newlib_tests/test_kconfig01.c new file +23 -0
new file mode 100644
index 000000000..ee919dcac
@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2020 Cyril Hrubis <[email protected]>
+ *
+ * Invalid boolean expression test.
+ */
+
+#include "tst_test.h"
+
+static void do_test(void)
+{
+	tst_res(TPASS, "Test passed!");
+}
+
+static const char *kconfigs[] = {
+	"CONFIG_EXT4_FS=m | CONFIG_MMU)",
+	NULL
+};
+
+static struct tst_test test = {
+	.test_all = do_test,
+	.needs_kconfigs = kconfigs,
+};
lib/tst_kconfig.c +241 -125

438 lines not on this page · raw message

testcases/kernel/syscalls/acct/acct02.c +8 -6
index 8ee1bfcf8..1bf6378db 100644
@@ -49,18 +49,20 @@ static union acct_union {
 	struct acct_v3	v3;
 } acct_struct;
 
+#define ACCT_V3 "CONFIG_BSD_PROCESS_ACCT_V3"
+
 static int acct_version_is_3(void)
 {
-	const char *kconfig_acct_v3[] = {
-		"CONFIG_BSD_PROCESS_ACCT_V3",
-		NULL
+	struct tst_kconfig_var kconfig = {
+		.id = ACCT_V3,
+		.id_len = sizeof(ACCT_V3)-1,
 	};
 
-	struct tst_kconfig_res results[1];
+	tst_kconfig_read(&kconfig, 1);
 
-	tst_kconfig_read(kconfig_acct_v3, results, 1);
+	tst_res(TINFO, ACCT_V3 "=%c", kconfig.choice);
 
-	return results[0].match == 'y';
+	return kconfig.choice == 'y';
 }
 
 static void run_command(void)
Signature · 1 line
2.26.2