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