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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LIBCFS_LIBCFS_H__
  34 #define __LIBCFS_LIBCFS_H__
  35
  36 #include <linux/gfp.h>
  37 #include <linux/list.h>
  38
  39 #include <uapi/linux/lnet/libcfs_ioctl.h>
  40 #include <linux/libcfs/linux/libcfs.h>
  41 #include <linux/libcfs/libcfs_debug.h>
  42 #include <linux/libcfs/libcfs_private.h>
  43 #include <linux/libcfs/libcfs_cpu.h>
  44 #include <linux/libcfs/libcfs_prim.h>
  45 #include <linux/libcfs/libcfs_time.h>
  46 #include <linux/libcfs/libcfs_string.h>
  47 #include <linux/libcfs/libcfs_workitem.h>
  48 #include <linux/libcfs/libcfs_hash.h>
  49 #include <linux/libcfs/libcfs_fail.h>
  50 #include <linux/libcfs/curproc.h>
  51
  52 #define LIBCFS_VERSION "0.7.0"
  53
  54 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  55
  56 /*
  57  * Lustre Error Checksum: calculates checksum
  58  * of Hex number by XORing each bit.
  59  */
  60 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
  61                            ((hexnum) >> 8 & 0xf))
  62
  63 /* need both kernel and user-land acceptor */
  64 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
  65 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
  66
  67 /*
  68  * Defined by platform
  69  */
  70 sigset_t cfs_block_allsigs(void);
  71 sigset_t cfs_block_sigs(unsigned long sigs);
  72 sigset_t cfs_block_sigsinv(unsigned long sigs);
  73 void cfs_restore_sigs(sigset_t sigset);
  74 void cfs_clear_sigpending(void);
  75
  76 /*
  77  * Random number handling
  78  */
  79
  80 /* returns a random 32-bit integer */
  81 unsigned int cfs_rand(void);
  82 /* seed the generator */
  83 void cfs_srand(unsigned int seed1, unsigned int seed2);
  84 void cfs_get_random_bytes(void *buf, int size);
  85
  86 struct libcfs_ioctl_handler {
  87         struct list_head item;
  88         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
  89 };
  90
  91 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
  92         struct libcfs_ioctl_handler ident = {                   \
  93                 .item           = LIST_HEAD_INIT(ident.item),   \
  94                 .handle_ioctl   = func                          \
  95         }
  96
  97 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
  98 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
  99
 100 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
 101                          const struct libcfs_ioctl_hdr __user *uparam);
 102 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data);
 103 int libcfs_ioctl(unsigned long cmd, void __user *arg);
 104
 105 /* container_of depends on "likely" which is defined in libcfs_private.h */
 106 static inline void *__container_of(void *ptr, unsigned long shift)
 107 {
 108         if (IS_ERR_OR_NULL(ptr))
 109                 return ptr;
 110         return (char *)ptr - shift;
 111 }
 112
 113 #define container_of0(ptr, type, member) \
 114         ((type *)__container_of((void *)(ptr), offsetof(type, member)))
 115
 116 #define _LIBCFS_H
 117
 118 void *libcfs_kvzalloc(size_t size, gfp_t flags);
 119 void *libcfs_kvzalloc_cpt(struct cfs_cpt_table *cptab, int cpt, size_t size,
 120                           gfp_t flags);
 121
 122 extern struct miscdevice libcfs_dev;
 123 /**
 124  * The path of debug log dump upcall script.
 125  */
 126 extern char lnet_debug_log_upcall[1024];
 127
 128 extern struct cfs_wi_sched *cfs_sched_rehash;
 129
 130 struct lnet_debugfs_symlink_def {
 131         char *name;
 132         char *target;
 133 };
 134
 135 void lustre_insert_debugfs(struct ctl_table *table,
 136                            const struct lnet_debugfs_symlink_def *symlinks);
 137 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 138                          void __user *buffer, size_t *lenp,
 139                          int (*handler)(void *data, int write, loff_t pos,
 140                                         void __user *buffer, int len));
 141
 142 #endif /* _LIBCFS_H */