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 do_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 THREAD_SIZE 8192
 203 # else
 204 # endif
 205
 206 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 207 #define CDEBUG_STACK() (0L)
 208
 209 /* initial pid  */
 210 #define LUSTRE_LNET_PID          12345
 211
 212 #define ENTRY_NESTING_SUPPORT (1)
 213 #define ENTRY_NESTING   do {;} while (0)
 214 #define EXIT_NESTING   do {;} while (0)
 215 #define __current_nesting_level() (0)
 216
 217 /**
 218  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 219  *
 220  * Implementation is in linux-curproc.c
 221  */
 222 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 223
 224 typedef __u32 kernel_cap_t;
 225
 226 /**
 227  * Module support (probably shouldn't be used in generic code?)
 228  */
 229 typedef struct cfs_module {
 230         int count;
 231         char *name;
 232 } cfs_module_t;
 233
 234 static inline void MODULE_AUTHOR(char *name)
 235 {
 236         printf("%s\n", name);
 237 }
 238 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
 239 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
 240
 241 #define THIS_MODULE (void *)0x11111
 242 #define __init
 243 #define __exit
 244
 245 #define EXPORT_SYMBOL(symbol)
 246
 247 static inline int cfs_request_module(const char *name, ...)
 248 {
 249         return (-EINVAL);
 250 }
 251
 252 static inline void __cfs_module_get(cfs_module_t *module)
 253 {
 254 }
 255
 256 static inline int cfs_try_module_get(cfs_module_t *module)
 257 {
 258         return 1;
 259 }
 260
 261 static inline void cfs_module_put(cfs_module_t *module)
 262 {
 263 }
 264
 265
 266 static inline int cfs_module_refcount(cfs_module_t *m)
 267 {
 268         return 1;
 269 }
 270
 271 /***************************************************************************
 272  *
 273  * Linux kernel slab shrinker emulation. Currently used only in lu_object.c
 274  *
 275  ***************************************************************************/
 276
 277 struct shrinker {
 278         ;
 279 };
 280
 281 #define DEFAULT_SEEKS (0)
 282
 283 typedef int (*shrinker_t)(int, unsigned int);
 284
 285 static inline
 286 struct shrinker *set_shrinker(int seeks, shrinker_t shrink)
 287 {
 288         return (struct shrinker *)0xdeadbea1; /* Cannot return NULL here */
 289 }
 290
 291 static inline void remove_shrinker(struct shrinker *shrinker)
 292 {
 293 }
 294
 295 /***************************************************************************
 296  *
 297  * Linux kernel radix tree emulation.
 298  *
 299  * XXX this stub-implementation assumes that elements stored in a radix tree
 300  *     are struct page's and nothing else. Proper implementation will be
 301  *     committed soon.
 302  *
 303  ***************************************************************************/
 304
 305 struct radix_tree_root {
 306         cfs_list_t list;
 307         void *rnode;
 308 };
 309
 310 struct radix_tree_node {
 311         cfs_list_t _node;
 312         unsigned long index;
 313         void *item;
 314 };
 315
 316 #define RADIX_TREE_INIT(mask)   {               \
 317                 NOT_IMPLEMENTED                 \
 318 }
 319
 320 #define RADIX_TREE(name, mask) \
 321         struct radix_tree_root name = RADIX_TREE_INIT(mask)
 322
 323
 324 #define INIT_RADIX_TREE(root, mask)                                     \
 325 do {                                                                    \
 326         CFS_INIT_LIST_HEAD(&((struct radix_tree_root *)root)->list);    \
 327         ((struct radix_tree_root *)root)->rnode = NULL;                 \
 328 } while (0)
 329
 330 static inline int radix_tree_insert(struct radix_tree_root *root,
 331                         unsigned long idx, void *item)
 332 {
 333         struct radix_tree_node *node;
 334         node = malloc(sizeof(*node));
 335         if (!node)
 336                 return -ENOMEM;
 337
 338         CFS_INIT_LIST_HEAD(&node->_node);
 339         node->index = idx;
 340         node->item = item;
 341         cfs_list_add_tail(&node->_node, &root->list);
 342         root->rnode = (void *)1001;
 343         return 0;
 344 }
 345
 346 static inline struct radix_tree_node *radix_tree_lookup0(struct radix_tree_root *root,
 347                                       unsigned long idx)
 348 {
 349         struct radix_tree_node *node;
 350
 351         if (cfs_list_empty(&root->list))
 352                 return NULL;
 353
 354         cfs_list_for_each_entry_typed(node, &root->list,
 355                                       struct radix_tree_node, _node)
 356                 if (node->index == idx)
 357                         return node;
 358
 359         return NULL;
 360 }
 361
 362 static inline void *radix_tree_lookup(struct radix_tree_root *root,
 363                                       unsigned long idx)
 364 {
 365         struct radix_tree_node *node = radix_tree_lookup0(root, idx);
 366
 367         if (node)
 368                 return node->item;
 369         return node;
 370 }
 371
 372 static inline void *radix_tree_delete(struct radix_tree_root *root,
 373                                       unsigned long idx)
 374 {
 375         struct radix_tree_node *p = radix_tree_lookup0(root, idx);
 376         void *item;
 377
 378         if (p == NULL)
 379                 return NULL;
 380
 381         cfs_list_del_init(&p->_node);
 382         item = p->item;
 383         free(p);
 384         if (cfs_list_empty(&root->list))
 385                 root->rnode = NULL;
 386
 387         return item;
 388 }
 389
 390 static inline unsigned int
 391 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
 392                        unsigned long first_index, unsigned int max_items)
 393 {
 394         int i;
 395         int j = 0;
 396
 397         for (i = 0; i < max_items; i++, first_index++) {
 398                 results[j++] = radix_tree_lookup(root, first_index);
 399                 if (results[j - 1] == NULL)
 400                         --j;
 401         }
 402
 403         return j;
 404 }
 405
 406 static inline int radix_tree_preload(int gfp_mask)
 407 {
 408         return 0;
 409 }
 410
 411 void radix_tree_init(void);
 412
 413 static inline void radix_tree_preload_end(void)
 414 {
 415 }
 416
 417 /***************************************************************************
 418  *
 419  * Linux kernel red black tree emulation.
 420  *
 421  ***************************************************************************/
 422 struct rb_node {
 423         unsigned long  rb_parent_color;
 424 #define RB_RED          0
 425 #define RB_BLACK        1
 426         struct rb_node *rb_right;
 427         struct rb_node *rb_left;
 428 };
 429
 430 struct rb_root {
 431         struct rb_node *rb_node;
 432 };
 433
 434
 435 #define rb_parent(r)   ((struct rb_node *)((r)->rb_parent_color & ~3))
 436 #define rb_color(r)   ((r)->rb_parent_color & 1)
 437 #define rb_is_red(r)   (!rb_color(r))
 438 #define rb_is_black(r) rb_color(r)
 439 #define rb_set_red(r)  do { (r)->rb_parent_color &= ~1; } while (0)
 440 #define rb_set_black(r)  do { (r)->rb_parent_color |= 1; } while (0)
 441
 442 static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
 443 {
 444         rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
 445 }
 446 static inline void rb_set_color(struct rb_node *rb, int color)
 447 {
 448         rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
 449 }
 450
 451 #define RB_ROOT ((struct rb_root) { NULL, })
 452 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
 453
 454 #define RB_EMPTY_ROOT(root)     ((root)->rb_node == NULL)
 455 #define RB_EMPTY_NODE(node)     (rb_parent(node) == node)
 456 #define RB_CLEAR_NODE(node)     (rb_set_parent(node, node))
 457
 458 static inline void rb_init_node(struct rb_node *rb)
 459 {
 460         rb->rb_parent_color = 0;
 461         rb->rb_right = NULL;
 462         rb->rb_left = NULL;
 463         RB_CLEAR_NODE(rb);
 464 }
 465
 466 extern void rb_insert_color(struct rb_node *, struct rb_root *);
 467 extern void rb_erase(struct rb_node *, struct rb_root *);
 468
 469 /* Find logical next and previous nodes in a tree */
 470 extern struct rb_node *rb_next(const struct rb_node *);
 471 extern struct rb_node *rb_prev(const struct rb_node *);
 472 extern struct rb_node *rb_first(const struct rb_root *);
 473 extern struct rb_node *rb_last(const struct rb_root *);
 474 static inline void rb_link_node(struct rb_node *node, struct rb_node *parent,
 475                                 struct rb_node **rb_link)
 476 {
 477         node->rb_parent_color = (unsigned long)parent;
 478         node->rb_left = node->rb_right = NULL;
 479
 480         *rb_link = node;
 481 }
 482
 483 /***************************************************************************
 484  *
 485  * End of Linux kernel red black tree emulation.
 486  *
 487  ***************************************************************************/
 488
 489 typedef ssize_t (*read_actor_t)();
 490
 491 # ifndef IFTODT
 492 #  define IFSHIFT               12
 493 #  define IFTODT(type)          (((type) & S_IFMT) >> IFSHIFT)
 494 #  define DTTOIF(dirtype)       ((dirtype) << IFSHIFT)
 495 # endif
 496
 497 #endif