[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",
};

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);

	/*
	 * 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;

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