[fio.git] / os / os-linux.h

#ifndef FIO_OS_LINUX_H
#define FIO_OS_LINUX_H

#include <sys/ioctl.h>
#include <sys/uio.h>
#include <sys/syscall.h>
#include <sys/vfs.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <sched.h>
#include <linux/unistd.h>
#include <linux/raw.h>
#include <linux/major.h>

#include "indirect.h"
#include "binject.h"
#include "../file.h"

#define FIO_HAVE_LIBAIO
#define FIO_HAVE_POSIXAIO
#define FIO_HAVE_FADVISE
#define FIO_HAVE_CPU_AFFINITY
#define FIO_HAVE_DISK_UTIL
#define FIO_HAVE_SGIO
#define FIO_HAVE_IOPRIO
#define FIO_HAVE_SPLICE
#define FIO_HAVE_IOSCHED_SWITCH
#define FIO_HAVE_ODIRECT
#define FIO_HAVE_HUGETLB
#define FIO_HAVE_RAWBIND
#define FIO_HAVE_BLKTRACE
#define FIO_HAVE_STRSEP
#define FIO_HAVE_FALLOCATE
#define FIO_HAVE_POSIXAIO_FSYNC
#define FIO_HAVE_PSHARED_MUTEX
#define FIO_HAVE_CL_SIZE
#define FIO_HAVE_CGROUPS
#define FIO_HAVE_FDATASYNC
#define FIO_HAVE_FS_STAT
#define FIO_HAVE_TRIM
#define FIO_HAVE_BINJECT
#define FIO_HAVE_CLOCK_MONOTONIC

/*
 * Can only enable this for newer glibcs, or the header and defines are
 * missing
 */
#if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 6
#define FIO_HAVE_LINUX_FALLOCATE
#endif

#ifdef SYNC_FILE_RANGE_WAIT_BEFORE
#define FIO_HAVE_SYNC_FILE_RANGE
#endif

#define OS_MAP_ANON		MAP_ANONYMOUS

#ifndef CLOCK_MONOTONIC
#define CLOCK_MONOTONIC 1
#endif

typedef cpu_set_t os_cpu_mask_t;

typedef struct drand48_data os_random_state_t;

/*
 * we want fadvise64 really, but it's so tangled... later
 */
#ifdef FIO_HAVE_FADVISE
#define fadvise(fd, off, len, advice)	\
	posix_fadvise((fd), (off_t)(off), (len), (advice))
#endif

/*
 * If you are on an ancient glibc (2.3.2), then define GLIBC_2_3_2 if you want
 * the affinity helpers to work.
 */
#ifndef GLIBC_2_3_2
#define fio_setaffinity(pid, cpumask)		\
	sched_setaffinity((pid), sizeof(cpumask), &(cpumask))
#define fio_getaffinity(pid, ptr)	\
	sched_getaffinity((pid), sizeof(cpu_set_t), (ptr))
#else
#define fio_setaffinity(pid, cpumask)	\
	sched_setaffinity((pid), &(cpumask))
#define fio_getaffinity(pid, ptr)	\
	sched_getaffinity((pid), (ptr))
#endif

#define fio_cpu_clear(mask, cpu)	CPU_CLR((cpu), (mask))
#define fio_cpu_set(mask, cpu)		CPU_SET((cpu), (mask))

static inline int fio_cpuset_init(os_cpu_mask_t *mask)
{
	CPU_ZERO(mask);
	return 0;
}

static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
{
	return 0;
}

#define FIO_MAX_CPUS			CPU_SETSIZE

static inline int ioprio_set(int which, int who, int ioprio)
{
	return syscall(__NR_ioprio_set, which, who, ioprio);
}

/*
 * Just check for SPLICE_F_MOVE, if that isn't there, assume the others
 * aren't either.
 */
#ifndef SPLICE_F_MOVE
#define SPLICE_F_MOVE	(0x01)	/* move pages instead of copying */
#define SPLICE_F_NONBLOCK (0x02) /* don't block on the pipe splicing (but */
				 /* we may still block on the fd we splice */
				 /* from/to, of course */
