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