Rename get_fs_size() to get_fs_free_size()
[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"
12
13 enum {
14         os_linux = 1,
15         os_aix,
16         os_freebsd,
17         os_hpux,
18         os_mac,
19         os_netbsd,
20         os_openbsd,
21         os_solaris,
22         os_windows,
23         os_android,
24         os_dragonfly,
25
26         os_nr,
27 };
28
29 #if defined(__ANDROID__)
30 #include "os-android.h"
31 #elif defined(__linux__)
32 #include "os-linux.h"
33 #elif defined(__FreeBSD__)
34 #include "os-freebsd.h"
35 #elif defined(__OpenBSD__)
36 #include "os-openbsd.h"
37 #elif defined(__NetBSD__)
38 #include "os-netbsd.h"
39 #elif defined(__sun__)
40 #include "os-solaris.h"
41 #elif defined(__APPLE__)
42 #include "os-mac.h"
43 #elif defined(_AIX)
44 #include "os-aix.h"
45 #elif defined(__hpux)
46 #include "os-hpux.h"
47 #elif defined(WIN32)
48 #include "os-windows.h"
49 #elif defined (__DragonFly__)
50 #include "os-dragonfly.h"
51 #else
52 #error "unsupported os"
53 #endif
54
55 #ifdef CONFIG_POSIXAIO
56 #include <aio.h>
57 #ifndef FIO_OS_HAVE_AIOCB_TYPEDEF
58 typedef struct aiocb os_aiocb_t;
59 #endif
60 #endif
61
62 #ifdef FIO_HAVE_SGIO
63 #include <linux/fs.h>
64 #include <scsi/sg.h>
65 #endif
66
67 #ifndef CONFIG_STRSEP
68 #include "../lib/strsep.h"
69 #endif
70
71 #ifdef MSG_DONTWAIT
72 #define OS_MSG_DONTWAIT MSG_DONTWAIT
73 #endif
74
75 #ifndef POSIX_FADV_DONTNEED
76 #define POSIX_FADV_DONTNEED     (0)
77 #define POSIX_FADV_SEQUENTIAL   (0)
78 #define POSIX_FADV_RANDOM       (0)
79 #endif
80
81 #ifndef FIO_HAVE_CPU_AFFINITY
82 #define fio_getaffinity(pid, mask)      do { } while (0)
83 #define fio_cpu_clear(mask, cpu)        do { } while (0)
84 typedef unsigned long os_cpu_mask_t;
85
86 static inline int fio_setaffinity(int pid, os_cpu_mask_t cpumask)
87 {
88         return 0;
89 }
90
91 static inline int fio_cpuset_exit(os_cpu_mask_t *mask)
92 {
93         return -1;
94 }
95
96 static inline int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
97 {
98         return 0;
99 }
100 #else
101 extern int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu);
102 #endif
103
104 #ifndef FIO_HAVE_IOPRIO
105 #define ioprio_set(which, who, prioclass, prio) (0)
106 #endif
107
108 #ifndef FIO_HAVE_ODIRECT
109 #define OS_O_DIRECT                     0
110 #else
111 #define OS_O_DIRECT                     O_DIRECT
112 #endif
113
114 #ifdef OS_O_ATOMIC
115 #define FIO_O_ATOMIC                    OS_O_ATOMIC
116 #else
117 #define FIO_O_ATOMIC                    0
118 #endif
119
120 #ifndef FIO_HAVE_HUGETLB
121 #define SHM_HUGETLB                     0
122 #define MAP_HUGETLB                     0
123 #ifndef FIO_HUGE_PAGE
124 #define FIO_HUGE_PAGE                   0
125 #endif
126 #else
127 #ifndef FIO_HUGE_PAGE
128 #define FIO_HUGE_PAGE                   4194304
129 #endif
130 #endif
131
132 #ifndef FIO_HAVE_MMAP_HUGE
133 #define MAP_HUGETLB                     0
134 #endif
135
136 #ifndef FIO_O_NOATIME
137 #define FIO_O_NOATIME                   0
138 #endif
139
140 #ifndef OS_RAND_MAX
141 #define OS_RAND_MAX                     RAND_MAX
142 #endif
143
144 #ifndef FIO_HAVE_RAWBIND
145 #define fio_lookup_raw(dev, majdev, mindev)     1
146 #endif
147
148 #ifndef FIO_PREFERRED_ENGINE
149 #define FIO_PREFERRED_ENGINE    "sync"
150 #endif
151
152 #ifndef FIO_OS_PATH_SEPARATOR
153 #define FIO_OS_PATH_SEPARATOR   "/"
154 #endif
155
156 #ifndef FIO_PREFERRED_CLOCK_SOURCE
157 #ifdef CONFIG_CLOCK_GETTIME
158 #define FIO_PREFERRED_CLOCK_SOURCE      CS_CGETTIME
159 #else
160 #define FIO_PREFERRED_CLOCK_SOURCE      CS_GTOD
161 #endif
162 #endif
163
164 #ifndef FIO_MAX_JOBS
165 #define FIO_MAX_JOBS            2048
166 #endif
167
168 #ifndef CONFIG_SOCKLEN_T
169 typedef unsigned int socklen_t;
170 #endif
171
172 #ifndef FIO_OS_HAS_CTIME_R
173 #define os_ctime_r(x, y, z)     (void) ctime_r((x), (y))
174 #endif
175
176 #ifdef FIO_USE_GENERIC_SWAP
177 static inline uint16_t fio_swap16(uint16_t val)
178 {
179         return (val << 8) | (val >> 8);
180 }
181
182 static inline uint32_t fio_swap32(uint32_t val)
183 {
184         val = ((val & 0xff00ff00UL) >> 8) | ((val & 0x00ff00ffUL) << 8);
185
186         return (val >> 16) | (val << 16);
187 }
188
189 static inline uint64_t fio_swap64(uint64_t val)
190 {
191         val = ((val & 0xff00ff00ff00ff00ULL) >> 8) |
192               ((val & 0x00ff00ff00ff00ffULL) << 8);
193         val = ((val & 0xffff0000ffff0000ULL) >> 16) |
194               ((val & 0x0000ffff0000ffffULL) << 16);
195
196         return (val >> 32) | (val << 32);
197 }
198 #endif
199
200 #ifndef FIO_HAVE_BYTEORDER_FUNCS
201 #ifdef CONFIG_LITTLE_ENDIAN
202 #define __le16_to_cpu(x)                (x)
203 #define __le32_to_cpu(x)                (x)
204 #define __le64_to_cpu(x)                (x)
205 #define __cpu_to_le16(x)                (x)
206 #define __cpu_to_le32(x)                (x)
207 #define __cpu_to_le64(x)                (x)
208 #else
209 #define __le16_to_cpu(x)                fio_swap16(x)
210 #define __le32_to_cpu(x)                fio_swap32(x)
211 #define __le64_to_cpu(x)                fio_swap64(x)
212 #define __cpu_to_le16(x)                fio_swap16(x)
213 #define __cpu_to_le32(x)                fio_swap32(x)
214 #define __cpu_to_le64(x)                fio_swap64(x)
215 #endif
216 #endif /* FIO_HAVE_BYTEORDER_FUNCS */
217
218 #ifdef FIO_INTERNAL
219 #define le16_to_cpu(val) ({                     \
220         typecheck(uint16_t, val);               \
221         __le16_to_cpu(val);                     \
222 })
223 #define le32_to_cpu(val) ({                     \
224         typecheck(uint32_t, val);               \
225         __le32_to_cpu(val);                     \
226 })
227 #define le64_to_cpu(val) ({                     \
228         typecheck(uint64_t, val);               \
229         __le64_to_cpu(val);                     \
230 })
231 #endif
232
233 #define cpu_to_le16(val) ({                     \
234         typecheck(uint16_t, val);               \
235         __cpu_to_le16(val);                     \
236 })
237 #define cpu_to_le32(val) ({                     \
238         typecheck(uint32_t, val);               \
239         __cpu_to_le32(val);                     \
240 })
241 #define cpu_to_le64(val) ({                     \
242         typecheck(uint64_t, val);               \
243         __cpu_to_le64(val);                     \
244 })
245
246 #ifndef FIO_HAVE_BLKTRACE
247 static inline int is_blktrace(const char *fname, int *need_swap)
248 {
249         return 0;
250 }
251 struct thread_data;
252 static inline int load_blktrace(struct thread_data *td, const char *fname,
253                                 int need_swap)
254 {
255         return 1;
256 }
257 #endif
258
259 #define FIO_DEF_CL_SIZE         128
260
261 static inline int os_cache_line_size(void)
262 {
263 #ifdef FIO_HAVE_CL_SIZE
264         int ret = arch_cache_line_size();
265
266         if (ret <= 0)
267                 return FIO_DEF_CL_SIZE;
268
269         return ret;
270 #else
271         return FIO_DEF_CL_SIZE;
272 #endif
273 }
274
275 #ifdef FIO_USE_GENERIC_BDEV_SIZE
276 static inline int blockdev_size(struct fio_file *f, unsigned long long *bytes)
277 {
278         off_t end;
279
280         *bytes = 0;
281
282         end = lseek(f->fd, 0, SEEK_END);
283         if (end < 0)
284                 return errno;
285
286         *bytes = end;
287         return 0;
288 }
289 #endif
290
291 #ifdef FIO_USE_GENERIC_RAND
292 typedef unsigned int os_random_state_t;
293
294 static inline void os_random_seed(unsigned long seed, os_random_state_t *rs)
295 {
296         srand(seed);
297 }
298
299 static inline long os_random_long(os_random_state_t *rs)
300 {
301         long val;
302
303         val = rand_r(rs);
304         return val;
305 }
306 #endif
307
308 #ifdef FIO_USE_GENERIC_INIT_RANDOM_STATE
309 extern void td_fill_rand_seeds(struct thread_data *td);
310 /*
311  * Initialize the various random states we need (random io, block size ranges,
312  * read/write mix, etc).
313  */
314 static inline int init_random_state(struct thread_data *td, unsigned long *rand_seeds, int size)
315 {
316         int fd;
317
318         fd = open("/dev/urandom", O_RDONLY);
319         if (fd == -1) {
320                 return 1;
321         }
322
323         if (read(fd, rand_seeds, size) < size) {
324                 close(fd);
325                 return 1;
326         }
327
328         close(fd);
329         td_fill_rand_seeds(td);
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 #endif