[fio.git] / helper_thread.c

#include <signal.h>
#ifdef CONFIG_VALGRIND_DEV
#include <valgrind/drd.h>
#else
#define DRD_IGNORE_VAR(x) do { } while (0)
#endif

#include "fio.h"
#include "smalloc.h"
#include "helper_thread.h"
#include "steadystate.h"
#include "pshared.h"

enum action {
	A_EXIT		= 1,
	A_RESET		= 2,
	A_DO_STAT	= 3,
};

static struct helper_data {
	volatile int exit;
	int pipe[2]; /* 0: read end; 1: write end. */
	struct sk_out *sk_out;
	pthread_t thread;
	struct fio_sem *startup_sem;
} *helper_data;

void helper_thread_destroy(void)
{
	if (!helper_data)
		return;

	close(helper_data->pipe[0]);
	close(helper_data->pipe[1]);
	sfree(helper_data);
}

#ifdef _WIN32
static void sock_init(void)
{
	WSADATA wsaData;
	int res;

	/* It is allowed to call WSAStartup() more than once. */
	res = WSAStartup(MAKEWORD(2, 2), &wsaData);
	assert(res == 0);
}

static int make_nonblocking(int fd)
{
	unsigned long arg = 1;

	return ioctlsocket(fd, FIONBIO, &arg);
}

static int write_to_pipe(int fd, const void *buf, size_t len)
{
	return send(fd, buf, len, 0);
}

static int read_from_pipe(int fd, void *buf, size_t len)
{
	return recv(fd, buf, len, 0);
}
#else
static void sock_init(void)
{
}

static int make_nonblocking(int fd)
{
	return fcntl(fd, F_SETFL, O_NONBLOCK);
}

static int write_to_pipe(int fd, const void *buf, size_t len)
{
	return write(fd, buf, len);
}

static int read_from_pipe(int fd, void *buf, size_t len)
{
	return read(fd, buf, len);
}
#endif

static void block_signals(void)
{
#ifdef HAVE_PTHREAD_SIGMASK
	sigset_t sigmask;

	ret = pthread_sigmask(SIG_UNBLOCK, NULL, &sigmask);
	assert(ret == 0);
	ret = pthread_sigmask(SIG_BLOCK, &sigmask, NULL);
	assert(ret == 0);
#endif
}

static void submit_action(enum action a)
{
	const char data = a;
	int ret;

	if (!helper_data)
		return;

	ret = write_to_pipe(helper_data->pipe[1], &data, sizeof(data));
	assert(ret == 1);
}

void helper_reset(void)
{
	submit_action(A_RESET);
}

/*
 * May be invoked in signal handler context and hence must only call functions
 * that are async-signal-safe. See also
 * https://pubs.opengroup.org/onlinepubs/9699919799/functions/V2_chap02.html#tag_15_04_03.
 */
void helper_do_stat(void)
{
	submit_action(A_DO_STAT);
}

bool helper_should_exit(void)
{
	if (!helper_data)
		return true;

	return helper_data->exit;
}

void helper_thread_exit(void)
{
	if (!helper_data)
		return;

	helper_data->exit = 1;
	submit_action(A_EXIT);
	pthread_join(helper_data->thread, NULL);
}

static unsigned int task_helper(struct timespec *last, struct timespec *now, unsigned int period, void do_task())
{
	unsigned int next, since;

	since = mtime_since(last, now);
	if (since >= period || period - since < 10) {
		do_task();
		timespec_add_msec(last, since);
		if (since > period)
			next = period - (since - period);
		else
			next = period;
	} else
		next = period - since;

	return next;
}

