[fio.git] / libfio.c

/*
 * fio - the flexible io tester
 *
 * Copyright (C) 2005 Jens Axboe <axboe@suse.de>
 * Copyright (C) 2006-2012 Jens Axboe <axboe@kernel.dk>
 *
 * The license below covers all files distributed with fio unless otherwise
 * noted in the file itself.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include <string.h>
#include <sys/types.h>
#include <signal.h>
#include <stdint.h>
#include <locale.h>
#include <fcntl.h>

#include "fio.h"
#include "smalloc.h"
#include "os/os.h"
#include "filelock.h"

/*
 * Just expose an empty list, if the OS does not support disk util stats
 */
#ifndef FIO_HAVE_DISK_UTIL
FLIST_HEAD(disk_list);
#endif

unsigned long arch_flags = 0;

uintptr_t page_mask = 0;
uintptr_t page_size = 0;

static const char *fio_os_strings[os_nr] = {
	"Invalid",
	"Linux",
	"AIX",
	"FreeBSD",
	"HP-UX",
	"OSX",
	"NetBSD",
	"OpenBSD",
	"Solaris",
	"Windows",
	"Android",
	"DragonFly",
};

static const char *fio_arch_strings[arch_nr] = {
	"Invalid",
	"x86-64",
	"x86",
	"ppc",
	"ia64",
	"s390",
	"alpha",
	"sparc",
	"sparc64",
	"arm",
	"sh",
	"hppa",
	"generic"
};

static void reset_io_counters(struct thread_data *td)
{
	int ddir;

	for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
		td->stat_io_bytes[ddir] = 0;
		td->this_io_bytes[ddir] = 0;
		td->stat_io_blocks[ddir] = 0;
		td->this_io_blocks[ddir] = 0;
		td->rate_bytes[ddir] = 0;
		td->rate_blocks[ddir] = 0;
		td->bytes_done[ddir] = 0;
	}
	td->zone_bytes = 0;

	td->last_was_sync = 0;
	td->rwmix_issues = 0;

	/*
	 * reset file done count if we are to start over
	 */
	if (td->o.time_based || td->o.loops || td->o.do_verify)
		td->nr_done_files = 0;
}

void clear_io_state(struct thread_data *td)
{
	struct fio_file *f;
	unsigned int i;

	reset_io_counters(td);

	close_files(td);
	for_each_file(td, f, i) {
		fio_file_clear_done(f);
		f->file_offset = get_start_offset(td, f);
	}

	/*
	 * Set the same seed to get repeatable runs
	 */
	td_fill_rand_seeds(td);
}

void reset_all_stats(struct thread_data *td)
{
	struct timeval tv;
	int i;

	reset_io_counters(td);

	for (i = 0; i < DDIR_RWDIR_CNT; i++) {
		td->io_bytes[i] = 0;
		td->io_blocks[i] = 0;
		td->io_issues[i] = 0;
		td->ts.total_io_u[i] = 0;
		td->ts.runtime[i] = 0;
		td->rwmix_issues = 0;
	}

	fio_gettime(&tv, NULL);
	memcpy(&td->epoch, &tv, sizeof(tv));
	memcpy(&td->start, &tv, sizeof(tv));

	lat_target_reset(td);
}

void reset_fio_state(void)
{
	groupid = 0;
	thread_number = 0;
	stat_number = 0;
	done_secs = 0;
}

const char *fio_get_os_string(int nr)
{
	if (nr < os_nr)
		return fio_os_strings[nr];

	return NULL;
}

const char *fio_get_arch_string(int nr)
{
	if (nr < arch_nr)
		return fio_arch_strings[nr];

	return NULL;
}

void td_set_runstate(struct thread_data *td, int runstate)
{
	if (td->runstate == runstate)
		return;

	dprint(FD_PROCESS, "pid=%d: runstate %d -> %d\n", (int) td->pid,
						td->runstate, runstate);
	td->runstate = runstate;
}

int td_bump_runstate(struct thread_data *td, int new_state)
{
	int old_state = td->runstate;

	td_set_runstate(td, new_state);
	return old_state;
}

void td_restore_runstate(struct thread_data *td, int old_state)
{
	td_set_runstate(td, old_state);
}

void fio_mark_td_terminate(struct thread_data *td)
{
	fio_gettime(&td->terminate_time, NULL);
	write_barrier();
	td->terminate = 1;
}

