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