Add include-what-you-use pragmas
[fio.git] / os / os.h
1 #ifndef FIO_OS_H
2 #define FIO_OS_H
3
4 #include <sys/types.h>
5 #include <sys/socket.h>
6 #include <fcntl.h>
7 #include <pthread.h>
8 #include <unistd.h>
9 #include <stdlib.h>
10
11 #include "../arch/arch.h" /* IWYU pragma: export */
12 #include "../lib/types.h"
13
14 enum {
15         os_linux = 1,
16         os_aix,
17         os_freebsd,
18         os_hpux,
19         os_mac,
20         os_netbsd,
21         os_openbsd,
22         os_solaris,
23         os_windows,
24         os_android,
25         os_dragonfly,
26
27         os_nr,
28 };
29
30 /* IWYU pragma: begin_exports */
31 #if defined(__ANDROID__)
32 #include "os-android.h"
33 #elif defined(__linux__)
34 #include "os-linux.h"
35 #elif defined(__FreeBSD__)
36 #include "os-freebsd.h"
37 #elif defined(__OpenBSD__)
38 #include "os-openbsd.h"
39 #elif defined(__NetBSD__)
40 #include "os-netbsd.h"
41 #elif defined(__sun__)
42 #include "os-solaris.h"
43 #elif defined(__APPLE__)
44 #include "os-mac.h"
45 #elif defined(_AIX)
46 #include "os-aix.h"
47 #elif defined(__hpux)
48 #include "os-hpux.h"
49 #elif defined(WIN32)
50 #include "os-windows.h"
51 #elif defined (__DragonFly__)
52 #include "os-dragonfly.h"
53 #else
54 #error "unsupported os"
55 #endif
56
57 #ifdef CONFIG_POSIXAIO
58 #include <aio.h>
59 #ifndef FIO_OS_HAVE_AIOCB_TYPEDEF
60 typedef struct aiocb os_aiocb_t;
61 #endif
62 #endif
63
64 #ifndef CONFIG_STRSEP
65 #include "../oslib/strsep.h"
66 #endif
67
68 #ifndef CONFIG_STRLCAT
69 #include "../oslib/strlcat.h"
70 #endif
71 /* IWYU pragma: end_exports */
72
73 #ifdef MSG_DONTWAIT
74 #define OS_MSG_DONTWAIT MSG_DONTWAIT
75 #endif
76
77 #ifndef POSIX_FADV_DONTNEED
78 #define POSIX_FADV_DONTNEED     (0)
79 #define POSIX_FADV_SEQUENTIAL   (0)
80 #define POSIX_FADV_RANDOM       (0)
81 #define POSIX_FADV_NORMAL       (0)
82 #endif
83
84 #ifndef FIO_HAVE_CPU_AFFINITY
85 #define fio_cpu_clear(mask, cpu)        do { } while (0)
86 typedef unsigned long os_cpu_mask_t;
87
88 static inline int fio_setaffinity(int pid, os_cpu_mask_t cpumask)
89 {
90         return 0;
91 }
92
93 static inline int fio_getaffinity(int pid, os_cpu_mask_t *cpumask)
94 {
95         return -1;
96 }
97
98 static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
99 {
100         return -1;
101 }
102
103 static inline int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
104 {
105         return 0;
106 }
107 #else
108 extern int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu);
109 #endif
110
111 #ifndef FIO_HAVE_IOPRIO
112 #define ioprio_set(which, who, prioclass, prio) (0)
113 #endif
114
115 #ifndef FIO_HAVE_ODIRECT
116 #define OS_O_DIRECT                     0
117 #else
118 #define OS_O_DIRECT                     O_DIRECT
119 #endif
120
121 #ifdef OS_O_ATOMIC
122 #define FIO_O_ATOMIC                    OS_O_ATOMIC
123 #else
124 #define FIO_O_ATOMIC                    0
125 #endif
126
127 #ifndef FIO_HAVE_HUGETLB
128 #define SHM_HUGETLB                     0
129 #define MAP_HUGETLB                     0
130 #ifndef FIO_HUGE_PAGE
131 #define FIO_HUGE_PAGE                   0
132 #endif
133 #else
134 #ifndef FIO_HUGE_PAGE
135 #define FIO_HUGE_PAGE                   4194304
136 #endif
137 #endif
138
139 #ifndef FIO_HAVE_MMAP_HUGE
140 #define MAP_HUGETLB                     0
141 #endif
142
143 #ifndef FIO_O_NOATIME
144 #define FIO_O_NOATIME                   0
145 #endif
146
147 #ifndef OS_RAND_MAX
148 #define OS_RAND_MAX                     RAND_MAX
149 #endif
150
151 #ifndef FIO_HAVE_RAWBIND
152 #define fio_lookup_raw(dev, majdev, mindev)     1
153 #endif
154
155 #ifndef FIO_PREFERRED_ENGINE
156 #define FIO_PREFERRED_ENGINE    "psync"
157 #endif
158
159 #ifndef FIO_OS_PATH_SEPARATOR
160 #define FIO_OS_PATH_SEPARATOR   '/'
161 #endif
162
163 #ifndef FIO_PREFERRED_CLOCK_SOURCE
164 #ifdef CONFIG_CLOCK_GETTIME
165 #define FIO_PREFERRED_CLOCK_SOURCE      CS_CGETTIME
166 #else
167 #define FIO_PREFERRED_CLOCK_SOURCE      CS_GTOD
168 #endif
169 #endif
170
171 #ifndef FIO_MAX_JOBS
172 #define FIO_MAX_JOBS            4096
173 #endif
174
175 #ifndef CONFIG_SOCKLEN_T
176 typedef unsigned int socklen_t;
177 #endif
178
179 #ifndef FIO_OS_HAS_CTIME_R
180 #define os_ctime_r(x, y, z)     (void) ctime_r((x), (y))
181 #endif
182
183 #ifdef FIO_USE_GENERIC_SWAP
184 static inline uint16_t fio_swap16(uint16_t val)
185 {
186         return (val << 8) | (val >> 8);
187 }
188
189 static inline uint32_t fio_swap32(uint32_t val)
190 {
191         val = ((val & 0xff00ff00UL) >> 8) | ((val & 0x00ff00ffUL) << 8);
192
193         return (val >> 16) | (val << 16);
194 }
195
196 static inline uint64_t fio_swap64(uint64_t val)
197 {
198         val = ((val & 0xff00ff00ff00ff00ULL) >> 8) |
199               ((val & 0x00ff00ff00ff00ffULL) << 8);
200         val = ((val & 0xffff0000ffff0000ULL) >> 16) |
201               ((val & 0x0000ffff0000ffffULL) << 16);
202
203         return (val >> 32) | (val << 32);
204 }
205 #endif
206
207 #ifndef FIO_HAVE_BYTEORDER_FUNCS
208 #ifdef CONFIG_LITTLE_ENDIAN
209 #define __be64_to_cpu(x)                fio_swap64(x)
210 #define __le16_to_cpu(x)                (x)
211 #define __le32_to_cpu(x)                (x)
212 #define __le64_to_cpu(x)                (x)
213 #define __cpu_to_be64(x)                fio_swap64(x)
214 #define __cpu_to_le16(x)                (x)
215 #define __cpu_to_le32(x)                (x)
216 #define __cpu_to_le64(x)                (x)
217 #else
218 #define __be64_to_cpu(x)                (x)
219 #define __le16_to_cpu(x)                fio_swap16(x)
220 #define __le32_to_cpu(x)                fio_swap32(x)
221 #define __le64_to_cpu(x)                fio_swap64(x)
222 #define __cpu_to_be64(x)                (x)
223 #define __cpu_to_le16(x)                fio_swap16(x)
224 #define __cpu_to_le32(x)                fio_swap32(x)
225 #define __cpu_to_le64(x)                fio_swap64(x)
226 #endif
227 #endif /* FIO_HAVE_BYTEORDER_FUNCS */
228
229 #ifdef FIO_INTERNAL
230 #define be64_to_cpu(val) ({                     \
231         typecheck(uint64_t, val);               \
232         __be64_to_cpu(val);                     \
233 })
234 #define le16_to_cpu(val) ({                     \
235         typecheck(uint16_t, val);               \
236         __le16_to_cpu(val);                     \
237 })
238 #define le32_to_cpu(val) ({                     \
239         typecheck(uint32_t, val);               \
240         __le32_to_cpu(val);                     \
241 })
242 #define le64_to_cpu(val) ({                     \
243         typecheck(uint64_t, val);               \
244         __le64_to_cpu(val);                     \
245 })
246 #endif
247
248 #define cpu_to_be64(val) ({                     \
249         typecheck(uint64_t, val);               \
250         __cpu_to_be64(val);                     \
251 })
252 #define cpu_to_le16(val) ({                     \
253         typecheck(uint16_t, val);               \
254         __cpu_to_le16(val);                     \
255 })
256 #define cpu_to_le32(val) ({                     \
257         typecheck(uint32_t, val);               \
258         __cpu_to_le32(val);                     \
259 })
260 #define cpu_to_le64(val) ({                     \
261         typecheck(uint64_t, val);               \
262         __cpu_to_le64(val);                     \
263 })
264
265 #define FIO_DEF_CL_SIZE         128
266
267 static inline int os_cache_line_size(void)
268 {
269 #ifdef FIO_HAVE_CL_SIZE
270         int ret = arch_cache_line_size();
271
272         if (ret <= 0)
273                 return FIO_DEF_CL_SIZE;
274
275         return ret;
276 #else
277         return FIO_DEF_CL_SIZE;
278 #endif
279 }
280
281 #ifdef FIO_USE_GENERIC_BDEV_SIZE
282 static inline int blockdev_size(struct fio_file *f, unsigned long long *bytes)
283 {
284         off_t end;
285
286         *bytes = 0;
287
288         end = lseek(f->fd, 0, SEEK_END);
289         if (end < 0)
290                 return errno;
291
292         *bytes = end;
293         return 0;
294 }
295 #endif
296
297 #ifdef FIO_USE_GENERIC_RAND
298 typedef unsigned int os_random_state_t;
299
300 static inline void os_random_seed(unsigned long seed, os_random_state_t *rs)
301 {
302         srand(seed);
303 }
304
305 static inline long os_random_long(os_random_state_t *rs)
306 {
307         long val;
308
309         val = rand_r(rs);
310         return val;
311 }
312 #endif
313
314 #ifdef FIO_USE_GENERIC_INIT_RANDOM_STATE
315 static inline int init_random_seeds(unsigned long *rand_seeds, int size)
316 {
317         int fd;
318
319         fd = open("/dev/urandom", O_RDONLY);
320         if (fd == -1) {
321                 return 1;
322         }
323
324         if (read(fd, rand_seeds, size) < size) {
325                 close(fd);
326                 return 1;
327         }
328
329         close(fd);
330         return 0;
331 }
332 #endif
333
334 #ifndef FIO_HAVE_FS_STAT
335 static inline unsigned long long get_fs_free_size(const char *path)
336 {
337         return 0;
338 }
339 #endif
340
341 #ifndef FIO_HAVE_CPU_ONLINE_SYSCONF
342 static inline unsigned int cpus_online(void)
343 {
344         return sysconf(_SC_NPROCESSORS_ONLN);
345 }
346 #endif
347
348 #ifndef CPU_COUNT
349 #ifdef FIO_HAVE_CPU_AFFINITY
350 static inline int CPU_COUNT(os_cpu_mask_t *mask)
351 {
352         int max_cpus = cpus_online();
353         int nr_cpus, i;
354
355         for (i = 0, nr_cpus = 0; i < max_cpus; i++)
356                 if (fio_cpu_isset(mask, i))
357                         nr_cpus++;
358
359         return nr_cpus;
360 }
361 #endif
362 #endif
363
364 #ifndef FIO_HAVE_GETTID
365 static inline int gettid(void)
366 {
367         return getpid();
368 }
369 #endif
370
371 #ifndef FIO_HAVE_SHM_ATTACH_REMOVED
372 static inline int shm_attach_to_open_removed(void)
373 {
374         return 0;
375 }
376 #endif
377
378 #ifndef FIO_HAVE_NATIVE_FALLOCATE
379 static inline bool fio_fallocate(struct fio_file *f, uint64_t offset, uint64_t len)
380 {
381         errno = ENOSYS;
382         return false;
383 }
384 #endif
385
386 #if defined(CONFIG_POSIX_FALLOCATE) || defined(FIO_HAVE_NATIVE_FALLOCATE)
387 # define FIO_HAVE_ANY_FALLOCATE
388 #endif
389
390 #endif