Whamcloud - gitweb
LU-3963 libcfs: cleanup list operations
[fs/lustre-release.git] / libcfs / include / libcfs / linux / kp30.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) 2011, 2013, 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_KP30_H__
38 #define __LIBCFS_LINUX_KP30_H__
39
40
41 #include <linux/kernel.h>
42 #include <linux/mm.h>
43 #include <linux/string.h>
44 #include <linux/stat.h>
45 #include <linux/init.h>
46 #include <linux/errno.h>
47 #include <linux/unistd.h>
48 #include <linux/kmod.h>
49 #include <linux/notifier.h>
50 #include <linux/fs.h>
51 #include <linux/miscdevice.h>
52 #include <linux/vmalloc.h>
53 #include <linux/time.h>
54 #include <linux/slab.h>
55 #include <linux/interrupt.h>
56 #include <linux/highmem.h>
57 #include <linux/module.h>
58 #include <linux/version.h>
59 #include <asm/atomic.h>
60 #include <asm/uaccess.h>
61 #include <linux/rwsem.h>
62 #include <linux/proc_fs.h>
63 #include <linux/file.h>
64 #include <linux/smp.h>
65 #include <linux/ctype.h>
66 #include <linux/compiler.h>
67 #ifdef HAVE_MM_INLINE
68 # include <linux/mm_inline.h>
69 #endif
70 #include <linux/kallsyms.h>
71 #include <linux/moduleparam.h>
72 #include <linux/scatterlist.h>
73
74 #include <libcfs/linux/portals_compat25.h>
75
76 /******************************************************************************/
77 /* Module parameter support */
78 #define CFS_MODULE_PARM(name, t, type, perm, desc) \
79         module_param(name, type, perm);\
80         MODULE_PARM_DESC(name, desc)
81
82 #define CFS_SYSFS_MODULE_PARM  1 /* module parameters accessible via sysfs */
83
84 /******************************************************************************/
85
86 #if (__GNUC__)
87 /* Use the special GNU C __attribute__ hack to have the compiler check the
88  * printf style argument string against the actual argument count and
89  * types.
90  */
91 #ifdef printf
92 # warning printf has been defined as a macro...
93 # undef printf
94 #endif
95
96 #endif /* __GNUC__ */
97
98 # define fprintf(a, format, b...) CDEBUG(D_OTHER, format , ## b)
99 # define printf(format, b...) CDEBUG(D_OTHER, format , ## b)
100 # define time(a) CURRENT_TIME
101
102 /******************************************************************************/
103 /* Light-weight trace
104  * Support for temporary event tracing with minimal Heisenberg effect. */
105 #define LWT_SUPPORT  0
106
107 #define LWT_MEMORY   (16<<20)
108
109 #ifndef KLWT_SUPPORT
110 # if defined(__KERNEL__)
111 #  if !defined(BITS_PER_LONG)
112 #   error "BITS_PER_LONG not defined"
113 #  endif
114 # elif !defined(__WORDSIZE)
115 #  error "__WORDSIZE not defined"
116 # else
117 #  define BITS_PER_LONG __WORDSIZE
118 # endif
119
120 /* kernel hasn't defined this? */
121 typedef struct {
122         long long   lwte_when;
123         char       *lwte_where;
124         void       *lwte_task;
125         long        lwte_p1;
126         long        lwte_p2;
127         long        lwte_p3;
128         long        lwte_p4;
129 # if BITS_PER_LONG > 32
130         long        lwte_pad;
131 # endif
132 } lwt_event_t;
133 #endif /* !KLWT_SUPPORT */
134
135 #if LWT_SUPPORT
136 # ifdef __KERNEL__
137 #  if !KLWT_SUPPORT
138
139 typedef struct _lwt_page {
140         struct list_head        lwtp_list;
141         struct page             *lwtp_page;
142         lwt_event_t             *lwtp_events;
143 } lwt_page_t;
144
145 typedef struct {
146         int                lwtc_current_index;
147         lwt_page_t        *lwtc_current_page;
148 } lwt_cpu_t;
149
150 extern int       lwt_enabled;
151 extern lwt_cpu_t lwt_cpus[];
152
153 /* Note that we _don't_ define LWT_EVENT at all if LWT_SUPPORT isn't set.
154  * This stuff is meant for finding specific problems; it never stays in
155  * production code... */
156
157 #define LWTSTR(n)       #n
158 #define LWTWHERE(f,l)   f ":" LWTSTR(l)
159 #define LWT_EVENTS_PER_PAGE (PAGE_CACHE_SIZE / sizeof(lwt_event_t))
160
161 #define LWT_EVENT(p1, p2, p3, p4)                                       \
162 do {                                                                    \
163         unsigned long    flags;                                         \
164         lwt_cpu_t       *cpu;                                           \
165         lwt_page_t      *p;                                             \
166         lwt_event_t     *e;                                             \
167                                                                         \
168         if (lwt_enabled) {                                              \
169                 local_irq_save (flags);                                 \
170                                                                         \
171                 cpu = &lwt_cpus[smp_processor_id()];                    \
172                 p = cpu->lwtc_current_page;                             \
173                 e = &p->lwtp_events[cpu->lwtc_current_index++];         \
174                                                                         \
175                 if (cpu->lwtc_current_index >= LWT_EVENTS_PER_PAGE) {   \
176                         cpu->lwtc_current_page =                        \
177                                 list_entry (p->lwtp_list.next,          \
178                                                 lwt_page_t, lwtp_list); \
179                         cpu->lwtc_current_index = 0;                    \
180                 }                                                       \
181                                                                         \
182                 e->lwte_when  = get_cycles();                           \
183                 e->lwte_where = LWTWHERE(__FILE__,__LINE__);            \
184                 e->lwte_task  = current;                                \
185                 e->lwte_p1    = (long)(p1);                             \
186                 e->lwte_p2    = (long)(p2);                             \
187                 e->lwte_p3    = (long)(p3);                             \
188                 e->lwte_p4    = (long)(p4);                             \
189                                                                         \
190                 local_irq_restore (flags);                              \
191         }                                                               \
192 } while (0)
193
194 #endif /* !KLWT_SUPPORT */
195
196 extern int  lwt_init (void);
197 extern void lwt_fini (void);
198 extern int  lwt_lookup_string (int *size, char *knlptr,
199                                char *usrptr, int usrsize);
200 extern int  lwt_control (int enable, int clear);
201 extern int  lwt_snapshot (cfs_cycles_t *now, int *ncpu, int *total_size,
202                           void *user_ptr, int user_size);
203 # else  /* __KERNEL__ */
204 #  define LWT_EVENT(p1,p2,p3,p4)     /* no userland implementation yet */
205 # endif /* __KERNEL__ */
206 #endif /* LWT_SUPPORT */
207
208 /* ------------------------------------------------------------------ */
209
210 #define IOCTL_LIBCFS_TYPE long
211
212 #ifdef __CYGWIN__
213 # ifndef BITS_PER_LONG
214 #  if (~0UL) == 0xffffffffUL
215 #   define BITS_PER_LONG 32
216 #  else
217 #   define BITS_PER_LONG 64
218 #  endif
219 # endif
220 #endif
221
222 #if BITS_PER_LONG > 32
223 # define LI_POISON ((int)0x5a5a5a5a5a5a5a5a)
224 # define LL_POISON ((long)0x5a5a5a5a5a5a5a5a)
225 # define LP_POISON ((void *)(long)0x5a5a5a5a5a5a5a5a)
226 #else
227 # define LI_POISON ((int)0x5a5a5a5a)
228 # define LL_POISON ((long)0x5a5a5a5a)
229 # define LP_POISON ((void *)(long)0x5a5a5a5a)
230 #endif
231
232 /* this is a bit chunky */
233
234 #define _LWORDSIZE BITS_PER_LONG
235
236 #if (defined(__KERNEL__) && defined(HAVE_KERN__U64_LONG_LONG)) || \
237     (!defined(__KERNEL__) && defined(HAVE_USER__U64_LONG_LONG))
238 # define LPU64 "%llu"
239 # define LPD64 "%lld"
240 # define LPX64 "%#llx"
241 # define LPX64i "%llx"
242 # define LPO64 "%#llo"
243 # define LPF64 "L"
244 #else
245 # define LPU64 "%lu"
246 # define LPD64 "%ld"
247 # define LPX64 "%#lx"
248 # define LPX64i "%lx"
249 # define LPO64 "%#lo"
250 # define LPF64 "l"
251 #endif
252
253 /*
254  * long_ptr_t & ulong_ptr_t, same to "long" for gcc
255  */
256 # define LPLU "%lu"
257 # define LPLD "%ld"
258 # define LPLX "%#lx"
259
260 /*
261  * pid_t
262  */
263 # define LPPID "%d"
264
265 #ifndef LPU64
266 # error "No word size defined"
267 #endif
268
269 #undef _LWORDSIZE
270
271 #ifdef HAVE_SYSCTL_CTLNAME
272 #define INIT_CTL_NAME   .ctl_name = CTL_UNNUMBERED,
273 #define INIT_STRATEGY   .strategy = &sysctl_intvec,
274 #else
275 #define INIT_CTL_NAME
276 #define INIT_STRATEGY
277 #endif
278
279 #endif