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 #include <mntent.h>
 115
 116 #define fget(x) NULL
 117 #define fput(f) do {} while (0)
 118
 119 /* Userpace byte flipping */
 120 #include <endian.h>
 121 #include <byteswap.h>
 122 #define __swab16(x) bswap_16(x)
 123 #define __swab32(x) bswap_32(x)
 124 #define __swab64(x) bswap_64(x)
 125 #define __swab16s(x) do {*(x) = bswap_16(*(x));} while (0)
 126 #define __swab32s(x) do {*(x) = bswap_32(*(x));} while (0)
 127 #define __swab64s(x) do {*(x) = bswap_64(*(x));} while (0)
 128 #if __BYTE_ORDER == __LITTLE_ENDIAN
 129 # define le16_to_cpu(x) (x)
 130 # define cpu_to_le16(x) (x)
 131 # define le32_to_cpu(x) (x)
 132 # define cpu_to_le32(x) (x)
 133 # define le64_to_cpu(x) (x)
 134 # define cpu_to_le64(x) (x)
 135
 136 # define be16_to_cpu(x) bswap_16(x)
 137 # define cpu_to_be16(x) bswap_16(x)
 138 # define be32_to_cpu(x) bswap_32(x)
 139 # define cpu_to_be32(x) bswap_32(x)
 140 # define be64_to_cpu(x) ((__u64)bswap_64(x))
 141 # define cpu_to_be64(x) ((__u64)bswap_64(x))
 142 #elif __BYTE_ORDER == __BIG_ENDIAN
 143 # define le16_to_cpu(x) bswap_16(x)
 144 # define cpu_to_le16(x) bswap_16(x)
 145 # define le32_to_cpu(x) bswap_32(x)
 146 # define cpu_to_le32(x) bswap_32(x)
 147 # define le64_to_cpu(x) ((__u64)bswap_64(x))
 148 # define cpu_to_le64(x) ((__u64)bswap_64(x))
 149
 150 # define be16_to_cpu(x) (x)
 151 # define cpu_to_be16(x) (x)
 152 # define be32_to_cpu(x) (x)
 153 # define cpu_to_be32(x) (x)
 154 # define be64_to_cpu(x) (x)
 155 # define cpu_to_be64(x) (x)
 156 #else /*  __BYTE_ORDER == __BIG_ENDIAN */
 157 # error "Unknown byte order"
 158 #endif /* __BYTE_ORDER != __BIG_ENDIAN */
 159
 160 #ifndef THREAD_SIZE /* x86_64 linux has THREAD_SIZE in userspace */
 161 # define THREAD_SIZE 8192
 162 #endif /* THREAD_SIZE */
 163
 164 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 165 #define CDEBUG_STACK() (0L)
 166
 167 /* initial pid  */
 168 #define LUSTRE_LNET_PID          12345
 169
 170 /**
 171  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 172  *
 173  * Implementation is in linux-curproc.c
 174  */
 175 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 176
 177 typedef __u32 kernel_cap_t;
 178
 179 /**
 180  * Module support (probably shouldn't be used in generic code?)
 181  */
 182 struct module {
 183         int count;
 184         char *name;
 185 };
 186
 187 static inline void MODULE_AUTHOR(char *name)
 188 {
 189         printf("%s\n", name);
 190 }
 191 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
 192 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
 193
 194 #define THIS_MODULE (void *)0x11111
 195 #define __init
 196 #define __exit
 197
 198 static inline int request_module(const char *name, ...)
 199 {
 200         return (-EINVAL);
 201 }
 202
 203 static inline void __module_get(struct module *module)
 204 {
 205 }
 206
 207 static inline int try_module_get(struct module *module)
 208 {
 209         return 1;
 210 }
 211
 212 static inline void module_put(struct module *module)
 213 {
 214 }
 215
 216
 217 static inline int module_refcount(struct module *m)
 218 {
 219         return 1;
 220 }
 221
 222 /***************************************************************************
 223  *
 224  * Linux kernel slab shrinker emulation. Currently used only in lu_object.c
 225  *
 226  ***************************************************************************/
 227
 228 struct shrinker {
 229 #ifndef __INTEL_COMPILER
 230         ;
 231 #endif
 232 };
 233
 234 struct shrinker_var {
 235 #ifndef __INTEL_COMPILER
 236         ;
 237 #endif
 238 };
 239
 240 #define DEF_SHRINKER_VAR(name, shrink, count, scan) \
 241                 struct shrinker_var name = {};
 242
 243 #define DEFAULT_SEEKS (0)
 244
 245 static inline
 246 struct shrinker *set_shrinker(int seeks, struct shrinker_var *var)
 247 {
 248         return (struct shrinker *)0xdeadbea1; /* Cannot return NULL here */
 249 }
 250
 251 static inline void remove_shrinker(struct shrinker *shrinker)
 252 {
 253 }
 254
 255 /***************************************************************************
 256  *
 257  * Linux kernel radix tree emulation.
 258  *
 259  * XXX this stub-implementation assumes that elements stored in a radix tree
 260  *     are struct page's and nothing else. Proper implementation will be
 261  *     committed soon.
 262  *
 263  ***************************************************************************/
 264
 265 struct radix_tree_root {
 266         struct list_head list;
 267         void *rnode;
 268 };
 269
 270 struct radix_tree_node {
 271         struct list_head _node;
 272         unsigned long index;
 273         void *item;
 274 };
 275
 276 #define RADIX_TREE_INIT(mask)   {       \
 277                 NOT_IMPLEMENTED         \
 278 }
 279
 280 #define RADIX_TREE(name, mask) \
 281         struct radix_tree_root name = RADIX_TREE_INIT(mask)
 282
 283
 284 #define INIT_RADIX_TREE(root, mask)                                     \
 285 do {                                                                    \
 286         INIT_LIST_HEAD(&((struct radix_tree_root *)root)->list);        \
 287         ((struct radix_tree_root *)root)->rnode = NULL;                 \
 288 } while (0)
 289
 290 static inline int radix_tree_insert(struct radix_tree_root *root,
 291                                         unsigned long idx, void *item)
 292 {
 293         struct radix_tree_node *node;
 294         node = malloc(sizeof(*node));
 295         if (!node)
 296                 return -ENOMEM;
 297
 298         INIT_LIST_HEAD(&node->_node);
 299         node->index = idx;
 300         node->item = item;
 301         list_add_tail(&node->_node, &root->list);
 302         root->rnode = (void *)1001;
 303         return 0;
 304 }
 305
 306 static inline struct radix_tree_node *
 307 radix_tree_lookup0(struct radix_tree_root *root, unsigned long idx)
 308 {
 309         struct radix_tree_node *node;
 310
 311         if (list_empty(&root->list))
 312                 return NULL;
 313
 314         list_for_each_entry(node, &root->list, _node)
 315                 if (node->index == idx)
 316                         return node;
 317
 318         return NULL;
 319 }
 320
 321 static inline void *radix_tree_lookup(struct radix_tree_root *root,
 322                                         unsigned long idx)
 323 {
 324         struct radix_tree_node *node = radix_tree_lookup0(root, idx);
 325
 326         if (node)
 327                 return node->item;
 328         return node;
 329 }
 330
 331 static inline void *radix_tree_delete(struct radix_tree_root *root,
 332                                         unsigned long idx)
 333 {
 334         struct radix_tree_node *p = radix_tree_lookup0(root, idx);
 335         void *item;
 336
 337         if (p == NULL)
 338                 return NULL;
 339
 340         list_del_init(&p->_node);
 341         item = p->item;
 342         free(p);
 343         if (list_empty(&root->list))
 344                 root->rnode = NULL;
 345
 346         return item;
 347 }
 348
 349 static inline unsigned int
 350 radix_tree_gang_lookup(struct radix_tree_root *root, void **results,
 351                        unsigned long first_index, unsigned int max_items)
 352 {
 353         int i;
 354         int j = 0;
 355
 356         for (i = 0; i < max_items; i++, first_index++) {
 357                 results[j++] = radix_tree_lookup(root, first_index);
 358                 if (results[j - 1] == NULL)
 359                         --j;
 360         }
 361
 362         return j;
 363 }
 364
 365 static inline int radix_tree_preload(int gfp_mask)
 366 {
 367         return 0;
 368 }
 369
 370 void radix_tree_init(void);
 371
 372 static inline void radix_tree_preload_end(void)
 373 {
 374 }
 375
 376 /***************************************************************************
 377  *
 378  * Linux kernel red black tree emulation.
 379  *
 380  ***************************************************************************/
 381 struct rb_node {
 382         unsigned long  rb_parent_color;
 383 #define RB_RED          0
 384 #define RB_BLACK        1
 385         struct rb_node *rb_right;
 386         struct rb_node *rb_left;
 387 };
 388
 389 struct rb_root {
 390         struct rb_node *rb_node;
 391 };
 392
 393
 394 #define rb_parent(r)   ((struct rb_node *)((r)->rb_parent_color & ~3))
 395 #define rb_color(r)   ((r)->rb_parent_color & 1)
 396 #define rb_is_red(r)   (!rb_color(r))
 397 #define rb_is_black(r) rb_color(r)
 398 #define rb_set_red(r)  do { (r)->rb_parent_color &= ~1; } while (0)
 399 #define rb_set_black(r)  do { (r)->rb_parent_color |= 1; } while (0)
 400
 401 static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
 402 {
 403         rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
 404 }
 405 static inline void rb_set_color(struct rb_node *rb, int color)
 406 {
 407         rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
 408 }
 409
 410 #define RB_ROOT ((struct rb_root) { NULL, })
 411 #define rb_entry(ptr, type, member) container_of(ptr, type, member)
 412
 413 #define RB_EMPTY_ROOT(root)     ((root)->rb_node == NULL)
 414 #define RB_EMPTY_NODE(node)     (rb_parent(node) == node)
 415 #define RB_CLEAR_NODE(node)     (rb_set_parent(node, node))
 416
 417 static inline void rb_init_node(struct rb_node *rb)
 418 {
 419         rb->rb_parent_color = 0;
 420         rb->rb_right = NULL;
 421         rb->rb_left = NULL;
 422         RB_CLEAR_NODE(rb);
 423 }
 424
 425 extern void rb_insert_color(struct rb_node *, struct rb_root *);
 426 extern void rb_erase(struct rb_node *, struct rb_root *);
 427
 428 /* Find logical next and previous nodes in a tree */
 429 extern struct rb_node *rb_next(const struct rb_node *);
 430 extern struct rb_node *rb_prev(const struct rb_node *);
 431 extern struct rb_node *rb_first(const struct rb_root *);
 432 extern struct rb_node *rb_last(const struct rb_root *);
 433 static inline void rb_link_node(struct rb_node *node, struct rb_node *parent,
 434                                 struct rb_node **rb_link)
 435 {
 436         node->rb_parent_color = (unsigned long)parent;
 437         node->rb_left = node->rb_right = NULL;
 438
 439         *rb_link = node;
 440 }
 441
 442 /***************************************************************************
 443  *
 444  * End of Linux kernel red black tree emulation.
 445  *
 446  ***************************************************************************/
 447
 448 typedef ssize_t (*read_actor_t)();
 449
 450 # ifndef IFTODT
 451 #  define IFSHIFT               12
 452 #  define IFTODT(type)          (((type) & S_IFMT) >> IFSHIFT)
 453 #  define DTTOIF(dirtype)       ((dirtype) << IFSHIFT)
 454 # endif
 455
 456 #ifndef ERESTARTSYS
 457 #define ERESTARTSYS ERESTART
 458 #endif
 459
 460 #endif