[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->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;
	91	}
2e1df07d	92	td->zone_bytes = 0;
2e1df07d JA	93
2e1df07d JA	94	td->last_was_sync = 0;
bcd5abfa	95	td->rwmix_issues = 0;
2e1df07d JA	96
	97	/*
	98	* reset file done count if we are to start over
	99	*/
44cbc6da	100	if (td->o.time_based \|\| td->o.loops \|\| td->o.do_verify)
2e1df07d JA	101	td->nr_done_files = 0;
	102	}
	103
	104	void clear_io_state(struct thread_data *td)
	105	{
	106	struct fio_file *f;
	107	unsigned int i;
	108
	109	reset_io_counters(td);
	110
	111	close_files(td);
ec803e97	112	for_each_file(td, f, i) {
2e1df07d	113	fio_file_clear_done(f);
ec803e97 BF	114	f->file_offset = get_start_offset(td, f);
ec803e97 BF	115	}
2e1df07d JA	116
	117	/*
	118	* Set the same seed to get repeatable runs
	119	*/
	120	td_fill_rand_seeds(td);
	121	}
	122
	123	void reset_all_stats(struct thread_data *td)
	124	{
	125	struct timeval tv;
	126	int i;
	127
	128	reset_io_counters(td);
	129
6eaf09d6	130	for (i = 0; i < DDIR_RWDIR_CNT; i++) {
2e1df07d JA	131	td->io_bytes[i] = 0;
	132	td->io_blocks[i] = 0;
	133	td->io_issues[i] = 0;
	134	td->ts.total_io_u[i] = 0;
6eaf09d6	135	td->ts.runtime[i] = 0;
5b3faae6	136	td->rwmix_issues = 0;
2e1df07d JA	137	}
	138
	139	fio_gettime(&tv, NULL);
2e1df07d JA	140	memcpy(&td->epoch, &tv, sizeof(tv));
2e1df07d JA	141	memcpy(&td->start, &tv, sizeof(tv));
3e260a46	142
6bb58215	143	lat_target_reset(td);
2e1df07d JA	144	}
	145
	146	void reset_fio_state(void)
	147	{
	148	groupid = 0;
	149	thread_number = 0;
2caefeec	150	stat_number = 0;
2e1df07d JA	151	done_secs = 0;
	152	}
	153
	154	const char *fio_get_os_string(int nr)
	155	{
	156	if (nr < os_nr)
	157	return fio_os_strings[nr];
	158
	159	return NULL;
	160	}
	161
	162	const char *fio_get_arch_string(int nr)
	163	{
	164	if (nr < arch_nr)
	165	return fio_arch_strings[nr];
	166
	167	return NULL;
	168	}
	169
	170	void td_set_runstate(struct thread_data *td, int runstate)
	171	{
	172	if (td->runstate == runstate)
	173	return;
	174
	175	dprint(FD_PROCESS, "pid=%d: runstate %d -> %d\n", (int) td->pid,
	176	td->runstate, runstate);
	177	td->runstate = runstate;
	178	}
	179
8edd973d JA	180	int td_bump_runstate(struct thread_data *td, int new_state)
	181	{
	182	int old_state = td->runstate;
	183
	184	td_set_runstate(td, new_state);
	185	return old_state;
	186	}
	187
	188	void td_restore_runstate(struct thread_data *td, int old_state)
	189	{
	190	td_set_runstate(td, old_state);
	191	}
	192
ebea2133 JA	193	void fio_mark_td_terminate(struct thread_data *td)
	194	{
	195	fio_gettime(&td->terminate_time, NULL);
	196	write_barrier();
	197	td->terminate = 1;
	198	}
	199
