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 #elif defined(__WINNT__)
  16 #include <libcfs/winnt/libcfs.h>
  17 #else
  18 #error Unsupported operating system.
  19 #endif
  20
  21 #include "curproc.h"
  22
  23 #ifndef __KERNEL__
  24 #include <stdio.h>
  25 #endif
  26
  27 #define LIBCFS_DEBUG
  28
  29 #ifndef offsetof
  30 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
  31 #endif
  32
  33 /* cardinality of array */
  34 #define sizeof_array(a) ((sizeof (a)) / (sizeof ((a)[0])))
  35
  36 #if !defined(container_of)
  37 /* given a pointer @ptr to the field @member embedded into type (usually
  38  * struct) @type, return pointer to the embedding instance of @type. */
  39 #define container_of(ptr, type, member) \
  40         ((type *)((char *)(ptr)-(unsigned long)(&((type *)0)->member)))
  41 #endif
  42
  43 #define container_of0(ptr, type, member)                        \
  44 ({                                                              \
  45         typeof(ptr) __ptr = (ptr);                              \
  46         __ptr ? container_of(__ptr, type, member) : NULL;       \
  47 })
  48
  49 /*
  50  * true iff @i is power-of-2
  51  */
  52 #define IS_PO2(i)                               \
  53 ({                                              \
  54         typeof(i) __i;                          \
  55                                                 \
  56         __i = (i);                              \
  57         !(__i & (__i - 1));                     \
  58 })
  59
  60 #define LOWEST_BIT_SET(x)       ((x) & ~((x) - 1))
  61
  62 /*
  63  *  Debugging
  64  */
  65 extern unsigned int libcfs_subsystem_debug;
  66 extern unsigned int libcfs_stack;
  67 extern unsigned int libcfs_debug;
  68 extern unsigned int libcfs_printk;
  69 extern unsigned int libcfs_console_ratelimit;
  70 extern unsigned int libcfs_debug_binary;
  71 extern char debug_file_path[1024];
  72
  73 int libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys);
  74 int libcfs_debug_str2mask(int *mask, const char *str, int is_subsys);
  75
  76 /* Has there been an LBUG? */
  77 extern unsigned int libcfs_catastrophe;
  78
  79 /*
  80  * struct ptldebug_header is defined in libcfs/<os>/libcfs.h
  81  */
  82
  83 #define PH_FLAG_FIRST_RECORD 1
  84
  85 /* Debugging subsystems (32 bits, non-overlapping) */
  86 /* keep these in sync with lnet/utils/debug.c and lnet/libcfs/debug.c */
  87 #define S_UNDEFINED   0x00000001
  88 #define S_MDC         0x00000002
  89 #define S_MDS         0x00000004
  90 #define S_OSC         0x00000008
  91 #define S_OST         0x00000010
  92 #define S_CLASS       0x00000020
  93 #define S_LOG         0x00000040
  94 #define S_LLITE       0x00000080
  95 #define S_RPC         0x00000100
  96 #define S_MGMT        0x00000200
  97 /* unused */
  98 #define S_LNET        0x00000400
  99 #define S_LND         0x00000800 /* ALL LNDs */
 100 #define S_PINGER      0x00001000
 101 #define S_FILTER      0x00002000
 102 /* unused */
 103 #define S_ECHO        0x00008000
 104 #define S_LDLM        0x00010000
 105 #define S_LOV         0x00020000
 106 /* unused */
 107 /* unused */
 108 /* unused */
 109 /* unused */
 110 /* unused */
 111 #define S_LMV         0x00800000 /* b_new_cmd */
 112 /* unused */
 113 #define S_SEC         0x02000000 /* upcall cache */
 114 #define S_GSS         0x04000000 /* b_new_cmd */
 115 /* unused */
 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 */
 121
 122 /* Debugging masks (32 bits, non-overlapping) */
 123 /* keep these in sync with lnet/utils/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 /* unused: keep in sync with lnet/utils/debug.c */
 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/debug.c */
 153
 154 #define D_CANTMASK   (D_ERROR | D_EMERG | D_WARNING | D_CONSOLE)
 155
 156 #ifndef DEBUG_SUBSYSTEM
 157 # define DEBUG_SUBSYSTEM S_UNDEFINED
 158 #endif
 159
 160 #define CDEBUG_MAX_LIMIT 600
 161 typedef struct {
 162         cfs_time_t      cdls_next;
 163         int             cdls_count;
 164         cfs_duration_t  cdls_delay;
 165 } cfs_debug_limit_state_t;
 166
 167 #define CDEBUG_ENABLED (1)
 168
 169 #ifdef __KERNEL__
 170
 171 #if CDEBUG_ENABLED
 172 #define __CDEBUG(cdls, mask, format, a...)                              \
 173 do {                                                                    \
 174         CHECK_STACK();                                                  \
 175                                                                         \
 176         if (((mask) & D_CANTMASK) != 0 ||                               \
 177             ((libcfs_debug & (mask)) != 0 &&                            \
 178              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
 179                 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, mask,           \
 180                                  __FILE__, __FUNCTION__, __LINE__,      \
 181                                  format, ## a);                         \
 182 } while (0)
 183
 184 #define CDEBUG(mask, format, a...) __CDEBUG(NULL, mask, format, ## a)
 185
 186 #define CDEBUG_LIMIT(mask, format, a...)        \
 187 do {                                            \
 188         static cfs_debug_limit_state_t cdls;    \
 189                                                 \
 190         __CDEBUG(&cdls, mask, format, ## a);    \
 191 } while (0)
 192
 193 #else /* CDEBUG_ENABLED */
 194 #define CDEBUG(mask, format, a...) (void)(0)
 195 #define CDEBUG_LIMIT(mask, format, a...) (void)(0)
 196 #endif
 197
 198 #elif defined(__arch_lib__) && !defined(LUSTRE_UTILS)
 199
 200 #define CDEBUG(mask, format, a...)                                      \
 201 do {                                                                    \
 202         if (((mask) & D_CANTMASK) != 0 ||                               \
 203             ((libcfs_debug & (mask)) != 0 &&                            \
 204              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
 205                 libcfs_debug_msg(NULL, DEBUG_SUBSYSTEM, mask,           \
 206                                  __FILE__, __FUNCTION__, __LINE__,      \
 207                                  format, ## a);                         \
 208 } while (0)
 209
 210 #define CDEBUG_LIMIT CDEBUG
 211
 212 #else
 213
 214 #define CDEBUG(mask, format, a...)                                      \
 215 do {                                                                    \
 216         if (((mask) & D_CANTMASK) != 0)                                 \
 217                 fprintf(stderr, "(%s:%d:%s()) " format,                 \
 218                         __FILE__, __LINE__, __FUNCTION__, ## a);        \
 219 } while (0)
 220
 221 #define CDEBUG_LIMIT CDEBUG
 222
 223 #endif /* !__KERNEL__ */
 224
 225 #define CWARN(format, a...)          CDEBUG_LIMIT(D_WARNING, format, ## a)
 226 #define CERROR(format, a...)         CDEBUG_LIMIT(D_ERROR, format, ## a)
 227 #define CEMERG(format, a...)         CDEBUG_LIMIT(D_EMERG, format, ## a)
 228
 229 #define LCONSOLE(mask, format, a...) CDEBUG(D_CONSOLE | (mask), format, ## a)
 230 #define LCONSOLE_INFO(format, a...)  CDEBUG_LIMIT(D_CONSOLE, format, ## a)
 231 #define LCONSOLE_WARN(format, a...)  CDEBUG_LIMIT(D_CONSOLE | D_WARNING, format, ## a)
 232 #define LCONSOLE_ERROR(format, a...) CDEBUG_LIMIT(D_CONSOLE | D_ERROR, format, ## a)
 233 #define LCONSOLE_EMERG(format, a...) CDEBUG(D_CONSOLE | D_EMERG, format, ## a)
 234
 235 #if CDEBUG_ENABLED
 236
 237 #define GOTO(label, rc)                                                 \
 238 do {                                                                    \
 239         long GOTO__ret = (long)(rc);                                    \
 240         CDEBUG(D_TRACE,"Process leaving via %s (rc=%lu : %ld : %lx)\n", \
 241                #label, (unsigned long)GOTO__ret, (signed long)GOTO__ret,\
 242                (signed long)GOTO__ret);                                 \
 243         goto label;                                                     \
 244 } while (0)
 245 #else
 246 #define GOTO(label, rc) do { ((void)(rc)); goto label; } while (0)
 247 #endif
 248
 249 #define CDEBUG_ENTRY_EXIT (1)
 250 #if CDEBUG_ENTRY_EXIT
 251
 252 /*
 253  * if rc == NULL, we need to code as RETURN((void *)NULL), otherwise
 254  * there will be a warning in osx.
 255  */
 256 #define RETURN(rc)                                                      \
 257 do {                                                                    \
 258         typeof(rc) RETURN__ret = (rc);                                  \
 259         CDEBUG(D_TRACE, "Process leaving (rc=%lu : %ld : %lx)\n",       \
 260                (long)RETURN__ret, (long)RETURN__ret, (long)RETURN__ret);\
 261         EXIT_NESTING;                                                   \
 262         return RETURN__ret;                                             \
 263 } while (0)
 264
 265 #define ENTRY                                                           \
 266 ENTRY_NESTING;                                                          \
 267 do {                                                                    \
 268         CDEBUG(D_TRACE, "Process entered\n");                           \
 269 } while (0)
 270
 271 #define EXIT                                                            \
 272 do {                                                                    \
 273         CDEBUG(D_TRACE, "Process leaving\n");                           \
 274         EXIT_NESTING;                                                   \
 275 } while(0)
 276 #else /* !CDEBUG_ENTRY_EXIT */
 277
 278 #define RETURN(rc) return (rc)
 279 #define ENTRY                           do { } while (0)
 280 #define EXIT                            do { } while (0)
 281
 282 #endif /* !CDEBUG_ENTRY_EXIT */
 283
 284 /*
 285  * Some (nomina odiosa sunt) platforms define NULL as naked 0. This confuses
 286  * Lustre RETURN(NULL) macro.
 287  */
 288 #if defined(NULL)
 289 #undef NULL
 290 #endif
 291
 292 #define NULL ((void *)0)
 293
 294 #define LUSTRE_SRV_LNET_PID      LUSTRE_LNET_PID
 295
 296 #ifdef __KERNEL__
 297
 298 #include <libcfs/list.h>
 299
 300 struct libcfs_ioctl_data;                       /* forward ref */
 301
 302 struct libcfs_ioctl_handler {
 303         struct list_head item;
 304         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_data *data);
 305 };
 306
 307 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
 308         struct libcfs_ioctl_handler ident = {                   \
 309                 /* .item = */ CFS_LIST_HEAD_INIT(ident.item),   \
 310                 /* .handle_ioctl = */ func                      \
 311         }
 312
 313 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
 314 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
 315
 316 /* libcfs tcpip */
 317 #define LNET_ACCEPTOR_MIN_RESERVED_PORT    512
 318 #define LNET_ACCEPTOR_MAX_RESERVED_PORT    1023
 319
 320 int libcfs_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
 321 int libcfs_ipif_enumerate(char ***names);
 322 void libcfs_ipif_free_enumeration(char **names, int n);
 323 int libcfs_sock_listen(cfs_socket_t **sockp, __u32 ip, int port, int backlog);
 324 int libcfs_sock_accept(cfs_socket_t **newsockp, cfs_socket_t *sock);
 325 void libcfs_sock_abort_accept(cfs_socket_t *sock);
 326 int libcfs_sock_connect(cfs_socket_t **sockp, int *fatal,
 327                         __u32 local_ip, int local_port,
 328                         __u32 peer_ip, int peer_port);
 329 int libcfs_sock_setbuf(cfs_socket_t *socket, int txbufsize, int rxbufsize);
 330 int libcfs_sock_getbuf(cfs_socket_t *socket, int *txbufsize, int *rxbufsize);
 331 int libcfs_sock_getaddr(cfs_socket_t *socket, int remote, __u32 *ip, int *port);
 332 int libcfs_sock_write(cfs_socket_t *sock, void *buffer, int nob, int timeout);
 333 int libcfs_sock_read(cfs_socket_t *sock, void *buffer, int nob, int timeout);
 334 void libcfs_sock_release(cfs_socket_t *sock);
 335
 336 /* libcfs watchdogs */
 337 struct lc_watchdog;
 338
 339 /* Add a watchdog which fires after "time" milliseconds of delay.  You have to
 340  * touch it once to enable it. */
 341 struct lc_watchdog *lc_watchdog_add(int time,
 342                                     void (*cb)(pid_t pid, void *),
 343                                     void *data);
 344
 345 /* Enables a watchdog and resets its timer. */
 346 void lc_watchdog_touch(struct lc_watchdog *lcw);
 347
 348 /* Disable a watchdog; touch it to restart it. */
 349 void lc_watchdog_disable(struct lc_watchdog *lcw);
 350
 351 /* Clean up the watchdog */
 352 void lc_watchdog_delete(struct lc_watchdog *lcw);
 353
 354 /* Dump a debug log */
 355 void lc_watchdog_dumplog(pid_t pid, void *data);
 356
 357 /* __KERNEL__ */
 358 #endif
 359
 360 /*
 361  * libcfs pseudo device operations
 362  *
 363  * struct cfs_psdev_t and
 364  * cfs_psdev_register() and
 365  * cfs_psdev_deregister() are declared in
 366  * libcfs/<os>/cfs_prim.h
 367  *
 368  * It's just draft now.
 369  */
 370
 371 struct cfs_psdev_file {
 372         unsigned long   off;
 373         void            *private_data;
 374         unsigned long   reserved1;
 375         unsigned long   reserved2;
 376 };
 377
 378 struct cfs_psdev_ops {
 379         int (*p_open)(unsigned long, void *);
 380         int (*p_close)(unsigned long, void *);
 381         int (*p_read)(struct cfs_psdev_file *, char *, unsigned long);
 382         int (*p_write)(struct cfs_psdev_file *, char *, unsigned long);
 383         int (*p_ioctl)(struct cfs_psdev_file *, unsigned long, void *);
 384 };
 385
 386 /*
 387  * generic time manipulation functions.
 388  */
 389
 390 static inline int cfs_time_after(cfs_time_t t1, cfs_time_t t2)
 391 {
 392         return cfs_time_before(t2, t1);
 393 }
 394
 395 static inline int cfs_time_aftereq(cfs_time_t t1, cfs_time_t t2)
 396 {
 397         return cfs_time_beforeq(t2, t1);
 398 }
 399
 400 /*
 401  * return seconds since UNIX epoch
 402  */
 403 static inline time_t cfs_unix_seconds(void)
 404 {
 405         cfs_fs_time_t t;
 406
 407         cfs_fs_time_current(&t);
 408         return (time_t)cfs_fs_time_sec(&t);
 409 }
 410
 411 static inline cfs_time_t cfs_time_shift(int seconds)
 412 {
 413         return cfs_time_add(cfs_time_current(), cfs_time_seconds(seconds));
 414 }
 415
 416 static inline long cfs_timeval_sub(struct timeval *large, struct timeval *small,
 417                                    struct timeval *result)
 418 {
 419         long r = (long) (
 420                 (large->tv_sec - small->tv_sec) * ONE_MILLION +
 421                 (large->tv_usec - small->tv_usec));
 422         if (result != NULL) {
 423                 result->tv_usec = r / ONE_MILLION;
 424                 result->tv_sec = r;
 425         }
 426         return r;
 427 }
 428
 429 #define CFS_RATELIMIT(seconds)                                  \
 430 ({                                                              \
 431         /*                                                      \
 432          * XXX nikita: non-portable initializer                 \
 433          */                                                     \
 434         static time_t __next_message = 0;                       \
 435         int result;                                             \
 436                                                                 \
 437         if (cfs_time_after(cfs_time_current(), __next_message)) \
 438                 result = 1;                                     \
 439         else {                                                  \
 440                 __next_message = cfs_time_shift(seconds);       \
 441                 result = 0;                                     \
 442         }                                                       \
 443         result;                                                 \
 444 })
 445
 446 struct libcfs_debug_msg_data {
 447         cfs_debug_limit_state_t *msg_cdls;
 448         int                      msg_subsys;
 449         const char              *msg_file;
 450         const char              *msg_fn;
 451         int                      msg_line;
 452 };
 453
 454 #define DEBUG_MSG_DATA_INIT(cdls, subsystem, file, func, ln ) { \
 455         .msg_cdls           = (cdls),       \
 456         .msg_subsys         = (subsystem),  \
 457         .msg_file           = (file),       \
 458         .msg_fn             = (func),       \
 459         .msg_line           = (ln)          \
 460     }
 461
 462
 463 extern int libcfs_debug_vmsg2(cfs_debug_limit_state_t *cdls,
 464                               int subsys, int mask,
 465                               const char *file, const char *fn, const int line,
 466                               const char *format1, va_list args,
 467                               const char *format2, ...);
 468
 469 #define libcfs_debug_vmsg(cdls, subsys, mask, file, fn, line, format, args) \
 470     libcfs_debug_vmsg2(cdls, subsys, mask, file, fn, line, format, args, NULL, NULL)
 471
 472 #define libcfs_debug_msg(cdls, subsys, mask, file, fn, line, format, a...) \
 473     libcfs_debug_vmsg2(cdls, subsys, mask, file, fn, line, NULL, NULL, format, ##a)
 474
 475 #define cdebug_va(cdls, mask, file, func, line, fmt, args)      do {            \
 476         CHECK_STACK();                                                          \
 477                                                                                 \
 478         if (((mask) & D_CANTMASK) != 0 ||                                       \
 479             ((libcfs_debug & (mask)) != 0 &&                                    \
 480              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                  \
 481                 libcfs_debug_vmsg(cdls, DEBUG_SUBSYSTEM, (mask),                \
 482                                   (file), (func), (line), fmt, args);           \
 483 } while(0);
 484
 485 #define cdebug(cdls, mask, file, func, line, fmt, a...) do {                    \
 486         CHECK_STACK();                                                          \
 487                                                                                 \
 488         if (((mask) & D_CANTMASK) != 0 ||                                       \
 489             ((libcfs_debug & (mask)) != 0 &&                                    \
 490              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))                  \
 491                 libcfs_debug_msg(cdls, DEBUG_SUBSYSTEM, (mask),                 \
 492                                  (file), (func), (line), fmt, ## a);            \
 493 } while(0);
 494
 495 extern void libcfs_assertion_failed(const char *expr, const char *file,
 496                                     const char *fn, const int line);
 497
 498 static inline void cfs_slow_warning(cfs_time_t now, int seconds, char *msg)
 499 {
 500         if (cfs_time_after(cfs_time_current(),
 501                            cfs_time_add(now, cfs_time_seconds(15))))
 502                 CERROR("slow %s %lu sec\n", msg,
 503                        cfs_duration_sec(cfs_time_sub(cfs_time_current(), now)));
 504 }
 505
 506 /*
 507  * helper function similar to do_gettimeofday() of Linux kernel
 508  */
 509 static inline void cfs_fs_timeval(struct timeval *tv)
 510 {
 511         cfs_fs_time_t time;
 512
 513         cfs_fs_time_current(&time);
 514         cfs_fs_time_usec(&time, tv);
 515 }
 516
 517 /*
 518  * return valid time-out based on user supplied one. Currently we only check
 519  * that time-out is not shorted than allowed.
 520  */
 521 static inline cfs_duration_t cfs_timeout_cap(cfs_duration_t timeout)
 522 {
 523         if (timeout < CFS_TICK)
 524                 timeout = CFS_TICK;
 525         return timeout;
 526 }
 527
 528 /*
 529  * Universal memory allocator API
 530  */
 531 enum cfs_alloc_flags {
 532         /* allocation is not allowed to block */
 533         CFS_ALLOC_ATOMIC = (1 << 0),
 534         /* allocation is allowed to block */
 535         CFS_ALLOC_WAIT = (1 << 1),
 536         /* allocation should return zeroed memory */
 537         CFS_ALLOC_ZERO   = (1 << 2),
 538         /* allocation is allowed to call file-system code to free/clean
 539          * memory */
 540         CFS_ALLOC_FS     = (1 << 3),
 541         /* allocation is allowed to do io to free/clean memory */
 542         CFS_ALLOC_IO     = (1 << 4),
 543         /* don't report allocation failure to the console */
 544         CFS_ALLOC_NOWARN = (1 << 5),
 545         /* standard allocator flag combination */
 546         CFS_ALLOC_STD    = CFS_ALLOC_FS | CFS_ALLOC_IO,
 547         CFS_ALLOC_USER   = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO,
 548 };
 549
 550 /* flags for cfs_page_alloc() in addition to enum cfs_alloc_flags */
 551 enum cfs_alloc_page_flags {
 552         /* allow to return page beyond KVM. It has to be mapped into KVM by
 553          * cfs_page_map(); */
 554         CFS_ALLOC_HIGH   = (1 << 5),
 555         CFS_ALLOC_HIGHUSER = CFS_ALLOC_WAIT | CFS_ALLOC_FS | CFS_ALLOC_IO | CFS_ALLOC_HIGH,
 556 };
 557
 558 /*
 559  * portable UNIX device file identification. (This is not _very_
 560  * portable. Probably makes no sense for Windows.)
 561  */
 562 /*
 563  * Platform defines
 564  *
 565  * cfs_rdev_t
 566  */
 567
 568 typedef unsigned int cfs_major_nr_t;
 569 typedef unsigned int cfs_minor_nr_t;
 570
 571 /*
 572  * Defined by platform.
 573  */
 574 cfs_rdev_t     cfs_rdev_build(cfs_major_nr_t major, cfs_minor_nr_t minor);
 575 cfs_major_nr_t cfs_rdev_major(cfs_rdev_t rdev);
 576 cfs_minor_nr_t cfs_rdev_minor(cfs_rdev_t rdev);
 577
 578 /*
 579  * Generic on-wire rdev format.
 580  */
 581
 582 typedef __u32 cfs_wire_rdev_t;
 583
 584 cfs_wire_rdev_t cfs_wire_rdev_build(cfs_major_nr_t major, cfs_minor_nr_t minor);
 585 cfs_major_nr_t  cfs_wire_rdev_major(cfs_wire_rdev_t rdev);
 586 cfs_minor_nr_t  cfs_wire_rdev_minor(cfs_wire_rdev_t rdev);
 587
 588 /*
 589  * Drop into debugger, if possible. Implementation is provided by platform.
 590  */
 591
 592 void cfs_enter_debugger(void);
 593
 594 /*
 595  * Defined by platform
 596  */
 597 void cfs_daemonize(char *str);
 598 int cfs_daemonize_ctxt(char *str);
 599 cfs_sigset_t cfs_get_blocked_sigs(void);
 600 cfs_sigset_t cfs_block_allsigs(void);
 601 cfs_sigset_t cfs_block_sigs(cfs_sigset_t bits);
 602 void cfs_restore_sigs(cfs_sigset_t);
 603 int cfs_signal_pending(void);
 604 void cfs_clear_sigpending(void);
 605 /*
 606  * XXX Liang:
 607  * these macros should be removed in the future,
 608  * we keep them just for keeping libcfs compatible
 609  * with other branches.
 610  */
 611 #define libcfs_daemonize(s)     cfs_daemonize(s)
 612 #define cfs_sigmask_lock(f)     do { f= 0; } while (0)
 613 #define cfs_sigmask_unlock(f)   do { f= 0; } while (0)
 614
 615 int convert_server_error(__u64 ecode);
 616 int convert_client_oflag(int cflag, int *result);
 617
 618 /*
 619  * Stack-tracing filling.
 620  */
 621
 622 /*
 623  * Platform-dependent data-type to hold stack frames.
 624  */
 625 struct cfs_stack_trace;
 626
 627 /*
 628  * Fill @trace with current back-trace.
 629  */
 630 void cfs_stack_trace_fill(struct cfs_stack_trace *trace);
 631
 632 /*
 633  * Return instruction pointer for frame @frame_no. NULL if @frame_no is
 634  * invalid.
 635  */
 636 void *cfs_stack_trace_frame(struct cfs_stack_trace *trace, int frame_no);
 637
 638 /*
 639  * Universal open flags.
 640  */
 641 #define CFS_O_ACCMODE           0003
 642 #define CFS_O_CREAT             0100
 643 #define CFS_O_EXCL              0200
 644 #define CFS_O_NOCTTY            0400
 645 #define CFS_O_TRUNC             01000
 646 #define CFS_O_APPEND            02000
 647 #define CFS_O_NONBLOCK          04000
 648 #define CFS_O_NDELAY            CFS_O_NONBLOCK
 649 #define CFS_O_SYNC              010000
 650 #define CFS_O_ASYNC             020000
 651 #define CFS_O_DIRECT            040000
 652 #define CFS_O_LARGEFILE         0100000
 653 #define CFS_O_DIRECTORY         0200000
 654 #define CFS_O_NOFOLLOW          0400000
 655 #define CFS_O_NOATIME           01000000
 656
 657 /* convert local open flags to universal open flags */
 658 int cfs_oflags2univ(int flags);
 659 /* convert universal open flags to local open flags */
 660 int cfs_univ2oflags(int flags);
 661
 662 #define _LIBCFS_H
 663
 664 #endif /* _LIBCFS_H */