void fio_terminate_threads(int group_id)
{
	struct thread_data *td;
	pid_t pid = getpid();
	int i;

	dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);

	for_each_td(td, i) {
		if (group_id == TERMINATE_ALL || groupid == td->groupid) {
			dprint(FD_PROCESS, "setting terminate on %s/%d\n",
						td->o.name, (int) td->pid);

			if (td->terminate)
				continue;

			fio_mark_td_terminate(td);
			td->o.start_delay = 0;

			/*
			 * if the thread is running, just let it exit
			 */
			if (!td->pid || pid == td->pid)
				continue;
			else if (td->runstate < TD_RAMP)
				kill(td->pid, SIGTERM);
			else {
				struct ioengine_ops *ops = td->io_ops;

				if (ops && ops->terminate)
					ops->terminate(td);
			}
		}
	}
}

int fio_running_or_pending_io_threads(void)
{
	struct thread_data *td;
	int i;

	for_each_td(td, i) {
		if (td->flags & TD_F_NOIO)
			continue;
		if (td->runstate < TD_EXITED)
			return 1;
	}

	return 0;
}

int fio_set_fd_nonblocking(int fd, const char *who)
{
	int flags;

	flags = fcntl(fd, F_GETFL);
	if (flags < 0)
		log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
	else {
		int new_flags = flags | O_NONBLOCK;

		new_flags = fcntl(fd, F_SETFL, new_flags);
		if (new_flags < 0)
			log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
	}

	return flags;
}

static int endian_check(void)
{
	union {
		uint8_t c[8];
		uint64_t v;
	} u;
	int le = 0, be = 0;

	u.v = 0x12;
	if (u.c[7] == 0x12)
		be = 1;
	else if (u.c[0] == 0x12)
		le = 1;

#if defined(CONFIG_LITTLE_ENDIAN)
	if (be)
		return 1;
#elif defined(CONFIG_BIG_ENDIAN)
	if (le)
		return 1;
#else
	return 1;
#endif

	if (!le && !be)
		return 1;

	return 0;
}

int initialize_fio(char *envp[])
{
	long ps;

	/*
	 * We need these to be properly 64-bit aligned, otherwise we
	 * can run into problems on archs that fault on unaligned fp
	 * access (ARM).
	 */
	compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
	compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
	compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
	compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
	compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
	compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
	compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
	compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");

	if (endian_check()) {
		log_err("fio: endianness settings appear wrong.\n");
		log_err("fio: please report this to fio@vger.kernel.org\n");
		return 1;
	}

#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
#error "No available clock source!"
#endif

	arch_init(envp);

	sinit();

	if (fio_filelock_init()) {
		log_err("fio: failed initializing filelock subsys\n");
		return 1;
	}

	/*
	 * We need locale for number printing, if it isn't set then just
	 * go with the US format.
	 */
	if (!getenv("LC_NUMERIC"))
		setlocale(LC_NUMERIC, "en_US");

	ps = sysconf(_SC_PAGESIZE);
	if (ps < 0) {
		log_err("Failed to get page size\n");
		return 1;
	}

	page_size = ps;
	page_mask = ps - 1;

	fio_keywords_init();
	return 0;
}
Commit	Line	Data
2e1df07d JA	1	/*
	2	* fio - the flexible io tester
	3	*
	4	* Copyright (C) 2005 Jens Axboe <axboe@suse.de>
	5	* Copyright (C) 2006-2012 Jens Axboe <axboe@kernel.dk>
	6	*
	7	* The license below covers all files distributed with fio unless otherwise
	8	* noted in the file itself.
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License version 2 as
	12	* published by the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*
	23	*/
	24
	25	#include <string.h>
59dfce57 JA	26	#include <sys/types.h>
59dfce57 JA	27	#include <signal.h>
a569b45f JA	28	#include <stdint.h>
a569b45f JA	29	#include <locale.h>
4a851614	30	#include <fcntl.h>
a569b45f	31
2e1df07d	32	#include "fio.h"
a569b45f JA	33	#include "smalloc.h"
a569b45f JA	34	#include "os/os.h"
243bfe19	35	#include "filelock.h"
2e1df07d	36
a3efc919 JA	37	/*
	38	* Just expose an empty list, if the OS does not support disk util stats
	39	*/
	40	#ifndef FIO_HAVE_DISK_UTIL
	41	FLIST_HEAD(disk_list);
	42	#endif
	43
	44	unsigned long arch_flags = 0;
	45
a569b45f JA	46	uintptr_t page_mask = 0;
	47	uintptr_t page_size = 0;
	48
