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