1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 #ifndef __LIBCFS_LIBCFS_H__
5 #define __LIBCFS_LIBCFS_H__
8 #define __attribute__(x)
11 #if defined(__linux__)
12 #include <libcfs/linux/libcfs.h>
13 #elif defined(__APPLE__)
14 #include <libcfs/darwin/libcfs.h>
15 #elif defined(__WINNT__)
16 #include <libcfs/winnt/libcfs.h>
18 #error Unsupported operating system.
27 /* Controlled via configure key */
28 /* #define LIBCFS_DEBUG */
31 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
34 /* cardinality of array */
35 #define sizeof_array(a) ((sizeof (a)) / (sizeof ((a)[0])))
37 #if !defined(container_of)
38 /* given a pointer @ptr to the field @member embedded into type (usually
39 * struct) @type, return pointer to the embedding instance of @type. */
40 #define container_of(ptr, type, member) \
41 ((type *)((char *)(ptr)-(unsigned long)(&((type *)0)->member)))
44 #define container_of0(ptr, type, member) \
46 typeof(ptr) __ptr = (ptr); \
47 __ptr ? container_of(__ptr, type, member) : NULL; \
51 * true iff @i is power-of-2
61 #define LOWEST_BIT_SET(x) ((x) & ~((x) - 1))
66 extern unsigned int libcfs_subsystem_debug;
67 extern unsigned int libcfs_stack;
68 extern unsigned int libcfs_debug;
69 extern unsigned int libcfs_printk;
70 extern unsigned int libcfs_console_ratelimit;
71 extern unsigned int libcfs_debug_binary;
72 extern char debug_file_path[1024];
74 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
75 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
77 /* Has there been an LBUG? */
78 extern unsigned int libcfs_catastrophe;
81 * struct ptldebug_header is defined in libcfs/<os>/libcfs.h
84 #define PH_FLAG_FIRST_RECORD 1
86 /* Debugging subsystems (32 bits, non-overlapping) */
87 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
88 #define S_UNDEFINED 0x00000001
89 #define S_MDC 0x00000002
90 #define S_MDS 0x00000004
91 #define S_OSC 0x00000008
92 #define S_OST 0x00000010
93 #define S_CLASS 0x00000020
94 #define S_LOG 0x00000040
95 #define S_LLITE 0x00000080
96 #define S_RPC 0x00000100
97 #define S_MGMT 0x00000200
98 #define S_LNET 0x00000400
99 #define S_LND 0x00000800 /* ALL LNDs */
100 #define S_PINGER 0x00001000
101 #define S_FILTER 0x00002000
103 #define S_ECHO 0x00008000
104 #define S_LDLM 0x00010000
105 #define S_LOV 0x00020000
111 #define S_LMV 0x00800000 /* b_new_cmd */
113 #define S_SEC 0x02000000 /* upcall cache */
114 #define S_GSS 0x04000000 /* b_new_cmd */
116 #define S_MGC 0x10000000
117 #define S_MGS 0x20000000
118 #define S_FID 0x40000000 /* b_new_cmd */
119 #define S_FLD 0x80000000 /* b_new_cmd */
120 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
122 /* Debugging masks (32 bits, non-overlapping) */
123 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
124 #define D_TRACE 0x00000001 /* ENTRY/EXIT markers */
125 #define D_INODE 0x00000002
126 #define D_SUPER 0x00000004
127 #define D_EXT2 0x00000008 /* anything from ext2_debug */
128 #define D_MALLOC 0x00000010 /* print malloc, free information */
129 #define D_CACHE 0x00000020 /* cache-related items */
130 #define D_INFO 0x00000040 /* general information */
131 #define D_IOCTL 0x00000080 /* ioctl related information */
132 #define D_NETERROR 0x00000100 /* network errors */
133 #define D_NET 0x00000200 /* network communications */
134 #define D_WARNING 0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
135 #define D_BUFFS 0x00000800
136 #define D_OTHER 0x00001000
137 #define D_DENTRY 0x00002000
138 #define D_NETTRACE 0x00004000
139 #define D_PAGE 0x00008000 /* bulk page handling */
140 #define D_DLMTRACE 0x00010000
141 #define D_ERROR 0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
142 #define D_EMERG 0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
143 #define D_HA 0x00080000 /* recovery and failover */
144 #define D_RPCTRACE 0x00100000 /* for distributed debugging */
145 #define D_VFSTRACE 0x00200000
146 #define D_READA 0x00400000 /* read-ahead */
147 #define D_MMAP 0x00800000
148 #define D_CONFIG 0x01000000
149 #define D_CONSOLE 0x02000000
150 #define D_QUOTA 0x04000000
151 #define D_SEC 0x08000000
152 /* keep these in sync with lnet/{utils,libcfs}/debug.c */
154 #define D_CANTMASK (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
156 #ifndef DEBUG_SUBSYSTEM
157 # define DEBUG_SUBSYSTEM S_UNDEFINED
160 #define CDEBUG_MAX_LIMIT 600
162 cfs_time_t cdls_next;
164 cfs_duration_t cdls_delay;
165 } cfs_debug_limit_state_t;
167 /* Controlled via configure key */
168 /* #define CDEBUG_ENABLED */
172 #ifdef CDEBUG_ENABLED
173 #define __CDEBUG(cdls, mask, format, a...) \
177 if (((mask) & D_CANTMASK) != 0 || \
178 ((libcfs_debug & (mask)) != 0 && \
179 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
180 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, mask, \
181 __FILE__, __FUNCTION__, __LINE__, \
185 #define CDEBUG(mask, format, a...) __CDEBUG(NULL, mask, format, ## a)
187 #define CDEBUG_LIMIT(mask, format, a...) \
189 static cfs_debug_limit_state_t cdls; \
191 __CDEBUG(&cdls, mask, format, ## a); \
194 #else /* CDEBUG_ENABLED */
195 #define CDEBUG(mask, format, a...) (void)(0)
196 #define CDEBUG_LIMIT(mask, format, a...) (void)(0)
197 #warning "CDEBUG IS DISABLED. THIS SHOULD NEVER BE DONE FOR PRODUCTION!"
200 #elif defined(__arch_lib__) && !defined(LUSTRE_UTILS)
202 #define CDEBUG(mask, format, a...) \
204 if (((mask) & D_CANTMASK) != 0 || \
205 ((libcfs_debug & (mask)) != 0 && \
206 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
207 libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, mask, \
208 __FILE__, __FUNCTION__, __LINE__, \
212 #define CDEBUG_LIMIT CDEBUG
216 #define CDEBUG(mask, format, a...) \
218 if (((mask) & D_CANTMASK) != 0) \
219 fprintf(stderr, "(%s:%d:%s()) " format, \
220 __FILE__, __LINE__, __FUNCTION__, ## a); \
223 #define CDEBUG_LIMIT CDEBUG
225 #endif /* !__KERNEL__ */
228 * Lustre Error Checksum: calculates checksum
229 * of Hex number by XORing each bit.
231 #define LERRCHKSUM(hexnum) (((hexnum) & 0xf) ^ ((hexnum) >> 4 & 0xf) ^ \
232 ((hexnum) >> 8 & 0xf))
234 #define CWARN(format, a...) CDEBUG_LIMIT(D_WARNING, format, ## a)
235 #define CERROR(format, a...) CDEBUG_LIMIT(D_ERROR, format, ## a)
236 #define CEMERG(format, a...) CDEBUG_LIMIT(D_EMERG, format, ## a)
238 #define LCONSOLE(mask, format, a...) CDEBUG(D_CONSOLE | (mask), format, ## a)
239 #define LCONSOLE_INFO(format, a...) CDEBUG_LIMIT(D_CONSOLE, format, ## a)
240 #define LCONSOLE_WARN(format, a...) CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## a)
241 #define LCONSOLE_ERROR(errnum, format, a...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, \
242 "%x-%x: " format, errnum, LERRCHKSUM(errnum), ## a)
243 #define LCONSOLE_EMERG(format, a...) CDEBUG(D_CONSOLE | D_EMERG, format, ## a)
245 #ifdef CDEBUG_ENABLED
247 #define GOTO(label, rc) \
249 long GOTO__ret = (long)(rc); \
250 CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
251 #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
252 (signed long)GOTO__ret); \
256 #define GOTO(label, rc) do { ((void)(rc)); goto label; } while (0)
259 /* Controlled via configure key */
260 /* #define CDEBUG_ENTRY_EXIT */
262 #ifdef CDEBUG_ENTRY_EXIT
265 * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
266 * there will be a warning in osx.
270 typeof(rc) RETURN__ret = (rc); \
271 CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n", \
272 (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
274 return RETURN__ret; \
280 CDEBUG(D_TRACE, "Process entered\n"); \
285 CDEBUG(D_TRACE, "Process leaving\n"); \
288 #else /* !CDEBUG_ENTRY_EXIT */
290 #define RETURN(rc) return (rc)
291 #define ENTRY do { } while (0)
292 #define EXIT do { } while (0)
294 #endif /* !CDEBUG_ENTRY_EXIT */
297 * Some (nomina odiosa sunt) platforms define NULL as naked 0. This confuses
298 * Lustre RETURN(NULL) macro.
304 #define NULL ((void *)0)
306 #define LUSTRE_SRV_LNET_PID LUSTRE_LNET_PID
310 #include <libcfs/list.h>
312 struct libcfs_ioctl_data; /* forward ref */
314 struct libcfs_ioctl_handler {
315 struct list_head item;
316 int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_data *data);
319 #define DECLARE_IOCTL_HANDLER(ident, func) \
320 struct libcfs_ioctl_handler ident = { \
321 /* .item = */ CFS_LIST_HEAD_INIT(ident.item), \
322 /* .handle_ioctl = */ func \
325 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
326 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
329 #define LNET_ACCEPTOR_MIN_RESERVED_PORT 512
330 #define LNET_ACCEPTOR_MAX_RESERVED_PORT 1023
332 int libcfs_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
333 int libcfs_ipif_enumerate(char ***names);
334 void libcfs_ipif_free_enumeration(char **names, int n);
335 int libcfs_sock_listen(cfs_socket_t **sockp, __u32 ip, int port, int backlog);
336 int libcfs_sock_accept(cfs_socket_t **newsockp, cfs_socket_t *sock);
337 void libcfs_sock_abort_accept(cfs_socket_t *sock);
338 int libcfs_sock_connect(cfs_socket_t **sockp, int *fatal,
339 __u32 local_ip, int local_port,
340 __u32 peer_ip, int peer_port);
341 int libcfs_sock_setbuf(cfs_socket_t *socket, int txbufsize, int rxbufsize);
342 int libcfs_sock_getbuf(cfs_socket_t *socket, int *txbufsize, int *rxbufsize);
343 int libcfs_sock_getaddr(cfs_socket_t *socket, int remote, __u32 *ip, int *port);
344 int libcfs_sock_write(cfs_socket_t *sock, void *buffer, int nob, int timeout);
345 int libcfs_sock_read(cfs_socket_t *sock, void *buffer, int nob, int timeout);
346 void libcfs_sock_release(cfs_socket_t *sock);
348 /* libcfs watchdogs */
351 /* Add a watchdog which fires after "time" milliseconds of delay. You have to
352 * touch it once to enable it. */
353 struct lc_watchdog *lc_watchdog_add(int time,
354 void (*cb)(pid_t pid, void *),
357 /* Enables a watchdog and resets its timer. */
358 void lc_watchdog_touch(struct lc_watchdog *lcw);
360 /* Disable a watchdog; touch it to restart it. */
361 void lc_watchdog_disable(struct lc_watchdog *lcw);
363 /* Clean up the watchdog */
364 void lc_watchdog_delete(struct lc_watchdog *lcw);
366 /* Dump a debug log */
367 void lc_watchdog_dumplog(pid_t pid, void *data);
373 * libcfs pseudo device operations
375 * struct cfs_psdev_t and
376 * cfs_psdev_register() and
377 * cfs_psdev_deregister() are declared in
378 * libcfs/<os>/cfs_prim.h
380 * It's just draft now.
383 struct cfs_psdev_file {
386 unsigned long reserved1;
387 unsigned long reserved2;
390 struct cfs_psdev_ops {
391 int (*p_open)(unsigned long, void *);
392 int (*p_close)(unsigned long, void *);
393 int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
394 int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
395 int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
399 * generic time manipulation functions.
402 static inline int cfs_time_after(cfs_time_t t1, cfs_time_t t2)
404 return cfs_time_before(t2, t1);
407 static inline int cfs_time_aftereq(cfs_time_t t1, cfs_time_t t2)
409 return cfs_time_beforeq(t2, t1);
413 * return seconds since UNIX epoch
415 static inline time_t cfs_unix_seconds(void)
419 cfs_fs_time_current(&t);
420 return (time_t)cfs_fs_time_sec(&t);
423 static inline cfs_time_t cfs_time_shift(int seconds)
425 return cfs_time_add(cfs_time_current(), cfs_time_seconds(seconds));
428 static inline long cfs_timeval_sub(struct timeval *large, struct timeval *small,
429 struct timeval *result)
432 (large->tv_sec - small->tv_sec) * ONE_MILLION +
433 (large->tv_usec - small->tv_usec));
434 if (result != NULL) {
435 result->tv_usec = r % ONE_MILLION;
436 result->tv_sec = r / ONE_MILLION;
441 #define CFS_RATELIMIT(seconds) \
444 * XXX nikita: non-portable initializer \
446 static time_t __next_message = 0; \
449 if (cfs_time_after(cfs_time_current(), __next_message)) \
452 __next_message = cfs_time_shift(seconds); \
458 struct libcfs_debug_msg_data {
459 cfs_debug_limit_state_t *msg_cdls;
461 const char *msg_file;
466 #define DEBUG_MSG_DATA_INIT(cdls, subsystem, file, func, ln ) { \
467 .msg_cdls = (cdls), \
468 .msg_subsys = (subsystem), \
469 .msg_file = (file), \
475 extern int libcfs_debug_vmsg2(cfs_debug_limit_state_t *cdls,
476 int subsys, int mask,
477 const char *file, const char *fn, const int line,
478 const char *format1, va_list args,
479 const char *format2, ...)
480 __attribute__ ((format (printf, 9, 10)));
482 #define libcfs_debug_vmsg(cdls, subsys, mask, file, fn, line, format, args) \
483 libcfs_debug_vmsg2(cdls, subsys, mask, file, fn,line,format,args,NULL,NULL)
485 #define libcfs_debug_msg(cdls, subsys, mask, file, fn, line, format, a...) \
486 libcfs_debug_vmsg2(cdls, subsys, mask, file, fn,line,NULL,NULL,format, ##a)
488 #define cdebug_va(cdls, mask, file, func, line, fmt, args) do { \
491 if (((mask) & D_CANTMASK) != 0 || \
492 ((libcfs_debug & (mask)) != 0 && \
493 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
494 libcfs_debug_vmsg(cdls, DEBUG_SUBSYSTEM, (mask), \
495 (file), (func), (line), fmt, args); \
498 #define cdebug(cdls, mask, file, func, line, fmt, a...) do { \
501 if (((mask) & D_CANTMASK) != 0 || \
502 ((libcfs_debug & (mask)) != 0 && \
503 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
504 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, (mask), \
505 (file), (func), (line), fmt, ## a); \
508 extern void libcfs_assertion_failed(const char *expr, const char *file,
509 const char *fn, const int line);
511 static inline void cfs_slow_warning(cfs_time_t now, int seconds, char *msg)
513 if (cfs_time_after(cfs_time_current(),
514 cfs_time_add(now, cfs_time_seconds(15))))
515 CERROR("slow %s %lu sec\n", msg,
516 cfs_duration_sec(cfs_time_sub(cfs_time_current(),now)));
520 * helper function similar to do_gettimeofday() of Linux kernel
522 static inline void cfs_fs_timeval(struct timeval *tv)
526 cfs_fs_time_current(&time);
527 cfs_fs_time_usec(&time, tv);
531 * return valid time-out based on user supplied one. Currently we only check
532 * that time-out is not shorted than allowed.
534 static inline cfs_duration_t cfs_timeout_cap(cfs_duration_t timeout)
536 if (timeout < CFS_TICK)
542 * Universal memory allocator API
544 enum cfs_alloc_flags {
545 /* allocation is not allowed to block */
546 CFS_ALLOC_ATOMIC = (1 << 0),
547 /* allocation is allowed to block */
548 CFS_ALLOC_WAIT = (1 << 1),
549 /* allocation should return zeroed memory */
550 CFS_ALLOC_ZERO = (1 << 2),
551 /* allocation is allowed to call file-system code to free/clean
553 CFS_ALLOC_FS = (1 << 3),
554 /* allocation is allowed to do io to free/clean memory */
555 CFS_ALLOC_IO = (1 << 4),
556 /* don't report allocation failure to the console */
557 CFS_ALLOC_NOWARN = (1 << 5),
558 /* standard allocator flag combination */
559 CFS_ALLOC_STD = CFS_ALLOC_FS | CFS_ALLOC_IO,
560 CFS_ALLOC_USER = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO,
563 /* flags for cfs_page_alloc() in addition to enum cfs_alloc_flags */
564 enum cfs_alloc_page_flags {
565 /* allow to return page beyond KVM. It has to be mapped into KVM by
567 CFS_ALLOC_HIGH = (1 << 5),
568 CFS_ALLOC_HIGHUSER = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO | CFS_ALLOC_HIGH,
572 * portable UNIX device file identification. (This is not _very_
573 * portable. Probably makes no sense for Windows.)
581 typedef unsigned int cfs_major_nr_t;
582 typedef unsigned int cfs_minor_nr_t;
585 * Defined by platform.
587 cfs_rdev_t cfs_rdev_build(cfs_major_nr_t major, cfs_minor_nr_t minor);
588 cfs_major_nr_t cfs_rdev_major(cfs_rdev_t rdev);
589 cfs_minor_nr_t cfs_rdev_minor(cfs_rdev_t rdev);
592 * Generic on-wire rdev format.
595 typedef __u32 cfs_wire_rdev_t;
597 cfs_wire_rdev_t cfs_wire_rdev_build(cfs_major_nr_t major, cfs_minor_nr_t minor);
598 cfs_major_nr_t cfs_wire_rdev_major(cfs_wire_rdev_t rdev);
599 cfs_minor_nr_t cfs_wire_rdev_minor(cfs_wire_rdev_t rdev);
602 * Drop into debugger, if possible. Implementation is provided by platform.
605 void cfs_enter_debugger(void);
608 * Defined by platform
610 void cfs_daemonize(char *str);
611 int cfs_daemonize_ctxt(char *str);
612 cfs_sigset_t cfs_get_blocked_sigs(void);
613 cfs_sigset_t cfs_block_allsigs(void);
614 cfs_sigset_t cfs_block_sigs(cfs_sigset_t bits);
615 void cfs_restore_sigs(cfs_sigset_t);
616 int cfs_signal_pending(void);
617 void cfs_clear_sigpending(void);
620 * these macros should be removed in the future,
621 * we keep them just for keeping libcfs compatible
622 * with other branches.
624 #define libcfs_daemonize(s) cfs_daemonize(s)
625 #define cfs_sigmask_lock(f) do { f= 0; } while (0)
626 #define cfs_sigmask_unlock(f) do { f= 0; } while (0)
628 int convert_server_error(__u64 ecode);
629 int convert_client_oflag(int cflag, int *result);
632 * Stack-tracing filling.
636 * Platform-dependent data-type to hold stack frames.
638 struct cfs_stack_trace;
641 * Fill @trace with current back-trace.
643 void cfs_stack_trace_fill(struct cfs_stack_trace *trace);
646 * Return instruction pointer for frame @frame_no. NULL if @frame_no is
649 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no);
652 * Universal open flags.
654 #define CFS_O_ACCMODE 0003
655 #define CFS_O_CREAT 0100
656 #define CFS_O_EXCL 0200
657 #define CFS_O_NOCTTY 0400
658 #define CFS_O_TRUNC 01000
659 #define CFS_O_APPEND 02000
660 #define CFS_O_NONBLOCK 04000
661 #define CFS_O_NDELAY CFS_O_NONBLOCK
662 #define CFS_O_SYNC 010000
663 #define CFS_O_ASYNC 020000
664 #define CFS_O_DIRECT 040000
665 #define CFS_O_LARGEFILE 0100000
666 #define CFS_O_DIRECTORY 0200000
667 #define CFS_O_NOFOLLOW 0400000
668 #define CFS_O_NOATIME 01000000
670 /* convert local open flags to universal open flags */
671 int cfs_oflags2univ(int flags);
672 /* convert universal open flags to local open flags */
673 int cfs_univ2oflags(int flags);
677 #endif /* _LIBCFS_H */