Whamcloud - gitweb
b=b=6065
[fs/lustre-release.git] / lnet / include / libcfs / libcfs.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  */
4 #ifndef __LIBCFS_LIBCFS_H__
5 #define __LIBCFS_LIBCFS_H__
6
7 #if !__GNUC__
8 #define __attribute__(x)
9 #endif
10
11 #if defined(__linux__)
12 #include <libcfs/linux/libcfs.h>
13 #elif defined(__APPLE__)
14 #include <libcfs/darwin/libcfs.h>
15 #else
16 #error Unsupported operating system.
17 #endif
18
19 #include "curproc.h"
20
21 #ifndef __KERNEL__
22 #include <stdio.h>
23 #endif
24
25 #define PORTAL_DEBUG
26
27 #ifndef offsetof
28 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
29 #endif
30
31 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
32
33 /*
34  *  Debugging
35  */
36 extern unsigned int portal_subsystem_debug;
37 extern unsigned int portal_stack;
38 extern unsigned int portal_debug;
39 extern unsigned int portal_printk;
40
41 /*
42  * struct ptldebug_header is defined in libcfs/<os>/libcfs.h
43  */
44
45 #define PH_FLAG_FIRST_RECORD 1
46
47 /* Debugging subsystems (32 bits, non-overlapping) */
48 #define S_UNDEFINED   0x00000001
49 #define S_MDC         0x00000002
50 #define S_MDS         0x00000004
51 #define S_OSC         0x00000008
52 #define S_OST         0x00000010
53 #define S_CLASS       0x00000020
54 #define S_LOG         0x00000040
55 #define S_LLITE       0x00000080
56 #define S_RPC         0x00000100
57 #define S_MGMT        0x00000200
58 #define S_PORTALS     0x00000400
59 #define S_NAL         0x00000800 /* ALL NALs */
60 #define S_PINGER      0x00001000
61 #define S_FILTER      0x00002000
62 #define S_PTLBD       0x00004000
63 #define S_ECHO        0x00008000
64 #define S_LDLM        0x00010000
65 #define S_LOV         0x00020000
66 #define S_PTLROUTER   0x00040000
67 #define S_COBD        0x00080000
68 #define S_SM          0x00100000
69 #define S_ASOBD       0x00200000
70 #define S_CONFOBD     0x00400000
71 #define S_LMV         0x00800000
72 #define S_CMOBD       0x01000000
73 #define S_SEC         0x02000000
74 /* If you change these values, please keep these files up to date...
75  *    portals/utils/debug.c
76  *    utils/lconf
77  */
78
79 /* Debugging masks (32 bits, non-overlapping) */
80 #define D_TRACE       0x00000001 /* ENTRY/EXIT markers */
81 #define D_INODE       0x00000002
82 #define D_SUPER       0x00000004
83 #define D_EXT2        0x00000008 /* anything from ext2_debug */
84 #define D_MALLOC      0x00000010 /* print malloc, free information */
85 #define D_CACHE       0x00000020 /* cache-related items */
86 #define D_INFO        0x00000040 /* general information */
87 #define D_IOCTL       0x00000080 /* ioctl related information */
88 #define D_BLOCKS      0x00000100 /* ext2 block allocation */
89 #define D_NET         0x00000200 /* network communications */
90 #define D_WARNING     0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
91 #define D_BUFFS       0x00000800
92 #define D_OTHER       0x00001000
93 #define D_DENTRY      0x00002000
94 #define D_PORTALS     0x00004000 /* ENTRY/EXIT markers */
95 #define D_PAGE        0x00008000 /* bulk page handling */
96 #define D_DLMTRACE    0x00010000
97 #define D_ERROR       0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
98 #define D_EMERG       0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
99 #define D_HA          0x00080000 /* recovery and failover */
100 #define D_RPCTRACE    0x00100000 /* for distributed debugging */
101 #define D_VFSTRACE    0x00200000
102 #define D_READA       0x00400000 /* read-ahead */
103 #define D_MMAP        0x00800000
104 #define D_CONFIG      0x01000000
105 #define D_CONSOLE     0x02000000
106 #define D_QUOTA       0x04000000
107 #define D_SEC         0x08000000
108 /* If you change these values, please keep these files up to date...
109  *    portals/utils/debug.c
110  *    utils/lconf
111  */
112
113 #ifndef DEBUG_SUBSYSTEM
114 # define DEBUG_SUBSYSTEM S_UNDEFINED
115 #endif
116
117 #ifdef __KERNEL__
118 #if 1
119 #define CDEBUG(mask, format, a...)                                            \
120 do {                                                                          \
121         CHECK_STACK(CDEBUG_STACK);                                            \
122         if (((mask) & (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)) ||         \
123             (portal_debug & (mask) &&                                         \
124              portal_subsystem_debug & DEBUG_SUBSYSTEM))                       \
125                 portals_debug_msg(DEBUG_SUBSYSTEM, mask,                      \
126                                   __FILE__, __FUNCTION__, __LINE__,           \
127                                   CDEBUG_STACK, format, ## a);                \
128 } while (0)
129
130 #define CDEBUG_MAX_LIMIT 600
131 #define CDEBUG_LIMIT(cdebug_mask, cdebug_format, a...)                        \
132 do {                                                                          \
133         static cfs_time_t cdebug_next = 0;                                    \
134         static int cdebug_count = 0;                                          \
135         static cfs_duration_t cdebug_delay = CFS_MIN_DELAY;                   \
136                                                                               \
137         CHECK_STACK(CDEBUG_STACK);                                            \
138         if (cfs_time_after(cfs_time_current(), cdebug_next)) {                \
139                 portals_debug_msg(DEBUG_SUBSYSTEM, cdebug_mask, __FILE__,     \
140                                   __FUNCTION__, __LINE__, CDEBUG_STACK,       \
141                                   cdebug_format, ## a);                       \
142                 if (cdebug_count) {                                           \
143                         portals_debug_msg(DEBUG_SUBSYSTEM, cdebug_mask,       \
144                                           __FILE__, __FUNCTION__, __LINE__,   \
145                                           0, "skipped %d similar messages\n", \
146                                           cdebug_count);                      \
147                         cdebug_count = 0;                                     \
148                 }                                                             \
149                 if (cfs_time_after(cfs_time_current(),                        \
150                                    cdebug_next +                              \
151                                    cfs_time_seconds(CDEBUG_MAX_LIMIT+10)))    \
152                         cdebug_delay = cdebug_delay > (8 * CFS_MIN_DELAY)?    \
153                                        cdebug_delay/8 : CFS_MIN_DELAY;        \
154                 else                                                          \
155                         cdebug_delay = cdebug_delay*2 >= cfs_time_seconds(CDEBUG_MAX_LIMIT)?\
156                                        cfs_time_seconds(CDEBUG_MAX_LIMIT) :   \
157                                        cdebug_delay*2;                        \
158                 cdebug_next = cfs_time_current() + cdebug_delay;              \
159         } else {                                                              \
160                 portals_debug_msg(DEBUG_SUBSYSTEM,                            \
161                                   portal_debug & ~(D_EMERG|D_ERROR|D_WARNING),\
162                                   __FILE__, __FUNCTION__, __LINE__,           \
163                                   CDEBUG_STACK, cdebug_format, ## a);         \
164                 cdebug_count++;                                               \
165         }                                                                     \
166 } while (0)
167
168 #define CWARN(format, a...) CDEBUG(D_WARNING, format, ## a)
169 #define CERROR(format, a...) CDEBUG(D_ERROR, format, ## a)
170 #define CEMERG(format, a...) CDEBUG(D_EMERG, format, ## a)
171
172 #define LCONSOLE(mask, format, a...) CDEBUG(D_CONSOLE | (mask), format, ## a)
173 #define LCONSOLE_INFO(format, a...)  CDEBUG_LIMIT(D_CONSOLE, format, ## a)
174 #define LCONSOLE_WARN(format, a...)  CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## a)
175 #define LCONSOLE_ERROR(format, a...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, format, ## a)
176 #define LCONSOLE_EMERG(format, a...) CDEBUG(D_CONSOLE | D_EMERG, format, ## a)
177
178 #define GOTO(label, rc)                                                 \
179 do {                                                                    \
180         long GOTO__ret = (long)(rc);                                    \
181         CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
182                #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
183                (signed long)GOTO__ret);                                 \
184         goto label;                                                     \
185 } while (0)
186
187 #define CDEBUG_ENTRY_EXIT (0)
188
189 #ifdef CDEBUG_ENTRY_EXIT
190
191 /*
192  * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
193  * there will be a warning in osx.
194  */
195 #define RETURN(rc)                                                      \
196 do {                                                                    \
197         typeof(rc) RETURN__ret = (rc);                                  \
198         CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n",       \
199                (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
200         EXIT_NESTING;                                                   \
201         return RETURN__ret;                                             \
202 } while (0)
203
204 #define ENTRY                                                           \
205 ENTRY_NESTING;                                                          \
206 do {                                                                    \
207         CDEBUG(D_TRACE, "Process entered\n");                           \
208 } while (0)
209
210 #define EXIT                                                            \
211 do {                                                                    \
212         CDEBUG(D_TRACE, "Process leaving\n");                           \
213         EXIT_NESTING;                                                   \
214 } while(0)
215 #else /* !CDEBUG_ENTRY_EXIT */
216
217 #define RETURN(rc) return (rc)
218 #define ENTRY
219 #define EXIT
220
221 #endif /* !CDEBUG_ENTRY_EXIT */
222
223 #else /* !1 */
224 #define CDEBUG(mask, format, a...)      do { } while (0)
225 #define CWARN(format, a...)             printk(KERN_WARNING format, ## a)
226 #define CERROR(format, a...)            printk(KERN_ERR format, ## a)
227 #define CEMERG(format, a...)            printk(KERN_EMERG format, ## a)
228 #define LCONSOLE(mask, format, a...)    printk(format, ## a)
229 #define LCONSOLE_INFO(format, a...)     printk(KERN_INFO format, ## a)
230 #define LCONSOLE_WARN(format, a...)     printk(KERN_WARNING format, ## a)
231 #define LCONSOLE_ERROR(format, a...)    printk(KERN_ERROR format, ## a)
232 #define LCONSOLE_EMERG(format, a...)    printk(KERN_EMERG format, ## a)
233 #define GOTO(label, rc)                 do { (void)(rc); goto label; } while (0)
234 #define RETURN(rc)                      return (rc)
235 #define ENTRY                           do { } while (0)
236 #define EXIT                            do { } while (0)
237 #endif /* !1 */
238 #else /* !__KERNEL__ */
239 #define CDEBUG(mask, format, a...)      do { } while (0)
240 #define LCONSOLE(mask, format, a...)    fprintf(stderr, format, ## a)
241 #define CWARN(format, a...)             fprintf(stderr, format, ## a)
242 #define CERROR(format, a...)            fprintf(stderr, format, ## a)
243 #define CEMERG(format, a...)            fprintf(stderr, format, ## a)
244 #define LCONSOLE_INFO(format, a...)     fprintf(stderr, format, ## a)
245 #define LCONSOLE_WARN(format, a...)     fprintf(stderr, format, ## a)
246 #define LCONSOLE_ERROR(format, a...)    fprintf(stderr, format, ## a)
247 #define LCONSOLE_EMERG(format, a...)    fprintf(stderr, format, ## a)
248 #define GOTO(label, rc)                 do { (void)(rc); goto label; } while (0)
249 #define RETURN(rc)                      return (rc)
250 #define ENTRY                           do { } while (0)
251 #define EXIT                            do { } while (0)
252 #endif /* !__KERNEL__ */
253
254 #define LUSTRE_SRV_PTL_PID      LUSTRE_PTL_PID
255
256 /*
257  * eeb cfg
258  * ecf6
259  * ecfG
260  */
261 #define PORTALS_CFG_VERSION 0xecf60001
262
263 struct portals_cfg {
264         __u32 pcfg_version;
265         __u32 pcfg_command;
266
267         __u32 pcfg_nal;
268         __u32 pcfg_flags;
269
270         __u32 pcfg_gw_nal;
271         __u32 pcfg_padding1;
272
273         __u64 pcfg_nid;
274         __u64 pcfg_nid2;
275         __u64 pcfg_nid3;
276         __u32 pcfg_id;
277         __u32 pcfg_misc;
278         __u32 pcfg_fd;
279         __u32 pcfg_count;
280         __u32 pcfg_size;
281         __u32 pcfg_wait;
282
283         __u32 pcfg_plen1; /* buffers in userspace */
284         __u32 pcfg_plen2; /* buffers in userspace */
285         __u32 pcfg_alloc_size;  /* size of this allocated portals_cfg */
286         char  pcfg_pbuf[0];
287 };
288
289 #define PCFG_INIT(pcfg, cmd)                            \
290 do {                                                    \
291         memset(&(pcfg), 0, sizeof((pcfg)));             \
292         (pcfg).pcfg_version = PORTALS_CFG_VERSION;      \
293         (pcfg).pcfg_command = (cmd);                    \
294                                                         \
295 } while (0)
296
297 #define PCFG_INIT_PBUF(pcfg, cmd, plen1, plen2)                         \
298         do {                                                            \
299                 int bufsize = size_round(sizeof(*(pcfg)));              \
300                 bufsize += size_round(plen1) + size_round(plen2);       \
301                 PORTAL_ALLOC((pcfg), bufsize);                          \
302                 if ((pcfg)) {                                           \
303                         memset((pcfg), 0, bufsize);                     \
304                         (pcfg)->pcfg_version = PORTALS_CFG_VERSION;     \
305                         (pcfg)->pcfg_command = (cmd);                   \
306                         (pcfg)->pcfg_plen1 = (plen1);                   \
307                         (pcfg)->pcfg_plen2 = (plen2);                   \
308                         (pcfg)->pcfg_alloc_size = bufsize;              \
309                 }                                                       \
310         } while (0)
311
312 #define PCFG_FREE_PBUF(pcfg) PORTAL_FREE((pcfg), (pcfg)->pcfg_alloc_size)
313
314 #define PCFG_PBUF(pcfg, idx)                                            \
315         (0 == (idx)                                                     \
316          ? ((char *)(pcfg) + size_round(sizeof(*(pcfg))))               \
317          : (1 == (idx)                                                  \
318             ? ((char *)(pcfg) + size_round(sizeof(*(pcfg))) + size_round(pcfg->pcfg_plen1)) \
319             : (NULL)))
320
321 typedef int (nal_cmd_handler_fn)(struct portals_cfg *, void *);
322 int libcfs_nal_cmd_register(int nal, nal_cmd_handler_fn *handler, void *arg);
323 int libcfs_nal_cmd(struct portals_cfg *pcfg);
324 void libcfs_nal_cmd_unregister(int nal);
325
326 struct portal_ioctl_data {
327         __u32 ioc_len;
328         __u32 ioc_version;
329         __u64 ioc_nid;
330         __u64 ioc_nid2;
331         __u64 ioc_nid3;
332         __u32 ioc_count;
333         __u32 ioc_nal;
334         __u32 ioc_nal_cmd;
335         __u32 ioc_fd;
336         __u32 ioc_id;
337
338         __u32 ioc_flags;
339         __u32 ioc_size;
340
341         __u32 ioc_wait;
342         __u32 ioc_timeout;
343         __u32 ioc_misc;
344
345         __u32 ioc_inllen1;
346         char *ioc_inlbuf1;
347         __u32 ioc_inllen2;
348         char *ioc_inlbuf2;
349
350         __u32 ioc_plen1; /* buffers in userspace */
351         char *ioc_pbuf1;
352         __u32 ioc_plen2; /* buffers in userspace */
353         char *ioc_pbuf2;
354
355         char ioc_bulk[0];
356 };
357
358
359 #ifdef __KERNEL__
360
361 #include <libcfs/list.h>
362
363 struct libcfs_ioctl_handler {
364         struct list_head item;
365         int (*handle_ioctl)(struct portal_ioctl_data *data,
366                             unsigned int cmd, unsigned long args);
367 };
368
369 #define DECLARE_IOCTL_HANDLER(ident, func)              \
370         struct libcfs_ioctl_handler ident = {           \
371                 .item = CFS_LIST_HEAD_INIT(ident.item),     \
372                 .handle_ioctl = func                    \
373         }
374
375 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
376 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
377
378 /* libcfs watchdogs */
379 struct lc_watchdog;
380
381 /* Just use the default handler (dumplog)  */
382 #define LC_WATCHDOG_DEFAULT_CB NULL
383
384 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
385  * touch it once to enable it. */
386 struct lc_watchdog *lc_watchdog_add(int time,
387                                     void (*cb)(struct lc_watchdog *,
388                                                struct task_struct *,
389                                                void *),
390                                     void *data);
391
392 /* Enables a watchdog and resets its timer. */
393 void lc_watchdog_touch(struct lc_watchdog *lcw);
394
395 /* Disable a watchdog; touch it to restart it. */
396 void lc_watchdog_disable(struct lc_watchdog *lcw);
397
398 /* Clean up the watchdog */
399 void lc_watchdog_delete(struct lc_watchdog *lcw);
400
401 /* Dump a debug log */
402 void lc_watchdog_dumplog(struct lc_watchdog *lcw,
403                          struct task_struct *tsk,
404                          void *data);
405
406 /* __KERNEL__ */
407 #endif
408
409 /*
410  * libcfs pseudo device operations
411  *
412  * struct cfs_psdev_t and
413  * cfs_psdev_register() and
414  * cfs_psdev_deregister() are declared in
415  * libcfs/<os>/cfs_prim.h
416  *
417  * It's just draft now.
418  */
419
420 struct cfs_psdev_file {
421         unsigned long   off;
422         void            *private_data;
423         unsigned long   reserved1;
424         unsigned long   reserved2;
425 };
426
427 struct cfs_psdev_ops {
428         int (*p_open)(unsigned long, void *);
429         int (*p_close)(unsigned long, void *);
430         int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
431         int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
432         int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
433 };
434
435 /*
436  * generic time manipulation functions.
437  */
438
439 static inline int cfs_time_after(cfs_time_t t1, cfs_time_t t2)
440 {
441         return cfs_time_before(t2, t1);
442 }
443
444 static inline int cfs_time_aftereq(cfs_time_t t1, cfs_time_t t2)
445 {
446         return cfs_time_beforeq(t2, t1);
447 }
448
449 /*
450  * return seconds since UNIX epoch
451  */
452 static inline time_t cfs_unix_seconds(void)
453 {
454         cfs_fs_time_t t;
455
456         cfs_fs_time_current(&t);
457         return cfs_fs_time_sec(&t);
458 }
459
460 #define CFS_RATELIMIT(seconds)                                  \
461 ({                                                              \
462         /*                                                      \
463          * XXX nikita: non-portable initializer                 \
464          */                                                     \
465         static time_t __next_message = 0;                       \
466         int result;                                             \
467                                                                 \
468         if (cfs_time_after(cfs_time_current(), __next_message)) \
469                 result = 1;                                     \
470         else {                                                  \
471                 __next_message = cfs_time_shift(seconds);       \
472                 result = 0;                                     \
473         }                                                       \
474         result;                                                 \
475 })
476
477 extern void portals_debug_msg(int subsys, int mask, char *file, const char *fn,
478                               const int line, unsigned long stack,
479                               char *format, ...)
480             __attribute__ ((format (printf, 7, 8)));
481
482 static inline void cfs_slow_warning(cfs_time_t now, int seconds, char *msg)
483 {
484         if (cfs_time_after(cfs_time_current(),
485                            cfs_time_add(now, cfs_time_seconds(15))))
486                 CERROR("slow %s %lu sec\n", msg,
487                        cfs_duration_sec(cfs_time_sub(cfs_time_current(), now)));
488 }
489
490 /*
491  * helper function similar to do_gettimeofday() of Linux kernel
492  */
493 static inline void cfs_fs_timeval(struct timeval *tv)
494 {
495         cfs_fs_time_t time;
496
497         cfs_fs_time_current(&time);
498         cfs_fs_time_usec(&time, tv);
499 }
500
501 /*
502  * return valid time-out based on user supplied one. Currently we only check
503  * that time-out is not shorted than allowed.
504  */
505 static inline cfs_duration_t cfs_timeout_cap(cfs_duration_t timeout)
506 {
507         if (timeout < cfs_time_minimal_timeout())
508                 timeout = cfs_time_minimal_timeout();
509         return timeout;
510 }
511
512 /*
513  * Portable memory allocator API (draft)
514  */
515 enum cfs_alloc_flags {
516         /* allocation is not allowed to block */
517         CFS_ALLOC_ATOMIC = (1 << 0),
518         /* allocation is allowed to block */
519         CFS_ALLOC_WAIT = (1 << 1),
520         /* allocation should return zeroed memory */
521         CFS_ALLOC_ZERO   = (1 << 2),
522         /* allocation is allowed to call file-system code to free/clean
523          * memory */
524         CFS_ALLOC_FS     = (1 << 3),
525         /* allocation is allowed to do io to free/clean memory */
526         CFS_ALLOC_IO     = (1 << 4),
527         /* standard allocator flag combination */
528         CFS_ALLOC_STD    = CFS_ALLOC_FS | CFS_ALLOC_IO,
529         CFS_ALLOC_USER   = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO,
530 };
531
532 #define CFS_SLAB_ATOMIC         CFS_ALLOC_ATOMIC
533 #define CFS_SLAB_WAIT           CFS_ALLOC_WAIT
534 #define CFS_SLAB_ZERO           CFS_ALLOC_ZERO
535 #define CFS_SLAB_FS             CFS_ALLOC_FS
536 #define CFS_SLAB_IO             CFS_ALLOC_IO
537 #define CFS_SLAB_STD            CFS_ALLOC_STD
538 #define CFS_SLAB_USER           CFS_ALLOC_USER
539
540 /* flags for cfs_page_alloc() in addition to enum cfs_alloc_flags */
541 enum cfs_page_alloc_flags {
542         /* allow to return page beyond KVM. It has to be mapped into KVM by
543          * cfs_page_map(); */
544         CFS_ALLOC_HIGH   = (1 << 5),
545         CFS_ALLOC_HIGHUSER = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO | CFS_ALLOC_HIGH,
546 };
547
548
549 #define _LIBCFS_H
550
551 #endif /* _LIBCFS_H */