/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*- * vim:expandtab:shiftwidth=8:tabstop=8: */ #ifndef __LIBCFS_KP30_H__ #define __LIBCFS_KP30_H__ /* Controlled via configure key */ /* #define LIBCFS_DEBUG */ #include #include #if defined(__linux__) #include #elif defined(__APPLE__) #include #elif defined(__WINNT__) #include #else #error Unsupported operating system #endif #ifndef DEBUG_SUBSYSTEM # define DEBUG_SUBSYSTEM S_UNDEFINED #endif #ifdef __KERNEL__ #ifdef LIBCFS_DEBUG /* * When this is on, LASSERT macro includes check for assignment used instead * of equality check, but doesn't have unlikely(). Turn this on from time to * time to make test-builds. This shouldn't be on for production release. */ #define LASSERT_CHECKED (0) #if LASSERT_CHECKED /* * Assertion. * * Strange construction with empty "then" clause is used to trigger compiler * warnings on the assertions of the form LASSERT(a = b); * * "warning: suggest parentheses around assignment used as truth value" * * requires -Wall. Unfortunately this rules out use of likely/unlikely. */ #define LASSERT(cond) \ ({ \ if (cond) \ ; \ else \ libcfs_assertion_failed( #cond , __FILE__, \ __FUNCTION__, __LINE__); \ }) #define LASSERTF(cond, fmt, a...) \ ({ \ if (cond) \ ; \ else { \ libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG, \ __FILE__, __FUNCTION__,__LINE__, \ "ASSERTION(" #cond ") failed:" fmt, \ ## a); \ LBUG(); \ } \ }) /* LASSERT_CHECKED */ #else #define LASSERT(cond) \ ({ \ if (unlikely(!(cond))) \ libcfs_assertion_failed(#cond , __FILE__, \ __FUNCTION__, __LINE__); \ }) #define LASSERTF(cond, fmt, a...) \ ({ \ if (unlikely(!(cond))) { \ libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, D_EMERG, \ __FILE__, __FUNCTION__,__LINE__, \ "ASSERTION(" #cond ") failed:" fmt, \ ## a); \ LBUG(); \ } \ }) /* LASSERT_CHECKED */ #endif /* LIBCFS_DEBUG */ #else #define LASSERT(e) ((void)(0)) #define LASSERTF(cond, fmt...) ((void)(0)) #endif /* LIBCFS_DEBUG */ void lbug_with_loc(char *file, const char *func, const int line) __attribute__((noreturn)); #define LBUG() lbug_with_loc(__FILE__, __FUNCTION__, __LINE__) extern atomic_t libcfs_kmemory; /* * Memory */ #ifdef LIBCFS_DEBUG # define libcfs_kmem_inc(ptr, size) \ do { \ atomic_add(size, &libcfs_kmemory); \ } while (0) # define libcfs_kmem_dec(ptr, size) do { \ atomic_sub(size, &libcfs_kmemory); \ } while (0) #else # define libcfs_kmem_inc(ptr, size) do {} while (0) # define libcfs_kmem_dec(ptr, size) do {} while (0) #endif /* LIBCFS_DEBUG */ #define LIBCFS_VMALLOC_SIZE 16384 #define LIBCFS_ALLOC_GFP(ptr, size, mask) \ do { \ LASSERT(!in_interrupt() || \ (size <= LIBCFS_VMALLOC_SIZE && mask == CFS_ALLOC_ATOMIC));\ if (unlikely((size) > LIBCFS_VMALLOC_SIZE)) \ (ptr) = cfs_alloc_large(size); \ else \ (ptr) = cfs_alloc((size), (mask)); \ if (unlikely((ptr) == NULL)) { \ CERROR("LNET: out of memory at %s:%d (tried to alloc '" \ #ptr "' = %d)\n", __FILE__, __LINE__, (int)(size));\ CERROR("LNET: %d total bytes allocated by lnet\n", \ atomic_read(&libcfs_kmemory)); \ } else { \ libcfs_kmem_inc((ptr), (size)); \ if (!((mask) & CFS_ALLOC_ZERO)) \ memset((ptr), 0, (size)); \ } \ CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d).\n", \ (int)(size), (ptr), atomic_read (&libcfs_kmemory)); \ } while (0) #define LIBCFS_ALLOC(ptr, size) \ LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_IO) #define LIBCFS_ALLOC_ATOMIC(ptr, size) \ LIBCFS_ALLOC_GFP(ptr, size, CFS_ALLOC_ATOMIC) #define LIBCFS_FREE(ptr, size) \ do { \ int s = (size); \ if (unlikely((ptr) == NULL)) { \ CERROR("LIBCFS: free NULL '" #ptr "' (%d bytes) at " \ "%s:%d\n", s, __FILE__, __LINE__); \ break; \ } \ if (unlikely(s > LIBCFS_VMALLOC_SIZE)) \ cfs_free_large(ptr); \ else \ cfs_free(ptr); \ libcfs_kmem_dec((ptr), s); \ CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n", \ s, (ptr), atomic_read(&libcfs_kmemory)); \ } while (0) /******************************************************************************/ /* htonl hack - either this, or compile with -O2. Stupid byteorder/generic.h */ #if defined(__GNUC__) && (__GNUC__ >= 2) && !defined(__OPTIMIZE__) #define ___htonl(x) __cpu_to_be32(x) #define ___htons(x) __cpu_to_be16(x) #define ___ntohl(x) __be32_to_cpu(x) #define ___ntohs(x) __be16_to_cpu(x) #define htonl(x) ___htonl(x) #define ntohl(x) ___ntohl(x) #define htons(x) ___htons(x) #define ntohs(x) ___ntohs(x) #endif void libcfs_debug_dumpstack(cfs_task_t *tsk); void libcfs_run_upcall(char **argv); void libcfs_run_lbug_upcall(char * file, const char *fn, const int line); void libcfs_debug_dumplog(void); int libcfs_debug_init(unsigned long bufsize); int libcfs_debug_cleanup(void); int libcfs_debug_clear_buffer(void); int libcfs_debug_mark_buffer(char *text); void libcfs_debug_set_level(unsigned int debug_level); #else /* !__KERNEL__ */ # ifdef LIBCFS_DEBUG # undef NDEBUG # include # define LASSERT(e) assert(e) # define LASSERTF(cond, args...) \ do { \ if (!(cond)) \ CERROR(args); \ assert(cond); \ } while (0) # define LBUG() assert(0) # else # define LASSERT(e) ((void)(0)) # define LASSERTF(cond, args...) do { } while (0) # define LBUG() ((void)(0)) # endif /* LIBCFS_DEBUG */ # define printk(format, args...) printf (format, ## args) # ifdef CRAY_XT3 /* buggy calloc! */ # define LIBCFS_ALLOC(ptr, size) \ do { \ (ptr) = malloc(size); \ memset(ptr, 0, size); \ } while (0) # else # define LIBCFS_ALLOC(ptr, size) do { (ptr) = calloc(1,size); } while (0) # endif # define LIBCFS_FREE(a, b) do { free(a); } while (0) void libcfs_debug_dumplog(void); int libcfs_debug_init(unsigned long bufsize); int libcfs_debug_cleanup(void); /* * Generic compiler-dependent macros required for kernel * build go below this comment. Actual compiler/compiler version * specific implementations come from the above header files */ #define likely(x) __builtin_expect(!!(x), 1) #define unlikely(x) __builtin_expect(!!(x), 0) /* !__KERNEL__ */ #endif /* * compile-time assertions. @cond has to be constant expression. * ISO C Standard: * * 6.8.4.2 The switch statement * * .... * * [#3] The expression of each case label shall be an integer * constant expression and no two of the case constant * expressions in the same switch statement shall have the same * value after conversion... * */ #define CLASSERT(cond) ({ switch(42) { case (cond): case 0: break; } }) /* support decl needed both by kernel and liblustre */ int libcfs_isknown_lnd(int type); char *libcfs_lnd2modname(int type); char *libcfs_lnd2str(int type); int libcfs_str2lnd(char *str); char *libcfs_net2str(__u32 net); char *libcfs_nid2str(lnet_nid_t nid); __u32 libcfs_str2net(char *str); lnet_nid_t libcfs_str2nid(char *str); int libcfs_str2anynid(lnet_nid_t *nid, char *str); char *libcfs_id2str(lnet_process_id_t id); void libcfs_setnet0alias(int type); /* how an LNET NID encodes net:address */ #define LNET_NIDADDR(nid) ((__u32)((nid) & 0xffffffff)) #define LNET_NIDNET(nid) ((__u32)(((nid) >> 32)) & 0xffffffff) #define LNET_MKNID(net,addr) ((((__u64)(net))<<32)|((__u64)(addr))) /* how net encodes type:number */ #define LNET_NETNUM(net) ((net) & 0xffff) #define LNET_NETTYP(net) (((net) >> 16) & 0xffff) #define LNET_MKNET(typ,num) ((((__u32)(typ))<<16)|((__u32)(num))) /* implication */ #define ergo(a, b) (!(a) || (b)) /* logical equivalence */ #define equi(a, b) (!!(a) == !!(b)) #ifndef CURRENT_TIME # define CURRENT_TIME time(0) #endif /* -------------------------------------------------------------------- * Light-weight trace * Support for temporary event tracing with minimal Heisenberg effect. * All stuff about lwt are put in arch/kp30.h * -------------------------------------------------------------------- */ struct libcfs_device_userstate { int ldu_memhog_pages; cfs_page_t *ldu_memhog_root_page; }; /* what used to be in portals_lib.h */ #ifndef MIN # define MIN(a,b) (((a)<(b)) ? (a): (b)) #endif #ifndef MAX # define MAX(a,b) (((a)>(b)) ? (a): (b)) #endif #define MKSTR(ptr) ((ptr))? (ptr) : "" static inline int size_round4 (int val) { return (val + 3) & (~0x3); } static inline int size_round (int val) { return (val + 7) & (~0x7); } static inline int size_round16(int val) { return (val + 0xf) & (~0xf); } static inline int size_round32(int val) { return (val + 0x1f) & (~0x1f); } static inline int size_round0(int val) { if (!val) return 0; return (val + 1 + 7) & (~0x7); } static inline size_t round_strlen(char *fset) { return (size_t)size_round((int)strlen(fset) + 1); } #define LOGL(var,len,ptr) \ do { \ if (var) \ memcpy((char *)ptr, (const char *)var, len); \ ptr += size_round(len); \ } while (0) #define LOGU(var,len,ptr) \ do { \ if (var) \ memcpy((char *)var, (const char *)ptr, len); \ ptr += size_round(len); \ } while (0) #define LOGL0(var,len,ptr) \ do { \ if (!len) \ break; \ memcpy((char *)ptr, (const char *)var, len); \ *((char *)(ptr) + len) = 0; \ ptr += size_round(len + 1); \ } while (0) /* * USER LEVEL STUFF BELOW */ #define LIBCFS_IOCTL_VERSION 0x0001000a struct libcfs_ioctl_data { __u32 ioc_len; __u32 ioc_version; __u64 ioc_nid; __u64 ioc_u64[1]; __u32 ioc_flags; __u32 ioc_count; __u32 ioc_net; __u32 ioc_u32[7]; __u32 ioc_inllen1; char *ioc_inlbuf1; __u32 ioc_inllen2; char *ioc_inlbuf2; __u32 ioc_plen1; /* buffers in userspace */ char *ioc_pbuf1; __u32 ioc_plen2; /* buffers in userspace */ char *ioc_pbuf2; char ioc_bulk[0]; }; struct libcfs_ioctl_hdr { __u32 ioc_len; __u32 ioc_version; }; struct libcfs_debug_ioctl_data { struct libcfs_ioctl_hdr hdr; unsigned int subs; unsigned int debug; }; #define LIBCFS_IOC_INIT(data) \ do { \ memset(&data, 0, sizeof(data)); \ data.ioc_version = LIBCFS_IOCTL_VERSION; \ data.ioc_len = sizeof(data); \ } while (0) /* FIXME check conflict with lustre_lib.h */ #define LIBCFS_IOC_DEBUG_MASK _IOWR('f', 250, long) static inline int libcfs_ioctl_packlen(struct libcfs_ioctl_data *data) { int len = sizeof(*data); len += size_round(data->ioc_inllen1); len += size_round(data->ioc_inllen2); return len; } static inline int libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data) { if (data->ioc_len > (1<<30)) { CERROR ("LIBCFS ioctl: ioc_len larger than 1<<30\n"); return 1; } if (data->ioc_inllen1 > (1<<30)) { CERROR ("LIBCFS ioctl: ioc_inllen1 larger than 1<<30\n"); return 1; } if (data->ioc_inllen2 > (1<<30)) { CERROR ("LIBCFS ioctl: ioc_inllen2 larger than 1<<30\n"); return 1; } if (data->ioc_inlbuf1 && !data->ioc_inllen1) { CERROR ("LIBCFS ioctl: inlbuf1 pointer but 0 length\n"); return 1; } if (data->ioc_inlbuf2 && !data->ioc_inllen2) { CERROR ("LIBCFS ioctl: inlbuf2 pointer but 0 length\n"); return 1; } if (data->ioc_pbuf1 && !data->ioc_plen1) { CERROR ("LIBCFS ioctl: pbuf1 pointer but 0 length\n"); return 1; } if (data->ioc_pbuf2 && !data->ioc_plen2) { CERROR ("LIBCFS ioctl: pbuf2 pointer but 0 length\n"); return 1; } if (data->ioc_plen1 && !data->ioc_pbuf1) { CERROR ("LIBCFS ioctl: plen1 nonzero but no pbuf1 pointer\n"); return 1; } if (data->ioc_plen2 && !data->ioc_pbuf2) { CERROR ("LIBCFS ioctl: plen2 nonzero but no pbuf2 pointer\n"); return 1; } if ((__u32)libcfs_ioctl_packlen(data) != data->ioc_len ) { CERROR ("LIBCFS ioctl: packlen != ioc_len\n"); return 1; } if (data->ioc_inllen1 && data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') { CERROR ("LIBCFS ioctl: inlbuf1 not 0 terminated\n"); return 1; } if (data->ioc_inllen2 && data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') { CERROR ("LIBCFS ioctl: inlbuf2 not 0 terminated\n"); return 1; } return 0; } #ifndef __KERNEL__ static inline int libcfs_ioctl_pack(struct libcfs_ioctl_data *data, char **pbuf, int max) { char *ptr; struct libcfs_ioctl_data *overlay; data->ioc_len = libcfs_ioctl_packlen(data); data->ioc_version = LIBCFS_IOCTL_VERSION; if (*pbuf && libcfs_ioctl_packlen(data) > max) return 1; if (*pbuf == NULL) { *pbuf = malloc(data->ioc_len); } if (!*pbuf) return 1; overlay = (struct libcfs_ioctl_data *)*pbuf; memcpy(*pbuf, data, sizeof(*data)); ptr = overlay->ioc_bulk; if (data->ioc_inlbuf1) LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr); if (data->ioc_inlbuf2) LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr); if (libcfs_ioctl_is_invalid(overlay)) return 1; return 0; } #else extern int libcfs_ioctl_getdata(char *buf, char *end, void *arg); extern int libcfs_ioctl_popdata(void *arg, void *buf, int size); #endif /* ioctls for manipulating snapshots 30- */ #define IOC_LIBCFS_TYPE 'e' #define IOC_LIBCFS_MIN_NR 30 /* libcfs ioctls */ #define IOC_LIBCFS_PANIC _IOWR('e', 30, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_CLEAR_DEBUG _IOWR('e', 31, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_MARK_DEBUG _IOWR('e', 32, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_LWT_CONTROL _IOWR('e', 33, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_LWT_SNAPSHOT _IOWR('e', 34, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_LWT_LOOKUP_STRING _IOWR('e', 35, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_MEMHOG _IOWR('e', 36, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_PING_TEST _IOWR('e', 37, IOCTL_LIBCFS_TYPE) /* lnet ioctls */ #define IOC_LIBCFS_GET_NI _IOWR('e', 50, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_FAIL_NID _IOWR('e', 51, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_ADD_ROUTE _IOWR('e', 52, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_DEL_ROUTE _IOWR('e', 53, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_ROUTE _IOWR('e', 54, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_NOTIFY_ROUTER _IOWR('e', 55, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_UNCONFIGURE _IOWR('e', 56, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_PORTALS_COMPATIBILITY _IOWR('e', 57, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_LNET_DIST _IOWR('e', 58, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_CONFIGURE _IOWR('e', 59, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_TESTPROTOCOMPAT _IOWR('e', 60, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_PING _IOWR('e', 61, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_DEBUG_PEER _IOWR('e', 62, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_LNETST _IOWR('e', 63, IOCTL_LIBCFS_TYPE) /* lnd ioctls */ #define IOC_LIBCFS_REGISTER_MYNID _IOWR('e', 70, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_CLOSE_CONNECTION _IOWR('e', 71, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_PUSH_CONNECTION _IOWR('e', 72, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_CONN _IOWR('e', 73, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_DEL_PEER _IOWR('e', 74, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_ADD_PEER _IOWR('e', 75, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_PEER _IOWR('e', 76, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_TXDESC _IOWR('e', 77, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_ADD_INTERFACE _IOWR('e', 78, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_DEL_INTERFACE _IOWR('e', 79, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_INTERFACE _IOWR('e', 80, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_GET_GMID _IOWR('e', 81, IOCTL_LIBCFS_TYPE) #define IOC_LIBCFS_MAX_NR 81 enum { /* Only add to these values (i.e. don't ever change or redefine them): * network addresses depend on them... */ QSWLND = 1, SOCKLND = 2, GMLND = 3, PTLLND = 4, O2IBLND = 5, CIBLND = 6, OPENIBLND = 7, IIBLND = 8, LOLND = 9, RALND = 10, VIBLND = 11, MXLND = 12, }; enum { DEBUG_DAEMON_START = 1, DEBUG_DAEMON_STOP = 2, DEBUG_DAEMON_PAUSE = 3, DEBUG_DAEMON_CONTINUE = 4, }; enum cfg_record_type { PORTALS_CFG_TYPE = 1, LUSTRE_CFG_TYPE = 123, }; typedef int (*cfg_record_cb_t)(enum cfg_record_type, int len, void *data); /* lustre_id output helper macros */ #define DLID4 "%lu/%lu/%lu/%lu" #define OLID4(id) \ (unsigned long)(id)->li_fid.lf_id, \ (unsigned long)(id)->li_fid.lf_group, \ (unsigned long)(id)->li_stc.u.e3s.l3s_ino, \ (unsigned long)(id)->li_stc.u.e3s.l3s_gen #endif