libcfs/include/libcfs/linux/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, 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_LINUX_LIBCFS_H__
  38 #define __LIBCFS_LINUX_LIBCFS_H__
  39
  40 #ifndef __LIBCFS_LIBCFS_H__
  41 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  42 #endif
  43
  44 #ifndef __KERNEL__
  45 #error This include is only for kernel use.
  46 #endif
  47
  48
  49 #include <stdarg.h>
  50 #include <libcfs/linux/linux-cpu.h>
  51 #include <libcfs/linux/linux-time.h>
  52 #include <libcfs/linux/linux-mem.h>
  53 #include <libcfs/linux/linux-prim.h>
  54 #include <libcfs/linux/linux-lock.h>
  55 #include <libcfs/linux/linux-fs.h>
  56 #include <libcfs/linux/linux-tcpip.h>
  57 #include <libcfs/linux/linux-bitops.h>
  58 #include <libcfs/linux/linux-types.h>
  59 #include <libcfs/linux/kp30.h>
  60
  61 #ifdef HAVE_ASM_TYPES_H
  62 #include <asm/types.h>
  63 #endif
  64 #include <linux/types.h>
  65 #include <asm/timex.h>
  66 #include <linux/sched.h> /* THREAD_SIZE */
  67 #include <linux/rbtree.h>
  68
  69 #define CFS_THREAD_SIZE   THREAD_SIZE
  70 #define LUSTRE_TRACE_SIZE (THREAD_SIZE >> 5)
  71
  72 #if !defined(__x86_64__)
  73 # ifdef  __ia64__
  74 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
  75                           ((unsigned long)__builtin_dwarf_cfa() &       \
  76                            (THREAD_SIZE - 1)))
  77 # else
  78 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
  79                           ((unsigned long)__builtin_frame_address(0) &  \
  80                            (THREAD_SIZE - 1)))
  81 # endif /* __ia64__ */
  82
  83 #define __CHECK_STACK(msgdata, mask, cdls)                              \
  84 do {                                                                    \
  85         if (unlikely(CDEBUG_STACK() > libcfs_stack)) {                  \
  86                 LIBCFS_DEBUG_MSG_DATA_INIT(msgdata, D_WARNING, NULL);   \
  87                 libcfs_stack = CDEBUG_STACK();                          \
  88                 libcfs_debug_msg(msgdata,                               \
  89                                  "maximum lustre stack %lu\n",          \
  90                                  CDEBUG_STACK());                       \
  91                 (msgdata)->msg_mask = mask;                             \
  92                 (msgdata)->msg_cdls = cdls;                             \
  93                 dump_stack();                                           \
  94               /*panic("LBUG");*/                                        \
  95         }                                                               \
  96 } while (0)
  97 #define CFS_CHECK_STACK(msgdata, mask, cdls)  __CHECK_STACK(msgdata, mask, cdls)
  98 #else /* __x86_64__ */
  99 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 100 #define CDEBUG_STACK() (0L)
 101 #endif /* __x86_64__ */
 102
 103 /* initial pid  */
 104 #define LUSTRE_LNET_PID          12345
 105
 106 #define ENTRY_NESTING_SUPPORT (1)
 107 #define ENTRY_NESTING   do {;} while (0)
 108 #define EXIT_NESTING   do {;} while (0)
 109 #define __current_nesting_level() (0)
 110
 111 /**
 112  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 113  *
 114  * Implementation is in linux-curproc.c
 115  */
 116 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 117
 118 #include <linux/capability.h>
 119 typedef kernel_cap_t cfs_kernel_cap_t;
 120
 121 /*
 122  * No stack-back-tracing in Linux for now.
 123  */
 124 struct cfs_stack_trace {
 125 };
 126
 127 /* long integer with size equal to pointer */
 128 typedef unsigned long ulong_ptr_t;
 129 typedef long long_ptr_t;
 130
 131 #ifndef WITH_WATCHDOG
 132 #define WITH_WATCHDOG
 133 #endif
 134
 135 #ifndef HAVE_STRUCT_CRED
 136
 137 #define current_cred() (current)
 138
 139 #define current_cred_xxx(xxx)                   \
 140 ({                                              \
 141         current->xxx;                     \
 142 })
 143
 144 #ifndef HAVE_CRED_WRAPPERS
 145
 146 #define current_uid()           (current_cred_xxx(uid))
 147 #define current_gid()           (current_cred_xxx(gid))
 148 #define current_euid()          (current_cred_xxx(euid))
 149 #define current_egid()          (current_cred_xxx(egid))
 150 #define current_suid()          (current_cred_xxx(suid))
 151 #define current_sgid()          (current_cred_xxx(sgid))
 152 #define current_fsuid()         (current_cred_xxx(fsuid))
 153 #define current_fsgid()         (current_cred_xxx(fsgid))
 154 #define current_cap()           (current_cred_xxx(cap_effective))
 155
 156 #endif /* HAVE_LINUX_CRED_H */
 157
 158 #define current_user()          (current_cred_xxx(user))
 159 #define current_user_ns()       (current_cred_xxx(user)->user_ns)
 160 #define current_security()      (current_cred_xxx(security))
 161
 162 #define cred task_struct
 163
 164 #define prepare_creds() (current)
 165 #define commit_creds(a)
 166
 167 #endif /* HAVE_STRUCT_CRED */
 168
 169 #ifndef HAVE_SCATTERLIST_INITTABLE
 170 #define sg_init_table(sg, nents) memset(sg, 0, sizeof(*(sg))*(nents))
 171 #endif
 172
 173 #ifndef HAVE_SCATTERLIST_SETPAGE
 174 #define sg_set_page(sg, p, len, off) \
 175         sg_set_buf(sg, page_address(p) + ((off) & ~CFS_PAGE_MASK), len)
 176 #endif
 177
 178 #endif /* _LINUX_LIBCFS_H */