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.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) 2012, 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_LINUX_LIBCFS_H__
  34 #define __LIBCFS_LINUX_LIBCFS_H__
  35
  36 #ifndef __LIBCFS_LIBCFS_H__
  37 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  38 #endif
  39
  40 #ifndef __KERNEL__
  41 #error This include is only for kernel use.
  42 #endif
  43
  44 #include <linux/bitops.h>
  45 #include <linux/compiler.h>
  46 #include <linux/ctype.h>
  47 #include <linux/errno.h>
  48 #include <linux/file.h>
  49 #include <linux/fs.h>
  50 #include <linux/highmem.h>
  51 #include <linux/interrupt.h>
  52 #include <linux/kallsyms.h>
  53 #include <linux/kernel.h>
  54 #include <linux/kmod.h>
  55 #include <linux/kthread.h>
  56 #include <linux/miscdevice.h>
  57 #include <linux/mm.h>
  58 #include <linux/module.h>
  59 #include <linux/moduleparam.h>
  60 #include <linux/mutex.h>
  61 #include <linux/notifier.h>
  62 #include <linux/random.h>
  63 #include <linux/rbtree.h>
  64 #include <linux/rwsem.h>
  65 #include <linux/scatterlist.h>
  66 #include <linux/sched.h>
  67 #ifdef HAVE_SCHED_HEADERS
  68 #include <linux/sched/signal.h>
  69 #include <linux/sched/mm.h>
  70 #endif
  71 #include <linux/signal.h>
  72 #include <linux/slab.h>
  73 #include <linux/smp.h>
  74 #include <linux/stat.h>
  75 #include <linux/string.h>
  76 #include <linux/time.h>
  77 #include <linux/timer.h>
  78 #include <linux/types.h>
  79 #include <linux/unistd.h>
  80 #include <linux/vmalloc.h>
  81 #include <net/sock.h>
  82 #include <linux/atomic.h>
  83 #include <asm/div64.h>
  84 #include <linux/timex.h>
  85 #include <linux/uaccess.h>
  86 #include <stdarg.h>
  87
  88 #include <libcfs/linux/linux-cpu.h>
  89 #include <libcfs/linux/linux-time.h>
  90 #include <libcfs/linux/linux-mem.h>
  91 #include <libcfs/linux/linux-misc.h>
  92 #include <libcfs/linux/linux-fs.h>
  93
  94 #if !defined(__x86_64__)
  95 # ifdef  __ia64__
  96 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
  97                           ((unsigned long)__builtin_dwarf_cfa() &       \
  98                            (THREAD_SIZE - 1)))
  99 # else
 100 #  define CDEBUG_STACK() (THREAD_SIZE -                                 \
 101                           ((unsigned long)__builtin_frame_address(0) &  \
 102                            (THREAD_SIZE - 1)))
 103 # endif /* __ia64__ */
 104
 105 #define __CHECK_STACK(msgdata, mask, cdls)                              \
 106 do {                                                                    \
 107         if (unlikely(CDEBUG_STACK() > libcfs_stack)) {                  \
 108                 LIBCFS_DEBUG_MSG_DATA_INIT(msgdata, D_WARNING, NULL);   \
 109                 libcfs_stack = CDEBUG_STACK();                          \
 110                 libcfs_debug_msg(msgdata,                               \
 111                                  "maximum lustre stack %lu\n",          \
 112                                  CDEBUG_STACK());                       \
 113                 (msgdata)->msg_mask = mask;                             \
 114                 (msgdata)->msg_cdls = cdls;                             \
 115                 dump_stack();                                           \
 116               /*panic("LBUG");*/                                        \
 117         }                                                               \
 118 } while (0)
 119 #define CFS_CHECK_STACK(msgdata, mask, cdls)  __CHECK_STACK(msgdata, mask, cdls)
 120 #else /* __x86_64__ */
 121 #define CFS_CHECK_STACK(msgdata, mask, cdls) do {} while(0)
 122 #define CDEBUG_STACK() (0L)
 123 #endif /* __x86_64__ */
 124
 125 /**
 126  * Platform specific declarations for cfs_curproc API (libcfs/curproc.h)
 127  *
 128  * Implementation is in linux-curproc.c
 129  */
 130 #define CFS_CURPROC_COMM_MAX (sizeof ((struct task_struct *)0)->comm)
 131
 132 /* helper for sysctl handlers */
 133 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
 134                          void __user *buffer, size_t *lenp,
 135                          int (*handler)(void *data, int write,
 136                          loff_t pos, void __user *buffer, int len));
 137
 138 #ifndef WITH_WATCHDOG
 139 #define WITH_WATCHDOG
 140 #endif
 141
 142 /*
 143  * Macros to access common characteristics of "current" UNIX process.
 144  */
 145 #define current_pid()             (current->pid)
 146 #define current_comm()            (current->comm)
 147
 148 /* check if task is running in compat mode.*/
 149 int current_is_32bit(void);
 150
 151 #endif /* _LINUX_LIBCFS_H */