#define SPLICE_F_MORE	(0x04)	/* expect more data */
#define SPLICE_F_GIFT   (0x08)  /* pages passed in are a gift */

static inline int splice(int fdin, loff_t *off_in, int fdout, loff_t *off_out,
			 size_t len, unsigned int flags)
{
	return syscall(__NR_sys_splice, fdin, off_in, fdout, off_out, len, flags);
}

static inline int tee(int fdin, int fdout, size_t len, unsigned int flags)
{
	return syscall(__NR_sys_tee, fdin, fdout, len, flags);
}

static inline int vmsplice(int fd, const struct iovec *iov,
			   unsigned long nr_segs, unsigned int flags)
{
	return syscall(__NR_sys_vmsplice, fd, iov, nr_segs, flags);
}
#endif

#define SPLICE_DEF_SIZE	(64*1024)

#ifdef FIO_HAVE_SYSLET

struct syslet_uatom;
struct async_head_user;

/*
 * syslet stuff
 */
static inline struct syslet_uatom *
async_exec(struct syslet_uatom *atom, struct async_head_user *ahu)
{
	return (struct syslet_uatom *) syscall(__NR_async_exec, atom, ahu);
}

static inline long
async_wait(unsigned long min_wait_events, unsigned long user_ring_idx,
	   struct async_head_user *ahu)
{
	return syscall(__NR_async_wait, min_wait_events,
			user_ring_idx, ahu);
}

static inline long async_thread(void *event, struct async_head_user *ahu)
{
	return syscall(__NR_async_thread, event, ahu);
}

static inline long umem_add(unsigned long *uptr, unsigned long inc)
{
	return syscall(__NR_umem_add, uptr, inc);
}
#endif /* FIO_HAVE_SYSLET */

enum {
	IOPRIO_CLASS_NONE,
	IOPRIO_CLASS_RT,
	IOPRIO_CLASS_BE,
	IOPRIO_CLASS_IDLE,
};

enum {
	IOPRIO_WHO_PROCESS = 1,
	IOPRIO_WHO_PGRP,
	IOPRIO_WHO_USER,
};

#define IOPRIO_BITS		16
#define IOPRIO_CLASS_SHIFT	13

#ifndef BLKGETSIZE64
#define BLKGETSIZE64	_IOR(0x12,114,size_t)
#endif

#ifndef BLKFLSBUF
#define BLKFLSBUF	_IO(0x12,97)
#endif

#ifndef BLKDISCARD
#define BLKDISCARD	_IO(0x12,119)
#endif

static inline int blockdev_invalidate_cache(struct fio_file *f)
{
	return ioctl(f->fd, BLKFLSBUF);
}

static inline int blockdev_size(struct fio_file *f, unsigned long long *bytes)
{
	if (!ioctl(f->fd, BLKGETSIZE64, bytes))
		return 0;

	return errno;
}

static inline unsigned long long os_phys_mem(void)
{
	long pagesize, pages;

	pagesize = sysconf(_SC_PAGESIZE);
	pages = sysconf(_SC_PHYS_PAGES);
	if (pages == -1 || pagesize == -1)
		return 0;

	return (unsigned long long) pages * (unsigned long long) pagesize;
}

static inline void os_random_seed(unsigned long seed, os_random_state_t *rs)
{
	srand48_r(seed, rs);
}

static inline long os_random_long(os_random_state_t *rs)
{
	long val;

	lrand48_r(rs, &val);
	return val;
}

static inline int fio_lookup_raw(dev_t dev, int *majdev, int *mindev)
{
	struct raw_config_request rq;
	int fd;

	if (major(dev) != RAW_MAJOR)
		return 1;

	/*
	 * we should be able to find /dev/rawctl or /dev/raw/rawctl
	 */
	fd = open("/dev/rawctl", O_RDONLY);
	if (fd < 0) {
		fd = open("/dev/raw/rawctl", O_RDONLY);
		if (fd < 0)
			return 1;
	}

	rq.raw_minor = minor(dev);
	if (ioctl(fd, RAW_GETBIND, &rq) < 0) {
		close(fd);
		return 1;
	}

	close(fd);
	*majdev = rq.block_major;
	*mindev = rq.block_minor;
	return 0;
}