static void *helper_thread_main(void *data)
{
	struct helper_data *hd = data;
	unsigned int msec_to_next_event, next_log, next_si = status_interval;
	unsigned int next_ss = STEADYSTATE_MSEC;
	struct timespec ts, last_du, last_ss, last_si;
	char action;
	int ret = 0;

	sk_out_assign(hd->sk_out);

	/* Let another thread handle signals. */
	block_signals();

	fio_get_mono_time(&ts);
	memcpy(&last_du, &ts, sizeof(ts));
	memcpy(&last_ss, &ts, sizeof(ts));
	memcpy(&last_si, &ts, sizeof(ts));

	fio_sem_up(hd->startup_sem);

	msec_to_next_event = DISK_UTIL_MSEC;
	while (!ret && !hd->exit) {
		uint64_t since_du;
		struct timeval timeout = {
			.tv_sec  = msec_to_next_event / 1000,
			.tv_usec = (msec_to_next_event % 1000) * 1000,
		};
		fd_set rfds, efds;

		if (read_from_pipe(hd->pipe[0], &action, sizeof(action)) < 0) {
			FD_ZERO(&rfds);
			FD_SET(hd->pipe[0], &rfds);
			FD_ZERO(&efds);
			FD_SET(hd->pipe[0], &efds);
			if (select(1, &rfds, NULL, &efds, &timeout) < 0) {
				log_err("fio: select() call in helper thread failed: %s",
					strerror(errno));
				ret = 1;
			}
			if (read_from_pipe(hd->pipe[0], &action, sizeof(action)) <
			    0)
				action = 0;
		}

		fio_get_mono_time(&ts);

		if (action == A_RESET) {
			last_du = ts;
			last_ss = ts;
		}

		since_du = mtime_since(&last_du, &ts);
		if (since_du >= DISK_UTIL_MSEC || DISK_UTIL_MSEC - since_du < 10) {
			ret = update_io_ticks();
			timespec_add_msec(&last_du, DISK_UTIL_MSEC);
			msec_to_next_event = DISK_UTIL_MSEC;
			if (since_du >= DISK_UTIL_MSEC)
				msec_to_next_event -= (since_du - DISK_UTIL_MSEC);
		} else
			msec_to_next_event = DISK_UTIL_MSEC - since_du;

		if (action == A_DO_STAT)
			__show_running_run_stats();

		if (status_interval) {
			next_si = task_helper(&last_si, &ts, status_interval, __show_running_run_stats);
			msec_to_next_event = min(next_si, msec_to_next_event);
		}

		next_log = calc_log_samples();
		if (!next_log)
			next_log = DISK_UTIL_MSEC;

		if (steadystate_enabled) {
			next_ss = task_helper(&last_ss, &ts, STEADYSTATE_MSEC, steadystate_check);
			msec_to_next_event = min(next_ss, msec_to_next_event);
                }

		msec_to_next_event = min(next_log, msec_to_next_event);
		dprint(FD_HELPERTHREAD, "next_si: %u, next_ss: %u, next_log: %u, msec_to_next_event: %u\n",
			next_si, next_ss, next_log, msec_to_next_event);

		if (!is_backend)
			print_thread_status();
	}

	fio_writeout_logs(false);

	sk_out_drop();
	return NULL;
}

/*
 * Connect two sockets to each other to emulate the pipe() system call on Windows.
 */
int pipe_over_loopback(int fd[2])
{
	struct sockaddr_in addr = { .sin_family = AF_INET };
	socklen_t len = sizeof(addr);
	int res;

	addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);

	sock_init();

	fd[0] = socket(AF_INET, SOCK_STREAM, 0);
	if (fd[0] < 0)
		goto err;
	fd[1] = socket(AF_INET, SOCK_STREAM, 0);
	if (fd[1] < 0)
		goto close_fd_0;
	res = bind(fd[0], (struct sockaddr *)&addr, len);
	if (res < 0)
		goto close_fd_1;
	res = getsockname(fd[0], (struct sockaddr *)&addr, &len);
	if (res < 0)
		goto close_fd_1;
	res = listen(fd[0], 1);
	if (res < 0)
		goto close_fd_1;
	res = connect(fd[1], (struct sockaddr *)&addr, len);
	if (res < 0)
		goto close_fd_1;
	res = accept(fd[0], NULL, NULL);
	if (res < 0)
		goto close_fd_1;
	close(fd[0]);
	fd[0] = res;
	return 0;

close_fd_1:
	close(fd[1]);

close_fd_0:
	close(fd[0]);

err:
	return -1;
}

int helper_thread_create(struct fio_sem *startup_sem, struct sk_out *sk_out)
{
	struct helper_data *hd;
	int ret;

	hd = scalloc(1, sizeof(*hd));

	setup_disk_util();
	steadystate_setup();

	hd->sk_out = sk_out;

#if defined(CONFIG_PIPE2)
	ret = pipe2(hd->pipe, O_CLOEXEC);
#elif defined(CONFIG_PIPE)
	ret = pipe(hd->pipe);
#else
	ret = pipe_over_loopback(hd->pipe);
#endif
	if (ret)
		return 1;

	ret = make_nonblocking(hd->pipe[0]);
	assert(ret >= 0);

	hd->startup_sem = startup_sem;

	DRD_IGNORE_VAR(helper_data);

	ret = pthread_create(&hd->thread, NULL, helper_thread_main, hd);
	if (ret) {
		log_err("Can't create helper thread: %s\n", strerror(ret));
		return 1;
	}

	helper_data = hd;

	dprint(FD_MUTEX, "wait on startup_sem\n");
	fio_sem_down(startup_sem);
	dprint(FD_MUTEX, "done waiting on startup_sem\n");
	return 0;
}
Commit	Line	Data
c31092b8	1	#include <signal.h>
4f37732a BVA	2	#ifdef CONFIG_VALGRIND_DEV
	3	#include <valgrind/drd.h>
	4	#else
	5	#define DRD_IGNORE_VAR(x) do { } while (0)
	6	#endif
	7
