libcfs/include/libcfs/posix/libcfs.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/posix/libcfs.h
  37  *
  38  * Defines for posix userspace.
  39  *
  40  * Author: Robert Read <rread@sun.com>
  41  */
  42
  43 #ifndef __LIBCFS_POSIX_LIBCFS_H__
  44 #define __LIBCFS_POSIX_LIBCFS_H__
  45
  46 #include <errno.h>
  47 #include <sys/errno.h>
  48 #include <string.h>
  49 #include <stdarg.h>
  50 #include <stddef.h>
  51 #include <stdio.h>
  52 #include <stdlib.h>
  53 #include <sys/mman.h>
  54 #include <sys/stat.h>
  55 #include <fcntl.h>
  56 #include <limits.h>
  57 #include <assert.h>
  58 #include <sys/ioctl.h>
  59 #include <sys/signal.h>
  60 #include <signal.h>
  61 #include <sys/time.h>
  62 #include <time.h>
  63 #include <getopt.h>
  64 #include <signal.h>
  65 #include <pwd.h>
  66 #include <sys/socket.h>
  67 #include <sys/utsname.h>
  68 #include <ctype.h>
  69 #include <stdbool.h>
  70 #include <limits.h>
  71
  72 #ifdef HAVE_NETDB_H
  73 #include <netdb.h>
  74 #endif
  75
  76 #ifdef HAVE_UNISTD_H
  77 #include <unistd.h>
  78 #endif
  79
  80 #ifdef HAVE_LIBPTHREAD
  81 #include <pthread.h>
  82 #endif
  83
  84 #if defined(HAVE_SYS_TYPES_H)
  85 #include <sys/types.h>
  86 #endif
  87
  88 #ifdef HAVE_SYS_USER_H
  89 # include <sys/user.h>
  90 #endif
  91
  92 #ifdef HAVE_SYS_VFS_H
  93 # include <sys/vfs.h>
  94 #endif
  95
  96 #ifdef HAVE_STDINT_H
  97 # include <stdint.h>
  98 #endif
  99
 100 #include <libcfs/list.h>
 101 #include <libcfs/user-time.h>
 102 #include <libcfs/user-prim.h>
 103 #include <libcfs/user-mem.h>
 104 #include <libcfs/user-lock.h>
 105 #include <libcfs/user-tcpip.h>
 106 #include <libcfs/user-bitops.h>
 107
 108 # define do_gettimeofday(tv) gettimeofday(tv, NULL);
 109 typedef unsigned long long cfs_cycles_t;
 110
 111 /* this goes in posix-fs.h */
 112 #include <sys/mount.h>
 113
 114 #ifdef __linux__
 115 #include <mntent.h>
 116 #endif
 117
 118 #define fget(x) NULL
 119 #define fput(f) do {} while (0)
 120
 121 #ifdef __linux__
 122 /* Userpace byte flipping */
 123 # include <endian.h>
 124 # include <byteswap.h>
 125 # define __swab16(x) bswap_16(x)
 126 # define __swab32(x) bswap_32(x)
 127 # define __swab64(x) bswap_64(x)
 128 # define __swab16s(x) do {*(x) = bswap_16(*(x));} while (0)
 129 # define __swab32s(x) do {*(x) = bswap_32(*(x));} while (0)
 130 # define __swab64s(x) do {*(x) = bswap_64(*(x));} while (0)
 131 # if __BYTE_ORDER == __LITTLE_ENDIAN
 132 #  define le16_to_cpu(x) (x)
 133 #  define cpu_to_le16(x) (x)
 134 #  define le32_to_cpu(x) (x)
 135 #  define cpu_to_le32(x) (x)
 136 #  define le64_to_cpu(x) (x)
 137 #  define cpu_to_le64(x) (x)
 138
 139 #  define be16_to_cpu(x) bswap_16(x)
 140 #  define cpu_to_be16(x) bswap_16(x)
 141 #  define be32_to_cpu(x) bswap_32(x)
 142 #  define cpu_to_be32(x) bswap_32(x)
 143 #  define be64_to_cpu(x) (__u64)bswap_64(x)
 144 #  define cpu_to_be64(x) (__u64)bswap_64(x)
 145 # else
 146 #  if __BYTE_ORDER == __BIG_ENDIAN
 147 #   define le16_to_cpu(x) bswap_16(x)
 148 #   define cpu_to_le16(x) bswap_16(x)
 149 #   define le32_to_cpu(x) bswap_32(x)
 150 #   define cpu_to_le32(x) bswap_32(x)
 151 #   define le64_to_cpu(x) (__u64)bswap_64(x)
 152 #   define cpu_to_le64(x) (__u64)bswap_64(x)
 153
 154 #   define be16_to_cpu(x) (x)
 155 #   define cpu_to_be16(x) (x)
 156 #   define be32_to_cpu(x) (x)
 157 #   define cpu_to_be32(x) (x)
 158 #   define be64_to_cpu(x) (x)
 159 #   define cpu_to_be64(x) (x)
 160
 161 #  else
 162 #   error "Unknown byte order"
 163 #  endif /* __BIG_ENDIAN */
 164 # endif /* __LITTLE_ENDIAN */
 165 #endif
 166
 167 # ifndef THREAD_SIZE /* x86_64 linux has THREAD_SIZE in userspace */
 168 #  define THREAD_SIZE 8192
 169 # else
 170 # endif
 171
 172 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 173 #define CDEBUG_STACK() (0L)
 174
 175 /* initial pid  */
 176 #define LUSTRE_LNET_PID          12345
 177
 178 #define ENTRY_NESTING_SUPPORT (1)
 179 #define ENTRY_NESTING   do {;} while (0)
 180 #define EXIT_NESTING   do {;} while (0)
 181 #define __current_nesting_level() (0)
 182
 183 /**
 184  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 185  *
 186  * Implementation is in linux-curproc.c
 187  */
 188 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 189
 190 typedef __u32 kernel_cap_t;
 191
 192 /**
 193  * Module support (probably shouldn't be used in generic code?)
 194  */
 195 struct module {
 196         int count;
 197         char *name;
 198 };
 199
 200 static inline void MODULE_AUTHOR(char *name)
 201 {
 202         printf("%s\n", name);
 203 }
 204 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
 205 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
 206
 207 #define THIS_MODULE (void *)0x11111
 208 #define __init
 209 #define __exit
 210
 211 static inline int request_module(const char *name, ...)
 212 {
 213         return (-EINVAL);
 214 }
 215
 216 static inline void __module_get(struct module *module)
 217 {
 218 }
 219
 220 static inline int try_module_get(struct module *module)
 221 {
 222         return 1;
 223 }
 224
 225 static inline void module_put(struct module *module)
 226 {
 227 }
 228
 229
 230 static inline int module_refcount(struct module *m)
 231 {
 232         return 1;
 233 }
 234
 235 /***************************************************************************
 236  *
 237  * Linux kernel slab shrinker emulation. Currently used only in lu_object.c
 238  *
 239  ***************************************************************************/
 240
 241 struct shrinker {
 242 #ifndef __INTEL_COMPILER
 243         ;
 244 #endif
 245 };
 246
 247 struct shrinker_var {
 248 #ifndef __INTEL_COMPILER
 249         ;
 250 #endif
 251 };
 252
 253 #define DEF_SHRINKER_VAR(name, shrink, count, scan) \
 254                 struct shrinker_var name = {};
 255
 256 #define DEFAULT_SEEKS (0)
 257
 258 static inline
 259 struct shrinker *set_shrinker(int seeks, struct shrinker_var *var)
 260 {
 261         return (struct shrinker *)0xdeadbea1; /* Cannot return NULL here */
 262 }
 263
 264 static inline void remove_shrinker(struct shrinker *shrinker)
 265 {
 266 }
 267
 268 /***************************************************************************
 269  *
 270  * Linux kernel radix tree emulation.
 271  *
 272  * XXX this stub-implementation assumes that elements stored in a radix tree
 273  *     are struct page's and nothing else. Proper implementation will be
 274  *     committed soon.
 275  *
 276  ***************************************************************************/
 277
 278 struct radix_tree_root {
 279         struct list_head list;
 280         void *rnode;
 281 };
 282
 283 struct radix_tree_node {
 284         struct list_head _node;
 285         unsigned long index;
 286         void *item;
 287 };
 288
 289 #define RADIX_TREE_INIT(mask)   {       \
 290                 NOT_IMPLEMENTED         \
 291 }
 292
 293 #define RADIX_TREE(name, mask) \
 294         struct radix_tree_root name = RADIX_TREE_INIT(mask)
 295
 296
 297 #define INIT_RADIX_TREE(root, mask)                                     \
 298 do {                                                                    \
 299         INIT_LIST_HEAD(&((struct radix_tree_root *)root)->list);        \
 300         ((struct radix_tree_root *)root)->rnode = NULL;                 \
 301 } while (0)
 302
 303 static inline int radix_tree_insert(struct radix_tree_root *root,
 304                                         unsigned long idx, void *item)
 305 {
 306         struct radix_tree_node *node;
 307         node = malloc(sizeof(*node));
 308         if (!node)
 309                 return -ENOMEM;
 310
 311         INIT_LIST_HEAD(&node->_node);
 312         node->index = idx;
 313         node->item = item;
 314         list_add_tail(&node->_node, &root->list);
 315         root->rnode = (void *)1001;
 316         return 0;
 317 }
 318
 319 static inline struct radix_tree_node *
 320 radix_tree_lookup0(struct radix_tree_root *root, unsigned long idx)
 321 {
 322         struct radix_tree_node *node;
 323
 324         if (list_empty(&root->list))
 325                 return NULL;
 326
 327         list_for_each_entry(node, &root->list, _node)
 328                 if (node->index == idx)
 329                         return node;
 330
 331         return NULL;
 332 }
 333
 334 static inline void *radix_tree_lookup(struct radix_tree_root *root,
 335                                         unsigned long idx)
 336 {
 337         struct radix_tree_node *node = radix_tree_lookup0(root, idx);
 338
 339         if (node)
 340                 return node->item;
 341         return node;
 342 }
 343
 344 static inline void *radix_tree_delete(struct radix_tree_root *root,
 345                                         unsigned long idx)
 346 {
 347         struct radix_tree_node *p = radix_tree_lookup0(root, idx);
 348         void *item;
 349
 350         if (p == NULL)
 351                 return NULL;
 352
 353         list_del_init(&p->_node);
 354         item = p->item;
 355         free(p);
 356         if (list_empty(&root->list))
 357                 root->rnode = NULL;
 358
 359         return item;
 360 }
 361
 362 static inline unsigned int
 363 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
 364                        unsigned long first_index, unsigned int max_items)
 365 {
 366         int i;
 367         int j = 0;
 368
 369         for (i = 0; i < max_items; i++, first_index++) {
 370                 results[j++] = radix_tree_lookup(root, first_index);
 371                 if (results[j - 1] == NULL)
 372                         --j;
 373         }
 374
 375         return j;
 376 }
 377
 378 static inline int radix_tree_preload(int gfp_mask)
 379 {
 380         return 0;
 381 }
 382
 383 void radix_tree_init(void);
 384
 385 static inline void radix_tree_preload_end(void)
 386 {
 387 }
 388
 389 /***************************************************************************
 390  *
 391  * Linux kernel red black tree emulation.
 392  *
 393  ***************************************************************************/
 394 struct rb_node {
 395         unsigned long  rb_parent_color;
 396 #define RB_RED          0
 397 #define RB_BLACK        1
 398         struct rb_node *rb_right;
 399         struct rb_node *rb_left;
 400 };
 401
 402 struct rb_root {
 403         struct rb_node *rb_node;
 404 };
 405
 406
 407 #define rb_parent(r)   ((struct rb_node *)((r)->rb_parent_color & ~3))
 408 #define rb_color(r)   ((r)->rb_parent_color & 1)
 409 #define rb_is_red(r)   (!rb_color(r))
 410 #define rb_is_black(r) rb_color(r)
 411 #define rb_set_red(r)  do { (r)->rb_parent_color &= ~1; } while (0)
 412 #define rb_set_black(r)  do { (r)->rb_parent_color |= 1; } while (0)
 413
 414 static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
 415 {
 416         rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
 417 }
 418 static inline void rb_set_color(struct rb_node *rb, int color)
 419 {
 420         rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
 421 }
 422
 423 #define RB_ROOT ((struct rb_root) { NULL, })
 424 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
 425
 426 #define RB_EMPTY_ROOT(root)     ((root)->rb_node == NULL)
 427 #define RB_EMPTY_NODE(node)     (rb_parent(node) == node)
 428 #define RB_CLEAR_NODE(node)     (rb_set_parent(node, node))
 429
 430 static inline void rb_init_node(struct rb_node *rb)
 431 {
 432         rb->rb_parent_color = 0;
 433         rb->rb_right = NULL;
 434         rb->rb_left = NULL;
 435         RB_CLEAR_NODE(rb);
 436 }
 437
 438 extern void rb_insert_color(struct rb_node *, struct rb_root *);
 439 extern void rb_erase(struct rb_node *, struct rb_root *);
 440
 441 /* Find logical next and previous nodes in a tree */
 442 extern struct rb_node *rb_next(const struct rb_node *);
 443 extern struct rb_node *rb_prev(const struct rb_node *);
 444 extern struct rb_node *rb_first(const struct rb_root *);
 445 extern struct rb_node *rb_last(const struct rb_root *);
 446 static inline void rb_link_node(struct rb_node *node, struct rb_node *parent,
 447                                 struct rb_node **rb_link)
 448 {
 449         node->rb_parent_color = (unsigned long)parent;
 450         node->rb_left = node->rb_right = NULL;
 451
 452         *rb_link = node;
 453 }
 454
 455 /***************************************************************************
 456  *
 457  * End of Linux kernel red black tree emulation.
 458  *
 459  ***************************************************************************/
 460
 461 typedef ssize_t (*read_actor_t)();
 462
 463 # ifndef IFTODT
 464 #  define IFSHIFT               12
 465 #  define IFTODT(type)          (((type) & S_IFMT) >> IFSHIFT)
 466 #  define DTTOIF(dirtype)       ((dirtype) << IFSHIFT)
 467 # endif
 468
 469 #ifndef ERESTARTSYS
 470 #define ERESTARTSYS ERESTART
 471 #endif
 472
 473 #endif