#ifdef O_NOATIME
#define FIO_O_NOATIME	O_NOATIME
#else
#define FIO_O_NOATIME	0
#endif

#ifdef MADV_REMOVE
#define FIO_MADV_FREE	MADV_REMOVE
#endif

#define CACHE_LINE_FILE	\
	"/sys/devices/system/cpu/cpu0/cache/index0/coherency_line_size"

static inline int arch_cache_line_size(void)
{
	char size[32];
	int fd, ret;

	fd = open(CACHE_LINE_FILE, O_RDONLY);
	if (fd < 0)
		return -1;

	ret = read(fd, size, sizeof(size));

	close(fd);

	if (ret <= 0)
		return -1;
	else
		return atoi(size);
}

static inline unsigned long long get_fs_size(const char *path)
{
	unsigned long long ret;
	struct statfs s;

	if (statfs(path, &s) < 0)
		return -1ULL;

	ret = s.f_bsize;
	ret *= (unsigned long long) s.f_bfree;
	return ret;
}

static inline int os_trim(int fd, unsigned long long start,
			  unsigned long long len)
{
	uint64_t range[2];

	range[0] = start;
	range[1] = len;

	if (!ioctl(fd, BLKDISCARD, range))
		return 0;

	return errno;
}

#endif
Commit	Line	Data
ebac4655 JA	1	#ifndef FIO_OS_LINUX_H
	2	#define FIO_OS_LINUX_H
	3
	4	#include <sys/ioctl.h>
8756e4d4	5	#include <sys/uio.h>
3c39a379	6	#include <sys/syscall.h>
2e3bd4c2	7	#include <sys/vfs.h>
3c39a379	8	#include <unistd.h>
97fbdfa1	9	#include <fcntl.h>
3c2d93ed	10	#include <errno.h>
d09913c2	11	#include <sched.h>
ea421790	12	#include <linux/unistd.h>
07e5b264 JA	13	#include <linux/raw.h>
07e5b264 JA	14	#include <linux/major.h>
ebac4655	15
f3de88a7	16	#include "indirect.h"
79a43187	17	#include "binject.h"
e2e58886	18	#include "../file.h"
f3de88a7	19
ebac4655 JA	20	#define FIO_HAVE_LIBAIO
	21	#define FIO_HAVE_POSIXAIO
	22	#define FIO_HAVE_FADVISE
	23	#define FIO_HAVE_CPU_AFFINITY
	24	#define FIO_HAVE_DISK_UTIL
	25	#define FIO_HAVE_SGIO
ba4f8923	26	#define FIO_HAVE_IOPRIO
8756e4d4	27	#define FIO_HAVE_SPLICE
22f78b32	28	#define FIO_HAVE_IOSCHED_SWITCH
2c0ecd28	29	#define FIO_HAVE_ODIRECT
74b025b0	30	#define FIO_HAVE_HUGETLB
07e5b264	31	#define FIO_HAVE_RAWBIND
5e62c22a	32	#define FIO_HAVE_BLKTRACE
5921e80c	33	#define FIO_HAVE_STRSEP
fffca02d	34	#define FIO_HAVE_FALLOCATE
207cb0f0	35	#define FIO_HAVE_POSIXAIO_FSYNC
f356d01d	36	#define FIO_HAVE_PSHARED_MUTEX
eb7ccf38	37	#define FIO_HAVE_CL_SIZE
a696fa2a	38	#define FIO_HAVE_CGROUPS
c36d16f5	39	#define FIO_HAVE_FDATASYNC
2e3bd4c2	40	#define FIO_HAVE_FS_STAT
a5f3027c	41	#define FIO_HAVE_TRIM
79a43187	42	#define FIO_HAVE_BINJECT
ecc314ba	43	#define FIO_HAVE_CLOCK_MONOTONIC
b6959b55	44
804bb9a1 JA	45	/*
	46	* Can only enable this for newer glibcs, or the header and defines are
	47	* missing
	48	*/
	49	#if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 6
	50	#define FIO_HAVE_LINUX_FALLOCATE
	51	#endif
	52
