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, 2014, 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-fs.h>
  54 #include <libcfs/linux/kp30.h>
  55
  56 #ifdef HAVE_ASM_TYPES_H
  57 #include <asm/types.h>
  58 #endif
  59 #include <linux/types.h>
  60 #include <asm/timex.h>
  61 #include <linux/sched.h> /* THREAD_SIZE */
  62 #include <linux/rbtree.h>
  63 #include <linux/bitops.h>
  64 #include <linux/capability.h>
  65
  66 #if !defined(__x86_64__)
  67 # ifdef  __ia64__
  68 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
  69                           ((unsigned long)__builtin_dwarf_cfa() &       \
  70                            (THREAD_SIZE - 1)))
  71 # else
  72 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
  73                           ((unsigned long)__builtin_frame_address(0) &  \
  74                            (THREAD_SIZE - 1)))
  75 # endif /* __ia64__ */
  76
  77 #define __CHECK_STACK(msgdata, mask, cdls)                              \
  78 do {                                                                    \
  79         if (unlikely(CDEBUG_STACK() > libcfs_stack)) {                  \
  80                 LIBCFS_DEBUG_MSG_DATA_INIT(msgdata, D_WARNING, NULL);   \
  81                 libcfs_stack = CDEBUG_STACK();                          \
  82                 libcfs_debug_msg(msgdata,                               \
  83                                  "maximum lustre stack %lu\n",          \
  84                                  CDEBUG_STACK());                       \
  85                 (msgdata)->msg_mask = mask;                             \
  86                 (msgdata)->msg_cdls = cdls;                             \
  87                 dump_stack();                                           \
  88               /*panic("LBUG");*/                                        \
  89         }                                                               \
  90 } while (0)
  91 #define CFS_CHECK_STACK(msgdata, mask, cdls)  __CHECK_STACK(msgdata, mask, cdls)
  92 #else /* __x86_64__ */
  93 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
  94 #define CDEBUG_STACK() (0L)
  95 #endif /* __x86_64__ */
  96
  97 /**
  98  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
  99  *
 100  * Implementation is in linux-curproc.c
 101  */
 102 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 103
 104 /* helper for sysctl handlers */
 105 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 106                          void __user *buffer, size_t *lenp,
 107                          int (*handler)(void *data, int write,
 108                          loff_t pos, void __user *buffer, int len));
 109
 110 #ifndef HAVE_KSTRTOUL
 111 static inline int kstrtoul(const char *s, unsigned int base, unsigned long *res)
 112 {
 113         char *end = (char *)s;
 114
 115         *res = simple_strtoul(s, &end, base);
 116         if (end - s == 0)
 117                 return -EINVAL;
 118         return 0;
 119 }
 120 #endif /* !HAVE_KSTRTOUL */
 121
 122 /*
 123  * No stack-back-tracing in Linux for now.
 124  */
 125 struct cfs_stack_trace {
 126 };
 127
 128 #ifndef WITH_WATCHDOG
 129 #define WITH_WATCHDOG
 130 #endif
 131
 132 /*
 133  * Macros to access common characteristics of "current" UNIX process.
 134  */
 135 #define current_pid()             (current->pid)
 136 #define current_comm()            (current->comm)
 137
 138 /* check if task is running in compat mode.*/
 139 int current_is_32bit(void);
 140
 141 #endif /* _LINUX_LIBCFS_H */