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
  71 #ifdef HAVE_NETDB_H
  72 #include <netdb.h>
  73 #endif
  74
  75 #ifdef HAVE_UNISTD_H
  76 #include <unistd.h>
  77 #endif
  78
  79 #ifdef HAVE_LIBPTHREAD
  80 #include <pthread.h>
  81 #endif
  82
  83 #if defined(HAVE_SYS_TYPES_H)
  84 #include <sys/types.h>
  85 #endif
  86
  87 #ifdef HAVE_SYS_USER_H
  88 # include <sys/user.h>
  89 #endif
  90
  91 #ifdef HAVE_SYS_VFS_H
  92 # include <sys/vfs.h>
  93 #endif
  94
  95 #ifdef HAVE_STDINT_H
  96 # include <stdint.h>
  97 #endif
  98
  99 #include <libcfs/list.h>
 100 #include <libcfs/posix/posix-types.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/posix/posix-wordsize.h>
 107 #include <libcfs/user-bitops.h>
 108
 109 # define cfs_gettimeofday(tv) gettimeofday(tv, NULL);
 110 typedef unsigned long long cfs_cycles_t;
 111
 112 #define IS_ERR(a) ((unsigned long)(a) > (unsigned long)-1000L)
 113 #define IS_ERR_VALUE(a) (IS_ERR(a))
 114 #define PTR_ERR(a) ((long)(a))
 115 #define ERR_PTR(a) ((void*)((long)(a)))
 116
 117 /* this goes in posix-fs.h */
 118 #include <sys/mount.h>
 119
 120 #ifdef __linux__
 121 #include <mntent.h>
 122 #endif
 123
 124 #define fget(x) NULL
 125 #define fput(f) do {} while (0)
 126
 127 #ifdef __linux__
 128 /* Userpace byte flipping */
 129 # include <endian.h>
 130 # include <byteswap.h>
 131 # define __swab16(x) bswap_16(x)
 132 # define __swab32(x) bswap_32(x)
 133 # define __swab64(x) bswap_64(x)
 134 # define __swab16s(x) do {*(x) = bswap_16(*(x));} while (0)
 135 # define __swab32s(x) do {*(x) = bswap_32(*(x));} while (0)
 136 # define __swab64s(x) do {*(x) = bswap_64(*(x));} while (0)
 137 # if __BYTE_ORDER == __LITTLE_ENDIAN
 138 #  define le16_to_cpu(x) (x)
 139 #  define cpu_to_le16(x) (x)
 140 #  define le32_to_cpu(x) (x)
 141 #  define cpu_to_le32(x) (x)
 142 #  define le64_to_cpu(x) (x)
 143 #  define cpu_to_le64(x) (x)
 144
 145 #  define be16_to_cpu(x) bswap_16(x)
 146 #  define cpu_to_be16(x) bswap_16(x)
 147 #  define be32_to_cpu(x) bswap_32(x)
 148 #  define cpu_to_be32(x) bswap_32(x)
 149 #  define be64_to_cpu(x) (__u64)bswap_64(x)
 150 #  define cpu_to_be64(x) (__u64)bswap_64(x)
 151 # else
 152 #  if __BYTE_ORDER == __BIG_ENDIAN
 153 #   define le16_to_cpu(x) bswap_16(x)
 154 #   define cpu_to_le16(x) bswap_16(x)
 155 #   define le32_to_cpu(x) bswap_32(x)
 156 #   define cpu_to_le32(x) bswap_32(x)
 157 #   define le64_to_cpu(x) (__u64)bswap_64(x)
 158 #   define cpu_to_le64(x) (__u64)bswap_64(x)
 159
 160 #   define be16_to_cpu(x) (x)
 161 #   define cpu_to_be16(x) (x)
 162 #   define be32_to_cpu(x) (x)
 163 #   define cpu_to_be32(x) (x)
 164 #   define be64_to_cpu(x) (x)
 165 #   define cpu_to_be64(x) (x)
 166
 167 #  else
 168 #   error "Unknown byte order"
 169 #  endif /* __BIG_ENDIAN */
 170 # endif /* __LITTLE_ENDIAN */
 171 #elif __APPLE__
 172 #define __cpu_to_le64(x)                        OSSwapHostToLittleInt64(x)
 173 #define __cpu_to_le32(x)                        OSSwapHostToLittleInt32(x)
 174 #define __cpu_to_le16(x)                        OSSwapHostToLittleInt16(x)
 175
 176 #define __le16_to_cpu(x)                        OSSwapLittleToHostInt16(x)
 177 #define __le32_to_cpu(x)                        OSSwapLittleToHostInt32(x)
 178 #define __le64_to_cpu(x)                        OSSwapLittleToHostInt64(x)
 179
 180 #define cpu_to_le64(x)                          __cpu_to_le64(x)
 181 #define cpu_to_le32(x)                          __cpu_to_le32(x)
 182 #define cpu_to_le16(x)                          __cpu_to_le16(x)
 183
 184 #define le64_to_cpu(x)                          __le64_to_cpu(x)
 185 #define le32_to_cpu(x)                          __le32_to_cpu(x)
 186 #define le16_to_cpu(x)                          __le16_to_cpu(x)
 187
 188 #define __swab16(x)                             OSSwapInt16(x)
 189 #define __swab32(x)                             OSSwapInt32(x)
 190 #define __swab64(x)                             OSSwapInt64(x)
 191 #define __swab16s(x)                            do { *(x) = __swab16(*(x)); } while (0)
 192 #define __swab32s(x)                            do { *(x) = __swab32(*(x)); } while (0)
 193 #define __swab64s(x)                            do { *(x) = __swab64(*(x)); } while (0)
 194 #endif
 195
 196 #if !defined(ALIGN)
 197 #define __ALIGN_MASK(x, mask)   (((x) + (mask)) & ~(mask))
 198 #define ALIGN(x, a)             __ALIGN_MASK(x, (typeof(x))(a) - 1)
 199 #endif
 200
 201 # ifndef THREAD_SIZE /* x86_64 linux has THREAD_SIZE in userspace */
 202 #  define CFS_THREAD_SIZE 8192
 203 # else
 204 #  define CFS_THREAD_SIZE THREAD_SIZE
 205 # endif
 206
 207 #define LUSTRE_TRACE_SIZE (CFS_THREAD_SIZE >> 5)
 208
 209 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 210 #define CDEBUG_STACK() (0L)
 211
 212 /* initial pid  */
 213 #define LUSTRE_LNET_PID          12345
 214
 215 #define ENTRY_NESTING_SUPPORT (1)
 216 #define ENTRY_NESTING   do {;} while (0)
 217 #define EXIT_NESTING   do {;} while (0)
 218 #define __current_nesting_level() (0)
 219
 220 /**
 221  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 222  *
 223  * Implementation is in linux-curproc.c
 224  */
 225 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 226
 227 typedef __u32 cfs_kernel_cap_t;
 228
 229 /**
 230  * Module support (probably shouldn't be used in generic code?)
 231  */
 232 typedef struct cfs_module {
 233         int count;
 234         char *name;
 235 } cfs_module_t;
 236
 237 static inline void MODULE_AUTHOR(char *name)
 238 {
 239         printf("%s\n", name);
 240 }
 241 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
 242 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
 243
 244 #define THIS_MODULE (void *)0x11111
 245 #define __init
 246 #define __exit
 247
 248 #define EXPORT_SYMBOL(symbol)
 249
 250 static inline int cfs_request_module(const char *name, ...)
 251 {
 252         return (-EINVAL);
 253 }
 254
 255 static inline void __cfs_module_get(cfs_module_t *module)
 256 {
 257 }
 258
 259 static inline int cfs_try_module_get(cfs_module_t *module)
 260 {
 261         return 1;
 262 }
 263
 264 static inline void cfs_module_put(cfs_module_t *module)
 265 {
 266 }
 267
 268
 269 static inline int cfs_module_refcount(cfs_module_t *m)
 270 {
 271         return 1;
 272 }
 273
 274 /***************************************************************************
 275  *
 276  * Linux kernel slab shrinker emulation. Currently used only in lu_object.c
 277  *
 278  ***************************************************************************/
 279
 280 struct shrinker {
 281         ;
 282 };
 283
 284 #define DEFAULT_SEEKS (0)
 285
 286 typedef int (*shrinker_t)(int, unsigned int);
 287
 288 static inline
 289 struct shrinker *set_shrinker(int seeks, shrinker_t shrink)
 290 {
 291         return (struct shrinker *)0xdeadbea1; /* Cannot return NULL here */
 292 }
 293
 294 static inline void remove_shrinker(struct shrinker *shrinker)
 295 {
 296 }
 297
 298 /***************************************************************************
 299  *
 300  * Linux kernel radix tree emulation.
 301  *
 302  * XXX this stub-implementation assumes that elements stored in a radix tree
 303  *     are struct page's and nothing else. Proper implementation will be
 304  *     committed soon.
 305  *
 306  ***************************************************************************/
 307
 308 struct radix_tree_root {
 309         cfs_list_t list;
 310         void *rnode;
 311 };
 312
 313 struct radix_tree_node {
 314         cfs_list_t _node;
 315         unsigned long index;
 316         void *item;
 317 };
 318
 319 #define RADIX_TREE_INIT(mask)   {               \
 320                 NOT_IMPLEMENTED                 \
 321 }
 322
 323 #define RADIX_TREE(name, mask) \
 324         struct radix_tree_root name = RADIX_TREE_INIT(mask)
 325
 326
 327 #define INIT_RADIX_TREE(root, mask)                                     \
 328 do {                                                                    \
 329         CFS_INIT_LIST_HEAD(&((struct radix_tree_root *)root)->list);    \
 330         ((struct radix_tree_root *)root)->rnode = NULL;                 \
 331 } while (0)
 332
 333 static inline int radix_tree_insert(struct radix_tree_root *root,
 334                         unsigned long idx, void *item)
 335 {
 336         struct radix_tree_node *node;
 337         node = malloc(sizeof(*node));
 338         if (!node)
 339                 return -ENOMEM;
 340
 341         CFS_INIT_LIST_HEAD(&node->_node);
 342         node->index = idx;
 343         node->item = item;
 344         cfs_list_add_tail(&node->_node, &root->list);
 345         root->rnode = (void *)1001;
 346         return 0;
 347 }
 348
 349 static inline struct radix_tree_node *radix_tree_lookup0(struct radix_tree_root *root,
 350                                       unsigned long idx)
 351 {
 352         struct radix_tree_node *node;
 353
 354         if (cfs_list_empty(&root->list))
 355                 return NULL;
 356
 357         cfs_list_for_each_entry_typed(node, &root->list,
 358                                       struct radix_tree_node, _node)
 359                 if (node->index == idx)
 360                         return node;
 361
 362         return NULL;
 363 }
 364
 365 static inline void *radix_tree_lookup(struct radix_tree_root *root,
 366                                       unsigned long idx)
 367 {
 368         struct radix_tree_node *node = radix_tree_lookup0(root, idx);
 369
 370         if (node)
 371                 return node->item;
 372         return node;
 373 }
 374
 375 static inline void *radix_tree_delete(struct radix_tree_root *root,
 376                                       unsigned long idx)
 377 {
 378         struct radix_tree_node *p = radix_tree_lookup0(root, idx);
 379         void *item;
 380
 381         if (p == NULL)
 382                 return NULL;
 383
 384         cfs_list_del_init(&p->_node);
 385         item = p->item;
 386         free(p);
 387         if (cfs_list_empty(&root->list))
 388                 root->rnode = NULL;
 389
 390         return item;
 391 }
 392
 393 static inline unsigned int
 394 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
 395                        unsigned long first_index, unsigned int max_items)
 396 {
 397         int i;
 398         int j = 0;
 399
 400         for (i = 0; i < max_items; i++, first_index++) {
 401                 results[j++] = radix_tree_lookup(root, first_index);
 402                 if (results[j - 1] == NULL)
 403                         --j;
 404         }
 405
 406         return j;
 407 }
 408
 409 static inline int radix_tree_preload(int gfp_mask)
 410 {
 411         return 0;
 412 }
 413
 414 void radix_tree_init(void);
 415
 416 static inline void radix_tree_preload_end(void)
 417 {
 418 }
 419
 420 /***************************************************************************
 421  *
 422  * Linux kernel red black tree emulation.
 423  *
 424  ***************************************************************************/
 425 struct rb_node {
 426         unsigned long  rb_parent_color;
 427 #define RB_RED          0
 428 #define RB_BLACK        1
 429         struct rb_node *rb_right;
 430         struct rb_node *rb_left;
 431 };
 432
 433 struct rb_root {
 434         struct rb_node *rb_node;
 435 };
 436
 437
 438 #define rb_parent(r)   ((struct rb_node *)((r)->rb_parent_color & ~3))
 439 #define rb_color(r)   ((r)->rb_parent_color & 1)
 440 #define rb_is_red(r)   (!rb_color(r))
 441 #define rb_is_black(r) rb_color(r)
 442 #define rb_set_red(r)  do { (r)->rb_parent_color &= ~1; } while (0)
 443 #define rb_set_black(r)  do { (r)->rb_parent_color |= 1; } while (0)
 444
 445 static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
 446 {
 447         rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
 448 }
 449 static inline void rb_set_color(struct rb_node *rb, int color)
 450 {
 451         rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
 452 }
 453
 454 #define RB_ROOT ((struct rb_root) { NULL, })
 455 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
 456
 457 #define RB_EMPTY_ROOT(root)     ((root)->rb_node == NULL)
 458 #define RB_EMPTY_NODE(node)     (rb_parent(node) == node)
 459 #define RB_CLEAR_NODE(node)     (rb_set_parent(node, node))
 460
 461 static inline void rb_init_node(struct rb_node *rb)
 462 {
 463         rb->rb_parent_color = 0;
 464         rb->rb_right = NULL;
 465         rb->rb_left = NULL;
 466         RB_CLEAR_NODE(rb);
 467 }
 468
 469 extern void rb_insert_color(struct rb_node *, struct rb_root *);
 470 extern void rb_erase(struct rb_node *, struct rb_root *);
 471
 472 /* Find logical next and previous nodes in a tree */
 473 extern struct rb_node *rb_next(const struct rb_node *);
 474 extern struct rb_node *rb_prev(const struct rb_node *);
 475 extern struct rb_node *rb_first(const struct rb_root *);
 476 extern struct rb_node *rb_last(const struct rb_root *);
 477 static inline void rb_link_node(struct rb_node *node, struct rb_node *parent,
 478                                 struct rb_node **rb_link)
 479 {
 480         node->rb_parent_color = (unsigned long)parent;
 481         node->rb_left = node->rb_right = NULL;
 482
 483         *rb_link = node;
 484 }
 485
 486 /***************************************************************************
 487  *
 488  * End of Linux kernel red black tree emulation.
 489  *
 490  ***************************************************************************/
 491
 492 typedef ssize_t (*read_actor_t)();
 493
 494 # ifndef IFTODT
 495 #  define IFSHIFT               12
 496 #  define IFTODT(type)          (((type) & S_IFMT) >> IFSHIFT)
 497 #  define DTTOIF(dirtype)       ((dirtype) << IFSHIFT)
 498 # endif
 499
 500 #endif