libaio,io_uring: relax cmdprio_percentage constraints
[fio.git] / os / os.h
CommitLineData
ebac4655
JA
1#ifndef FIO_OS_H
2#define FIO_OS_H
3
a14ca44a 4#include <sys/types.h>
203913ea 5#include <sys/socket.h>
93bcfd20 6#include <fcntl.h>
03e20d68 7#include <pthread.h>
a14ca44a 8#include <unistd.h>
ecc314ba 9#include <stdlib.h>
30bec59e 10#include <errno.h>
a14ca44a 11
c473a9bd 12#include "../arch/arch.h" /* IWYU pragma: export */
e39c0676 13#include "../lib/types.h"
836fcc0f 14
cca84643
JA
15enum {
16 os_linux = 1,
17 os_aix,
18 os_freebsd,
19 os_hpux,
20 os_mac,
21 os_netbsd,
3cd4c66f 22 os_openbsd,
cca84643
JA
23 os_solaris,
24 os_windows,
ec5c6b12 25 os_android,
239b2882 26 os_dragonfly,
cca84643
JA
27
28 os_nr,
29};
30
58828d07
SW
31typedef enum {
32 CPU_ARM64_CRC32C,
33} cpu_features;
34
c473a9bd 35/* IWYU pragma: begin_exports */
ec5c6b12
AC
36#if defined(__ANDROID__)
37#include "os-android.h"
38#elif defined(__linux__)
ebac4655
JA
39#include "os-linux.h"
40#elif defined(__FreeBSD__)
41#include "os-freebsd.h"
3cd4c66f
J
42#elif defined(__OpenBSD__)
43#include "os-openbsd.h"
7452440e
YT
44#elif defined(__NetBSD__)
45#include "os-netbsd.h"
2c0ecd28
JA
46#elif defined(__sun__)
47#include "os-solaris.h"
2afd826b
JA
48#elif defined(__APPLE__)
49#include "os-mac.h"
bf2e821a
CC
50#elif defined(_AIX)
51#include "os-aix.h"
c00a2289
JA
52#elif defined(__hpux)
53#include "os-hpux.h"
93bcfd20 54#elif defined(WIN32)
03e20d68 55#include "os-windows.h"
239b2882
JA
56#elif defined (__DragonFly__)
57#include "os-dragonfly.h"
ebac4655
JA
58#else
59#error "unsupported os"
60#endif
61
30bec59e
JA
62#ifndef EDQUOT
63#define EDQUOT EIO
64#endif
65
67bf9823 66#ifdef CONFIG_POSIXAIO
ebac4655 67#include <aio.h>
e97c1442
JA
68#ifndef FIO_OS_HAVE_AIOCB_TYPEDEF
69typedef struct aiocb os_aiocb_t;
70#endif
ebac4655
JA
71#endif
72
4feafb1e 73#ifndef CONFIG_STRSEP
984f30c9 74#include "../oslib/strsep.h"
5921e80c
JA
75#endif
76
5ad7be56 77#ifndef CONFIG_STRLCAT
984f30c9 78#include "../oslib/strlcat.h"
5ad7be56 79#endif
c473a9bd 80/* IWYU pragma: end_exports */
5ad7be56 81
8e239cae
JA
82#ifdef MSG_DONTWAIT
83#define OS_MSG_DONTWAIT MSG_DONTWAIT
84#endif
85
4d8947de 86#ifndef POSIX_FADV_DONTNEED
ebac4655
JA
87#define POSIX_FADV_DONTNEED (0)
88#define POSIX_FADV_SEQUENTIAL (0)
89#define POSIX_FADV_RANDOM (0)
3ab9ebca 90#define POSIX_FADV_NORMAL (0)
4d8947de 91#endif
ebac4655
JA
92
93#ifndef FIO_HAVE_CPU_AFFINITY
be4ecfdf 94#define fio_cpu_clear(mask, cpu) do { } while (0)
7452440e 95typedef unsigned long os_cpu_mask_t;
3e55d40f
TK
96
97static inline int fio_setaffinity(int pid, os_cpu_mask_t cpumask)
98{
99 return 0;
100}
101
2c6772e2
TK
102static inline int fio_getaffinity(int pid, os_cpu_mask_t *cpumask)
103{
104 return -1;
105}
106
3e55d40f
TK
107static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
108{
109 return -1;
110}
111
112static inline int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
113{
114 return 0;
115}
c2acfbac
JA
116#else
117extern int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu);
ebac4655
JA
118#endif
119
120#ifndef FIO_HAVE_IOPRIO
8d6e8d99 121#define ioprio_value(prioclass, prio) (0)
28727df7 122#define ioprio_set(which, who, prioclass, prio) (0)
ebac4655
JA
123#endif
124
2c0ecd28 125#ifndef FIO_HAVE_ODIRECT
7d424763
JA
126#define OS_O_DIRECT 0
127#else
128#define OS_O_DIRECT O_DIRECT
2c0ecd28
JA
129#endif
130
d01612f3
CM
131#ifdef OS_O_ATOMIC
132#define FIO_O_ATOMIC OS_O_ATOMIC
133#else
134#define FIO_O_ATOMIC 0
135#endif
136
74b025b0
JA
137#ifndef FIO_HAVE_HUGETLB
138#define SHM_HUGETLB 0
d6dc02fb 139#define MAP_HUGETLB 0
4d8947de 140#ifndef FIO_HUGE_PAGE
74b025b0 141#define FIO_HUGE_PAGE 0
4d8947de 142#endif
74b025b0 143#else
cb25df61 144#ifndef FIO_HUGE_PAGE
ee0e0a71 145#define FIO_HUGE_PAGE 4194304
74b025b0 146#endif
cb25df61 147#endif
74b025b0 148
39b93568
JA
149#ifndef FIO_HAVE_MMAP_HUGE
150#define MAP_HUGETLB 0
151#endif
152
5921e80c
JA
153#ifndef FIO_O_NOATIME
154#define FIO_O_NOATIME 0
155#endif
156
dc873b6f
JA
157#ifndef OS_RAND_MAX
158#define OS_RAND_MAX RAND_MAX
159#endif
160
58483fa4 161#ifndef FIO_PREFERRED_ENGINE
df96a39e 162#define FIO_PREFERRED_ENGINE "psync"
58483fa4
JA
163#endif
164
b9fd788f 165#ifndef FIO_OS_PATH_SEPARATOR
53a7af85 166#define FIO_OS_PATH_SEPARATOR '/'
b9fd788f
BC
167#endif
168
16de1bf9 169#ifndef FIO_PREFERRED_CLOCK_SOURCE
86e53416 170#ifdef CONFIG_CLOCK_GETTIME
16de1bf9 171#define FIO_PREFERRED_CLOCK_SOURCE CS_CGETTIME
86e53416
BC
172#else
173#define FIO_PREFERRED_CLOCK_SOURCE CS_GTOD
174#endif
16de1bf9
BC
175#endif
176
67bf9823
JA
177#ifndef CONFIG_SOCKLEN_T
178typedef unsigned int socklen_t;
5ba13ea6
JA
179#endif
180
45054cbe 181#ifndef FIO_OS_HAS_CTIME_R
1f81991e 182#define os_ctime_r(x, y, z) (void) ctime_r((x), (y))
45054cbe
SD
183#endif
184
901ebe18 185#ifdef FIO_USE_GENERIC_SWAP
9677bec3 186static inline uint16_t fio_swap16(uint16_t val)
232f9b73
JA
187{
188 return (val << 8) | (val >> 8);
189}
190
901ebe18 191static inline uint32_t fio_swap32(uint32_t val)
232f9b73
JA
192{
193 val = ((val & 0xff00ff00UL) >> 8) | ((val & 0x00ff00ffUL) << 8);
194
195 return (val >> 16) | (val << 16);
196}
197
901ebe18 198static inline uint64_t fio_swap64(uint64_t val)
232f9b73
JA
199{
200 val = ((val & 0xff00ff00ff00ff00ULL) >> 8) |
201 ((val & 0x00ff00ff00ff00ffULL) << 8);
202 val = ((val & 0xffff0000ffff0000ULL) >> 16) |
203 ((val & 0x0000ffff0000ffffULL) << 16);
204
205 return (val >> 32) | (val << 32);
206}
207#endif
208
ec5c6b12 209#ifndef FIO_HAVE_BYTEORDER_FUNCS
0dcebdf4 210#ifdef CONFIG_LITTLE_ENDIAN
a824149a
DF
211#define __be16_to_cpu(x) fio_swap16(x)
212#define __be32_to_cpu(x) fio_swap32(x)
b747af64 213#define __be64_to_cpu(x) fio_swap64(x)
8111092f
JA
214#define __le16_to_cpu(x) (x)
215#define __le32_to_cpu(x) (x)
216#define __le64_to_cpu(x) (x)
a824149a
DF
217#define __cpu_to_be16(x) fio_swap16(x)
218#define __cpu_to_be32(x) fio_swap32(x)
b747af64 219#define __cpu_to_be64(x) fio_swap64(x)
8111092f
JA
220#define __cpu_to_le16(x) (x)
221#define __cpu_to_le32(x) (x)
222#define __cpu_to_le64(x) (x)
223#else
a824149a
DF
224#define __be16_to_cpu(x) (x)
225#define __be32_to_cpu(x) (x)
b747af64 226#define __be64_to_cpu(x) (x)
8111092f
JA
227#define __le16_to_cpu(x) fio_swap16(x)
228#define __le32_to_cpu(x) fio_swap32(x)
229#define __le64_to_cpu(x) fio_swap64(x)
a824149a
DF
230#define __cpu_to_be16(x) (x)
231#define __cpu_to_be32(x) (x)
b747af64 232#define __cpu_to_be64(x) (x)
8111092f
JA
233#define __cpu_to_le16(x) fio_swap16(x)
234#define __cpu_to_le32(x) fio_swap32(x)
235#define __cpu_to_le64(x) fio_swap64(x)
236#endif
ec5c6b12 237#endif /* FIO_HAVE_BYTEORDER_FUNCS */
8111092f 238
0bbe46e7 239#ifdef FIO_INTERNAL
a824149a
DF
240#define be16_to_cpu(val) ({ \
241 typecheck(uint16_t, val); \
242 __be16_to_cpu(val); \
243})
244#define be32_to_cpu(val) ({ \
245 typecheck(uint32_t, val); \
246 __be32_to_cpu(val); \
247})
b747af64
SW
248#define be64_to_cpu(val) ({ \
249 typecheck(uint64_t, val); \
250 __be64_to_cpu(val); \
251})
8111092f 252#define le16_to_cpu(val) ({ \
ff8039b7 253 typecheck(uint16_t, val); \
c46fda90 254 __le16_to_cpu(val); \
8111092f
JA
255})
256#define le32_to_cpu(val) ({ \
ff8039b7 257 typecheck(uint32_t, val); \
c46fda90 258 __le32_to_cpu(val); \
8111092f
JA
259})
260#define le64_to_cpu(val) ({ \
ff8039b7
JA
261 typecheck(uint64_t, val); \
262 __le64_to_cpu(val); \
8111092f 263})
0bbe46e7
DG
264#endif
265
a824149a
DF
266#define cpu_to_be16(val) ({ \
267 typecheck(uint16_t, val); \
268 __cpu_to_be16(val); \
269})
270#define cpu_to_be32(val) ({ \
271 typecheck(uint32_t, val); \
272 __cpu_to_be32(val); \
273})
b747af64
SW
274#define cpu_to_be64(val) ({ \
275 typecheck(uint64_t, val); \
276 __cpu_to_be64(val); \
277})
8111092f 278#define cpu_to_le16(val) ({ \
ff8039b7 279 typecheck(uint16_t, val); \
c46fda90 280 __cpu_to_le16(val); \
8111092f
JA
281})
282#define cpu_to_le32(val) ({ \
ff8039b7 283 typecheck(uint32_t, val); \
c46fda90 284 __cpu_to_le32(val); \
8111092f
JA
285})
286#define cpu_to_le64(val) ({ \
ff8039b7 287 typecheck(uint64_t, val); \
c46fda90 288 __cpu_to_le64(val); \
8111092f
JA
289})
290
eb7ccf38
JA
291#define FIO_DEF_CL_SIZE 128
292
293static inline int os_cache_line_size(void)
294{
295#ifdef FIO_HAVE_CL_SIZE
296 int ret = arch_cache_line_size();
297
298 if (ret <= 0)
299 return FIO_DEF_CL_SIZE;
300
301 return ret;
302#else
303 return FIO_DEF_CL_SIZE;
304#endif
305}
306
792d5517 307#ifdef FIO_USE_GENERIC_BDEV_SIZE
ecc314ba 308static inline int blockdev_size(struct fio_file *f, unsigned long long *bytes)
792d5517 309{
3b2e1464 310 off_t end;
792d5517 311
3b2e1464
JA
312 *bytes = 0;
313
ecc314ba 314 end = lseek(f->fd, 0, SEEK_END);
792d5517
JA
315 if (end < 0)
316 return errno;
317
318 *bytes = end;
319 return 0;
320}
321#endif
322
93bcfd20 323#ifdef FIO_USE_GENERIC_INIT_RANDOM_STATE
9781c080 324static inline int init_random_seeds(uint64_t *rand_seeds, int size)
93bcfd20
BC
325{
326 int fd;
327
328 fd = open("/dev/urandom", O_RDONLY);
329 if (fd == -1) {
330 return 1;
331 }
332
333 if (read(fd, rand_seeds, size) < size) {
334 close(fd);
335 return 1;
336 }
337
338 close(fd);
93bcfd20
BC
339 return 0;
340}
341#endif
342
2e3bd4c2 343#ifndef FIO_HAVE_FS_STAT
c08ad04c 344static inline unsigned long long get_fs_free_size(const char *path)
2e3bd4c2
JA
345{
346 return 0;
347}
348#endif
349
c00a2289
JA
350#ifndef FIO_HAVE_CPU_ONLINE_SYSCONF
351static inline unsigned int cpus_online(void)
352{
353 return sysconf(_SC_NPROCESSORS_ONLN);
354}
355#endif
356
7221da37 357#ifndef CPU_COUNT
6cf71c24
JA
358#ifdef FIO_HAVE_CPU_AFFINITY
359static inline int CPU_COUNT(os_cpu_mask_t *mask)
360{
361 int max_cpus = cpus_online();
362 int nr_cpus, i;
363
364 for (i = 0, nr_cpus = 0; i < max_cpus; i++)
365 if (fio_cpu_isset(mask, i))
366 nr_cpus++;
367
368 return nr_cpus;
369}
370#endif
371#endif
372
47f767c1 373#ifndef FIO_HAVE_GETTID
de5ed0e4 374#ifndef CONFIG_HAVE_GETTID
47f767c1
JA
375static inline int gettid(void)
376{
377 return getpid();
378}
379#endif
de5ed0e4 380#endif
47f767c1 381
0cfe2089
TK
382#ifndef FIO_HAVE_SHM_ATTACH_REMOVED
383static inline int shm_attach_to_open_removed(void)
384{
385 return 0;
386}
387#endif
388
2c3e17be
SW
389#ifndef FIO_HAVE_NATIVE_FALLOCATE
390static inline bool fio_fallocate(struct fio_file *f, uint64_t offset, uint64_t len)
391{
392 errno = ENOSYS;
393 return false;
394}
395#endif
396
cbbdf1c8 397#if defined(CONFIG_POSIX_FALLOCATE) || defined(FIO_HAVE_NATIVE_FALLOCATE)
38ca5f03 398# define FIO_HAVE_DEFAULT_FALLOCATE
cbbdf1c8
SW
399#endif
400
58828d07
SW
401#ifndef FIO_HAVE_CPU_HAS
402static inline bool os_cpu_has(cpu_features feature)
403{
404 return false;
405}
406#endif
407
df18600f
SW
408#ifndef FIO_EMULATED_MKDIR_TWO
409# define fio_mkdir(path, mode) mkdir(path, mode)
ebac4655 410#endif
df18600f
SW
411
412#endif /* FIO_OS_H */