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