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