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 LIBCFS_VERSION "0.7.0"
  46
  47 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  48
  49 /*
  50  * Lustre Error Checksum: calculates checksum
  51  * of Hex number by XORing each bit.
  52  */
  53 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
  54                            ((hexnum) >> 8 & 0xf))
  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  * Drop into debugger, if possible. Implementation is provided by platform.
  64  */
  65
  66 void cfs_enter_debugger(void);
  67
  68 /*
  69  * Defined by platform
  70  */
  71 int unshare_fs_struct(void);
  72 sigset_t cfs_block_allsigs(void);
  73 sigset_t cfs_block_sigs(unsigned long sigs);
  74 sigset_t cfs_block_sigsinv(unsigned long sigs);
  75 void cfs_restore_sigs(sigset_t);
  76 int cfs_signal_pending(void);
  77 void cfs_clear_sigpending(void);
  78
  79 /*
  80  * Random number handling
  81  */
  82
  83 /* returns a random 32-bit integer */
  84 unsigned int cfs_rand(void);
  85 /* seed the generator */
  86 void cfs_srand(unsigned int, unsigned int);
  87 void cfs_get_random_bytes(void *buf, int size);
  88
  89 #include "libcfs_debug.h"
  90 #include "libcfs_cpu.h"
  91 #include "libcfs_private.h"
  92 #include "libcfs_ioctl.h"
  93 #include "libcfs_prim.h"
  94 #include "libcfs_time.h"
  95 #include "libcfs_string.h"
  96 #include "libcfs_workitem.h"
  97 #include "libcfs_hash.h"
  98 #include "libcfs_fail.h"
  99
 100 struct libcfs_ioctl_handler {
 101         struct list_head item;
 102         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
 103 };
 104
 105 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
 106         struct libcfs_ioctl_handler ident = {                   \
 107                 .item           = LIST_HEAD_INIT(ident.item),   \
 108                 .handle_ioctl   = func                          \
 109         }
 110
 111 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
 112 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
 113
 114 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
 115                          const struct libcfs_ioctl_hdr __user *uparam);
 116 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 117 int libcfs_ioctl(unsigned long cmd, void *arg);
 118
 119 /* container_of depends on "likely" which is defined in libcfs_private.h */
 120 static inline void *__container_of(void *ptr, unsigned long shift)
 121 {
 122         if (IS_ERR_OR_NULL(ptr))
 123                 return ptr;
 124         return (char *)ptr - shift;
 125 }
 126
 127 #define container_of0(ptr, type, member) \
 128         ((type *)__container_of((void *)(ptr), offsetof(type, member)))
 129
 130 #define _LIBCFS_H
 131
 132 void *libcfs_kvzalloc(size_t size, gfp_t flags);
 133 void *libcfs_kvzalloc_cpt(struct cfs_cpt_table *cptab, int cpt, size_t size,
 134                           gfp_t flags);
 135
 136 extern struct miscdevice libcfs_dev;
 137 /**
 138  * The path of debug log dump upcall script.
 139  */
 140 extern char lnet_upcall[1024];
 141 extern char lnet_debug_log_upcall[1024];
 142
 143 extern struct cfs_wi_sched *cfs_sched_rehash;
 144
 145 struct lnet_debugfs_symlink_def {
 146         char *name;
 147         char *target;
 148 };
 149
 150 void lustre_insert_debugfs(struct ctl_table *table,
 151                            const struct lnet_debugfs_symlink_def *symlinks);
 152 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 153                           void __user *buffer, size_t *lenp,
 154                           int (*handler)(void *data, int write,
 155                           loff_t pos, void __user *buffer, int len));
 156
 157 #endif /* _LIBCFS_H */