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