xref: /linux/tools/testing/selftests/powerpc/include/utils.h (revision d1bc05b7bf02f8635fe6c445f67d78f85234cbb7)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright 2013, Michael Ellerman, IBM Corp.
4  */
5 
6 #ifndef _SELFTESTS_POWERPC_UTILS_H
7 #define _SELFTESTS_POWERPC_UTILS_H
8 
9 #define __cacheline_aligned __attribute__((aligned(128)))
10 
11 #include <stdint.h>
12 #include <stdbool.h>
13 #include <linux/auxvec.h>
14 #include <linux/perf_event.h>
15 #include <asm/cputable.h>
16 #include "reg.h"
17 
18 /* Avoid headaches with PRI?64 - just use %ll? always */
19 typedef unsigned long long u64;
20 typedef   signed long long s64;
21 
22 /* Just for familiarity */
23 typedef uint32_t u32;
24 typedef uint16_t u16;
25 typedef uint8_t u8;
26 
27 void test_harness_set_timeout(uint64_t time);
28 int test_harness(int (test_function)(void), char *name);
29 
30 int read_auxv(char *buf, ssize_t buf_size);
31 void *find_auxv_entry(int type, char *auxv);
32 void *get_auxv_entry(int type);
33 
34 int pick_online_cpu(void);
35 
36 int parse_intmax(const char *buffer, size_t count, intmax_t *result, int base);
37 int parse_uintmax(const char *buffer, size_t count, uintmax_t *result, int base);
38 int parse_int(const char *buffer, size_t count, int *result, int base);
39 int parse_uint(const char *buffer, size_t count, unsigned int *result, int base);
40 int parse_long(const char *buffer, size_t count, long *result, int base);
41 int parse_ulong(const char *buffer, size_t count, unsigned long *result, int base);
42 
43 int read_file(const char *path, char *buf, size_t count, size_t *len);
44 int write_file(const char *path, const char *buf, size_t count);
45 int read_debugfs_file(const char *debugfs_file, char *buf, size_t count);
46 int write_debugfs_file(const char *debugfs_file, const char *buf, size_t count);
47 int read_debugfs_int(const char *debugfs_file, int *result);
48 int write_debugfs_int(const char *debugfs_file, int result);
49 int read_sysfs_file(char *debugfs_file, char *result, size_t result_size);
50 int perf_event_open_counter(unsigned int type,
51 			    unsigned long config, int group_fd);
52 int perf_event_enable(int fd);
53 int perf_event_disable(int fd);
54 int perf_event_reset(int fd);
55 
56 struct perf_event_read {
57 	__u64 nr;
58 	__u64 l1d_misses;
59 };
60 
61 #if !defined(__GLIBC_PREREQ) || !__GLIBC_PREREQ(2, 30)
62 #include <unistd.h>
63 #include <sys/syscall.h>
64 
65 static inline pid_t gettid(void)
66 {
67 	return syscall(SYS_gettid);
68 }
69 #endif
70 
71 static inline bool have_hwcap(unsigned long ftr)
72 {
73 	return ((unsigned long)get_auxv_entry(AT_HWCAP) & ftr) == ftr;
74 }
75 
76 #ifdef AT_HWCAP2
77 static inline bool have_hwcap2(unsigned long ftr2)
78 {
79 	return ((unsigned long)get_auxv_entry(AT_HWCAP2) & ftr2) == ftr2;
80 }
81 #else
82 static inline bool have_hwcap2(unsigned long ftr2)
83 {
84 	return false;
85 }
86 #endif
87 
88 static inline char *auxv_base_platform(void)
89 {
90 	return ((char *)get_auxv_entry(AT_BASE_PLATFORM));
91 }
92 
93 static inline char *auxv_platform(void)
94 {
95 	return ((char *)get_auxv_entry(AT_PLATFORM));
96 }
97 
98 bool is_ppc64le(void);
99 int using_hash_mmu(bool *using_hash);
100 
101 /* Yes, this is evil */
102 #define FAIL_IF(x)						\
103 do {								\
104 	if ((x)) {						\
105 		fprintf(stderr,					\
106 		"[FAIL] Test FAILED on line %d\n", __LINE__);	\
107 		return 1;					\
108 	}							\
109 } while (0)
110 
111 #define FAIL_IF_EXIT(x)						\
112 do {								\
113 	if ((x)) {						\
114 		fprintf(stderr,					\
115 		"[FAIL] Test FAILED on line %d\n", __LINE__);	\
116 		_exit(1);					\
117 	}							\
118 } while (0)
119 
120 /* The test harness uses this, yes it's gross */
121 #define MAGIC_SKIP_RETURN_VALUE	99
122 
123 #define SKIP_IF(x)						\
124 do {								\
125 	if ((x)) {						\
126 		fprintf(stderr,					\
127 		"[SKIP] Test skipped on line %d\n", __LINE__);	\
128 		return MAGIC_SKIP_RETURN_VALUE;			\
129 	}							\
130 } while (0)
131 
132 #define SKIP_IF_MSG(x, msg)					\
133 do {								\
134 	if ((x)) {						\
135 		fprintf(stderr,					\
136 		"[SKIP] Test skipped on line %d: %s\n",		\
137 		 __LINE__, msg);				\
138 		return MAGIC_SKIP_RETURN_VALUE;			\
139 	}							\
140 } while (0)
141 
142 #define _str(s) #s
143 #define str(s) _str(s)
144 
145 #define sigsafe_err(msg)	({ \
146 		ssize_t nbytes __attribute__((unused)); \
147 		nbytes = write(STDERR_FILENO, msg, strlen(msg)); })
148 
149 /* POWER9 feature */
150 #ifndef PPC_FEATURE2_ARCH_3_00
151 #define PPC_FEATURE2_ARCH_3_00 0x00800000
152 #endif
153 
154 /* POWER10 feature */
155 #ifndef PPC_FEATURE2_ARCH_3_1
156 #define PPC_FEATURE2_ARCH_3_1 0x00040000
157 #endif
158 
159 /* POWER10 features */
160 #ifndef PPC_FEATURE2_MMA
161 #define PPC_FEATURE2_MMA 0x00020000
162 #endif
163 
164 #if defined(__powerpc64__)
165 #define UCONTEXT_NIA(UC)	(UC)->uc_mcontext.gp_regs[PT_NIP]
166 #define UCONTEXT_MSR(UC)	(UC)->uc_mcontext.gp_regs[PT_MSR]
167 #elif defined(__powerpc__)
168 #define UCONTEXT_NIA(UC)	(UC)->uc_mcontext.uc_regs->gregs[PT_NIP]
169 #define UCONTEXT_MSR(UC)	(UC)->uc_mcontext.uc_regs->gregs[PT_MSR]
170 #else
171 #error implement UCONTEXT_NIA
172 #endif
173 
174 #endif /* _SELFTESTS_POWERPC_UTILS_H */
175