igt_aux.h 9.64 KB
Newer Older
1
/*
2
 * Copyright © 2014, 2015 Intel Corporation
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
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * Authors:
 *    Daniel Vetter <daniel.vetter@ffwll.ch>
 *
 */

#ifndef IGT_AUX_H
#define IGT_AUX_H

31
#include <inttypes.h>
32
#include <stdbool.h>
33
#include <stddef.h>
Paulo Zanoni's avatar
Paulo Zanoni committed
34
#include <sys/time.h>
35

36 37
#include <i915/gem_submission.h>

38 39 40 41
/* signal interrupt helpers */
#define gettid() syscall(__NR_gettid)
#define sigev_notify_thread_id _sigev_un._tid

42 43 44 45
/* auxialiary igt helpers from igt_aux.c */
/* generally useful helpers */
void igt_fork_signal_helper(void);
void igt_stop_signal_helper(void);
46 47
void igt_suspend_signal_helper(void);
void igt_resume_signal_helper(void);
48

49
void igt_fork_shrink_helper(int fd);
50 51
void igt_stop_shrink_helper(void);

52 53 54
void igt_fork_hang_detector(int fd);
void igt_stop_hang_detector(void);

55
struct __igt_sigiter {
56 57 58
	unsigned pass;
};

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
bool __igt_sigiter_continue(struct __igt_sigiter *iter, bool interrupt);

/**
 * igt_while_interruptible:
 * @enable: enable igt_ioctl interrupting or not
 *
 * Provides control flow such that all drmIoctl() (strictly igt_ioctl())
 * within the loop are forcibly injected with signals (SIGRTMIN).
 *
 * This is useful to exercise ioctl error paths, at least where those can be
 * exercises by interrupting blocking waits, like stalling for the gpu.
 *
 * The code block attached to this macro is run in a loop with doubling the
 * interrupt timeout on each ioctl for every run, until no ioctl gets
 * interrupted any more. The starting timeout is taken to be the signal delivery
 * latency, measured at runtime. This way the any ioctls called from this code
 * block should be exhaustively tested for all signal interruption paths.
 *
 * Note that since this overloads the igt_ioctl(), this method is not useful
 * for widespread signal injection, for example providing coverage of
 * pagefaults. To interrupt everything, see igt_fork_signal_helper().
 */
#define igt_while_interruptible(enable) \
	for (struct __igt_sigiter iter__={}; __igt_sigiter_continue(&iter__, (enable)); )
83

84 85 86 87 88 89 90 91 92 93 94 95
/**
 * igt_until_timeout:
 * @timeout: timeout in seconds
 *
 * Convenience macro loop to run the provided code block in a loop until the
 * timeout has expired. Of course when an individual execution takes too long,
 * the actual execution time could be a lot longer.
 *
 * The code block will be executed at least once.
 */
#define igt_until_timeout(timeout) \
	for (struct timespec t__={}; igt_seconds_elapsed(&t__) < (timeout); )
96

97 98 99 100 101 102 103 104 105 106 107 108 109
/**
 * igt_for_milliseconds:
 * @time: how long to run the loop in milliseconds
 *
 * Convenience macro loop to run the provided code block in a loop until the
 * target interval has expired. Of course when an individual execution takes
 * too long, the actual execution time could be a lot longer.
 *
 * The code block will be executed at least once.
 */
#define igt_for_milliseconds(t) \
	for (struct timespec t__={}; igt_nsec_elapsed(&t__)>>20 < (t); )

110
void igt_exchange_int(void *array, unsigned i, unsigned j);
111
void igt_exchange_int64(void *array, unsigned i, unsigned j);
112 113 114 115 116
void igt_permute_array(void *array, unsigned size,
			   void (*exchange_func)(void *array,
						 unsigned i,
						 unsigned j));
void igt_progress(const char *header, uint64_t i, uint64_t total);
117
void igt_print_activity(void);
118
bool igt_check_boolean_env_var(const char *env_var, bool default_value);
119 120 121