093729f7 JA	53	#ifdef SYNC_FILE_RANGE_WAIT_BEFORE
	54	#define FIO_HAVE_SYNC_FILE_RANGE
	55	#endif
	56
dc873b6f	57	#define OS_MAP_ANON MAP_ANONYMOUS
ebac4655	58
4d8947de SL	59	#ifndef CLOCK_MONOTONIC
	60	#define CLOCK_MONOTONIC 1
	61	#endif
	62
ebac4655	63	typedef cpu_set_t os_cpu_mask_t;
4e78e405	64
6dfd46b9	65	typedef struct drand48_data os_random_state_t;
ebac4655 JA	66
	67	/*
	68	* we want fadvise64 really, but it's so tangled... later
	69	*/
4d8947de	70	#ifdef FIO_HAVE_FADVISE
ebac4655 JA	71	#define fadvise(fd, off, len, advice) \
ebac4655 JA	72	posix_fadvise((fd), (off_t)(off), (len), (advice))
4d8947de	73	#endif
ebac4655	74
c8f025f8 JA	75	/*
	76	* If you are on an ancient glibc (2.3.2), then define GLIBC_2_3_2 if you want
	77	* the affinity helpers to work.
	78	*/
	79	#ifndef GLIBC_2_3_2
e8462bd8 JA	80	#define fio_setaffinity(pid, cpumask) \
e8462bd8 JA	81	sched_setaffinity((pid), sizeof(cpumask), &(cpumask))
ebac4655 JA	82	#define fio_getaffinity(pid, ptr) \
ebac4655 JA	83	sched_getaffinity((pid), sizeof(cpu_set_t), (ptr))
c8f025f8	84	#else
e8462bd8 JA	85	#define fio_setaffinity(pid, cpumask) \
e8462bd8 JA	86	sched_setaffinity((pid), &(cpumask))
c8f025f8 JA	87	#define fio_getaffinity(pid, ptr) \
	88	sched_getaffinity((pid), (ptr))
	89	#endif
be4ecfdf JA	90
be4ecfdf JA	91	#define fio_cpu_clear(mask, cpu) CPU_CLR((cpu), (mask))
6d459ee7	92	#define fio_cpu_set(mask, cpu) CPU_SET((cpu), (mask))
d2ce18b5 JA	93
	94	static inline int fio_cpuset_init(os_cpu_mask_t *mask)
	95	{
	96	CPU_ZERO(mask);
	97	return 0;
	98	}
	99
	100	static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
	101	{
	102	return 0;
	103	}
6d459ee7 JA	104
6d459ee7 JA	105	#define FIO_MAX_CPUS CPU_SETSIZE
4d8947de	106
ebac4655 JA	107	static inline int ioprio_set(int which, int who, int ioprio)
	108	{
	109	return syscall(__NR_ioprio_set, which, who, ioprio);
	110	}
	111
97fbdfa1 JA	112	/*
	113	* Just check for SPLICE_F_MOVE, if that isn't there, assume the others
	114	* aren't either.
	115	*/
	116	#ifndef SPLICE_F_MOVE
	117	#define SPLICE_F_MOVE (0x01) /* move pages instead of copying */
	118	#define SPLICE_F_NONBLOCK (0x02) /* don't block on the pipe splicing (but */
	119	/* we may still block on the fd we splice */
	120	/* from/to, of course */
	121	#define SPLICE_F_MORE (0x04) /* expect more data */
	122	#define SPLICE_F_GIFT (0x08) /* pages passed in are a gift */