2e1df07d JA	49	static const char *fio_os_strings[os_nr] = {
	50	"Invalid",
	51	"Linux",
	52	"AIX",
	53	"FreeBSD",
	54	"HP-UX",
	55	"OSX",
	56	"NetBSD",
1c7eaa7b	57	"OpenBSD",
2e1df07d	58	"Solaris",
1c7eaa7b JA	59	"Windows",
1c7eaa7b JA	60	"Android",
239b2882	61	"DragonFly",
2e1df07d JA	62	};
	63
	64	static const char *fio_arch_strings[arch_nr] = {
	65	"Invalid",
	66	"x86-64",
	67	"x86",
	68	"ppc",
	69	"ia64",
	70	"s390",
	71	"alpha",
	72	"sparc",
	73	"sparc64",
	74	"arm",
	75	"sh",
	76	"hppa",
	77	"generic"
	78	};
	79
	80	static void reset_io_counters(struct thread_data *td)
	81	{
6eaf09d6	82	int ddir;
bcd5abfa	83
6eaf09d6 SL	84	for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
	85	td->stat_io_bytes[ddir] = 0;
	86	td->this_io_bytes[ddir] = 0;
	87	td->stat_io_blocks[ddir] = 0;
	88	td->this_io_blocks[ddir] = 0;
	89	td->rate_bytes[ddir] = 0;
	90	td->rate_blocks[ddir] = 0;
55312f9f	91	td->bytes_done[ddir] = 0;
6eaf09d6	92	}
2e1df07d	93	td->zone_bytes = 0;
2e1df07d JA	94
2e1df07d JA	95	td->last_was_sync = 0;
bcd5abfa	96	td->rwmix_issues = 0;
2e1df07d JA	97
	98	/*
	99	* reset file done count if we are to start over
	100	*/
44cbc6da	101	if (td->o.time_based \|\| td->o.loops \|\| td->o.do_verify)
2e1df07d JA	102	td->nr_done_files = 0;
	103	}
	104
	105	void clear_io_state(struct thread_data *td)
	106	{
	107	struct fio_file *f;
	108	unsigned int i;
	109
	110	reset_io_counters(td);
	111
	112	close_files(td);
ec803e97	113	for_each_file(td, f, i) {
2e1df07d	114	fio_file_clear_done(f);
ec803e97 BF	115	f->file_offset = get_start_offset(td, f);
ec803e97 BF	116	}
2e1df07d JA	117
	118	/*
	119	* Set the same seed to get repeatable runs
	120	*/
	121	td_fill_rand_seeds(td);
	122	}
	123
	124	void reset_all_stats(struct thread_data *td)
	125	{
	126	struct timeval tv;
	127	int i;
	128
	129	reset_io_counters(td);
	130
6eaf09d6	131	for (i = 0; i < DDIR_RWDIR_CNT; i++) {
2e1df07d JA	132	td->io_bytes[i] = 0;
	133	td->io_blocks[i] = 0;
	134	td->io_issues[i] = 0;
	135	td->ts.total_io_u[i] = 0;
6eaf09d6	136	td->ts.runtime[i] = 0;
5b3faae6	137	td->rwmix_issues = 0;
2e1df07d JA	138	}
	139
	140	fio_gettime(&tv, NULL);
2e1df07d JA	141	memcpy(&td->epoch, &tv, sizeof(tv));
2e1df07d JA	142	memcpy(&td->start, &tv, sizeof(tv));
3e260a46	143
6bb58215	144	lat_target_reset(td);
2e1df07d JA	145	}
	146
	147	void reset_fio_state(void)
	148	{
	149	groupid = 0;
	150	thread_number = 0;
2caefeec	151	stat_number = 0;
2e1df07d JA	152	done_secs = 0;
	153	}
	154
	155	const char *fio_get_os_string(int nr)
	156	{
	157	if (nr < os_nr)
	158	return fio_os_strings[nr];
	159
	160	return NULL;
	161	}
	162
	163	const char *fio_get_arch_string(int nr)
	164	{
	165	if (nr < arch_nr)
	166	return fio_arch_strings[nr];
	167
	168	return NULL;
	169	}
	170
	171	void td_set_runstate(struct thread_data *td, int runstate)
	172	{
	173	if (td->runstate == runstate)
	174	return;
	175
	176	dprint(FD_PROCESS, "pid=%d: runstate %d -> %d\n", (int) td->pid,
	177	td->runstate, runstate);
	178	td->runstate = runstate;
	179	}
	180
8edd973d JA	181	int td_bump_runstate(struct thread_data *td, int new_state)
	182	{
	183	int old_state = td->runstate;
	184
	185	td_set_runstate(td, new_state);
	186	return old_state;
	187	}
	188
	189	void td_restore_runstate(struct thread_data *td, int old_state)
	190	{
	191	td_set_runstate(td, old_state);
	192	}
	193
ebea2133 JA	194	void fio_mark_td_terminate(struct thread_data *td)
	195	{
	196	fio_gettime(&td->terminate_time, NULL);
	197	write_barrier();
	198	td->terminate = 1;
	199	}
	200
