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