libcfs/include/libcfs/winnt/winnt-prim.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/winnt/winnt-prim.h
  37  *
  38  * Basic library routines.
  39  */
  40
  41 #ifndef __LIBCFS_WINNT_CFS_PRIM_H__
  42 #define __LIBCFS_WINNT_CFS_PRIM_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef EXPORT_SYMBOL
  49 # define EXPORT_SYMBOL(s)
  50 #endif
  51
  52 /*
  53  * libcfs proc device object
  54  */
  55
  56
  57 #define LUSTRE_PROC_DEVICE  L"\\Device\\LNetProcFS"      /* proc fs emulator device object */
  58 #define LUSTRE_PROC_SYMLNK  L"\\DosDevices\\LNetProcFS"  /* proc fs user-visible device */
  59
  60
  61 /*
  62  * Device IO Control Code Definitions
  63  */
  64
  65 #define FILE_DEVICE_LIBCFS      ('LC')
  66
  67 #define FUNC_LIBCFS_VERSION     0x101  // get version of current libcfs
  68 #define FUNC_LIBCFS_IOCTL       0x102  // Device i/o control to proc fs
  69
  70
  71 #define IOCTL_LIBCFS_VERSION \
  72      CTL_CODE (FILE_DEVICE_LIBCFS, FUNC_LIBCFS_VERSION, METHOD_BUFFERED, FILE_ANY_ACCESS)
  73 #define IOCTL_LIBCFS_ENTRY   \
  74      CTL_CODE(FILE_DEVICE_LIBCFS, FUNC_LIBCFS_IOCTL,   METHOD_BUFFERED, FILE_ANY_ACCESS)
  75
  76 #pragma pack(4)
  77 typedef struct _CFS_PROC_IOCTL {
  78
  79     ULONG           cmd;    // ioctl command identifier
  80     ULONG           len;    // length of data
  81     int             rc;     // return code
  82     ULONG           usused; // unused
  83
  84     // UCHAR        data[]; // content of the real ioctl
  85
  86 } CFS_PROC_IOCTL, *PCFS_PROC_IOCTL;
  87 #pragma pack()
  88
  89 #ifdef __KERNEL__
  90
  91 void cfs_enter_debugger(void);
  92 #define __builtin_return_address(x) (0)
  93
  94 /*
  95  * Symbol functions for libcfs
  96  *
  97  * OSX has no facility for use to register symbol.
  98  * So we have to implement it.
  99  */
 100 #define CFS_SYMBOL_LEN     64
 101
 102 struct  cfs_symbol {
 103         char             name[CFS_SYMBOL_LEN];
 104         void            *value;
 105         int              ref;
 106         struct list_head sym_list;
 107 };
 108
 109 extern int      cfs_symbol_register(const char *, const void *);
 110 extern void     cfs_symbol_unregister(const char *);
 111 extern void *   cfs_symbol_get(const char *);
 112 extern void     cfs_symbol_put(const char *);
 113 extern void     cfs_symbol_clean();
 114
 115 typedef struct file_operations cfs_file_operations_t;
 116
 117 /*
 118  * Pseudo device register
 119  */
 120
 121 typedef struct miscdevice{
 122     int                     minor;
 123     const char *            name;
 124     cfs_file_operations_t * fops;
 125 };
 126
 127 int misc_register(struct miscdevice *psdev);
 128 int misc_deregister(struct miscdevice *psdev);
 129
 130
 131 /*
 132  * Proc emulator file system APIs
 133  */
 134
 135 typedef int read_proc_t(char *page, char **start, off_t off,
 136                             int count, int *eof, void *data);
 137 typedef int write_proc_t(struct file *file, const char *buffer,
 138                              unsigned long count, void *data);
 139
 140 #define CFS_PROC_ENTRY_MAGIC 'CPEM'
 141
 142 #define CFS_PROC_FLAG_DIRECTORY    0x00000001 // directory node
 143 #define CFS_PROC_FLAG_ATTACHED     0x00000002 // node is attached to proc
 144 #define CFS_PROC_FLAG_MISCDEV      0x00000004 // miscellaneous device
 145
 146 typedef struct cfs_proc_entry
 147 {
 148     ULONG                   magic;      // Magic
 149     ULONG                   flags;      // Flags
 150
 151     struct _dir_entry {                 // proc directory entry
 152         PRTL_SPLAY_LINKS    root;
 153     };
 154
 155     struct cfs_proc_entry  *parent;
 156
 157     struct _file_entry {                // proc file / leaf entry
 158             read_proc_t  *  read_proc;
 159             write_proc_t *  write_proc;
 160     };
 161
 162     mode_t                  mode;
 163     unsigned short          nlink;
 164     BOOLEAN                 deleted;
 165
 166
 167     struct file_operations *proc_fops;
 168     void                   *data;
 169
 170     // proc_dir_entry ended.
 171
 172     RTL_SPLAY_LINKS         s_link;       // splay link
 173
 174     //
 175     // Maximum length of proc entry name is 0x20
 176     //
 177
 178     char                    name[0x20];
 179
 180 } cfs_proc_entry_t, cfs_proc_dir_entry_t;
 181
 182 typedef cfs_proc_entry_t cfs_proc_dir_entry_t;
 183 #define proc_dir_entry cfs_proc_entry
 184
 185 #define PROC_BLOCK_SIZE    PAGE_SIZE
 186
 187 struct proc_dir_entry *PDE(const struct inode *inode);
 188
 189
 190 /*
 191  * Sysctl register
 192  */
 193 typedef int ctl_handler(struct ctl_table *table,
 194                         int *name,  int nlen,
 195                         void *oldval, size_t *oldlenp,
 196                         void *newval, size_t newlen,
 197                         void **context);
 198
 199 typedef int proc_handler (struct ctl_table *ctl,
 200                           int write, struct file *filp,
 201                           void *buffer, size_t *lenp);
 202
 203
 204 int proc_dointvec(struct ctl_table *table, int write, struct file *filp,
 205                      void *buffer, size_t *lenp);
 206
 207 int proc_dostring(struct ctl_table *table, int write, struct file *filp,
 208                   void *buffer, size_t *lenp);
 209
 210 int sysctl_string(struct ctl_table *table, int *name, int nlen,
 211                   void *oldval, size_t *oldlenp,
 212                   void *newval, size_t newlen, void **context);
 213
 214 /*
 215  *  System io control definitions
 216  */
 217
 218 #define CTL_MAXNAME 10
 219
 220 #define CTL_ANY     -1  /* Matches any name */
 221 #define CTL_NONE    0
 222
 223 enum
 224 {
 225     CTL_KERN=1,     /* General kernel info and control */
 226     CTL_VM=2,       /* VM management */
 227     CTL_NET=3,      /* Networking */
 228     CTL_PROC=4,     /* Process info */
 229     CTL_FS=5,       /* Filesystems */
 230     CTL_DEBUG=6,        /* Debugging */
 231     CTL_DEV=7,      /* Devices */
 232     CTL_BUS=8,      /* Busses */
 233     CTL_ABI=9,      /* Binary emulation */
 234     CTL_CPU=10      /* CPU stuff (speed scaling, etc) */
 235 };
 236
 237 /* sysctl table definitons */
 238 struct ctl_table
 239 {
 240         int ctl_name;
 241         char *procname;
 242         void *data;
 243         int maxlen;
 244         mode_t mode;
 245         struct ctl_table *child;
 246         proc_handler *proc_handler;     /* text formatting callback */
 247         ctl_handler *strategy;          /* read / write callback functions */
 248         cfs_proc_entry_t *de;   /* proc entry block */
 249         void *extra1;
 250         void *extra2;
 251 };
 252
 253
 254 /* the mantaner of the cfs_sysctl_table trees */
 255 struct ctl_table_header
 256 {
 257         struct ctl_table *ctl_table;
 258         struct list_head ctl_entry;
 259 };
 260
 261 /* proc root entries, support routines */
 262 extern cfs_proc_entry_t *  cfs_proc_root;   /* / */
 263 extern cfs_proc_entry_t *  cfs_proc_proc;   /* /proc */
 264 extern cfs_proc_entry_t *  cfs_proc_fs;     /* /proc/fs */
 265 extern cfs_proc_entry_t *  cfs_proc_sys;    /* /proc/sys */
 266 extern cfs_proc_entry_t *  cfs_proc_dev;    /* /dev */
 267
 268 cfs_proc_entry_t * create_proc_entry(const char *name, mode_t mod,
 269                                           cfs_proc_entry_t *parent);
 270 void proc_free_entry(cfs_proc_entry_t *de);
 271 void remove_proc_entry(const char *name, cfs_proc_entry_t *entry);
 272 cfs_proc_entry_t * search_proc_entry(const char * name,
 273                         cfs_proc_entry_t *  root );
 274 cfs_proc_entry_t *proc_symlink(const char *name,
 275                                        cfs_proc_entry_t *parent,
 276                                const char *dest);
 277 cfs_proc_entry_t *proc_mkdir(const char *name,
 278                                      cfs_proc_entry_t *parent);
 279
 280 #define cfs_create_proc_entry create_proc_entry
 281 #define cfs_free_proc_entry   proc_free_entry
 282 #define cfs_remove_proc_entry remove_proc_entry
 283
 284 struct ctl_table_header *register_sysctl_table(struct ctl_table *table);
 285 void unregister_sysctl_table(struct ctl_table_header *header);
 286
 287 /*
 288  * seq device (linux/seq_file.h)
 289  */
 290
 291
 292 /*
 293  * seq file definitions
 294  */
 295
 296 struct dentry;
 297 struct vfsmount;
 298
 299 struct path {
 300         struct vfsmount *mnt;
 301         struct dentry *dentry;
 302 };
 303
 304 struct seq_operations;
 305 struct file;
 306 struct inode;
 307
 308 struct seq_file {
 309         char *buf;
 310         size_t size;
 311         size_t from;
 312         size_t count;
 313         loff_t index;
 314         u32    version;
 315         struct mutex            lock;
 316         const struct seq_operations *op;
 317         void *private;
 318 };
 319
 320 struct seq_operations {
 321         void * (*start) (struct seq_file *m, loff_t *pos);
 322         void (*stop) (struct seq_file *m, void *v);
 323         void * (*next) (struct seq_file *m, void *v, loff_t *pos);
 324         int (*show) (struct seq_file *m, void *v);
 325 };
 326
 327 int seq_open(struct file *, const struct seq_operations *);
 328 ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
 329 loff_t seq_lseek(struct file *, loff_t, int);
 330 int seq_release(struct inode *, struct file *);
 331 int seq_escape(struct seq_file *, const char *, const char *);
 332 int seq_putc(struct seq_file *m, char c);
 333 int seq_puts(struct seq_file *m, const char *s);
 334
 335 int seq_path(struct seq_file *, struct path *, char *);
 336
 337 int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
 338 int single_release(struct inode *, struct file *);
 339 void *__seq_open_private(struct file *, const struct seq_operations *, int);
 340 int seq_open_private(struct file *, const struct seq_operations *, int);
 341 int seq_release_private(struct inode *, struct file *);
 342
 343 #define SEQ_START_TOKEN ((void *)1)
 344
 345 /*
 346  * Helpers for iteration over list_head-s in seq_files
 347  */
 348
 349 extern struct list_head *seq_list_start(struct list_head *head, loff_t pos);
 350 extern struct list_head *seq_list_start_head(struct list_head *head, loff_t pos);
 351 extern struct list_head *seq_list_next(void *v, struct list_head *head, loff_t *ppos);
 352
 353 /*
 354  *  declaration of proc kernel process routines
 355  */
 356
 357 struct file *lustre_open_file(char *filename);
 358
 359 int lustre_close_file(struct file *fh);
 360
 361 int lustre_do_ioctl(struct file *fh, unsigned long cmd, ulong_ptr_t arg);
 362
 363 int lustre_ioctl_file(struct file *fh, PCFS_PROC_IOCTL devctl);
 364
 365 size_t lustre_read_file(struct file *fh, loff_t offl, size_t size, char *buf);
 366
 367 size_t lustre_write_file(struct file *fh, loff_t off, size_t size, char *buf);
 368
 369 /*
 370  * Wait Queue
 371  */
 372
 373
 374 #define TASK_INTERRUPTIBLE       0x00000001
 375 #define TASK_UNINTERRUPTIBLE             0x00000002
 376 #define TASK_RUNNING         0x00000003
 377 #define CFS_TASK_UNINTERRUPTIBLE TASK_UNINTERRUPTIBLE
 378
 379 #define CFS_WAITQ_MAGIC     'CWQM'
 380 #define CFS_WAITLINK_MAGIC  'CWLM'
 381
 382 typedef struct cfs_waitq {
 383         unsigned int            magic;
 384         unsigned int            flags;
 385
 386         spinlock_t              guard;
 387         struct list_head        waiters;
 388 } wait_queue_head_t;
 389
 390
 391 typedef struct cfs_waitlink wait_queue_t;
 392
 393 #define CFS_WAITQ_CHANNELS     (2)
 394
 395 #define CFS_WAITQ_CHAN_NORMAL  (0)
 396 #define CFS_WAITQ_CHAN_FORWARD (1)
 397
 398 typedef struct cfs_waitlink_channel {
 399         struct list_head        link;
 400         wait_queue_head_t       *waitq;
 401         wait_queue_t            *waitl;
 402 } cfs_waitlink_channel_t;
 403
 404 struct cfs_waitlink {
 405
 406     unsigned int            magic;
 407     int                     flags;
 408     event_t  *              event;
 409     atomic_t *          hits;
 410
 411     cfs_waitlink_channel_t  waitq[CFS_WAITQ_CHANNELS];
 412 };
 413
 414 enum {
 415         CFS_WAITQ_EXCLUSIVE = 1
 416 };
 417
 418 #define CFS_DECL_WAITQ(name) wait_queue_head_t name
 419
 420 /* Kernel thread */
 421
 422 typedef int (*cfs_thread_t) (void *arg);
 423
 424 typedef struct _cfs_thread_context {
 425     cfs_thread_t        func;
 426     void *              arg;
 427 } cfs_thread_context_t;
 428
 429 /*
 430  * thread creation flags from Linux, not used in winnt
 431  */
 432 #define CSIGNAL         0x000000ff      /* signal mask to be sent at exit */
 433 #define CLONE_VM        0x00000100      /* set if VM shared between processes */
 434 #define CLONE_FS        0x00000200      /* set if fs info shared between processes */
 435 #define CLONE_FILES     0x00000400      /* set if open files shared between processes */
 436 #define CLONE_SIGHAND   0x00000800      /* set if signal handlers and blocked signals shared */
 437 #define CLONE_PID       0x00001000      /* set if pid shared */
 438 #define CLONE_PTRACE    0x00002000      /* set if we want to let tracing continue on the child too */
 439 #define CLONE_VFORK     0x00004000      /* set if the parent wants the child to wake it up on mm_release */
 440 #define CLONE_PARENT    0x00008000      /* set if we want to have the same parent as the cloner */
 441 #define CLONE_THREAD    0x00010000      /* Same thread group? */
 442 #define CLONE_NEWNS     0x00020000      /* New namespace group? */
 443
 444 #define CLONE_SIGNAL    (CLONE_SIGHAND | CLONE_THREAD)
 445
 446 /*
 447  * group_info: linux/sched.h
 448  */
 449 #define NGROUPS_SMALL           32
 450 #define NGROUPS_PER_BLOCK       ((int)(PAGE_SIZE / sizeof(gid_t)))
 451 struct group_info {
 452         int ngroups;
 453         atomic_t usage;
 454         gid_t small_block[NGROUPS_SMALL];
 455         int nblocks;
 456         gid_t *blocks[0];
 457 };
 458
 459 #define get_group_info(group_info) do { \
 460         atomic_inc(&(group_info)->usage); \
 461 } while (0)
 462
 463 #define put_group_info(group_info) do { \
 464         if (atomic_dec_and_test(&(group_info)->usage)) \
 465                 groups_free(group_info); \
 466 } while (0)
 467
 468 static __inline struct group_info *groups_alloc(int gidsetsize)
 469 {
 470     struct group_info * groupinfo;
 471     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__, __FUNCTION__));
 472     groupinfo = kmalloc(sizeof(struct group_info), 0);
 473
 474     if (groupinfo) {
 475         memset(groupinfo, 0, sizeof(struct group_info));
 476     }
 477     return groupinfo;
 478 }
 479
 480 static __inline void groups_free(struct group_info *group_info)
 481 {
 482         KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 483                 __FUNCTION__));
 484         kfree(group_info);
 485 }
 486
 487 static __inline int
 488 set_current_groups(struct group_info *group_info)
 489 {
 490     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 491              __FUNCTION__));
 492     return 0;
 493 }
 494
 495 static __inline int groups_search(struct group_info *group_info,
 496                                   gid_t grp) {
 497     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 498             __FUNCTION__));
 499     return 0;
 500 }
 501
 502 /*
 503  *   capability issue (linux/capability.h)
 504  */
 505
 506 /* Override resource limits. Set resource limits. */
 507 /* Override quota limits. */
 508 /* Override reserved space on ext2 filesystem */
 509 /* Modify data journaling mode on ext3 filesystem (uses journaling
 510    resources) */
 511 /* NOTE: ext2 honors fsuid when checking for resource overrides, so
 512    you can override using fsuid too */
 513 /* Override size restrictions on IPC message queues */
 514 /* Allow more than 64hz interrupts from the real-time clock */
 515 /* Override max number of consoles on console allocation */
 516 /* Override max number of keymaps */
 517
 518 #define CAP_SYS_RESOURCE     24
 519
 520 /*
 521  *  capabilities support
 522  */
 523
 524 typedef __u32 kernel_cap_t;
 525
 526 #define cap_raise(c, flag)  do {} while(0)
 527 #define cap_lower(c, flag)  do {} while(0)
 528 #define cap_raised(c, flag) do {} while(0)
 529
 530
 531 /*
 532  * Task struct
 533  */
 534
 535 #define MAX_SCHEDULE_TIMEOUT     ((long_ptr_t)(~0UL>>12))
 536 #define schedule_timeout(t)      schedule_timeout_and_set_state(0, t)
 537
 538 struct vfsmount;
 539
 540 #define NGROUPS 1
 541 #define CFS_CURPROC_COMM_MAX (16)
 542 struct task_struct{
 543     mode_t                umask;
 544     sigset_t              blocked;
 545
 546     pid_t                 pid;
 547     pid_t                 pgrp;
 548
 549     uid_t                 uid,euid,suid,fsuid;
 550     gid_t                 gid,egid,sgid,fsgid;
 551
 552     int                   ngroups;
 553     int                   cgroups;
 554     gid_t                 groups[NGROUPS];
 555     struct group_info     *group_info;
 556     kernel_cap_t      cap_effective,
 557                           cap_inheritable,
 558                           cap_permitted;
 559
 560     char                  comm[CFS_CURPROC_COMM_MAX];
 561     void                 *journal_info;
 562     struct vfsmount      *fs;
 563 };
 564
 565 static inline void task_lock(struct task_struct *t)
 566 {
 567 }
 568
 569 static inline void task_unlock(struct task_struct *t)
 570 {
 571 }
 572
 573 /*
 574  *  linux task struct emulator ...
 575  */
 576
 577 #define TASKMAN_MAGIC  'TMAN'   /* Task Manager */
 578 #define TASKSLT_MAGIC  'TSLT'   /* Task Slot */
 579
 580 typedef struct _TASK_MAN {
 581         ULONG           Magic;          /* Magic and Flags */
 582         ULONG           Flags;
 583
 584         spinlock_t      Lock;           /* Protection lock */
 585
 586         struct kmem_cache       *slab;          /* Memory slab for task slot */
 587
 588         ULONG           NumOfTasks;     /* Total tasks (threads) */
 589         LIST_ENTRY      TaskList;       /* List of task slots */
 590 } TASK_MAN, *PTASK_MAN;
 591
 592 typedef struct _TASK_SLOT {
 593
 594     ULONG           Magic;      /* Magic and Flags */
 595     ULONG           Flags;
 596
 597     LIST_ENTRY      Link;       /* To be linked to TaskMan */
 598
 599     event_t         Event;      /* Schedule event */
 600
 601     HANDLE          Pid;        /* Process id */
 602     HANDLE          Tid;        /* Thread id */
 603     PETHREAD        Tet;        /* Pointer to ethread */
 604
 605     atomic_t    count;      /* refer count */
 606     atomic_t    hits;       /* times of waken event singaled */
 607
 608     KIRQL           irql;       /* irql for rwlock ... */
 609
 610     struct task_struct      task;       /* linux task part */
 611
 612 } TASK_SLOT, *PTASK_SLOT;
 613
 614
 615 #define set_current_state(s)     do {;} while (0)
 616
 617 #define wait_event(wq, condition)                           \
 618 do {                                                            \
 619         wait_queue_t __wait;                                    \
 620                                                                 \
 621         init_waitqueue_entry_current(&__wait);                  \
 622         while (TRUE) {                                          \
 623             add_wait_queue(&wq, &__wait);                        \
 624             if (condition) {                                    \
 625                 break;                                          \
 626             }                                                   \
 627             waitq_wait(&__wait, TASK_INTERRUPTIBLE);            \
 628             remove_wait_queue(&wq, &__wait);                    \
 629         }                                                       \
 630         remove_wait_queue(&wq, &__wait);                        \
 631 } while(0)
 632
 633 #define wait_event_interruptible(wq, condition)                 \
 634 {                                                               \
 635         wait_queue_t __wait;                                    \
 636                                                                 \
 637         __ret = 0;                                              \
 638         init_waitqueue_entry_current(&__wait);                             \
 639         while (TRUE) {                                          \
 640                 add_wait_queue(&wq, &__wait);                   \
 641                 if (condition) {                                \
 642                         break;                                  \
 643                 }                                               \
 644                 waitq_wait(&__wait, TASK_INTERRUPTIBLE);\
 645                 remove_wait_queue(&wq, &__wait);                        \
 646         }                                                       \
 647         remove_wait_queue(&wq, &__wait);                            \
 648         __ret;                                                  \
 649 }
 650
 651 # define wait_event_interruptible_exclusive(wq, condition)  \
 652          wait_event_interruptible(wq, condition)
 653
 654 /*
 655    retval == 0; condition met; we're good.
 656    retval < 0; interrupted by signal.
 657    retval > 0; timed out.
 658 */
 659
 660 #define wait_event_interruptible_timeout(wq, condition, timeout)\
 661 do {                                                            \
 662         wait_queue_t __wait;                                    \
 663                                                                 \
 664         init_waitqueue_entry_current(&__wait);                  \
 665         while (TRUE) {                                          \
 666             add_wait_queue(&wq, &__wait);                       \
 667             if (condition) {                                    \
 668                 break;                                          \
 669             }                                                   \
 670             if (waitq_timedwait(&__wait,                        \
 671                 TASK_INTERRUPTIBLE, timeout) == 0) {            \
 672                 break;                                          \
 673             }                                                   \
 674             remove_wait_queue(&wq, &__wait);                    \
 675         }                                                       \
 676         remove_wait_queue(&wq, &__wait);                        \
 677 } while(0)
 678
 679 int     init_task_manager();
 680 void    cleanup_task_manager();
 681 struct task_struct * current;
 682 int     wake_up_process(struct task_struct * task);
 683 void sleep_on(wait_queue_head_t *waitq);
 684 #define might_sleep() do {} while(0)
 685 #define DECL_JOURNAL_DATA
 686 #define PUSH_JOURNAL        do {;} while(0)
 687 #define POP_JOURNAL                 do {;} while(0)
 688
 689
 690 /* module related definitions */
 691
 692 #ifndef __exit
 693 #define __exit
 694 #endif
 695 #ifndef __init
 696 #define __init
 697 #endif
 698
 699 struct module{
 700     const char *name;
 701 };
 702
 703 extern struct module libcfs_global_module;
 704 #define THIS_MODULE  &libcfs_global_module
 705
 706 #define request_module(x, y) (0)
 707 #define MODULE_AUTHOR(s)
 708 #define MODULE_DESCRIPTION(s)
 709 #define MODULE_LICENSE(s)
 710 #define MODULE_PARM(a, b)
 711 #define MODULE_PARM_DESC(a, b)
 712
 713 #define module_init(X) int  __init module_##X() {return X();}
 714 #define module_exit(X) void __exit module_##X() {X();}
 715
 716 #define DECLARE_INIT(X) extern int  __init  module_##X(void)
 717 #define DECLARE_EXIT(X) extern void __exit  module_##X(void)
 718
 719 #define MODULE_INIT(X) do { int rc = module_##X(); \
 720                             if (rc) goto errorout; \
 721                           } while(0)
 722
 723 #define MODULE_EXIT(X) do { module_##X(); } while(0)
 724
 725
 726 /* Module interfaces */
 727 #define cfs_module(name, version, init, fini) \
 728         module_init(init);                    \
 729         module_exit(fini)
 730 #define module_refcount(x) (1)
 731
 732 /*
 733  * typecheck
 734  */
 735
 736 #define typecheck(a, b) do {} while(0)
 737
 738 /*
 739  * linux/crypto.h
 740  */
 741
 742 #define CRYPTO_MAX_ALG_NAME             64
 743
 744 #define CRYPTO_TFM_MODE_ECB             0x00000001
 745 #define CRYPTO_TFM_MODE_CBC             0x00000002
 746 #define CRYPTO_TFM_MODE_CFB             0x00000004
 747 #define CRYPTO_TFM_MODE_CTR             0x00000008
 748 #define CRYPTO_TFM_MODE_EME             0x00000010
 749
 750 /*
 751  * hash
 752  */
 753 /* 2^31 + 2^29 - 2^25 + 2^22 - 2^19 - 2^16 + 1 */
 754 #define GOLDEN_RATIO_PRIME_32 0x9e370001UL
 755
 756 #if 0 /* defined in libcfs/libcfs_hash.h */
 757 static inline u32 cfs_hash_long(u32 val, unsigned int bits)
 758 {
 759         /* On some cpus multiply is faster, on others gcc will do shifts */
 760         u32 hash = val * GOLDEN_RATIO_PRIME_32;
 761
 762         /* High bits are more random, so use them. */
 763         return hash >> (32 - bits);
 764 }
 765 #endif
 766
 767 /*
 768  * Timer
 769  */
 770
 771 #define CFS_TIMER_FLAG_INITED   0x00000001  // Initialized already
 772 #define CFS_TIMER_FLAG_TIMERED  0x00000002  // KeSetTimer is called
 773
 774 struct timer_list {
 775
 776     KSPIN_LOCK      Lock;
 777
 778     ULONG           Flags;
 779
 780     KDPC            Dpc;
 781     KTIMER          Timer;
 782
 783     cfs_time_t      deadline;
 784
 785     void (*proc)(ulong_ptr_t);
 786     void *          arg;
 787
 788 };
 789
 790 /*
 791  *  libcfs globals initialization/cleanup
 792  */
 793
 794 int
 795 libcfs_arch_init(void);
 796
 797 void
 798 libcfs_arch_cleanup(void);
 799
 800 /*
 801  *  cache alignment size
 802  */
 803
 804 #define L1_CACHE_ALIGN(x) (x)
 805
 806 #define __cacheline_aligned
 807
 808 /*
 809  * SMP ...
 810  */
 811
 812
 813 #define SMP_CACHE_BYTES             128
 814 #define NR_CPUS                 (32)
 815 #define smp_num_cpus                ((CCHAR)KeNumberProcessors)
 816 #define num_possible_cpus()     smp_num_cpus
 817 #define num_online_cpus()       smp_num_cpus
 818 #define smp_processor_id()          ((USHORT)KeGetCurrentProcessorNumber())
 819 #define smp_call_function(f, a, n, w)           do {} while(0)
 820 #define smp_rmb()                   do {} while(0)
 821
 822 /*
 823  *  Irp related
 824  */
 825
 826 #define NR_IRQS                 512
 827 #define in_interrupt()          (0)
 828
 829 /*
 830  *  printk flags
 831  */
 832
 833 #define KERN_EMERG      "<0>"   /* system is unusable                   */
 834 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
 835 #define KERN_CRIT       "<2>"   /* critical conditions                  */
 836 #define KERN_ERR        "<3>"   /* error conditions                     */
 837 #define KERN_WARNING    "<4>"   /* warning conditions                   */
 838 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
 839 #define KERN_INFO       "<6>"   /* informational                        */
 840 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
 841
 842 /*
 843  * Misc
 844  */
 845
 846 #define inter_module_get(n)                     cfs_symbol_get(n)
 847 #define inter_module_put(n)                     cfs_symbol_put(n)
 848
 849 #ifndef likely
 850 #define likely(exp) (exp)
 851 #endif
 852 #ifndef unlikely
 853 #define unlikely(exp) (exp)
 854 #endif
 855
 856 #define local_irq_save(x)
 857 #define local_irq_restore(x)
 858
 859 #define va_copy(_d, _s)                 (_d = _s)
 860
 861 char *strnchr(const char *s, size_t count, int c);
 862
 863 #define adler32(a,b,l) zlib_adler32(a,b,l)
 864 ULONG zlib_adler32(ULONG adler, const BYTE *buf, UINT len);
 865
 866 typedef ssize_t (*read_actor_t)();
 867
 868 #if DBG
 869 /*
 870  *  winnt debug routines
 871  */
 872
 873 VOID
 874 KsPrintf(
 875     LONG  DebugPrintLevel,
 876     PCHAR DebugMessage,
 877     ...
 878     );
 879
 880 PUCHAR
 881 KsNtStatusToString (IN NTSTATUS Status);
 882 #endif
 883
 884 #else   /* !__KERNEL__ */
 885
 886 void cfs_enter_debugger();
 887
 888 /*
 889  *  PAGE_SIZE ...
 890  */
 891
 892 #ifndef PAGE_SIZE
 893 #define PAGE_SIZE       (4096)
 894 #endif
 895
 896 #define getpagesize()   (4096)
 897
 898 #define PAGE_CACHE_SIZE PAGE_SIZE
 899 #define PAGE_CACHE_MASK PAGE_MASK
 900
 901 #define PTHREAD_MUTEX_INITIALIZER ((pthread_mutex_t) -1)
 902 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER ((pthread_mutex_t) -2)
 903 #define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER ((pthread_mutex_t) -3)
 904
 905 struct file {
 906         int foo;
 907 };
 908
 909 #include "../user-prim.h"
 910 #include "../user-lock.h"
 911 #include <sys/stat.h>
 912 #include <sys/types.h>
 913
 914 #define strcasecmp  strcmp
 915 #define strncasecmp strncmp
 916 #define getpid()   (0)
 917
 918 #define getuid()    (0)
 919 #define getgrgid(x) (NULL)
 920
 921 struct passwd {
 922         uid_t pw_uid;
 923         char  pw_name[64];
 924 };
 925 struct passwd * getpwuid(uid_t uid);
 926
 927 int cfs_proc_mknod(const char *path, mode_t mode, dev_t dev);
 928
 929 int gethostname(char * name, int namelen);
 930
 931 #define setlinebuf(x) do {} while(0)
 932
 933
 934 /* Maximum EA Information Length */
 935 #define EA_MAX_LENGTH  (sizeof(FILE_FULL_EA_INFORMATION) + 15)
 936
 937 /*
 938  *  proc user mode routines
 939  */
 940
 941 int cfs_proc_open (char * filename, int oflag);
 942 int cfs_proc_close(int fd);
 943 int cfs_proc_read(int fd, void *buffer, unsigned int count);
 944 int cfs_proc_write(int fd, void *buffer, unsigned int count);
 945 int cfs_proc_ioctl(int fd, int cmd, void *buffer);
 946 FILE *cfs_proc_fopen(char *path, char * mode);
 947 char *cfs_proc_fgets(char * buf, int len, FILE *fp);
 948 int cfs_proc_fclose(FILE *fp);
 949
 950 /* Bits set in the FLAGS argument to `glob'.  */
 951 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
 952 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
 953 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
 954 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
 955 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
 956 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
 957 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
 958 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
 959
 960 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
 961 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
 962 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
 963 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
 964 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
 965 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
 966 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
 967 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
 968                                       if the user name is not available.  */
 969 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 970                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 971                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
 972                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
 973 #else
 974 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 975                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 976                          GLOB_PERIOD)
 977 #endif
 978
 979 /* Error returns from `glob'.  */
 980 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
 981 #define GLOB_ABORTED    2       /* Read error.  */
 982 #define GLOB_NOMATCH    3       /* No matches found.  */
 983 #define GLOB_NOSYS      4       /* Not implemented.  */
 984 #ifdef __USE_GNU
 985 /* Previous versions of this file defined GLOB_ABEND instead of
 986    GLOB_ABORTED.  Provide a compatibility definition here.  */
 987 # define GLOB_ABEND GLOB_ABORTED
 988 #endif
 989
 990 /* Structure describing a globbing run.  */
 991 #ifdef __USE_GNU
 992 struct stat;
 993 #endif
 994 typedef struct
 995   {
 996     size_t gl_pathc;            /* Count of paths matched by the pattern.  */
 997     char **gl_pathv;            /* List of matched pathnames.  */
 998     size_t gl_offs;             /* Slots to reserve in `gl_pathv'.  */
 999     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
1000
1001     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
1002        are used instead of the normal file access functions.  */
1003     void (*gl_closedir) (void *);
1004 #ifdef __USE_GNU
1005     struct dirent *(*gl_readdir) (void *);
1006 #else
1007     void *(*gl_readdir) (void *);
1008 #endif
1009     void *(*gl_opendir) (const char *);
1010 #ifdef __USE_GNU
1011     int (*gl_lstat) (const char *__restrict, struct stat *__restrict);
1012     int (*gl_stat) (const char *__restrict, struct stat *__restrict);
1013 #else
1014     int (*gl_lstat) (const char *__restrict, void *__restrict);
1015     int (*gl_stat) (const char *__restrict, void *__restrict);
1016 #endif
1017   } glob_t;
1018
1019 #ifdef __USE_LARGEFILE64
1020 # ifdef __USE_GNU
1021 struct stat64;
1022 # endif
1023 typedef struct
1024   {
1025     __size_t gl_pathc;
1026     char **gl_pathv;
1027     __size_t gl_offs;
1028     int gl_flags;
1029
1030     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
1031        are used instead of the normal file access functions.  */
1032     void (*gl_closedir) (void *);
1033 # ifdef __USE_GNU
1034     struct dirent64 *(*gl_readdir) (void *);
1035 # else
1036     void *(*gl_readdir) (void *);
1037 # endif
1038     void *(*gl_opendir) (__const char *);
1039 # ifdef __USE_GNU
1040     int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
1041     int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
1042 # else
1043     int (*gl_lstat) (__const char *__restrict, void *__restrict);
1044     int (*gl_stat) (__const char *__restrict, void *__restrict);
1045 # endif
1046   } glob64_t;
1047 #endif
1048
1049 int glob (const char * __pattern, int __flags,
1050                  int (*__errfunc) (const char *, int),
1051                  glob_t * __pglob);
1052 void globfree(glob_t *__pglog);
1053
1054 #endif /* !__KERNEL__ */
1055
1056 /*
1057  *  module routines
1058  */
1059
1060 static inline void __module_get(struct module *module)
1061 {
1062 }
1063
1064 static inline int try_module_get(struct module *module)
1065 {
1066         return 1;
1067 }
1068
1069 static inline void module_put(struct module *module)
1070 {
1071 }
1072
1073 /*
1074  *  sigset_t routines
1075  */
1076
1077 #define sigaddset(what,sig) (*(what) |= (1<<(sig)), 0)
1078 #define sigdelset(what,sig) (*(what) &= ~(1<<(sig)), 0)
1079 #define sigemptyset(what)   (*(what) = 0, 0)
1080 #define sigfillset(what)    (*(what) = ~(0), 0)
1081 #define sigismember(what,sig) (((*(what)) & (1<<(sig))) != 0)
1082
1083 static __inline int
1084 sigprocmask(int sig, sigset_t *w1, sigset_t *w2) {
1085     return 0;
1086 }
1087 static __inline int
1088 sigpending(sigset_t *what) {
1089     return 0;
1090 }
1091
1092 /*
1093  * common inode flags (user & kernel)
1094  */
1095
1096 #define S_ISLNK(m)      (((m) & S_IFMT) == S_IFLNK)
1097 #define S_ISREG(m)      (((m) & S_IFMT) == S_IFREG)
1098 #define S_ISDIR(m)      (((m) & S_IFMT) == S_IFDIR)
1099 #define S_ISCHR(m)      (((m) & S_IFMT) == S_IFCHR)
1100 #define S_ISBLK(m)      (((m) & S_IFMT) == S_IFBLK)
1101 #define S_ISFIFO(m)     (((m) & S_IFMT) == S_IFIFO)
1102 #define S_ISSOCK(m)     (((m) & S_IFMT) == S_IFSOCK)
1103
1104 #define S_IRWXU 00700
1105 #define S_IRUSR 00400
1106 #define S_IWUSR 00200
1107 #define S_IXUSR 00100
1108
1109 #define S_IRWXG 00070
1110 #define S_IRGRP 00040
1111 #define S_IWGRP 00020
1112 #define S_IXGRP 00010
1113
1114 #define S_IRWXO 00007
1115 #define S_IROTH 00004
1116 #define S_IWOTH 00002
1117 #define S_IXOTH 00001
1118
1119 #define S_IRWXUGO   (S_IRWXU|S_IRWXG|S_IRWXO)
1120 #define S_IALLUGO   (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
1121 #define S_IRUGO     (S_IRUSR|S_IRGRP|S_IROTH)
1122 #define S_IWUGO     (S_IWUSR|S_IWGRP|S_IWOTH)
1123 #define S_IXUGO     (S_IXUSR|S_IXGRP|S_IXOTH)
1124
1125
1126 /*
1127  *  linux ioctl coding definitions
1128  */
1129
1130 #define _IOC_NRBITS 8
1131 #define _IOC_TYPEBITS   8
1132 #define _IOC_SIZEBITS   14
1133 #define _IOC_DIRBITS    2
1134
1135 #define _IOC_NRMASK     ((1 << _IOC_NRBITS)-1)
1136 #define _IOC_TYPEMASK   ((1 << _IOC_TYPEBITS)-1)
1137 #define _IOC_SIZEMASK   ((1 << _IOC_SIZEBITS)-1)
1138 #define _IOC_DIRMASK    ((1 << _IOC_DIRBITS)-1)
1139
1140 #define _IOC_NRSHIFT    0
1141 #define _IOC_TYPESHIFT  (_IOC_NRSHIFT+_IOC_NRBITS)
1142 #define _IOC_SIZESHIFT  (_IOC_TYPESHIFT+_IOC_TYPEBITS)
1143 #define _IOC_DIRSHIFT   (_IOC_SIZESHIFT+_IOC_SIZEBITS)
1144
1145 /*
1146  * Direction bits.
1147  */
1148 #define _IOC_NONE   0U
1149 #define _IOC_WRITE  1U
1150 #define _IOC_READ   2U
1151
1152 #define _IOC(dir,type,nr,size) \
1153     (((dir)  << _IOC_DIRSHIFT) | \
1154      ((type) << _IOC_TYPESHIFT) | \
1155      ((nr)   << _IOC_NRSHIFT) | \
1156      ((size) << _IOC_SIZESHIFT))
1157
1158 /* used to create numbers */
1159 #define _IO(type,nr)      _IOC(_IOC_NONE,(type),(nr),0)
1160 #define _IOR(type,nr,size)    _IOC(_IOC_READ,(type),(nr),sizeof(size))
1161 #define _IOW(type,nr,size)    _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
1162 #define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
1163
1164 /* used to decode ioctl numbers.. */
1165 #define _IOC_DIR(nr)        (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
1166 #define _IOC_TYPE(nr)       (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
1167 #define _IOC_NR(nr)         (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
1168 #define _IOC_SIZE(nr)       (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)
1169
1170 /* i/o vector sgructure ... */
1171 struct iovec {
1172     void *iov_base;
1173     size_t iov_len;
1174 };
1175
1176 /* idr support routines */
1177 struct idr_context *cfs_idr_init();
1178 int cfs_idr_remove(struct idr_context *idp, int id);
1179 int cfs_idr_get_new(struct idr_context *idp, void *ptr);
1180 int cfs_idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id);
1181 void *cfs_idr_find(struct idr_context *idp, int id);
1182 void cfs_idr_exit(struct idr_context *idp);
1183
1184 /* runtime time routines for both kenrel and user mode */
1185 extern int cfs_isalpha(int);
1186 extern int cfs_isspace(int);
1187 extern int cfs_isupper(int);
1188 extern int cfs_isdigit(int);
1189 extern int cfs_isxdigit(int);
1190
1191 #define ULONG_LONG_MAX ((__u64)(0xFFFFFFFFFFFFFFFF))
1192 /*
1193  * Convert a string to an unsigned long long integer.
1194  *
1195  * Ignores `locale' stuff.  Assumes that the upper and lower case
1196  * alphabets and digits are each contiguous.
1197  */
1198 __u64 strtoull(char *nptr, char **endptr,int base);
1199
1200 /*
1201  *  getopt routines
1202  */
1203
1204 /* For communication from `getopt' to the caller.
1205    When `getopt' finds an option that takes an argument,
1206    the argument value is returned here.
1207    Also, when `ordering' is RETURN_IN_ORDER,
1208    each non-option ARGV-element is returned here.  */
1209
1210 extern char *optarg;
1211
1212 /* Index in ARGV of the next element to be scanned.
1213    This is used for communication to and from the caller
1214    and for communication between successive calls to `getopt'.
1215
1216    On entry to `getopt', zero means this is the first call; initialize.
1217
1218    When `getopt' returns -1, this is the index of the first of the
1219    non-option elements that the caller should itself scan.
1220
1221    Otherwise, `optind' communicates from one call to the next
1222    how much of ARGV has been scanned so far.  */
1223
1224 extern int optind;
1225
1226 /* Callers store zero here to inhibit the error message `getopt' prints
1227    for unrecognized options.  */
1228
1229 extern int opterr;
1230
1231 /* Set to an option character which was unrecognized.  */
1232
1233 extern int optopt;
1234
1235
1236 struct option
1237 {
1238   const char *name;
1239   /* has_arg can't be an enum because some compilers complain about
1240      type mismatches in all the code that assumes it is an int.  */
1241   int has_arg;
1242   int *flag;
1243   int val;
1244 };
1245
1246 /* Names for the values of the `has_arg' field of `struct option'.  */
1247 # define no_argument            0
1248 # define required_argument      1
1249 # define optional_argument      2
1250
1251 extern int getopt(int ___argc, char *const *___argv, const char *__shortopts);
1252 extern int getopt_long (int ___argc, char *const *___argv,
1253                         const char *__shortopts,
1254                         const struct option *__longopts, int *__longind);
1255 extern int getopt_long_only (int ___argc, char *const *___argv,
1256                              const char *__shortopts,
1257                              const struct option *__longopts, int *__longind);
1258
1259 extern char *strcasestr (const char *phaystack, const char *pneedle);
1260
1261 /*
1262  * global environment runtime routine
1263  */
1264
1265 static __inline char * __cdecl cfs_getenv(const char *ENV) {return NULL;}
1266 static __inline void   __cdecl set_getenv(const char *ENV, const char *value, int overwrite) {}
1267
1268 int setenv(const char *envname, const char *envval, int overwrite);
1269
1270 typedef struct utsname {
1271          char sysname[64];
1272          char nodename[64];
1273          char release[128];
1274          char version[128];
1275          char machine[64];
1276 };
1277
1278 int uname(struct utsname *uts);
1279
1280 #endif