bool igt_aub_dump_enabled(void);

122
/* suspend/hibernate and auto-resume system */
123

124 125 126 127 128 129 130 131 132 133 134 135 136
/**
 *  igt_suspend_state:
 *  @SUSPEND_STATE_FREEZE: suspend-to-idle target state, aka S0ix or freeze,
 *			   first non-hibernation state
 *  @SUSPEND_STATE_STANDBY: standby target state, aka S1, second
 *			    non-hibernation state
 *  @SUSPEND_STATE_MEM: suspend-to-mem target state aka S3, third
 *			non-hibernation state
 *  @SUSPEND_STATE_DISK: suspend-to-disk target state, aka S4 or hibernation
 *
 *  Target suspend states used with igt_system_suspend_autoresume().
 *  See /sys/power/state for the available states on a given machine.
 */
137 138 139
enum igt_suspend_state {
	SUSPEND_STATE_FREEZE,
	SUSPEND_STATE_STANDBY,
140
	SUSPEND_STATE_MEM,
141 142
	SUSPEND_STATE_DISK,

143
	/*< private >*/
144 145 146
	SUSPEND_STATE_NUM,
};

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/**
 * igt_suspend_test:
 * @SUSPEND_TEST_NONE: no testing, perform a full suspend/resume cycle
 * @SUSPEND_TEST_FREEZER: complete cycle after freezing all freezable threads
 * @SUSPEND_TEST_DEVICES: complete cycle after the above step and suspending
 *			  devices (before calling the drivers' suspend late and
 *			  no_irq hooks). Platform and system devices are not
 *			  suspended here, see #SUSPEND_TEST_CORE.
 * @SUSPEND_TEST_PLATFORM: complete cycle after all the above steps and calling
 *			   the ACPI platform global control methods (applies
 *			   only with /sys/power/disk set to platform)
 * @SUSPEND_TEST_PROCESSORS: complete cycle after all the above steps and
 *			     disabling non-boot CPUs
 * @SUSPEND_TEST_CORE: complete cycle after all the above steps and suspending
 *		       platform and system devices
 *
 * Test points used with igt_system_suspend_autoresume(). Specifies if and where
 * the suspend sequence is to be terminated.
 */
166 167 168 169 170 171 172 173
enum igt_suspend_test {
	SUSPEND_TEST_NONE,
	SUSPEND_TEST_FREEZER,
	SUSPEND_TEST_DEVICES,
	SUSPEND_TEST_PLATFORM,
	SUSPEND_TEST_PROCESSORS,
	SUSPEND_TEST_CORE,

174
	/*< private >*/
175 176 177 178 179
	SUSPEND_TEST_NUM,
};

void igt_system_suspend_autoresume(enum igt_suspend_state state,
				   enum igt_suspend_test test);
180
void igt_set_autoresume_delay(int delay_secs);
181
int igt_get_autoresume_delay(enum igt_suspend_state state);
182 183 184 185

/* dropping priviledges */
void igt_drop_root(void);

186
void igt_debug_wait_for_keypress(const char *var);
187
void igt_debug_manual_check(const char *var, const char *expected);
188 189 190 191 192

/* sysinfo cross-arch wrappers from intel_os.c */

/* These are separate to allow easier testing when porting, see the comment at
 * the bottom of intel_os.c. */
193
void intel_purge_vm_caches(int fd);
194
uint64_t intel_get_avail_ram_mb(void);
195 196
uint64_t intel_get_total_ram_mb(void);
uint64_t intel_get_total_swap_mb(void);
197
void *intel_get_total_pinnable_mem(size_t *pinned);
198

199
int __intel_check_memory(uint64_t count, uint64_t size, unsigned mode,
200
			 uint64_t *out_required, uint64_t *out_total);
201
void intel_require_memory(uint64_t count, uint64_t size, unsigned mode);
202
void intel_require_files(uint64_t count);
203 204 205
#define CHECK_RAM 0x1
#define CHECK_SWAP 0x2