a39fb9ea JA	8	#include "fio.h"
	9	#include "smalloc.h"
	10	#include "helper_thread.h"
16e56d25	11	#include "steadystate.h"
ae626d4e	12	#include "pshared.h"
a39fb9ea	13
52a552e2 BVA	14	enum action {
	15	A_EXIT = 1,
	16	A_RESET = 2,
	17	A_DO_STAT = 3,
	18	};
	19
a39fb9ea JA	20	static struct helper_data {
a39fb9ea JA	21	volatile int exit;
52a552e2	22	int pipe[2]; /* 0: read end; 1: write end. */
a39fb9ea JA	23	struct sk_out *sk_out;
a39fb9ea JA	24	pthread_t thread;
971caeb1	25	struct fio_sem *startup_sem;
a39fb9ea JA	26	} *helper_data;
	27
	28	void helper_thread_destroy(void)
	29	{
998e9ebb BVA	30	if (!helper_data)
	31	return;
	32
52a552e2 BVA	33	close(helper_data->pipe[0]);
52a552e2 BVA	34	close(helper_data->pipe[1]);
a39fb9ea JA	35	sfree(helper_data);
	36	}
	37
52a552e2 BVA	38	#ifdef _WIN32
52a552e2 BVA	39	static void sock_init(void)
a39fb9ea	40	{
52a552e2 BVA	41	WSADATA wsaData;
52a552e2 BVA	42	int res;
a39fb9ea	43
52a552e2 BVA	44	/* It is allowed to call WSAStartup() more than once. */
	45	res = WSAStartup(MAKEWORD(2, 2), &wsaData);
	46	assert(res == 0);
	47	}
a39fb9ea	48
52a552e2 BVA	49	static int make_nonblocking(int fd)
	50	{
	51	unsigned long arg = 1;
dda11987	52
52a552e2	53	return ioctlsocket(fd, FIONBIO, &arg);
a39fb9ea JA	54	}
a39fb9ea JA	55
52a552e2 BVA	56	static int write_to_pipe(int fd, const void *buf, size_t len)
	57	{
	58	return send(fd, buf, len, 0);
	59	}
	60
	61	static int read_from_pipe(int fd, void *buf, size_t len)
	62	{
	63	return recv(fd, buf, len, 0);
	64	}
	65	#else
	66	static void sock_init(void)
	67	{
	68	}
	69
	70	static int make_nonblocking(int fd)
	71	{
	72	return fcntl(fd, F_SETFL, O_NONBLOCK);
	73	}
	74
	75	static int write_to_pipe(int fd, const void *buf, size_t len)
	76	{
	77	return write(fd, buf, len);
	78	}
	79
	80	static int read_from_pipe(int fd, void *buf, size_t len)
	81	{
	82	return read(fd, buf, len);
	83	}
	84	#endif
	85
2575407f BVA	86	static void block_signals(void)
	87	{
	88	#ifdef HAVE_PTHREAD_SIGMASK
	89	sigset_t sigmask;
	90
	91	ret = pthread_sigmask(SIG_UNBLOCK, NULL, &sigmask);
	92	assert(ret == 0);
	93	ret = pthread_sigmask(SIG_BLOCK, &sigmask, NULL);
	94	assert(ret == 0);
	95	#endif
	96	}
	97
52a552e2	98	static void submit_action(enum action a)
a39fb9ea	99	{
52a552e2 BVA	100	const char data = a;
	101	int ret;
	102
dda11987 JA	103	if (!helper_data)
	104	return;
	105
52a552e2 BVA	106	ret = write_to_pipe(helper_data->pipe[1], &data, sizeof(data));
	107	assert(ret == 1);
	108	}
	109
	110	void helper_reset(void)
	111	{
	112	submit_action(A_RESET);
	113	}
	114
	115	/*
	116	* May be invoked in signal handler context and hence must only call functions
	117	* that are async-signal-safe. See also
	118	* https://pubs.opengroup.org/onlinepubs/9699919799/functions/V2_chap02.html#tag_15_04_03.
	119	*/
	120	void helper_do_stat(void)
	121	{
	122	submit_action(A_DO_STAT);
a39fb9ea JA	123	}
	124
	125	bool helper_should_exit(void)
	126	{
	127	if (!helper_data)
	128	return true;
	129
	130	return helper_data->exit;
	131	}
	132
	133	void helper_thread_exit(void)
	134	{
998e9ebb BVA	135	if (!helper_data)
	136	return;
	137
a39fb9ea	138	helper_data->exit = 1;
52a552e2 BVA	139	submit_action(A_EXIT);
52a552e2 BVA	140	pthread_join(helper_data->thread, NULL);
a39fb9ea JA	141	}
a39fb9ea JA	142
3da71e37 VF	143	static unsigned int task_helper(struct timespec last, struct timespec now, unsigned int period, void do_task())
	144	{
	145	unsigned int next, since;
	146
	147	since = mtime_since(last, now);
	148	if (since >= period \|\| period - since < 10) {
	149	do_task();
	150	timespec_add_msec(last, since);
	151	if (since > period)
	152	next = period - (since - period);
	153	else
	154	next = period;
	155	} else
	156	next = period - since;
	157
	158	return next;
	159	}
	160