8756e4d4 JA	123
8756e4d4 JA	124	static inline int splice(int fdin, loff_t off_in, int fdout, loff_t off_out,
495ee9b6	125	size_t len, unsigned int flags)
8756e4d4	126	{
97fbdfa1	127	return syscall(__NR_sys_splice, fdin, off_in, fdout, off_out, len, flags);
8756e4d4 JA	128	}
	129
	130	static inline int tee(int fdin, int fdout, size_t len, unsigned int flags)
	131	{
97fbdfa1	132	return syscall(__NR_sys_tee, fdin, fdout, len, flags);
8756e4d4 JA	133	}
	134
	135	static inline int vmsplice(int fd, const struct iovec *iov,
	136	unsigned long nr_segs, unsigned int flags)
	137	{
97fbdfa1	138	return syscall(__NR_sys_vmsplice, fd, iov, nr_segs, flags);
8756e4d4	139	}
97fbdfa1	140	#endif
8756e4d4	141
3feedc60 JA	142	#define SPLICE_DEF_SIZE (64*1024)
3feedc60 JA	143
b6959b55	144	#ifdef FIO_HAVE_SYSLET
bf0dc8fa IM	145
	146	struct syslet_uatom;
	147	struct async_head_user;
	148
a4f4fdd7 JA	149	/*
	150	* syslet stuff
	151	*/
bf0dc8fa IM	152	static inline struct syslet_uatom *
bf0dc8fa IM	153	async_exec(struct syslet_uatom atom, struct async_head_user ahu)
a4f4fdd7	154	{
2b52511f	155	return (struct syslet_uatom *) syscall(__NR_async_exec, atom, ahu);
a4f4fdd7 JA	156	}
a4f4fdd7 JA	157
bf0dc8fa IM	158	static inline long
	159	async_wait(unsigned long min_wait_events, unsigned long user_ring_idx,
	160	struct async_head_user *ahu)
a4f4fdd7	161	{
bf0dc8fa IM	162	return syscall(__NR_async_wait, min_wait_events,
bf0dc8fa IM	163	user_ring_idx, ahu);
a4f4fdd7 JA	164	}
a4f4fdd7 JA	165
7756b0d0	166	static inline long async_thread(void event, struct async_head_user ahu)
a4f4fdd7	167	{
7756b0d0	168	return syscall(__NR_async_thread, event, ahu);
a4f4fdd7 JA	169	}
	170
	171	static inline long umem_add(unsigned long *uptr, unsigned long inc)
	172	{
	173	return syscall(__NR_umem_add, uptr, inc);
	174	}
b6959b55	175	#endif /* FIO_HAVE_SYSLET */
a4f4fdd7	176
6cefbe33 JA	177	enum {
	178	IOPRIO_CLASS_NONE,
	179	IOPRIO_CLASS_RT,
	180	IOPRIO_CLASS_BE,
	181	IOPRIO_CLASS_IDLE,
	182	};
	183
ebac4655 JA	184	enum {
	185	IOPRIO_WHO_PROCESS = 1,
	186	IOPRIO_WHO_PGRP,
	187	IOPRIO_WHO_USER,
	188	};
	189
6cefbe33	190	#define IOPRIO_BITS 16
ebac4655 JA	191	#define IOPRIO_CLASS_SHIFT 13
	192
	193	#ifndef BLKGETSIZE64
	194	#define BLKGETSIZE64 _IOR(0x12,114,size_t)
	195	#endif
	196
e5b401d4 JA	197	#ifndef BLKFLSBUF
	198	#define BLKFLSBUF _IO(0x12,97)
	199	#endif
	200
a5f3027c JA	201	#ifndef BLKDISCARD
	202	#define BLKDISCARD _IO(0x12,119)
	203	#endif
	204
e2e58886	205	static inline int blockdev_invalidate_cache(struct fio_file *f)
e5b401d4	206	{
ecc314ba	207	return ioctl(f->fd, BLKFLSBUF);
e5b401d4 JA	208	}
e5b401d4 JA	209
ecc314ba	210	static inline int blockdev_size(struct fio_file f, unsigned long long bytes)
ebac4655	211	{
ecc314ba	212	if (!ioctl(f->fd, BLKGETSIZE64, bytes))
ebac4655 JA	213	return 0;
	214
	215	return errno;
	216	}
	217