206 207 208 209 210 211 212 213 214 215
#define min(a, b) ({			\
	typeof(a) _a = (a);		\
	typeof(b) _b = (b);		\
	_a < _b ? _a : _b;		\
})
#define max(a, b) ({			\
	typeof(a) _a = (a);		\
	typeof(b) _b = (b);		\
	_a > _b ? _a : _b;		\
})
216

217 218 219 220 221 222 223
#define clamp(x, min, max) ({		\
	typeof(min) _min = (min);	\
	typeof(max) _max = (max);	\
	typeof(x) _x = (x);		\
	_x < _min ? _min : _x > _max ? _max : _x;	\
})

224
#define igt_swap(a, b) do {	\
Ville Syrjälä's avatar
Ville Syrjälä committed
225 226 227 228 229
	typeof(a) _tmp = (a);	\
	(a) = (b);		\
	(b) = _tmp;		\
} while (0)

230 231 232
void igt_lock_mem(size_t size);
void igt_unlock_mem(void);

Paulo Zanoni's avatar
Paulo Zanoni committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
/**
 * igt_wait:
 * @COND: condition to wait
 * @timeout_ms: timeout in milliseconds
 * @interval_ms: amount of time we try to sleep between COND checks
 *
 * Waits until COND evaluates to true or the timeout passes.
 *
 * It is safe to call this macro if the signal helper is active. The only
 * problem is that the usleep() calls will return early, making us evaluate COND
 * too often, possibly eating valuable CPU cycles.
 *
 * Returns:
 * True of COND evaluated to true, false otherwise.
 */
#define igt_wait(COND, timeout_ms, interval_ms) ({			\
249 250 251 252
	const unsigned long interval_us__ = 1000 * (interval_ms);	\
	const unsigned long timeout_ms__ = (timeout_ms);		\
	struct timespec tv__ = {};					\
	bool ret__;							\
Paulo Zanoni's avatar
Paulo Zanoni committed
253 254
									\
	do {								\
255 256
		uint64_t elapsed__ = igt_nsec_elapsed(&tv__) >> 20;	\
									\
Paulo Zanoni's avatar
Paulo Zanoni committed
257
		if (COND) {						\
258 259 260 261 262 263
			igt_debug("%s took %"PRIu64"ms\n", #COND, elapsed__); \
			ret__ = true;					\
			break;						\
		}							\
		if (elapsed__ > timeout_ms__) {				\
			ret__ = false;					\
Paulo Zanoni's avatar
Paulo Zanoni committed
264 265 266
			break;						\
		}							\
									\
267 268
		usleep(interval_us__);					\
	} while (1);							\
Paulo Zanoni's avatar
Paulo Zanoni committed
269
									\
270
	ret__;								\
Paulo Zanoni's avatar
Paulo Zanoni committed
271 272
})

273 274 275
struct igt_mean;
void igt_start_siglatency(int sig); /* 0 => SIGRTMIN (default) */
double igt_stop_siglatency(struct igt_mean *result);
276 277 278 279

void igt_set_module_param(const char *name, const char *val);
void igt_set_module_param_int(const char *name, int val);

280 281 282
int igt_terminate_process(int sig, const char *comm);
void igt_lsof(const char *dpath);

Ville Syrjälä's avatar
Ville Syrjälä committed
283 284 285 286 287
#define igt_hweight(x) \
	__builtin_choose_expr(sizeof(x) == 8, \
			      __builtin_popcountll(x), \
			      __builtin_popcount(x))

288 289
#define is_power_of_two(x)  (((x) & ((x)-1)) == 0)

290 291 292 293 294 295
#define igt_fls(x) ((x) ? __builtin_choose_expr(sizeof(x) == 8, \
						64 - __builtin_clzll(x), \
						32 - __builtin_clz(x)) : 0)

#define roundup_power_of_two(x) ((x) != 0 ? 1 << igt_fls((x) - 1) : 0)

296 297
#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))

298
#endif /* IGT_AUX_H */