a39fb9ea JA	161	static void helper_thread_main(void data)
	162	{
	163	struct helper_data *hd = data;
3da71e37	164	unsigned int msec_to_next_event, next_log, next_si = status_interval;
0f77d30d VF	165	unsigned int next_ss = STEADYSTATE_MSEC;
0f77d30d VF	166	struct timespec ts, last_du, last_ss, last_si;
52a552e2	167	char action;
a39fb9ea JA	168	int ret = 0;
	169
	170	sk_out_assign(hd->sk_out);
	171
c31092b8	172	/* Let another thread handle signals. */
2575407f	173	block_signals();
c31092b8	174
69212fc4	175	fio_get_mono_time(&ts);
8b6a404c VF	176	memcpy(&last_du, &ts, sizeof(ts));
8b6a404c VF	177	memcpy(&last_ss, &ts, sizeof(ts));
0f77d30d	178	memcpy(&last_si, &ts, sizeof(ts));
a39fb9ea	179
971caeb1	180	fio_sem_up(hd->startup_sem);
a39fb9ea JA	181
	182	msec_to_next_event = DISK_UTIL_MSEC;
	183	while (!ret && !hd->exit) {
3da71e37	184	uint64_t since_du;
52a552e2	185	struct timeval timeout = {
0e59dd68 VF	186	.tv_sec = msec_to_next_event / 1000,
0e59dd68 VF	187	.tv_usec = (msec_to_next_event % 1000) * 1000,
52a552e2 BVA	188	};
52a552e2 BVA	189	fd_set rfds, efds;
a39fb9ea	190
52a552e2 BVA	191	if (read_from_pipe(hd->pipe[0], &action, sizeof(action)) < 0) {
	192	FD_ZERO(&rfds);
	193	FD_SET(hd->pipe[0], &rfds);
	194	FD_ZERO(&efds);
	195	FD_SET(hd->pipe[0], &efds);
8c55e40e	196	if (select(1, &rfds, NULL, &efds, &timeout) < 0) {
700ad386 BVA	197	log_err("fio: select() call in helper thread failed: %s",
700ad386 BVA	198	strerror(errno));
8c55e40e VF	199	ret = 1;
8c55e40e VF	200	}
52a552e2 BVA	201	if (read_from_pipe(hd->pipe[0], &action, sizeof(action)) <
	202	0)
	203	action = 0;
	204	}
a39fb9ea	205
69212fc4	206	fio_get_mono_time(&ts);
a39fb9ea	207
52a552e2 BVA	208	if (action == A_RESET) {
	209	last_du = ts;
	210	last_ss = ts;
a39fb9ea JA	211	}
a39fb9ea JA	212
8b6a404c	213	since_du = mtime_since(&last_du, &ts);
a39fb9ea JA	214	if (since_du >= DISK_UTIL_MSEC \|\| DISK_UTIL_MSEC - since_du < 10) {
a39fb9ea JA	215	ret = update_io_ticks();
8b6a404c	216	timespec_add_msec(&last_du, DISK_UTIL_MSEC);
a39fb9ea JA	217	msec_to_next_event = DISK_UTIL_MSEC;
	218	if (since_du >= DISK_UTIL_MSEC)
	219	msec_to_next_event -= (since_du - DISK_UTIL_MSEC);
dd290fb4 VF	220	} else
dd290fb4 VF	221	msec_to_next_event = DISK_UTIL_MSEC - since_du;
a39fb9ea	222
52a552e2	223	if (action == A_DO_STAT)
a39fb9ea	224	__show_running_run_stats();
a39fb9ea	225
0f77d30d	226	if (status_interval) {
3da71e37	227	next_si = task_helper(&last_si, &ts, status_interval, __show_running_run_stats);
0f77d30d VF	228	msec_to_next_event = min(next_si, msec_to_next_event);
	229	}
	230
a39fb9ea JA	231	next_log = calc_log_samples();
	232	if (!next_log)
	233	next_log = DISK_UTIL_MSEC;
	234
84784e07	235	if (steadystate_enabled) {
3da71e37 VF	236	next_ss = task_helper(&last_ss, &ts, STEADYSTATE_MSEC, steadystate_check);
3da71e37 VF	237	msec_to_next_event = min(next_ss, msec_to_next_event);
16e56d25 VF	238	}
16e56d25 VF	239
3da71e37 VF	240	msec_to_next_event = min(next_log, msec_to_next_event);
	241	dprint(FD_HELPERTHREAD, "next_si: %u, next_ss: %u, next_log: %u, msec_to_next_event: %u\n",
	242	next_si, next_ss, next_log, msec_to_next_event);
a39fb9ea JA	243
	244	if (!is_backend)
	245	print_thread_status();
	246	}
	247
	248	fio_writeout_logs(false);
	249
	250	sk_out_drop();
	251	return NULL;
	252	}
	253
