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_file_alloc(const char *path, char **buf, size_t *len);
46 int read_long(const char *path, long *result, int base);
47 int write_long(const char *path, long result, int base);
48 int read_ulong(const char *path, unsigned long *result, int base);
49 int write_ulong(const char *path, unsigned long result, int base);
50 int read_debugfs_file(const char *debugfs_file, char *buf, size_t count);
51 int write_debugfs_file(const char *debugfs_file, const char *buf, size_t count);
52 int read_debugfs_int(const char *debugfs_file, int *result);
53 int write_debugfs_int(const char *debugfs_file, int result);
54 int read_sysfs_file(char *debugfs_file, char *result, size_t result_size);
55 int perf_event_open_counter(unsigned int type,
56 			    unsigned long config, int group_fd);
57 int perf_event_enable(int fd);
58 int perf_event_disable(int fd);
59 int perf_event_reset(int fd);
60 
61 struct perf_event_read {
62 	__u64 nr;
63 	__u64 l1d_misses;
64 };
65 
66 #if !defined(__GLIBC_PREREQ) || !__GLIBC_PREREQ(2, 30)
67 #include <unistd.h>
68 #include <sys/syscall.h>
69 
70 static inline pid_t gettid(void)
71 {
72 	return syscall(SYS_gettid);
73 }
74 #endif
75 
76 static inline bool have_hwcap(unsigned long ftr)
77 {
78 	return ((unsigned long)get_auxv_entry(AT_HWCAP) & ftr) == ftr;
79 }
80 
81 #ifdef AT_HWCAP2
82 static inline bool have_hwcap2(unsigned long ftr2)
83 {
84 	return ((unsigned long)get_auxv_entry(AT_HWCAP2) & ftr2) == ftr2;
85 }
86 #else
87 static inline bool have_hwcap2(unsigned long ftr2)
88 {
89 	return false;
90 }
91 #endif
92 
93 static inline char *auxv_base_platform(void)
94 {
95 	return ((char *)get_auxv_entry(AT_BASE_PLATFORM));
96 }
97 
98 static inline char *auxv_platform(void)
99 {
100 	return ((char *)get_auxv_entry(AT_PLATFORM));
101 }
102 
103 bool is_ppc64le(void);
104 int using_hash_mmu(bool *using_hash);
105 
106 /* Yes, this is evil */
107 #define FAIL_IF(x)						\
108 do {								\
109 	if ((x)) {						\
110 		fprintf(stderr,					\
111 		"[FAIL] Test FAILED on line %d\n", __LINE__);	\
112 		return 1;					\
113 	}							\
114 } while (0)
115 
116 #define FAIL_IF_EXIT(x)						\
117 do {								\
118 	if ((x)) {						\
119 		fprintf(stderr,					\
120 		"[FAIL] Test FAILED on line %d\n", __LINE__);	\
121 		_exit(1);					\
122 	}							\
123 } while (0)
124 
125 /* The test harness uses this, yes it's gross */
126 #define MAGIC_SKIP_RETURN_VALUE	99
127 
128 #define SKIP_IF(x)						\
129 do {								\
130 	if ((x)) {						\
131 		fprintf(stderr,					\
132 		"[SKIP] Test skipped on line %d\n", __LINE__);	\
133 		return MAGIC_SKIP_RETURN_VALUE;			\
134 	}							\
135 } while (0)
136 
137 #define SKIP_IF_MSG(x, msg)					\
138 do {								\
139 	if ((x)) {						\
140 		fprintf(stderr,					\
141 		"[SKIP] Test skipped on line %d: %s\n",		\
142 		 __LINE__, msg);				\
143 		return MAGIC_SKIP_RETURN_VALUE;			\
144 	}							\
145 } while (0)
146 
147 #define _str(s) #s
148 #define str(s) _str(s)
149 
150 #define sigsafe_err(msg)	({ \
151 		ssize_t nbytes __attribute__((unused)); \
152 		nbytes = write(STDERR_FILENO, msg, strlen(msg)); })
153 
154 /* POWER9 feature */
155 #ifndef PPC_FEATURE2_ARCH_3_00
156 #define PPC_FEATURE2_ARCH_3_00 0x00800000
157 #endif
158 
159 /* POWER10 feature */
160 #ifndef PPC_FEATURE2_ARCH_3_1
161 #define PPC_FEATURE2_ARCH_3_1 0x00040000
162 #endif
163 
164 /* POWER10 features */
165 #ifndef PPC_FEATURE2_MMA
166 #define PPC_FEATURE2_MMA 0x00020000
167 #endif
168 
169 #if defined(__powerpc64__)
170 #define UCONTEXT_NIA(UC)	(UC)->uc_mcontext.gp_regs[PT_NIP]
171 #define UCONTEXT_MSR(UC)	(UC)->uc_mcontext.gp_regs[PT_MSR]
172 #elif defined(__powerpc__)
173 #define UCONTEXT_NIA(UC)	(UC)->uc_mcontext.uc_regs->gregs[PT_NIP]
174 #define UCONTEXT_MSR(UC)	(UC)->uc_mcontext.uc_regs->gregs[PT_MSR]
175 #else
176 #error implement UCONTEXT_NIA
177 #endif
178 
179 #endif /* _SELFTESTS_POWERPC_UTILS_H */
180