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