lustre/portals/include/linux/libcfs.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  */
   4 #ifndef _LIBCFS_H
   5 #define _LIBCFS_H
   6
   7 #ifdef HAVE_ASM_TYPES_H
   8 #include <asm/types.h>
   9 #else
  10 #include "types.h"
  11 #endif
  12
  13 #ifdef __KERNEL__
  14 # include <linux/time.h>
  15 # include <asm/timex.h>
  16 #else
  17 # include <sys/time.h>
  18 # define do_gettimeofday(tv) gettimeofday(tv, NULL);
  19 typedef unsigned long long cycles_t;
  20 #endif
  21
  22 #define PORTAL_DEBUG
  23
  24 #ifndef offsetof
  25 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
  26 #endif
  27
  28 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  29
  30 #ifndef __KERNEL__
  31 /* Userpace byte flipping */
  32 # include <endian.h>
  33 # include <byteswap.h>
  34 # define __swab16(x) bswap_16(x)
  35 # define __swab32(x) bswap_32(x)
  36 # define __swab64(x) bswap_64(x)
  37 # define __swab16s(x) do {*(x) = bswap_16(*(x));} while (0)
  38 # define __swab32s(x) do {*(x) = bswap_32(*(x));} while (0)
  39 # define __swab64s(x) do {*(x) = bswap_64(*(x));} while (0)
  40 # if __BYTE_ORDER == __LITTLE_ENDIAN
  41 #  define le16_to_cpu(x) (x)
  42 #  define cpu_to_le16(x) (x)
  43 #  define le32_to_cpu(x) (x)
  44 #  define cpu_to_le32(x) (x)
  45 #  define le64_to_cpu(x) (x)
  46 #  define cpu_to_le64(x) (x)
  47 # else
  48 #  if __BYTE_ORDER == __BIG_ENDIAN
  49 #   define le16_to_cpu(x) bswap_16(x)
  50 #   define cpu_to_le16(x) bswap_16(x)
  51 #   define le32_to_cpu(x) bswap_32(x)
  52 #   define cpu_to_le32(x) bswap_32(x)
  53 #   define le64_to_cpu(x) bswap_64(x)
  54 #   define cpu_to_le64(x) bswap_64(x)
  55 #  else
  56 #   error "Unknown byte order"
  57 #  endif /* __BIG_ENDIAN */
  58 # endif /* __LITTLE_ENDIAN */
  59 #endif /* ! __KERNEL__ */
  60
  61 /*
  62  *  Debugging
  63  */
  64 extern unsigned int portal_subsystem_debug;
  65 extern unsigned int portal_stack;
  66 extern unsigned int portal_debug;
  67 extern unsigned int portal_printk;
  68
  69 struct ptldebug_header {
  70         __u32 ph_len;
  71         __u32 ph_flags;
  72         __u32 ph_subsys;
  73         __u32 ph_mask;
  74         __u32 ph_cpu_id;
  75         __u32 ph_sec;
  76         __u64 ph_usec;
  77         __u32 ph_stack;
  78         __u32 ph_pid;
  79         __u32 ph_extern_pid;
  80         __u32 ph_line_num;
  81 } __attribute__((packed));
  82
  83 #define PH_FLAG_FIRST_RECORD 1
  84
  85 /* Debugging subsystems (32 bits, non-overlapping) */
  86 #define S_UNDEFINED   0x00000001
  87 #define S_MDC         0x00000002
  88 #define S_MDS         0x00000004
  89 #define S_OSC         0x00000008
  90 #define S_OST         0x00000010
  91 #define S_CLASS       0x00000020
  92 #define S_LOG         0x00000040
  93 #define S_LLITE       0x00000080
  94 #define S_RPC         0x00000100
  95 #define S_MGMT        0x00000200
  96 #define S_PORTALS     0x00000400
  97 #define S_NAL         0x00000800 /* ALL NALs */
  98 #define S_PINGER      0x00001000
  99 #define S_FILTER      0x00002000
 100 #define S_PTLBD       0x00004000
 101 #define S_ECHO        0x00008000
 102 #define S_LDLM        0x00010000
 103 #define S_LOV         0x00020000
 104 #define S_PTLROUTER   0x00040000
 105 #define S_COBD        0x00080000
 106 #define S_SM          0x00100000
 107 #define S_ASOBD       0x00200000
 108 #define S_CONFOBD     0x00400000
 109 #define S_LMV         0x00800000
 110 #define S_CMOBD       0x01000000
 111 /* If you change these values, please keep these files up to date...
 112  *    portals/utils/debug.c
 113  *    utils/lconf
 114  */
 115
 116 /* Debugging masks (32 bits, non-overlapping) */
 117 #define D_TRACE       0x00000001 /* ENTRY/EXIT markers */
 118 #define D_INODE       0x00000002
 119 #define D_SUPER       0x00000004
 120 #define D_EXT2        0x00000008 /* anything from ext2_debug */
 121 #define D_MALLOC      0x00000010 /* print malloc, free information */
 122 #define D_CACHE       0x00000020 /* cache-related items */
 123 #define D_INFO        0x00000040 /* general information */
 124 #define D_IOCTL       0x00000080 /* ioctl related information */
 125 #define D_BLOCKS      0x00000100 /* ext2 block allocation */
 126 #define D_NET         0x00000200 /* network communications */
 127 #define D_WARNING     0x00000400 /* CWARN(...) == CDEBUG (D_WARNING, ...) */
 128 #define D_BUFFS       0x00000800
 129 #define D_OTHER       0x00001000
 130 #define D_DENTRY      0x00002000
 131 #define D_PORTALS     0x00004000 /* ENTRY/EXIT markers */
 132 #define D_PAGE        0x00008000 /* bulk page handling */
 133 #define D_DLMTRACE    0x00010000
 134 #define D_ERROR       0x00020000 /* CERROR(...) == CDEBUG (D_ERROR, ...) */
 135 #define D_EMERG       0x00040000 /* CEMERG(...) == CDEBUG (D_EMERG, ...) */
 136 #define D_HA          0x00080000 /* recovery and failover */
 137 #define D_RPCTRACE    0x00100000 /* for distributed debugging */
 138 #define D_VFSTRACE    0x00200000
 139 #define D_READA       0x00400000 /* read-ahead */
 140 #define D_MMAP        0x00800000
 141 #define D_CONFIG      0x01000000
 142 /* If you change these values, please keep these files up to date...
 143  *    portals/utils/debug.c
 144  *    utils/lconf
 145  */
 146
 147 #ifdef __KERNEL__
 148 # include <linux/sched.h> /* THREAD_SIZE */
 149 #else
 150 # ifndef THREAD_SIZE /* x86_64 has THREAD_SIZE in userspace */
 151 #  define THREAD_SIZE 8192
 152 # endif
 153 #endif
 154
 155 #define LUSTRE_TRACE_SIZE (THREAD_SIZE >> 5)
 156
 157 #ifdef __KERNEL__
 158 # ifdef  __ia64__
 159 #  define CDEBUG_STACK (THREAD_SIZE -                                      \
 160                         ((unsigned long)__builtin_dwarf_cfa() &            \
 161                          (THREAD_SIZE - 1)))
 162 # else
 163 #  define CDEBUG_STACK (THREAD_SIZE -                                      \
 164                         ((unsigned long)__builtin_frame_address(0) &       \
 165                          (THREAD_SIZE - 1)))
 166 # endif /* __ia64__ */
 167
 168 #define CHECK_STACK(stack)                                                    \
 169         do {                                                                  \
 170                 if ((stack) > 3*THREAD_SIZE/4 && (stack) > portal_stack) {    \
 171                         portals_debug_msg(DEBUG_SUBSYSTEM, D_WARNING,         \
 172                                           __FILE__, __FUNCTION__, __LINE__,   \
 173                                           (stack),"maximum lustre stack %u\n",\
 174                                           portal_stack = (stack));            \
 175                       /*panic("LBUG");*/                                      \
 176                 }                                                             \
 177         } while (0)
 178 #else /* !__KERNEL__ */
 179 #define CHECK_STACK(stack) do { } while(0)
 180 #define CDEBUG_STACK (0L)
 181 #endif /* __KERNEL__ */
 182
 183 #if 1
 184 #define CDEBUG(mask, format, a...)                                            \
 185 do {                                                                          \
 186         CHECK_STACK(CDEBUG_STACK);                                            \
 187         if (((mask) & (D_ERROR | D_EMERG | D_WARNING)) ||                     \
 188             (portal_debug & (mask) &&                                         \
 189              portal_subsystem_debug & DEBUG_SUBSYSTEM))                       \
 190                 portals_debug_msg(DEBUG_SUBSYSTEM, mask,                      \
 191                                   __FILE__, __FUNCTION__, __LINE__,           \
 192                                   CDEBUG_STACK, format, ## a);                \
 193 } while (0)
 194
 195 #define CDEBUG_MAX_LIMIT 600
 196 #define CDEBUG_LIMIT(cdebug_mask, cdebug_format, a...)                        \
 197 do {                                                                          \
 198         static unsigned long cdebug_next = 0;                                 \
 199         static int cdebug_count = 0, cdebug_delay = 1;                        \
 200                                                                               \
 201         CHECK_STACK(CDEBUG_STACK);                                            \
 202         if (time_after(jiffies, cdebug_next)) {                               \
 203                 portals_debug_msg(DEBUG_SUBSYSTEM, cdebug_mask, __FILE__,     \
 204                                   __FUNCTION__, __LINE__, CDEBUG_STACK,       \
 205                                   cdebug_format, ## a);                       \
 206                 if (cdebug_count) {                                           \
 207                         portals_debug_msg(DEBUG_SUBSYSTEM, cdebug_mask,       \
 208                                           __FILE__, __FUNCTION__, __LINE__,   \
 209                                           0, "skipped %d similar messages\n", \
 210                                           cdebug_count);                      \
 211                         cdebug_count = 0;                                     \
 212                 }                                                             \
 213                 if (time_after(jiffies, cdebug_next+(CDEBUG_MAX_LIMIT+10)*HZ))\
 214                         cdebug_delay = cdebug_delay > 8 ? cdebug_delay/8 : 1; \
 215                 else                                                          \
 216                         cdebug_delay = cdebug_delay*2 >= CDEBUG_MAX_LIMIT*HZ ?\
 217                                         CDEBUG_MAX_LIMIT*HZ : cdebug_delay*2; \
 218                 cdebug_next = jiffies + cdebug_delay;                         \
 219         } else {                                                              \
 220                 portals_debug_msg(DEBUG_SUBSYSTEM,                            \
 221                                   portal_debug & ~(D_EMERG|D_ERROR|D_WARNING),\
 222                                   __FILE__, __FUNCTION__, __LINE__,           \
 223                                   CDEBUG_STACK, cdebug_format, ## a);         \
 224                 cdebug_count++;                                               \
 225         }                                                                     \
 226 } while (0)
 227
 228 #define CWARN(format, a...) CDEBUG_LIMIT(D_WARNING, format, ## a)
 229 #define CERROR(format, a...) CDEBUG_LIMIT(D_ERROR, format, ## a)
 230 #define CEMERG(format, a...) CDEBUG(D_EMERG, format, ## a)
 231
 232 #define GOTO(label, rc)                                                 \
 233 do {                                                                    \
 234         long GOTO__ret = (long)(rc);                                    \
 235         CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
 236                #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
 237                (signed long)GOTO__ret);                                 \
 238         goto label;                                                     \
 239 } while (0)
 240
 241 #define RETURN(rc)                                                      \
 242 do {                                                                    \
 243         typeof(rc) RETURN__ret = (rc);                                  \
 244         CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n",       \
 245                (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
 246         return RETURN__ret;                                             \
 247 } while (0)
 248
 249 #define ENTRY                                                           \
 250 do {                                                                    \
 251         CDEBUG(D_TRACE, "Process entered\n");                           \
 252 } while (0)
 253
 254 #define EXIT                                                            \
 255 do {                                                                    \
 256         CDEBUG(D_TRACE, "Process leaving\n");                           \
 257 } while(0)
 258 #else
 259 #define CDEBUG(mask, format, a...)      do { } while (0)
 260 #define CWARN(format, a...)             printk(KERN_WARNING format, ## a)
 261 #define CERROR(format, a...)            printk(KERN_ERR format, ## a)
 262 #define CEMERG(format, a...)            printk(KERN_EMERG format, ## a)
 263 #define GOTO(label, rc)                 do { (void)(rc); goto label; } while (0)
 264 #define RETURN(rc)                      return (rc)
 265 #define ENTRY                           do { } while (0)
 266 #define EXIT                            do { } while (0)
 267 #endif
 268
 269 /* initial pid  */
 270 # if CRAY_PORTALS
 271 /*
 272  * 1) ptl_pid_t in cray portals is only 16 bits, not 32 bits, therefore this
 273  *    is too big.
 274  *
 275  * 2) the implementation of ernal in cray portals further restricts the pid
 276  *    space that may be used to 0 <= pid <= 255 (an 8 bit value).  Returns
 277  *    an error at nal init time for any pid outside this range.  Other nals
 278  *    in cray portals don't have this restriction.
 279  * */
 280 #define LUSTRE_PTL_PID          9
 281 # else
 282 #define LUSTRE_PTL_PID          12345
 283 # endif
 284
 285 #define LUSTRE_SRV_PTL_PID      LUSTRE_PTL_PID
 286
 287 #define PORTALS_CFG_VERSION 0x00010001;
 288
 289 struct portals_cfg {
 290         __u32 pcfg_version;
 291         __u32 pcfg_command;
 292
 293         __u32 pcfg_nal;
 294         __u32 pcfg_flags;
 295
 296         __u32 pcfg_gw_nal;
 297         __u64 pcfg_nid;
 298         __u64 pcfg_nid2;
 299         __u64 pcfg_nid3;
 300         __u32 pcfg_id;
 301         __u32 pcfg_misc;
 302         __u32 pcfg_fd;
 303         __u32 pcfg_count;
 304         __u32 pcfg_size;
 305         __u32 pcfg_wait;
 306
 307         __u32 pcfg_plen1; /* buffers in userspace */
 308         char *pcfg_pbuf1;
 309         __u32 pcfg_plen2; /* buffers in userspace */
 310         char *pcfg_pbuf2;
 311 };
 312
 313 #define PCFG_INIT(pcfg, cmd)                            \
 314 do {                                                    \
 315         memset(&pcfg, 0, sizeof(pcfg));                 \
 316         pcfg.pcfg_version = PORTALS_CFG_VERSION;        \
 317         pcfg.pcfg_command = (cmd);                      \
 318                                                         \
 319 } while (0)
 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 <linux/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 = 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 #endif
 379
 380 #ifdef __KERNEL__
 381 /* libcfs watchdogs */
 382 struct lc_watchdog;
 383
 384 /* Just use the default handler (dumplog)  */
 385 #define LC_WATCHDOG_DEFAULT_CB NULL
 386
 387 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
 388  * touch it once to enable it. */
 389 struct lc_watchdog *lc_watchdog_add(int time,
 390                                     void (*cb)(struct lc_watchdog *,
 391                                                struct task_struct *,
 392                                                void *),
 393                                     void *data);
 394
 395 /* Enables a watchdog and resets its timer. */
 396 void lc_watchdog_touch(struct lc_watchdog *lcw);
 397
 398 /* Disable a watchdog; touch it to restart it. */
 399 void lc_watchdog_disable(struct lc_watchdog *lcw);
 400
 401 /* Clean up the watchdog */
 402 void lc_watchdog_delete(struct lc_watchdog *lcw);
 403
 404 /* Dump a debug log */
 405 void lc_watchdog_dumplog(struct lc_watchdog *lcw,
 406                          struct task_struct *tsk,
 407                          void *data);
 408 #endif /* !__KERNEL__ */
 409
 410 #endif /* _LIBCFS_H */