2 * arch/arm/probes/kprobes/test-core.h
4 * Copyright (C) 2011 Jon Medhurst <tixy@yxit.co.uk>.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #define VERBOSE 0 /* Set to '1' for more logging of test cases */
13 #ifdef CONFIG_THUMB2_KERNEL
14 #define NORMAL_ISA "16"
16 #define NORMAL_ISA "32"
20 /* Flags used in kprobe_test_flags */
21 #define TEST_FLAG_NO_ITBLOCK (1<<0)
22 #define TEST_FLAG_FULL_ITBLOCK (1<<1)
23 #define TEST_FLAG_NARROW_INSTR (1<<2)
25 extern int kprobe_test_flags
;
26 extern int kprobe_test_cc_position
;
29 #define TEST_MEMORY_SIZE 256
33 * Test case structures.
35 * The arguments given to test cases can be one of three types.
38 * Load a register with the given value.
41 * Load a register with a pointer into the stack buffer (SP + given value).
44 * Store the given value into the stack buffer at [SP+index].
48 #define ARG_TYPE_END 0
49 #define ARG_TYPE_REG 1
50 #define ARG_TYPE_PTR 2
51 #define ARG_TYPE_MEM 3
52 #define ARG_TYPE_REG_MASKED 4
54 #define ARG_FLAG_UNSUPPORTED 0x01
55 #define ARG_FLAG_SUPPORTED 0x02
56 #define ARG_FLAG_THUMB 0x10 /* Must be 16 so TEST_ISA can be used */
57 #define ARG_FLAG_ARM 0x20 /* Must be 32 so TEST_ISA can be used */
60 u8 type
; /* ARG_TYPE_x */
64 struct test_arg_regptr
{
65 u8 type
; /* ARG_TYPE_REG or ARG_TYPE_PTR or ARG_TYPE_REG_MASKED */
72 u8 type
; /* ARG_TYPE_MEM */
79 u8 type
; /* ARG_TYPE_END */
80 u8 flags
; /* ARG_FLAG_x */
88 * Building blocks for test cases.
90 * Each test case is wrapped between TESTCASE_START and TESTCASE_END.
92 * To specify arguments for a test case the TEST_ARG_{REG,PTR,MEM} macros are
93 * used followed by a terminating TEST_ARG_END.
95 * After this, the instruction to be tested is defined with TEST_INSTRUCTION.
96 * Or for branches, TEST_BRANCH_B and TEST_BRANCH_F (branch forwards/backwards).
98 * Some specific test cases may make use of other custom constructs.
102 #define verbose(fmt, ...) pr_info(fmt, ##__VA_ARGS__)
104 #define verbose(fmt, ...)
107 #define TEST_GROUP(title) \
109 verbose(title"\n"); \
110 verbose("---------------------------------------------------------\n");
112 #define TESTCASE_START(title) \
113 __asm__ __volatile__ ( \
114 "bl __kprobes_test_case_start \n\t" \
115 ".pushsection .rodata \n\t" \
117 /* don't use .asciz here as 'title' may be */ \
118 /* multiple strings to be concatenated. */ \
119 ".ascii "#title" \n\t" \
124 #define TEST_ARG_REG(reg, val) \
125 ".byte "__stringify(ARG_TYPE_REG)" \n\t" \
126 ".byte "#reg" \n\t" \
130 #define TEST_ARG_PTR(reg, val) \
131 ".byte "__stringify(ARG_TYPE_PTR)" \n\t" \
132 ".byte "#reg" \n\t" \
136 #define TEST_ARG_MEM(index, val) \
137 ".byte "__stringify(ARG_TYPE_MEM)" \n\t" \
138 ".byte "#index" \n\t" \
142 #define TEST_ARG_REG_MASKED(reg, val) \
143 ".byte "__stringify(ARG_TYPE_REG_MASKED)" \n\t" \
144 ".byte "#reg" \n\t" \
148 #define TEST_ARG_END(flags) \
149 ".byte "__stringify(ARG_TYPE_END)" \n\t" \
150 ".byte "TEST_ISA flags" \n\t" \
151 ".short 50f-0f \n\t" \
152 ".short 2f-0f \n\t" \
153 ".short 99f-0f \n\t" \
154 ".code "TEST_ISA" \n\t" \
157 #define TEST_INSTRUCTION(instruction) \
159 "1: "instruction" \n\t" \
162 #define TEST_BRANCH_F(instruction) \
163 TEST_INSTRUCTION(instruction) \
167 #define TEST_BRANCH_B(instruction) \
172 TEST_INSTRUCTION(instruction)
174 #define TEST_BRANCH_FX(instruction, codex) \
175 TEST_INSTRUCTION(instruction) \
181 #define TEST_BRANCH_BX(instruction, codex) \
187 TEST_INSTRUCTION(instruction)
189 #define TESTCASE_END \
192 " bl __kprobes_test_case_end_"TEST_ISA" \n\t" \
193 ".code "NORMAL_ISA" \n\t" \
195 : "r0", "r1", "r2", "r3", "ip", "lr", "memory", "cc" \
200 * Macros to define test cases.
202 * Those of the form TEST_{R,P,M}* can be used to define test cases
203 * which take combinations of the three basic types of arguments. E.g.
205 * TEST_R One register argument
206 * TEST_RR Two register arguments
207 * TEST_RPR A register, a pointer, then a register argument
209 * For testing instructions which may branch, there are macros TEST_BF_*
210 * and TEST_BB_* for branching forwards and backwards.
212 * TEST_SUPPORTED and TEST_UNSUPPORTED don't cause the code to be executed,
213 * the just verify that a kprobe is or is not allowed on the given instruction.
217 TESTCASE_START(code) \
219 TEST_INSTRUCTION(code) \
222 #define TEST_UNSUPPORTED(code) \
223 TESTCASE_START(code) \
224 TEST_ARG_END("|"__stringify(ARG_FLAG_UNSUPPORTED)) \
225 TEST_INSTRUCTION(code) \
228 #define TEST_SUPPORTED(code) \
229 TESTCASE_START(code) \
230 TEST_ARG_END("|"__stringify(ARG_FLAG_SUPPORTED)) \
231 TEST_INSTRUCTION(code) \
234 #define TEST_R(code1, reg, val, code2) \
235 TESTCASE_START(code1 #reg code2) \
236 TEST_ARG_REG(reg, val) \
238 TEST_INSTRUCTION(code1 #reg code2) \
241 #define TEST_RR(code1, reg1, val1, code2, reg2, val2, code3) \
242 TESTCASE_START(code1 #reg1 code2 #reg2 code3) \
243 TEST_ARG_REG(reg1, val1) \
244 TEST_ARG_REG(reg2, val2) \
246 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3) \
249 #define TEST_RRR(code1, reg1, val1, code2, reg2, val2, code3, reg3, val3, code4)\
250 TESTCASE_START(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
251 TEST_ARG_REG(reg1, val1) \
252 TEST_ARG_REG(reg2, val2) \
253 TEST_ARG_REG(reg3, val3) \
255 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
258 #define TEST_RRRR(code1, reg1, val1, code2, reg2, val2, code3, reg3, val3, code4, reg4, val4) \
259 TESTCASE_START(code1 #reg1 code2 #reg2 code3 #reg3 code4 #reg4) \
260 TEST_ARG_REG(reg1, val1) \
261 TEST_ARG_REG(reg2, val2) \
262 TEST_ARG_REG(reg3, val3) \
263 TEST_ARG_REG(reg4, val4) \
265 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3 #reg3 code4 #reg4) \
268 #define TEST_P(code1, reg1, val1, code2) \
269 TESTCASE_START(code1 #reg1 code2) \
270 TEST_ARG_PTR(reg1, val1) \
272 TEST_INSTRUCTION(code1 #reg1 code2) \
275 #define TEST_PR(code1, reg1, val1, code2, reg2, val2, code3) \
276 TESTCASE_START(code1 #reg1 code2 #reg2 code3) \
277 TEST_ARG_PTR(reg1, val1) \
278 TEST_ARG_REG(reg2, val2) \
280 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3) \
283 #define TEST_RP(code1, reg1, val1, code2, reg2, val2, code3) \
284 TESTCASE_START(code1 #reg1 code2 #reg2 code3) \
285 TEST_ARG_REG(reg1, val1) \
286 TEST_ARG_PTR(reg2, val2) \
288 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3) \
291 #define TEST_PRR(code1, reg1, val1, code2, reg2, val2, code3, reg3, val3, code4)\
292 TESTCASE_START(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
293 TEST_ARG_PTR(reg1, val1) \
294 TEST_ARG_REG(reg2, val2) \
295 TEST_ARG_REG(reg3, val3) \
297 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
300 #define TEST_RPR(code1, reg1, val1, code2, reg2, val2, code3, reg3, val3, code4)\
301 TESTCASE_START(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
302 TEST_ARG_REG(reg1, val1) \
303 TEST_ARG_PTR(reg2, val2) \
304 TEST_ARG_REG(reg3, val3) \
306 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
309 #define TEST_RRP(code1, reg1, val1, code2, reg2, val2, code3, reg3, val3, code4)\
310 TESTCASE_START(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
311 TEST_ARG_REG(reg1, val1) \
312 TEST_ARG_REG(reg2, val2) \
313 TEST_ARG_PTR(reg3, val3) \
315 TEST_INSTRUCTION(code1 #reg1 code2 #reg2 code3 #reg3 code4) \
318 #define TEST_BF_P(code1, reg1, val1, code2) \
319 TESTCASE_START(code1 #reg1 code2) \
320 TEST_ARG_PTR(reg1, val1) \
322 TEST_BRANCH_F(code1 #reg1 code2) \
325 #define TEST_BF(code) \
326 TESTCASE_START(code) \
328 TEST_BRANCH_F(code) \
331 #define TEST_BB(code) \
332 TESTCASE_START(code) \
334 TEST_BRANCH_B(code) \
337 #define TEST_BF_R(code1, reg, val, code2) \
338 TESTCASE_START(code1 #reg code2) \
339 TEST_ARG_REG(reg, val) \
341 TEST_BRANCH_F(code1 #reg code2) \
344 #define TEST_BB_R(code1, reg, val, code2) \
345 TESTCASE_START(code1 #reg code2) \
346 TEST_ARG_REG(reg, val) \
348 TEST_BRANCH_B(code1 #reg code2) \
351 #define TEST_BF_RR(code1, reg1, val1, code2, reg2, val2, code3) \
352 TESTCASE_START(code1 #reg1 code2 #reg2 code3) \
353 TEST_ARG_REG(reg1, val1) \
354 TEST_ARG_REG(reg2, val2) \
356 TEST_BRANCH_F(code1 #reg1 code2 #reg2 code3) \
359 #define TEST_BF_X(code, codex) \
360 TESTCASE_START(code) \
362 TEST_BRANCH_FX(code, codex) \
365 #define TEST_BB_X(code, codex) \
366 TESTCASE_START(code) \
368 TEST_BRANCH_BX(code, codex) \
371 #define TEST_BF_RX(code1, reg, val, code2, codex) \
372 TESTCASE_START(code1 #reg code2) \
373 TEST_ARG_REG(reg, val) \
375 TEST_BRANCH_FX(code1 #reg code2, codex) \
378 #define TEST_X(code, codex) \
379 TESTCASE_START(code) \
381 TEST_INSTRUCTION(code) \
386 #define TEST_RX(code1, reg, val, code2, codex) \
387 TESTCASE_START(code1 #reg code2) \
388 TEST_ARG_REG(reg, val) \
390 TEST_INSTRUCTION(code1 __stringify(reg) code2) \
395 #define TEST_RRX(code1, reg1, val1, code2, reg2, val2, code3, codex) \
396 TESTCASE_START(code1 #reg1 code2 #reg2 code3) \
397 TEST_ARG_REG(reg1, val1) \
398 TEST_ARG_REG(reg2, val2) \
400 TEST_INSTRUCTION(code1 __stringify(reg1) code2 __stringify(reg2) code3) \
405 #define TEST_RMASKED(code1, reg, mask, code2) \
406 TESTCASE_START(code1 #reg code2) \
407 TEST_ARG_REG_MASKED(reg, mask) \
409 TEST_INSTRUCTION(code1 #reg code2) \
413 * We ignore the state of the imprecise abort disable flag (CPSR.A) because this
414 * can change randomly as the kernel doesn't take care to preserve or initialise
415 * this across context switches. Also, with Security Extensions, the flag may
416 * not be under control of the kernel; for this reason we ignore the state of
417 * the FIQ disable flag CPSR.F as well.
419 #define PSR_IGNORE_BITS (PSR_A_BIT | PSR_F_BIT)
423 * Macros for defining space directives spread over multiple lines.
424 * These are required so the compiler guesses better the length of inline asm
425 * code and will spill the literal pool early enough to avoid generating PC
426 * relative loads with out of range offsets.
429 #define SPACE_0x8 TWICE(".space 4\n\t")
430 #define SPACE_0x10 TWICE(SPACE_0x8)
431 #define SPACE_0x20 TWICE(SPACE_0x10)
432 #define SPACE_0x40 TWICE(SPACE_0x20)
433 #define SPACE_0x80 TWICE(SPACE_0x40)
434 #define SPACE_0x100 TWICE(SPACE_0x80)
435 #define SPACE_0x200 TWICE(SPACE_0x100)
436 #define SPACE_0x400 TWICE(SPACE_0x200)
437 #define SPACE_0x800 TWICE(SPACE_0x400)
438 #define SPACE_0x1000 TWICE(SPACE_0x800)
441 /* Various values used in test cases... */
442 #define N(val) (val ^ 0xffffffff)
443 #define VAL1 0x12345678
445 #define VAL3 0xa5f801
447 #define VALM 0x456789ab
448 #define VALR 0xdeaddead
449 #define HH1 0x0123fecb
450 #define HH2 0xa9874567
453 #ifdef CONFIG_THUMB2_KERNEL
454 void kprobe_thumb16_test_cases(void);
455 void kprobe_thumb32_test_cases(void);
457 void kprobe_arm_test_cases(void);