52a552e2 BVA	254	/*
	255	* Connect two sockets to each other to emulate the pipe() system call on Windows.
	256	*/
	257	int pipe_over_loopback(int fd[2])
	258	{
	259	struct sockaddr_in addr = { .sin_family = AF_INET };
	260	socklen_t len = sizeof(addr);
	261	int res;
	262
	263	addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
	264
	265	sock_init();
	266
	267	fd[0] = socket(AF_INET, SOCK_STREAM, 0);
	268	if (fd[0] < 0)
	269	goto err;
	270	fd[1] = socket(AF_INET, SOCK_STREAM, 0);
	271	if (fd[1] < 0)
	272	goto close_fd_0;
	273	res = bind(fd[0], (struct sockaddr *)&addr, len);
	274	if (res < 0)
	275	goto close_fd_1;
	276	res = getsockname(fd[0], (struct sockaddr *)&addr, &len);
	277	if (res < 0)
	278	goto close_fd_1;
	279	res = listen(fd[0], 1);
	280	if (res < 0)
	281	goto close_fd_1;
	282	res = connect(fd[1], (struct sockaddr *)&addr, len);
	283	if (res < 0)
	284	goto close_fd_1;
	285	res = accept(fd[0], NULL, NULL);
	286	if (res < 0)
	287	goto close_fd_1;
	288	close(fd[0]);
	289	fd[0] = res;
	290	return 0;
	291
	292	close_fd_1:
	293	close(fd[1]);
	294
	295	close_fd_0:
	296	close(fd[0]);
	297
	298	err:
	299	return -1;
	300	}
	301
971caeb1	302	int helper_thread_create(struct fio_sem startup_sem, struct sk_out sk_out)
a39fb9ea JA	303	{
	304	struct helper_data *hd;
	305	int ret;
	306
b3090ff4	307	hd = scalloc(1, sizeof(*hd));
a39fb9ea JA	308
a39fb9ea JA	309	setup_disk_util();
16e56d25	310	steadystate_setup();
a39fb9ea JA	311
a39fb9ea JA	312	hd->sk_out = sk_out;
34febb23	313
52a552e2 BVA	314	#if defined(CONFIG_PIPE2)
	315	ret = pipe2(hd->pipe, O_CLOEXEC);
	316	#elif defined(CONFIG_PIPE)
	317	ret = pipe(hd->pipe);
	318	#else
	319	ret = pipe_over_loopback(hd->pipe);
	320	#endif
34febb23	321	if (ret)
f9e5b5ee	322	return 1;
34febb23	323
52a552e2 BVA	324	ret = make_nonblocking(hd->pipe[0]);
	325	assert(ret >= 0);
	326
971caeb1	327	hd->startup_sem = startup_sem;
a39fb9ea	328
4f37732a BVA	329	DRD_IGNORE_VAR(helper_data);
4f37732a BVA	330
a39fb9ea JA	331	ret = pthread_create(&hd->thread, NULL, helper_thread_main, hd);
	332	if (ret) {
	333	log_err("Can't create helper thread: %s\n", strerror(ret));
	334	return 1;
	335	}
	336
	337	helper_data = hd;
	338
971caeb1 BVA	339	dprint(FD_MUTEX, "wait on startup_sem\n");
	340	fio_sem_down(startup_sem);
	341	dprint(FD_MUTEX, "done waiting on startup_sem\n");
a39fb9ea JA	342	return 0;
a39fb9ea JA	343	}