Merge branch 'doc-Clarify_Runtime_Param' of https://github.com/horshack-dpreview/fio
[fio.git] / os / os-linux.h
... / ...
CommitLineData
1#ifndef FIO_OS_LINUX_H
2#define FIO_OS_LINUX_H
3
4#ifdef __ANDROID__
5#define FIO_OS os_android
6#else
7#define FIO_OS os_linux
8#endif
9
10#include <sys/ioctl.h>
11#include <sys/uio.h>
12#include <sys/syscall.h>
13#include <sys/sysmacros.h>
14#include <sys/vfs.h>
15#include <sys/mman.h>
16#include <unistd.h>
17#include <fcntl.h>
18#include <errno.h>
19#include <sched.h>
20#include <linux/unistd.h>
21#include <linux/major.h>
22#include <linux/fs.h>
23#include <scsi/sg.h>
24#include <asm/byteorder.h>
25#ifdef __ANDROID__
26#include "os-ashmem.h"
27#define FIO_NO_HAVE_SHM_H
28#endif
29
30#ifdef ARCH_HAVE_CRC_CRYPTO
31#include <sys/auxv.h>
32#ifndef HWCAP_PMULL
33#define HWCAP_PMULL (1 << 4)
34#endif /* HWCAP_PMULL */
35#ifndef HWCAP_CRC32
36#define HWCAP_CRC32 (1 << 7)
37#endif /* HWCAP_CRC32 */
38#endif /* ARCH_HAVE_CRC_CRYPTO */
39
40#include "./os-linux-syscall.h"
41#include "../file.h"
42
43#ifndef __has_builtin // Optional of course.
44 #define __has_builtin(x) 0 // Compatibility with non-clang compilers.
45#endif
46
47#define FIO_HAVE_CPU_AFFINITY
48#define FIO_HAVE_DISK_UTIL
49#define FIO_HAVE_SGIO
50#define FIO_HAVE_IOPRIO
51#define FIO_HAVE_IOPRIO_CLASS
52#define FIO_HAVE_IOSCHED_SWITCH
53#define FIO_HAVE_ODIRECT
54#define FIO_HAVE_HUGETLB
55#define FIO_HAVE_BLKTRACE
56#define FIO_HAVE_CL_SIZE
57#define FIO_HAVE_CGROUPS
58#define FIO_HAVE_FS_STAT
59#define FIO_HAVE_TRIM
60#define FIO_HAVE_GETTID
61#define FIO_USE_GENERIC_INIT_RANDOM_STATE
62#define FIO_HAVE_BYTEORDER_FUNCS
63#define FIO_HAVE_PWRITEV2
64#define FIO_HAVE_SHM_ATTACH_REMOVED
65
66#ifdef MAP_HUGETLB
67#define FIO_HAVE_MMAP_HUGE
68#endif
69
70#define OS_MAP_ANON MAP_ANONYMOUS
71
72#define FIO_EXT_ENG_DIR "/usr/local/lib/fio"
73
74typedef cpu_set_t os_cpu_mask_t;
75
76#ifdef CONFIG_3ARG_AFFINITY
77#define fio_setaffinity(pid, cpumask) \
78 sched_setaffinity((pid), sizeof(cpumask), &(cpumask))
79#define fio_getaffinity(pid, ptr) \
80 sched_getaffinity((pid), sizeof(cpu_set_t), (ptr))
81#elif defined(CONFIG_2ARG_AFFINITY)
82#define fio_setaffinity(pid, cpumask) \
83 sched_setaffinity((pid), &(cpumask))
84#define fio_getaffinity(pid, ptr) \
85 sched_getaffinity((pid), (ptr))
86#endif
87
88#ifdef CONFIG_PTHREAD_GETAFFINITY
89#define FIO_HAVE_GET_THREAD_AFFINITY
90#define fio_get_thread_affinity(mask) \
91 pthread_getaffinity_np(pthread_self(), sizeof(mask), &(mask))
92#endif
93
94#define fio_cpu_clear(mask, cpu) CPU_CLR((cpu), (mask))
95#define fio_cpu_set(mask, cpu) CPU_SET((cpu), (mask))
96#define fio_cpu_isset(mask, cpu) (CPU_ISSET((cpu), (mask)) != 0)
97#define fio_cpu_count(mask) CPU_COUNT((mask))
98
99static inline int fio_cpuset_init(os_cpu_mask_t *mask)
100{
101 CPU_ZERO(mask);
102 return 0;
103}
104
105static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
106{
107 return 0;
108}
109
110#define FIO_MAX_CPUS CPU_SETSIZE
111
112enum {
113 IOPRIO_CLASS_NONE,
114 IOPRIO_CLASS_RT,
115 IOPRIO_CLASS_BE,
116 IOPRIO_CLASS_IDLE,
117};
118
119enum {
120 IOPRIO_WHO_PROCESS = 1,
121 IOPRIO_WHO_PGRP,
122 IOPRIO_WHO_USER,
123};
124
125#define IOPRIO_BITS 16
126#define IOPRIO_CLASS_SHIFT 13
127
128#define IOPRIO_MIN_PRIO 0 /* highest priority */
129#define IOPRIO_MAX_PRIO 7 /* lowest priority */
130
131#define IOPRIO_MIN_PRIO_CLASS 0
132#define IOPRIO_MAX_PRIO_CLASS 3
133
134static inline int ioprio_value(int ioprio_class, int ioprio)
135{
136 /*
137 * If no class is set, assume BE
138 */
139 if (!ioprio_class)
140 ioprio_class = IOPRIO_CLASS_BE;
141
142 return (ioprio_class << IOPRIO_CLASS_SHIFT) | ioprio;
143}
144
145static inline bool ioprio_value_is_class_rt(unsigned int priority)
146{
147 return (priority >> IOPRIO_CLASS_SHIFT) == IOPRIO_CLASS_RT;
148}
149
150static inline int ioprio_set(int which, int who, int ioprio_class, int ioprio)
151{
152 return syscall(__NR_ioprio_set, which, who,
153 ioprio_value(ioprio_class, ioprio));
154}
155
156#ifndef CONFIG_HAVE_GETTID
157static inline int gettid(void)
158{
159 return syscall(__NR_gettid);
160}
161#endif
162
163#define SPLICE_DEF_SIZE (64*1024)
164
165#ifndef BLKGETSIZE64
166#define BLKGETSIZE64 _IOR(0x12,114,size_t)
167#endif
168
169#ifndef BLKFLSBUF
170#define BLKFLSBUF _IO(0x12,97)
171#endif
172
173#ifndef BLKDISCARD
174#define BLKDISCARD _IO(0x12,119)
175#endif
176
177static inline int blockdev_invalidate_cache(struct fio_file *f)
178{
179 return ioctl(f->fd, BLKFLSBUF);
180}
181
182static inline int blockdev_size(struct fio_file *f, unsigned long long *bytes)
183{
184 if (!ioctl(f->fd, BLKGETSIZE64, bytes))
185 return 0;
186
187 return errno;
188}
189
190static inline unsigned long long os_phys_mem(void)
191{
192 long pagesize, pages;
193
194 pagesize = sysconf(_SC_PAGESIZE);
195 pages = sysconf(_SC_PHYS_PAGES);
196 if (pages == -1 || pagesize == -1)
197 return 0;
198
199 return (unsigned long long) pages * (unsigned long long) pagesize;
200}
201
202#ifdef O_NOATIME
203#define FIO_O_NOATIME O_NOATIME
204#else
205#define FIO_O_NOATIME 0
206#endif
207
208#ifdef MADV_REMOVE
209#define FIO_MADV_FREE MADV_REMOVE
210#endif
211
212/* Check for GCC or Clang byte swap intrinsics */
213#if (__has_builtin(__builtin_bswap16) && __has_builtin(__builtin_bswap32) \
214 && __has_builtin(__builtin_bswap64)) || (__GNUC__ > 4 \
215 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)) /* fio_swapN */
216#define fio_swap16(x) __builtin_bswap16(x)
217#define fio_swap32(x) __builtin_bswap32(x)
218#define fio_swap64(x) __builtin_bswap64(x)
219#else
220#include <byteswap.h>
221#define fio_swap16(x) bswap_16(x)
222#define fio_swap32(x) bswap_32(x)
223#define fio_swap64(x) bswap_64(x)
224#endif /* fio_swapN */
225
226#define CACHE_LINE_FILE \
227 "/sys/devices/system/cpu/cpu0/cache/index0/coherency_line_size"
228
229static inline int arch_cache_line_size(void)
230{
231 char size[32];
232 int fd, ret;
233
234 fd = open(CACHE_LINE_FILE, O_RDONLY);
235 if (fd < 0)
236 return -1;
237
238 ret = read(fd, size, sizeof(size));
239
240 close(fd);
241
242 if (ret <= 0)
243 return -1;
244 else
245 return atoi(size);
246}
247
248static inline unsigned long long get_fs_free_size(const char *path)
249{
250 unsigned long long ret;
251 struct statfs s;
252
253 if (statfs(path, &s) < 0)
254 return -1ULL;
255
256 ret = s.f_bsize;
257 ret *= (unsigned long long) s.f_bfree;
258 return ret;
259}
260
261static inline int os_trim(struct fio_file *f, unsigned long long start,
262 unsigned long long len)
263{
264 uint64_t range[2];
265
266 range[0] = start;
267 range[1] = len;
268
269 if (!ioctl(f->fd, BLKDISCARD, range))
270 return 0;
271
272 return errno;
273}
274
275#ifdef CONFIG_SCHED_IDLE
276static inline int fio_set_sched_idle(void)
277{
278 struct sched_param p = { .sched_priority = 0, };
279 return sched_setscheduler(gettid(), SCHED_IDLE, &p);
280}
281#endif
282
283#ifndef F_GET_RW_HINT
284#ifndef F_LINUX_SPECIFIC_BASE
285#define F_LINUX_SPECIFIC_BASE 1024
286#endif
287#define F_GET_RW_HINT (F_LINUX_SPECIFIC_BASE + 11)
288#define F_SET_RW_HINT (F_LINUX_SPECIFIC_BASE + 12)
289#define F_GET_FILE_RW_HINT (F_LINUX_SPECIFIC_BASE + 13)
290#define F_SET_FILE_RW_HINT (F_LINUX_SPECIFIC_BASE + 14)
291#endif
292
293#ifndef RWH_WRITE_LIFE_NONE
294#define RWH_WRITE_LIFE_NOT_SET 0
295#define RWH_WRITE_LIFE_NONE 1
296#define RWH_WRITE_LIFE_SHORT 2
297#define RWH_WRITE_LIFE_MEDIUM 3
298#define RWH_WRITE_LIFE_LONG 4
299#define RWH_WRITE_LIFE_EXTREME 5
300#endif
301
302#define FIO_HAVE_WRITE_HINT
303
304#ifndef RWF_HIPRI
305#define RWF_HIPRI 0x00000001
306#endif
307#ifndef RWF_DSYNC
308#define RWF_DSYNC 0x00000002
309#endif
310#ifndef RWF_SYNC
311#define RWF_SYNC 0x00000004
312#endif
313#ifndef RWF_NOWAIT
314#define RWF_NOWAIT 0x00000008
315#endif
316
317#ifndef RWF_UNCACHED
318#define RWF_UNCACHED 0x00000040
319#endif
320
321#ifndef RWF_WRITE_LIFE_SHIFT
322#define RWF_WRITE_LIFE_SHIFT 4
323#define RWF_WRITE_LIFE_SHORT (1 << RWF_WRITE_LIFE_SHIFT)
324#define RWF_WRITE_LIFE_MEDIUM (2 << RWF_WRITE_LIFE_SHIFT)
325#define RWF_WRITE_LIFE_LONG (3 << RWF_WRITE_LIFE_SHIFT)
326#define RWF_WRITE_LIFE_EXTREME (4 << RWF_WRITE_LIFE_SHIFT)
327#endif
328
329#ifndef CONFIG_PWRITEV2
330#ifdef __NR_preadv2
331static inline void make_pos_h_l(unsigned long *pos_h, unsigned long *pos_l,
332 off_t offset)
333{
334#if BITS_PER_LONG == 64
335 *pos_l = offset;
336 *pos_h = 0;
337#else
338 *pos_l = offset & 0xffffffff;
339 *pos_h = ((uint64_t) offset) >> 32;
340#endif
341}
342static inline ssize_t preadv2(int fd, const struct iovec *iov, int iovcnt,
343 off_t offset, unsigned int flags)
344{
345 unsigned long pos_l, pos_h;
346
347 make_pos_h_l(&pos_h, &pos_l, offset);
348 return syscall(__NR_preadv2, fd, iov, iovcnt, pos_l, pos_h, flags);
349}
350static inline ssize_t pwritev2(int fd, const struct iovec *iov, int iovcnt,
351 off_t offset, unsigned int flags)
352{
353 unsigned long pos_l, pos_h;
354
355 make_pos_h_l(&pos_h, &pos_l, offset);
356 return syscall(__NR_pwritev2, fd, iov, iovcnt, pos_l, pos_h, flags);
357}
358#else
359static inline ssize_t preadv2(int fd, const struct iovec *iov, int iovcnt,
360 off_t offset, unsigned int flags)
361{
362 errno = ENOSYS;
363 return -1;
364}
365static inline ssize_t pwritev2(int fd, const struct iovec *iov, int iovcnt,
366 off_t offset, unsigned int flags)
367{
368 errno = ENOSYS;
369 return -1;
370}
371#endif /* __NR_preadv2 */
372#endif /* CONFIG_PWRITEV2 */
373
374static inline int shm_attach_to_open_removed(void)
375{
376 return 1;
377}
378
379#ifdef CONFIG_LINUX_FALLOCATE
380#define FIO_HAVE_NATIVE_FALLOCATE
381static inline bool fio_fallocate(struct fio_file *f, uint64_t offset,
382 uint64_t len)
383{
384 int ret;
385 ret = fallocate(f->fd, 0, offset, len);
386 if (ret == 0)
387 return true;
388
389 /* Work around buggy old glibc versions... */
390 if (ret > 0)
391 errno = ret;
392
393 return false;
394}
395#endif
396
397#define FIO_HAVE_CPU_HAS
398static inline bool os_cpu_has(cpu_features feature)
399{
400 bool have_feature;
401 unsigned long fio_unused hwcap;
402
403 switch (feature) {
404#ifdef ARCH_HAVE_CRC_CRYPTO
405 case CPU_ARM64_CRC32C:
406 hwcap = getauxval(AT_HWCAP);
407 have_feature = (hwcap & (HWCAP_PMULL | HWCAP_CRC32)) ==
408 (HWCAP_PMULL | HWCAP_CRC32);
409 break;
410#endif
411 default:
412 have_feature = false;
413 }
414
415 return have_feature;
416}
417
418#endif