drivers/staging/lustre/include/linux/libcfs/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) 2011, 2015, 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
  37 #ifndef __LIBCFS_LIBCFS_H__
  38 #define __LIBCFS_LIBCFS_H__
  39
  40 #include "linux/libcfs.h"
  41 #include <linux/gfp.h>
  42
  43 #include "curproc.h"
  44
  45 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  46
  47 /*
  48  * Lustre Error Checksum: calculates checksum
  49  * of Hex number by XORing each bit.
  50  */
  51 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
  52                            ((hexnum) >> 8 & 0xf))
  53
  54 #define LUSTRE_SRV_LNET_PID      LUSTRE_LNET_PID
  55
  56 #include <linux/list.h>
  57
  58 /* need both kernel and user-land acceptor */
  59 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
  60 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
  61
  62 /*
  63  * libcfs pseudo device operations
  64  *
  65  * It's just draft now.
  66  */
  67
  68 struct cfs_psdev_file {
  69         unsigned long   off;
  70         void        *private_data;
  71         unsigned long   reserved1;
  72         unsigned long   reserved2;
  73 };
  74
  75 struct cfs_psdev_ops {
  76         int (*p_open)(unsigned long, void *);
  77         int (*p_close)(unsigned long, void *);
  78         int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
  79         int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
  80         int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
  81 };
  82
  83 /*
  84  * Drop into debugger, if possible. Implementation is provided by platform.
  85  */
  86
  87 void cfs_enter_debugger(void);
  88
  89 /*
  90  * Defined by platform
  91  */
  92 int unshare_fs_struct(void);
  93 sigset_t cfs_get_blocked_sigs(void);
  94 sigset_t cfs_block_allsigs(void);
  95 sigset_t cfs_block_sigs(unsigned long sigs);
  96 sigset_t cfs_block_sigsinv(unsigned long sigs);
  97 void cfs_restore_sigs(sigset_t);
  98 int cfs_signal_pending(void);
  99 void cfs_clear_sigpending(void);
 100
 101 /*
 102  * Random number handling
 103  */
 104
 105 /* returns a random 32-bit integer */
 106 unsigned int cfs_rand(void);
 107 /* seed the generator */
 108 void cfs_srand(unsigned int, unsigned int);
 109 void cfs_get_random_bytes(void *buf, int size);
 110
 111 #include "libcfs_debug.h"
 112 #include "libcfs_cpu.h"
 113 #include "libcfs_private.h"
 114 #include "libcfs_ioctl.h"
 115 #include "libcfs_prim.h"
 116 #include "libcfs_time.h"
 117 #include "libcfs_string.h"
 118 #include "libcfs_kernelcomm.h"
 119 #include "libcfs_workitem.h"
 120 #include "libcfs_hash.h"
 121 #include "libcfs_fail.h"
 122 #include "libcfs_crypto.h"
 123
 124 /* container_of depends on "likely" which is defined in libcfs_private.h */
 125 static inline void *__container_of(void *ptr, unsigned long shift)
 126 {
 127         if (IS_ERR_OR_NULL(ptr))
 128                 return ptr;
 129         return (char *)ptr - shift;
 130 }
 131
 132 #define container_of0(ptr, type, member) \
 133         ((type *)__container_of((void *)(ptr), offsetof(type, member)))
 134
 135 #define _LIBCFS_H
 136
 137 void *libcfs_kvzalloc(size_t size, gfp_t flags);
 138 void *libcfs_kvzalloc_cpt(struct cfs_cpt_table *cptab, int cpt, size_t size,
 139                           gfp_t flags);
 140
 141 extern struct miscdevice libcfs_dev;
 142 /**
 143  * The path of debug log dump upcall script.
 144  */
 145 extern char lnet_upcall[1024];
 146 extern char lnet_debug_log_upcall[1024];
 147
 148 extern struct cfs_psdev_ops libcfs_psdev_ops;
 149
 150 extern struct cfs_wi_sched *cfs_sched_rehash;
 151
 152 struct lnet_debugfs_symlink_def {
 153         char *name;
 154         char *target;
 155 };
 156
 157 void lustre_insert_debugfs(struct ctl_table *table,
 158                            const struct lnet_debugfs_symlink_def *symlinks);
 159
 160 #endif /* _LIBCFS_H */