test_static_keys.c 6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
/*
 * Kernel module for testing static keys.
 *
 * Copyright 2015 Akamai Technologies Inc. All Rights Reserved
 *
 * Authors:
 *      Jason Baron       <jbaron@akamai.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/module.h>
#include <linux/jump_label.h>

/* old keys */
struct static_key old_true_key	= STATIC_KEY_INIT_TRUE;
struct static_key old_false_key	= STATIC_KEY_INIT_FALSE;

/* new api */
DEFINE_STATIC_KEY_TRUE(true_key);
DEFINE_STATIC_KEY_FALSE(false_key);

/* external */
extern struct static_key base_old_true_key;
extern struct static_key base_inv_old_true_key;
extern struct static_key base_old_false_key;
extern struct static_key base_inv_old_false_key;

/* new api */
extern struct static_key_true base_true_key;
extern struct static_key_true base_inv_true_key;
extern struct static_key_false base_false_key;
extern struct static_key_false base_inv_false_key;


struct test_key {
	bool			init_state;
	struct static_key	*key;
	bool			(*test_key)(void);
};

49 50 51 52 53
#define test_key_func(key, branch)	\
static bool key ## _ ## branch(void)	\
{					\
	return branch(&key);		\
}
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

static void invert_key(struct static_key *key)
{
	if (static_key_enabled(key))
		static_key_disable(key);
	else
		static_key_enable(key);
}

static void invert_keys(struct test_key *keys, int size)
{
	struct static_key *previous = NULL;
	int i;

	for (i = 0; i < size; i++) {
		if (previous != keys[i].key) {
			invert_key(keys[i].key);
			previous = keys[i].key;
		}
	}
}

76
static int verify_keys(struct test_key *keys, int size, bool invert)
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
{
	int i;
	bool ret, init;

	for (i = 0; i < size; i++) {
		ret = static_key_enabled(keys[i].key);
		init = keys[i].init_state;
		if (ret != (invert ? !init : init))
			return -EINVAL;
		ret = keys[i].test_key();
		if (static_key_enabled(keys[i].key)) {
			if (!ret)
				return -EINVAL;
		} else {
			if (ret)
				return -EINVAL;
		}
	}
	return 0;
}

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
test_key_func(old_true_key, static_key_true)
test_key_func(old_false_key, static_key_false)
test_key_func(true_key, static_branch_likely)
test_key_func(true_key, static_branch_unlikely)
test_key_func(false_key, static_branch_likely)
test_key_func(false_key, static_branch_unlikely)
test_key_func(base_old_true_key, static_key_true)
test_key_func(base_inv_old_true_key, static_key_true)
test_key_func(base_old_false_key, static_key_false)
test_key_func(base_inv_old_false_key, static_key_false)
test_key_func(base_true_key, static_branch_likely)
test_key_func(base_true_key, static_branch_unlikely)
test_key_func(base_inv_true_key, static_branch_likely)
test_key_func(base_inv_true_key, static_branch_unlikely)
test_key_func(base_false_key, static_branch_likely)
test_key_func(base_false_key, static_branch_unlikely)
test_key_func(base_inv_false_key, static_branch_likely)
test_key_func(base_inv_false_key, static_branch_unlikely)

117 118 119 120 121 122 123 124 125 126
static int __init test_static_key_init(void)
{
	int ret;
	int size;

	struct test_key static_key_tests[] = {
		/* internal keys - old keys */
		{
			.init_state	= true,
			.key		= &old_true_key,
127
			.test_key	= &old_true_key_static_key_true,
128 129 130 131
		},
		{
			.init_state	= false,
			.key		= &old_false_key,
132
			.test_key	= &old_false_key_static_key_false,
133 134 135 136 137
		},
		/* internal keys - new keys */
		{
			.init_state	= true,
			.key		= &true_key.key,
138
			.test_key	= &true_key_static_branch_likely,
139 140 141 142
		},
		{
			.init_state	= true,
			.key		= &true_key.key,
143
			.test_key	= &true_key_static_branch_unlikely,
144 145 146 147
		},
		{
			.init_state	= false,
			.key		= &false_key.key,
148
			.test_key	= &false_key_static_branch_likely,
149 150 151 152
		},
		{
			.init_state	= false,
			.key		= &false_key.key,
153
			.test_key	= &false_key_static_branch_unlikely,
154 155 156 157 158
		},
		/* external keys - old keys */
		{
			.init_state	= true,
			.key		= &base_old_true_key,
159
			.test_key	= &base_old_true_key_static_key_true,
160 161 162 163
		},
		{
			.init_state	= false,
			.key		= &base_inv_old_true_key,
164
			.test_key	= &base_inv_old_true_key_static_key_true,
165 166 167 168
		},
		{
			.init_state	= false,
			.key		= &base_old_false_key,
169
			.test_key	= &base_old_false_key_static_key_false,
170 171 172 173
		},
		{
			.init_state	= true,
			.key		= &base_inv_old_false_key,
174
			.test_key	= &base_inv_old_false_key_static_key_false,
175 176 177 178 179
		},
		/* external keys - new keys */
		{
			.init_state	= true,
			.key		= &base_true_key.key,
180
			.test_key	= &base_true_key_static_branch_likely,
181 182 183 184
		},
		{
			.init_state	= true,
			.key		= &base_true_key.key,
185
			.test_key	= &base_true_key_static_branch_unlikely,
186 187 188 189
		},
		{
			.init_state	= false,
			.key		= &base_inv_true_key.key,
190
			.test_key	= &base_inv_true_key_static_branch_likely,
191 192 193 194
		},
		{
			.init_state	= false,
			.key		= &base_inv_true_key.key,
195
			.test_key	= &base_inv_true_key_static_branch_unlikely,
196 197 198 199
		},
		{
			.init_state	= false,
			.key		= &base_false_key.key,
200
			.test_key	= &base_false_key_static_branch_likely,
201 202 203 204
		},
		{
			.init_state	= false,
			.key		= &base_false_key.key,
205
			.test_key	= &base_false_key_static_branch_unlikely,
206 207 208 209
		},
		{
			.init_state	= true,
			.key		= &base_inv_false_key.key,
210
			.test_key	= &base_inv_false_key_static_branch_likely,
211 212 213 214
		},
		{
			.init_state	= true,
			.key		= &base_inv_false_key.key,
215
			.test_key	= &base_inv_false_key_static_branch_unlikely,
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
		},
	};

	size = ARRAY_SIZE(static_key_tests);

	ret = verify_keys(static_key_tests, size, false);
	if (ret)
		goto out;

	invert_keys(static_key_tests, size);
	ret = verify_keys(static_key_tests, size, true);
	if (ret)
		goto out;

	invert_keys(static_key_tests, size);
	ret = verify_keys(static_key_tests, size, false);
	if (ret)
		goto out;
	return 0;
out:
	return ret;
}

static void __exit test_static_key_exit(void)
{
}

module_init(test_static_key_init);
module_exit(test_static_key_exit);

MODULE_AUTHOR("Jason Baron <jbaron@akamai.com>");
MODULE_LICENSE("GPL");