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