32cd46a0 JA	218	static inline unsigned long long os_phys_mem(void)
	219	{
	220	long pagesize, pages;
	221
	222	pagesize = sysconf(_SC_PAGESIZE);
	223	pages = sysconf(_SC_PHYS_PAGES);
	224	if (pages == -1 \|\| pagesize == -1)
	225	return 0;
	226
	227	return (unsigned long long) pages * (unsigned long long) pagesize;
	228	}
	229
6dfd46b9 JA	230	static inline void os_random_seed(unsigned long seed, os_random_state_t *rs)
	231	{
	232	srand48_r(seed, rs);
	233	}
	234
	235	static inline long os_random_long(os_random_state_t *rs)
	236	{
	237	long val;
	238
	239	lrand48_r(rs, &val);
	240	return val;
	241	}
	242
8cc7afa9	243	static inline int fio_lookup_raw(dev_t dev, int majdev, int mindev)
07e5b264 JA	244	{
	245	struct raw_config_request rq;
	246	int fd;
	247
	248	if (major(dev) != RAW_MAJOR)
8cc7afa9	249	return 1;
07e5b264 JA	250
	251	/*
	252	* we should be able to find /dev/rawctl or /dev/raw/rawctl
	253	*/
	254	fd = open("/dev/rawctl", O_RDONLY);
	255	if (fd < 0) {
	256	fd = open("/dev/raw/rawctl", O_RDONLY);
	257	if (fd < 0)
8cc7afa9	258	return 1;
07e5b264 JA	259	}
	260
	261	rq.raw_minor = minor(dev);
	262	if (ioctl(fd, RAW_GETBIND, &rq) < 0) {
	263	close(fd);
8cc7afa9	264	return 1;
07e5b264 JA	265	}
	266
	267	close(fd);
	268	*majdev = rq.block_major;
	269	*mindev = rq.block_minor;
8cc7afa9	270	return 0;
07e5b264 JA	271	}
07e5b264 JA	272
5b6f5c66	273	#ifdef O_NOATIME
5921e80c	274	#define FIO_O_NOATIME O_NOATIME
5b6f5c66 JA	275	#else
	276	#define FIO_O_NOATIME 0
	277	#endif
5921e80c	278
a1c58075 JA	279	#ifdef MADV_REMOVE
	280	#define FIO_MADV_FREE MADV_REMOVE
	281	#endif
	282
eb7ccf38 JA	283	#define CACHE_LINE_FILE \
	284	"/sys/devices/system/cpu/cpu0/cache/index0/coherency_line_size"
	285
	286	static inline int arch_cache_line_size(void)
	287	{
	288	char size[32];
	289	int fd, ret;
	290
	291	fd = open(CACHE_LINE_FILE, O_RDONLY);
	292	if (fd < 0)
	293	return -1;
	294
	295	ret = read(fd, size, sizeof(size));
ec76f15a JA	296
	297	close(fd);
	298
eb7ccf38 JA	299	if (ret <= 0)
eb7ccf38 JA	300	return -1;
ec76f15a JA	301	else
ec76f15a JA	302	return atoi(size);
eb7ccf38 JA	303	}
eb7ccf38 JA	304
2e3bd4c2 JA	305	static inline unsigned long long get_fs_size(const char *path)
	306	{
	307	unsigned long long ret;
	308	struct statfs s;
	309
	310	if (statfs(path, &s) < 0)
	311	return -1ULL;
	312
	313	ret = s.f_bsize;
	314	ret *= (unsigned long long) s.f_bfree;
	315	return ret;
	316	}
	317
a5f3027c JA	318	static inline int os_trim(int fd, unsigned long long start,
	319	unsigned long long len)
	320	{
	321	uint64_t range[2];
	322
	323	range[0] = start;
	324	range[1] = len;
	325
	326	if (!ioctl(fd, BLKDISCARD, range))
	327	return 0;
	328
	329	return errno;
	330	}
	331
ebac4655	332	#endif