2e1df07d JA	201	void fio_terminate_threads(int group_id)
	202	{
	203	struct thread_data *td;
41fa20ec	204	pid_t pid = getpid();
2e1df07d JA	205	int i;
	206
	207	dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
	208
	209	for_each_td(td, i) {
	210	if (group_id == TERMINATE_ALL \|\| groupid == td->groupid) {
	211	dprint(FD_PROCESS, "setting terminate on %s/%d\n",
	212	td->o.name, (int) td->pid);
cba5460c JA	213
	214	if (td->terminate)
	215	continue;
	216
ebea2133	217	fio_mark_td_terminate(td);
2e1df07d JA	218	td->o.start_delay = 0;
	219
	220	/*
	221	* if the thread is running, just let it exit
	222	*/
36d80bc7	223	if (!td->pid \|\| pid == td->pid)
2e1df07d JA	224	continue;
	225	else if (td->runstate < TD_RAMP)
	226	kill(td->pid, SIGTERM);
36d80bc7	227	else {
2e1df07d JA	228	struct ioengine_ops *ops = td->io_ops;
2e1df07d JA	229
36d80bc7 JA	230	if (ops && ops->terminate)
36d80bc7 JA	231	ops->terminate(td);
2e1df07d JA	232	}
	233	}
	234	}
	235	}
	236
046395d7 JA	237	int fio_running_or_pending_io_threads(void)
	238	{
	239	struct thread_data *td;
	240	int i;
	241
	242	for_each_td(td, i) {
	243	if (td->flags & TD_F_NOIO)
	244	continue;
	245	if (td->runstate < TD_EXITED)
	246	return 1;
	247	}
	248
	249	return 0;
	250	}
	251
3a35845f	252	int fio_set_fd_nonblocking(int fd, const char *who)
4a851614 JA	253	{
	254	int flags;
	255
	256	flags = fcntl(fd, F_GETFL);
	257	if (flags < 0)
	258	log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
	259	else {
3a35845f JA	260	int new_flags = flags \| O_NONBLOCK;
	261
	262	new_flags = fcntl(fd, F_SETFL, new_flags);
	263	if (new_flags < 0)
4a851614 JA	264	log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
4a851614 JA	265	}
3a35845f JA	266
3a35845f JA	267	return flags;
4a851614 JA	268	}
4a851614 JA	269
a569b45f JA	270	static int endian_check(void)
	271	{
	272	union {
	273	uint8_t c[8];
	274	uint64_t v;
	275	} u;
	276	int le = 0, be = 0;
	277
	278	u.v = 0x12;
	279	if (u.c[7] == 0x12)
	280	be = 1;
	281	else if (u.c[0] == 0x12)
	282	le = 1;
	283
	284	#if defined(CONFIG_LITTLE_ENDIAN)
	285	if (be)
	286	return 1;
	287	#elif defined(CONFIG_BIG_ENDIAN)
	288	if (le)
	289	return 1;
	290	#else
	291	return 1;
	292	#endif
	293
	294	if (!le && !be)
	295	return 1;
	296
	297	return 0;
	298	}
	299
	300	int initialize_fio(char *envp[])
	301	{
	302	long ps;
	303
976a7756 JA	304	/*
	305	* We need these to be properly 64-bit aligned, otherwise we
	306	* can run into problems on archs that fault on unaligned fp
	307	* access (ARM).
	308	*/
24ffb6f8	309	compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
3d0ebb30 GG	310	compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
3d0ebb30 GG	311	compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
24ffb6f8 JA	312	compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
	313	compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
	314	compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
	315	compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
b8c6b4de	316	compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
976a7756	317
a569b45f JA	318	if (endian_check()) {
	319	log_err("fio: endianness settings appear wrong.\n");
	320	log_err("fio: please report this to fio@vger.kernel.org\n");
	321	return 1;
	322	}
	323
	324	#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
	325	#error "No available clock source!"
	326	#endif
	327
	328	arch_init(envp);
	329
	330	sinit();
	331
243bfe19 JA	332	if (fio_filelock_init()) {
	333	log_err("fio: failed initializing filelock subsys\n");
	334	return 1;
	335	}
	336
a569b45f JA	337	/*
	338	* We need locale for number printing, if it isn't set then just
	339	* go with the US format.
	340	*/
	341	if (!getenv("LC_NUMERIC"))
	342	setlocale(LC_NUMERIC, "en_US");
	343
	344	ps = sysconf(_SC_PAGESIZE);
	345	if (ps < 0) {
	346	log_err("Failed to get page size\n");
	347	return 1;
	348	}
	349
	350	page_size = ps;
	351	page_mask = ps - 1;
2e1df07d	352
a569b45f JA	353	fio_keywords_init();
	354	return 0;
	355	}