2e1df07d JA	200	void fio_terminate_threads(int group_id)
	201	{
	202	struct thread_data *td;
41fa20ec	203	pid_t pid = getpid();
2e1df07d JA	204	int i;
	205
	206	dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
	207
	208	for_each_td(td, i) {
	209	if (group_id == TERMINATE_ALL \|\| groupid == td->groupid) {
	210	dprint(FD_PROCESS, "setting terminate on %s/%d\n",
	211	td->o.name, (int) td->pid);
cba5460c JA	212
	213	if (td->terminate)
	214	continue;
	215
ebea2133	216	fio_mark_td_terminate(td);
2e1df07d JA	217	td->o.start_delay = 0;
	218
	219	/*
	220	* if the thread is running, just let it exit
	221	*/
36d80bc7	222	if (!td->pid \|\| pid == td->pid)
2e1df07d JA	223	continue;
	224	else if (td->runstate < TD_RAMP)
	225	kill(td->pid, SIGTERM);
36d80bc7	226	else {
2e1df07d JA	227	struct ioengine_ops *ops = td->io_ops;
2e1df07d JA	228
36d80bc7 JA	229	if (ops && ops->terminate)
36d80bc7 JA	230	ops->terminate(td);
2e1df07d JA	231	}
	232	}
	233	}
	234	}
	235
046395d7 JA	236	int fio_running_or_pending_io_threads(void)
	237	{
	238	struct thread_data *td;
	239	int i;
	240
	241	for_each_td(td, i) {
	242	if (td->flags & TD_F_NOIO)
	243	continue;
	244	if (td->runstate < TD_EXITED)
	245	return 1;
	246	}
	247
	248	return 0;
	249	}
	250
3a35845f	251	int fio_set_fd_nonblocking(int fd, const char *who)
4a851614 JA	252	{
	253	int flags;
	254
	255	flags = fcntl(fd, F_GETFL);
	256	if (flags < 0)
	257	log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
	258	else {
3a35845f JA	259	int new_flags = flags \| O_NONBLOCK;
	260
	261	new_flags = fcntl(fd, F_SETFL, new_flags);
	262	if (new_flags < 0)
4a851614 JA	263	log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
4a851614 JA	264	}
3a35845f JA	265
3a35845f JA	266	return flags;
4a851614 JA	267	}
4a851614 JA	268
a569b45f JA	269	static int endian_check(void)
	270	{
	271	union {
	272	uint8_t c[8];
	273	uint64_t v;
	274	} u;
	275	int le = 0, be = 0;
	276
	277	u.v = 0x12;
	278	if (u.c[7] == 0x12)
	279	be = 1;
	280	else if (u.c[0] == 0x12)
	281	le = 1;
	282
	283	#if defined(CONFIG_LITTLE_ENDIAN)
	284	if (be)
	285	return 1;
	286	#elif defined(CONFIG_BIG_ENDIAN)
	287	if (le)
	288	return 1;
	289	#else
	290	return 1;
	291	#endif
	292
	293	if (!le && !be)
	294	return 1;
	295
	296	return 0;
	297	}
	298
	299	int initialize_fio(char *envp[])
	300	{
	301	long ps;
	302
976a7756 JA	303	/*
	304	* We need these to be properly 64-bit aligned, otherwise we
	305	* can run into problems on archs that fault on unaligned fp
	306	* access (ARM).
	307	*/
24ffb6f8	308	compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
3d0ebb30 GG	309	compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
3d0ebb30 GG	310	compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
24ffb6f8 JA	311	compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
	312	compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
	313	compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
	314	compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
b8c6b4de	315	compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
976a7756	316
a569b45f JA	317	if (endian_check()) {
	318	log_err("fio: endianness settings appear wrong.\n");
	319	log_err("fio: please report this to fio@vger.kernel.org\n");
	320	return 1;
	321	}
	322
	323	#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
	324	#error "No available clock source!"
	325	#endif
	326
	327	arch_init(envp);
	328
	329	sinit();
	330
243bfe19 JA	331	if (fio_filelock_init()) {
	332	log_err("fio: failed initializing filelock subsys\n");
	333	return 1;
	334	}
	335
a569b45f JA	336	/*
	337	* We need locale for number printing, if it isn't set then just
	338	* go with the US format.
	339	*/
	340	if (!getenv("LC_NUMERIC"))
	341	setlocale(LC_NUMERIC, "en_US");
	342
	343	ps = sysconf(_SC_PAGESIZE);
	344	if (ps < 0) {
	345	log_err("Failed to get page size\n");
	346	return 1;
	347	}
	348
	349	page_size = ps;
	350	page_mask = ps - 1;
2e1df07d	351
a569b45f JA	352	fio_keywords_init();
	353	return 0;
	354	}