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         cfs_list_t 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         cfs_list_t              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 cfs_list_t *seq_list_start(cfs_list_t *head, loff_t pos);
 350 extern cfs_list_t *seq_list_start_head(cfs_list_t *head, loff_t pos);
 351 extern cfs_list_t *seq_list_next(void *v, cfs_list_t *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         cfs_list_t              waiters;
 388
 389 } wait_queue_head_t;
 390
 391
 392 typedef struct cfs_waitlink wait_queue_t;
 393
 394 #define CFS_WAITQ_CHANNELS     (2)
 395
 396 #define CFS_WAITQ_CHAN_NORMAL  (0)
 397 #define CFS_WAITQ_CHAN_FORWARD (1)
 398
 399
 400
 401 typedef struct cfs_waitlink_channel {
 402     cfs_list_t              link;
 403     wait_queue_head_t *           waitq;
 404     wait_queue_t *        waitl;
 405 } cfs_waitlink_channel_t;
 406
 407 struct cfs_waitlink {
 408
 409     unsigned int            magic;
 410     int                     flags;
 411     event_t  *              event;
 412     atomic_t *          hits;
 413
 414     cfs_waitlink_channel_t  waitq[CFS_WAITQ_CHANNELS];
 415 };
 416
 417 enum {
 418         CFS_WAITQ_EXCLUSIVE = 1
 419 };
 420
 421 #define CFS_DECL_WAITQ(name) wait_queue_head_t name
 422
 423 /* Kernel thread */
 424
 425 typedef int (*cfs_thread_t) (void *arg);
 426
 427 typedef struct _cfs_thread_context {
 428     cfs_thread_t        func;
 429     void *              arg;
 430 } cfs_thread_context_t;
 431
 432 /*
 433  * thread creation flags from Linux, not used in winnt
 434  */
 435 #define CSIGNAL         0x000000ff      /* signal mask to be sent at exit */
 436 #define CLONE_VM        0x00000100      /* set if VM shared between processes */
 437 #define CLONE_FS        0x00000200      /* set if fs info shared between processes */
 438 #define CLONE_FILES     0x00000400      /* set if open files shared between processes */
 439 #define CLONE_SIGHAND   0x00000800      /* set if signal handlers and blocked signals shared */
 440 #define CLONE_PID       0x00001000      /* set if pid shared */
 441 #define CLONE_PTRACE    0x00002000      /* set if we want to let tracing continue on the child too */
 442 #define CLONE_VFORK     0x00004000      /* set if the parent wants the child to wake it up on mm_release */
 443 #define CLONE_PARENT    0x00008000      /* set if we want to have the same parent as the cloner */
 444 #define CLONE_THREAD    0x00010000      /* Same thread group? */
 445 #define CLONE_NEWNS     0x00020000      /* New namespace group? */
 446
 447 #define CLONE_SIGNAL    (CLONE_SIGHAND | CLONE_THREAD)
 448
 449 /*
 450  * group_info: linux/sched.h
 451  */
 452 #define NGROUPS_SMALL           32
 453 #define NGROUPS_PER_BLOCK       ((int)(PAGE_SIZE / sizeof(gid_t)))
 454 struct group_info {
 455         int ngroups;
 456         atomic_t usage;
 457         gid_t small_block[NGROUPS_SMALL];
 458         int nblocks;
 459         gid_t *blocks[0];
 460 };
 461
 462 #define get_group_info(group_info) do { \
 463         atomic_inc(&(group_info)->usage); \
 464 } while (0)
 465
 466 #define put_group_info(group_info) do { \
 467         if (atomic_dec_and_test(&(group_info)->usage)) \
 468                 groups_free(group_info); \
 469 } while (0)
 470
 471 static __inline struct group_info *groups_alloc(int gidsetsize)
 472 {
 473     struct group_info * groupinfo;
 474     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__, __FUNCTION__));
 475     groupinfo = kmalloc(sizeof(struct group_info), 0);
 476
 477     if (groupinfo) {
 478         memset(groupinfo, 0, sizeof(struct group_info));
 479     }
 480     return groupinfo;
 481 }
 482
 483 static __inline void groups_free(struct group_info *group_info)
 484 {
 485         KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 486                 __FUNCTION__));
 487         kfree(group_info);
 488 }
 489
 490 static __inline int
 491 set_current_groups(struct group_info *group_info)
 492 {
 493     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 494              __FUNCTION__));
 495     return 0;
 496 }
 497
 498 static __inline int groups_search(struct group_info *group_info,
 499                                   gid_t grp) {
 500     KdPrint(("%s(%d): %s NOT implemented.\n", __FILE__, __LINE__,
 501             __FUNCTION__));
 502     return 0;
 503 }
 504
 505 /*
 506  *   capability issue (linux/capability.h)
 507  */
 508
 509 /* Override resource limits. Set resource limits. */
 510 /* Override quota limits. */
 511 /* Override reserved space on ext2 filesystem */
 512 /* Modify data journaling mode on ext3 filesystem (uses journaling
 513    resources) */
 514 /* NOTE: ext2 honors fsuid when checking for resource overrides, so
 515    you can override using fsuid too */
 516 /* Override size restrictions on IPC message queues */
 517 /* Allow more than 64hz interrupts from the real-time clock */
 518 /* Override max number of consoles on console allocation */
 519 /* Override max number of keymaps */
 520
 521 #define CAP_SYS_RESOURCE     24
 522
 523 /*
 524  *  capabilities support
 525  */
 526
 527 typedef __u32 kernel_cap_t;
 528
 529 #define cap_raise(c, flag)  do {} while(0)
 530 #define cap_lower(c, flag)  do {} while(0)
 531 #define cap_raised(c, flag) do {} while(0)
 532
 533
 534 /*
 535  * Task struct
 536  */
 537
 538 #define MAX_SCHEDULE_TIMEOUT     ((long_ptr_t)(~0UL>>12))
 539 #define schedule_timeout(t)      schedule_timeout_and_set_state(0, t)
 540
 541 struct vfsmount;
 542
 543 #define NGROUPS 1
 544 #define CFS_CURPROC_COMM_MAX (16)
 545 struct task_struct{
 546     mode_t                umask;
 547     sigset_t              blocked;
 548
 549     pid_t                 pid;
 550     pid_t                 pgrp;
 551
 552     uid_t                 uid,euid,suid,fsuid;
 553     gid_t                 gid,egid,sgid,fsgid;
 554
 555     int                   ngroups;
 556     int                   cgroups;
 557     gid_t                 groups[NGROUPS];
 558     struct group_info     *group_info;
 559     kernel_cap_t      cap_effective,
 560                           cap_inheritable,
 561                           cap_permitted;
 562
 563     char                  comm[CFS_CURPROC_COMM_MAX];
 564     void                 *journal_info;
 565     struct vfsmount      *fs;
 566 };
 567
 568 static inline void task_lock(struct task_struct *t)
 569 {
 570 }
 571
 572 static inline void task_unlock(struct task_struct *t)
 573 {
 574 }
 575
 576 /*
 577  *  linux task struct emulator ...
 578  */
 579
 580 #define TASKMAN_MAGIC  'TMAN'   /* Task Manager */
 581 #define TASKSLT_MAGIC  'TSLT'   /* Task Slot */
 582
 583 typedef struct _TASK_MAN {
 584         ULONG           Magic;          /* Magic and Flags */
 585         ULONG           Flags;
 586
 587         spinlock_t      Lock;           /* Protection lock */
 588
 589         struct kmem_cache       *slab;          /* Memory slab for task slot */
 590
 591         ULONG           NumOfTasks;     /* Total tasks (threads) */
 592         LIST_ENTRY      TaskList;       /* List of task slots */
 593 } TASK_MAN, *PTASK_MAN;
 594
 595 typedef struct _TASK_SLOT {
 596
 597     ULONG           Magic;      /* Magic and Flags */
 598     ULONG           Flags;
 599
 600     LIST_ENTRY      Link;       /* To be linked to TaskMan */
 601
 602     event_t         Event;      /* Schedule event */
 603
 604     HANDLE          Pid;        /* Process id */
 605     HANDLE          Tid;        /* Thread id */
 606     PETHREAD        Tet;        /* Pointer to ethread */
 607
 608     atomic_t    count;      /* refer count */
 609     atomic_t    hits;       /* times of waken event singaled */
 610
 611     KIRQL           irql;       /* irql for rwlock ... */
 612
 613     struct task_struct      task;       /* linux task part */
 614
 615 } TASK_SLOT, *PTASK_SLOT;
 616
 617
 618 #define set_current_state(s)     do {;} while (0)
 619
 620 #define wait_event(wq, condition)                           \
 621 do {                                                            \
 622         wait_queue_t __wait;                                    \
 623                                                                 \
 624         init_waitqueue_entry_current(&__wait);                  \
 625         while (TRUE) {                                          \
 626             add_wait_queue(&wq, &__wait);                        \
 627             if (condition) {                                    \
 628                 break;                                          \
 629             }                                                   \
 630             waitq_wait(&__wait, TASK_INTERRUPTIBLE);            \
 631             remove_wait_queue(&wq, &__wait);                    \
 632         }                                                       \
 633         remove_wait_queue(&wq, &__wait);                        \
 634 } while(0)
 635
 636 #define wait_event_interruptible(wq, condition)                 \
 637 {                                                               \
 638         wait_queue_t __wait;                                    \
 639                                                                 \
 640         __ret = 0;                                              \
 641         init_waitqueue_entry_current(&__wait);                             \
 642         while (TRUE) {                                          \
 643                 add_wait_queue(&wq, &__wait);                   \
 644                 if (condition) {                                \
 645                         break;                                  \
 646                 }                                               \
 647                 waitq_wait(&__wait, TASK_INTERRUPTIBLE);\
 648                 remove_wait_queue(&wq, &__wait);                        \
 649         }                                                       \
 650         remove_wait_queue(&wq, &__wait);                            \
 651         __ret;                                                  \
 652 }
 653
 654 # define wait_event_interruptible_exclusive(wq, condition)  \
 655          wait_event_interruptible(wq, condition)
 656
 657 /*
 658    retval == 0; condition met; we're good.
 659    retval < 0; interrupted by signal.
 660    retval > 0; timed out.
 661 */
 662
 663 #define wait_event_interruptible_timeout(wq, condition, timeout)\
 664 do {                                                            \
 665         wait_queue_t __wait;                                    \
 666                                                                 \
 667         init_waitqueue_entry_current(&__wait);                  \
 668         while (TRUE) {                                          \
 669             add_wait_queue(&wq, &__wait);                       \
 670             if (condition) {                                    \
 671                 break;                                          \
 672             }                                                   \
 673             if (waitq_timedwait(&__wait,                        \
 674                 TASK_INTERRUPTIBLE, timeout) == 0) {            \
 675                 break;                                          \
 676             }                                                   \
 677             remove_wait_queue(&wq, &__wait);                    \
 678         }                                                       \
 679         remove_wait_queue(&wq, &__wait);                        \
 680 } while(0)
 681
 682 int     init_task_manager();
 683 void    cleanup_task_manager();
 684 struct task_struct * current;
 685 int     wake_up_process(struct task_struct * task);
 686 void sleep_on(wait_queue_head_t *waitq);
 687 #define might_sleep() do {} while(0)
 688 #define DECL_JOURNAL_DATA
 689 #define PUSH_JOURNAL        do {;} while(0)
 690 #define POP_JOURNAL                 do {;} while(0)
 691
 692
 693 /* module related definitions */
 694
 695 #ifndef __exit
 696 #define __exit
 697 #endif
 698 #ifndef __init
 699 #define __init
 700 #endif
 701
 702 struct module{
 703     const char *name;
 704 };
 705
 706 extern struct module libcfs_global_module;
 707 #define THIS_MODULE  &libcfs_global_module
 708
 709 #define request_module(x, y) (0)
 710 #define MODULE_AUTHOR(s)
 711 #define MODULE_DESCRIPTION(s)
 712 #define MODULE_LICENSE(s)
 713 #define MODULE_PARM(a, b)
 714 #define MODULE_PARM_DESC(a, b)
 715
 716 #define module_init(X) int  __init module_##X() {return X();}
 717 #define module_exit(X) void __exit module_##X() {X();}
 718
 719 #define DECLARE_INIT(X) extern int  __init  module_##X(void)
 720 #define DECLARE_EXIT(X) extern void __exit  module_##X(void)
 721
 722 #define MODULE_INIT(X) do { int rc = module_##X(); \
 723                             if (rc) goto errorout; \
 724                           } while(0)
 725
 726 #define MODULE_EXIT(X) do { module_##X(); } while(0)
 727
 728
 729 /* Module interfaces */
 730 #define cfs_module(name, version, init, fini) \
 731         module_init(init);                    \
 732         module_exit(fini)
 733 #define module_refcount(x) (1)
 734
 735 /*
 736  * typecheck
 737  */
 738
 739 #define typecheck(a, b) do {} while(0)
 740
 741 /*
 742  * linux/crypto.h
 743  */
 744
 745 #define CRYPTO_MAX_ALG_NAME             64
 746
 747 #define CRYPTO_TFM_MODE_ECB             0x00000001
 748 #define CRYPTO_TFM_MODE_CBC             0x00000002
 749 #define CRYPTO_TFM_MODE_CFB             0x00000004
 750 #define CRYPTO_TFM_MODE_CTR             0x00000008
 751 #define CRYPTO_TFM_MODE_EME             0x00000010
 752
 753 /*
 754  * hash
 755  */
 756 /* 2^31 + 2^29 - 2^25 + 2^22 - 2^19 - 2^16 + 1 */
 757 #define GOLDEN_RATIO_PRIME_32 0x9e370001UL
 758
 759 #if 0 /* defined in libcfs/libcfs_hash.h */
 760 static inline u32 cfs_hash_long(u32 val, unsigned int bits)
 761 {
 762         /* On some cpus multiply is faster, on others gcc will do shifts */
 763         u32 hash = val * GOLDEN_RATIO_PRIME_32;
 764
 765         /* High bits are more random, so use them. */
 766         return hash >> (32 - bits);
 767 }
 768 #endif
 769
 770 /*
 771  * Timer
 772  */
 773
 774 #define CFS_TIMER_FLAG_INITED   0x00000001  // Initialized already
 775 #define CFS_TIMER_FLAG_TIMERED  0x00000002  // KeSetTimer is called
 776
 777 struct timer_list {
 778
 779     KSPIN_LOCK      Lock;
 780
 781     ULONG           Flags;
 782
 783     KDPC            Dpc;
 784     KTIMER          Timer;
 785
 786     cfs_time_t      deadline;
 787
 788     void (*proc)(ulong_ptr_t);
 789     void *          arg;
 790
 791 };
 792
 793 /*
 794  *  libcfs globals initialization/cleanup
 795  */
 796
 797 int
 798 libcfs_arch_init(void);
 799
 800 void
 801 libcfs_arch_cleanup(void);
 802
 803 /*
 804  *  cache alignment size
 805  */
 806
 807 #define L1_CACHE_ALIGN(x) (x)
 808
 809 #define __cacheline_aligned
 810
 811 /*
 812  * SMP ...
 813  */
 814
 815
 816 #define SMP_CACHE_BYTES             128
 817 #define NR_CPUS                 (32)
 818 #define smp_num_cpus                ((CCHAR)KeNumberProcessors)
 819 #define num_possible_cpus()     smp_num_cpus
 820 #define num_online_cpus()       smp_num_cpus
 821 #define smp_processor_id()          ((USHORT)KeGetCurrentProcessorNumber())
 822 #define smp_call_function(f, a, n, w)           do {} while(0)
 823 #define smp_rmb()                   do {} while(0)
 824
 825 /*
 826  *  Irp related
 827  */
 828
 829 #define NR_IRQS                 512
 830 #define in_interrupt()          (0)
 831
 832 /*
 833  *  printk flags
 834  */
 835
 836 #define KERN_EMERG      "<0>"   /* system is unusable                   */
 837 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
 838 #define KERN_CRIT       "<2>"   /* critical conditions                  */
 839 #define KERN_ERR        "<3>"   /* error conditions                     */
 840 #define KERN_WARNING    "<4>"   /* warning conditions                   */
 841 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
 842 #define KERN_INFO       "<6>"   /* informational                        */
 843 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
 844
 845 /*
 846  * Misc
 847  */
 848
 849 #define inter_module_get(n)                     cfs_symbol_get(n)
 850 #define inter_module_put(n)                     cfs_symbol_put(n)
 851
 852 #ifndef likely
 853 #define likely(exp) (exp)
 854 #endif
 855 #ifndef unlikely
 856 #define unlikely(exp) (exp)
 857 #endif
 858
 859 #define local_irq_save(x)
 860 #define local_irq_restore(x)
 861
 862 #define va_copy(_d, _s)                 (_d = _s)
 863
 864 char *strnchr(const char *s, size_t count, int c);
 865
 866 #define adler32(a,b,l) zlib_adler32(a,b,l)
 867 ULONG zlib_adler32(ULONG adler, const BYTE *buf, UINT len);
 868
 869 typedef ssize_t (*read_actor_t)();
 870
 871 #if DBG
 872 /*
 873  *  winnt debug routines
 874  */
 875
 876 VOID
 877 KsPrintf(
 878     LONG  DebugPrintLevel,
 879     PCHAR DebugMessage,
 880     ...
 881     );
 882
 883 PUCHAR
 884 KsNtStatusToString (IN NTSTATUS Status);
 885 #endif
 886
 887 #else   /* !__KERNEL__ */
 888
 889 void cfs_enter_debugger();
 890
 891 /*
 892  *  PAGE_SIZE ...
 893  */
 894
 895 #ifndef PAGE_SIZE
 896 #define PAGE_SIZE       (4096)
 897 #endif
 898
 899 #define getpagesize()   (4096)
 900
 901 #define PAGE_CACHE_SIZE PAGE_SIZE
 902 #define PAGE_CACHE_MASK PAGE_MASK
 903
 904 #define PTHREAD_MUTEX_INITIALIZER ((pthread_mutex_t) -1)
 905 #define PTHREAD_RECURSIVE_MUTEX_INITIALIZER ((pthread_mutex_t) -2)
 906 #define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER ((pthread_mutex_t) -3)
 907
 908 struct file {
 909         int foo;
 910 };
 911
 912 #include "../user-prim.h"
 913 #include "../user-lock.h"
 914 #include <sys/stat.h>
 915 #include <sys/types.h>
 916
 917 #define strcasecmp  strcmp
 918 #define strncasecmp strncmp
 919 #define getpid()   (0)
 920
 921 #define getuid()    (0)
 922 #define getgrgid(x) (NULL)
 923
 924 struct passwd {
 925         uid_t pw_uid;
 926         char  pw_name[64];
 927 };
 928 struct passwd * getpwuid(uid_t uid);
 929
 930 int cfs_proc_mknod(const char *path, mode_t mode, dev_t dev);
 931
 932 int gethostname(char * name, int namelen);
 933
 934 #define setlinebuf(x) do {} while(0)
 935
 936
 937 /* Maximum EA Information Length */
 938 #define EA_MAX_LENGTH  (sizeof(FILE_FULL_EA_INFORMATION) + 15)
 939
 940 /*
 941  *  proc user mode routines
 942  */
 943
 944 int cfs_proc_open (char * filename, int oflag);
 945 int cfs_proc_close(int fd);
 946 int cfs_proc_read(int fd, void *buffer, unsigned int count);
 947 int cfs_proc_write(int fd, void *buffer, unsigned int count);
 948 int cfs_proc_ioctl(int fd, int cmd, void *buffer);
 949 FILE *cfs_proc_fopen(char *path, char * mode);
 950 char *cfs_proc_fgets(char * buf, int len, FILE *fp);
 951 int cfs_proc_fclose(FILE *fp);
 952
 953 /* Bits set in the FLAGS argument to `glob'.  */
 954 #define GLOB_ERR        (1 << 0)/* Return on read errors.  */
 955 #define GLOB_MARK       (1 << 1)/* Append a slash to each name.  */
 956 #define GLOB_NOSORT     (1 << 2)/* Don't sort the names.  */
 957 #define GLOB_DOOFFS     (1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
 958 #define GLOB_NOCHECK    (1 << 4)/* If nothing matches, return the pattern.  */
 959 #define GLOB_APPEND     (1 << 5)/* Append to results of a previous call.  */
 960 #define GLOB_NOESCAPE   (1 << 6)/* Backslashes don't quote metacharacters.  */
 961 #define GLOB_PERIOD     (1 << 7)/* Leading `.' can be matched by metachars.  */
 962
 963 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
 964 # define GLOB_MAGCHAR    (1 << 8)/* Set in gl_flags if any metachars seen.  */
 965 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
 966 # define GLOB_BRACE      (1 << 10)/* Expand "{a,b}" to "a" "b".  */
 967 # define GLOB_NOMAGIC    (1 << 11)/* If no magic chars, return the pattern.  */
 968 # define GLOB_TILDE      (1 << 12)/* Expand ~user and ~ to home directories. */
 969 # define GLOB_ONLYDIR    (1 << 13)/* Match only directories.  */
 970 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
 971                                       if the user name is not available.  */
 972 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 973                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 974                          GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
 975                          GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
 976 #else
 977 # define __GLOB_FLAGS   (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
 978                          GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
 979                          GLOB_PERIOD)
 980 #endif
 981
 982 /* Error returns from `glob'.  */
 983 #define GLOB_NOSPACE    1       /* Ran out of memory.  */
 984 #define GLOB_ABORTED    2       /* Read error.  */
 985 #define GLOB_NOMATCH    3       /* No matches found.  */
 986 #define GLOB_NOSYS      4       /* Not implemented.  */
 987 #ifdef __USE_GNU
 988 /* Previous versions of this file defined GLOB_ABEND instead of
 989    GLOB_ABORTED.  Provide a compatibility definition here.  */
 990 # define GLOB_ABEND GLOB_ABORTED
 991 #endif
 992
 993 /* Structure describing a globbing run.  */
 994 #ifdef __USE_GNU
 995 struct stat;
 996 #endif
 997 typedef struct
 998   {
 999     size_t gl_pathc;            /* Count of paths matched by the pattern.  */
1000     char **gl_pathv;            /* List of matched pathnames.  */
1001     size_t gl_offs;             /* Slots to reserve in `gl_pathv'.  */
1002     int gl_flags;               /* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
1003
1004     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
1005        are used instead of the normal file access functions.  */
1006     void (*gl_closedir) (void *);
1007 #ifdef __USE_GNU
1008     struct dirent *(*gl_readdir) (void *);
1009 #else
1010     void *(*gl_readdir) (void *);
1011 #endif
1012     void *(*gl_opendir) (const char *);
1013 #ifdef __USE_GNU
1014     int (*gl_lstat) (const char *__restrict, struct stat *__restrict);
1015     int (*gl_stat) (const char *__restrict, struct stat *__restrict);
1016 #else
1017     int (*gl_lstat) (const char *__restrict, void *__restrict);
1018     int (*gl_stat) (const char *__restrict, void *__restrict);
1019 #endif
1020   } glob_t;
1021
1022 #ifdef __USE_LARGEFILE64
1023 # ifdef __USE_GNU
1024 struct stat64;
1025 # endif
1026 typedef struct
1027   {
1028     __size_t gl_pathc;
1029     char **gl_pathv;
1030     __size_t gl_offs;
1031     int gl_flags;
1032
1033     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
1034        are used instead of the normal file access functions.  */
1035     void (*gl_closedir) (void *);
1036 # ifdef __USE_GNU
1037     struct dirent64 *(*gl_readdir) (void *);
1038 # else
1039     void *(*gl_readdir) (void *);
1040 # endif
1041     void *(*gl_opendir) (__const char *);
1042 # ifdef __USE_GNU
1043     int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
1044     int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
1045 # else
1046     int (*gl_lstat) (__const char *__restrict, void *__restrict);
1047     int (*gl_stat) (__const char *__restrict, void *__restrict);
1048 # endif
1049   } glob64_t;
1050 #endif
1051
1052 int glob (const char * __pattern, int __flags,
1053                  int (*__errfunc) (const char *, int),
1054                  glob_t * __pglob);
1055 void globfree(glob_t *__pglog);
1056
1057 #endif /* !__KERNEL__ */
1058
1059 /*
1060  *  module routines
1061  */
1062
1063 static inline void __module_get(struct module *module)
1064 {
1065 }
1066
1067 static inline int try_module_get(struct module *module)
1068 {
1069         return 1;
1070 }
1071
1072 static inline void module_put(struct module *module)
1073 {
1074 }
1075
1076 /*
1077  *  sigset_t routines
1078  */
1079
1080 #define sigaddset(what,sig) (*(what) |= (1<<(sig)), 0)
1081 #define sigdelset(what,sig) (*(what) &= ~(1<<(sig)), 0)
1082 #define sigemptyset(what)   (*(what) = 0, 0)
1083 #define sigfillset(what)    (*(what) = ~(0), 0)
1084 #define sigismember(what,sig) (((*(what)) & (1<<(sig))) != 0)
1085
1086 static __inline int
1087 sigprocmask(int sig, sigset_t *w1, sigset_t *w2) {
1088     return 0;
1089 }
1090 static __inline int
1091 sigpending(sigset_t *what) {
1092     return 0;
1093 }
1094
1095 /*
1096  * common inode flags (user & kernel)
1097  */
1098
1099 #define S_ISLNK(m)      (((m) & S_IFMT) == S_IFLNK)
1100 #define S_ISREG(m)      (((m) & S_IFMT) == S_IFREG)
1101 #define S_ISDIR(m)      (((m) & S_IFMT) == S_IFDIR)
1102 #define S_ISCHR(m)      (((m) & S_IFMT) == S_IFCHR)
1103 #define S_ISBLK(m)      (((m) & S_IFMT) == S_IFBLK)
1104 #define S_ISFIFO(m)     (((m) & S_IFMT) == S_IFIFO)
1105 #define S_ISSOCK(m)     (((m) & S_IFMT) == S_IFSOCK)
1106
1107 #define S_IRWXU 00700
1108 #define S_IRUSR 00400
1109 #define S_IWUSR 00200
1110 #define S_IXUSR 00100
1111
1112 #define S_IRWXG 00070
1113 #define S_IRGRP 00040
1114 #define S_IWGRP 00020
1115 #define S_IXGRP 00010
1116
1117 #define S_IRWXO 00007
1118 #define S_IROTH 00004
1119 #define S_IWOTH 00002
1120 #define S_IXOTH 00001
1121
1122 #define S_IRWXUGO   (S_IRWXU|S_IRWXG|S_IRWXO)
1123 #define S_IALLUGO   (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
1124 #define S_IRUGO     (S_IRUSR|S_IRGRP|S_IROTH)
1125 #define S_IWUGO     (S_IWUSR|S_IWGRP|S_IWOTH)
1126 #define S_IXUGO     (S_IXUSR|S_IXGRP|S_IXOTH)
1127
1128
1129 /*
1130  *  linux ioctl coding definitions
1131  */
1132
1133 #define _IOC_NRBITS 8
1134 #define _IOC_TYPEBITS   8
1135 #define _IOC_SIZEBITS   14
1136 #define _IOC_DIRBITS    2
1137
1138 #define _IOC_NRMASK     ((1 << _IOC_NRBITS)-1)
1139 #define _IOC_TYPEMASK   ((1 << _IOC_TYPEBITS)-1)
1140 #define _IOC_SIZEMASK   ((1 << _IOC_SIZEBITS)-1)
1141 #define _IOC_DIRMASK    ((1 << _IOC_DIRBITS)-1)
1142
1143 #define _IOC_NRSHIFT    0
1144 #define _IOC_TYPESHIFT  (_IOC_NRSHIFT+_IOC_NRBITS)
1145 #define _IOC_SIZESHIFT  (_IOC_TYPESHIFT+_IOC_TYPEBITS)
1146 #define _IOC_DIRSHIFT   (_IOC_SIZESHIFT+_IOC_SIZEBITS)
1147
1148 /*
1149  * Direction bits.
1150  */
1151 #define _IOC_NONE   0U
1152 #define _IOC_WRITE  1U
1153 #define _IOC_READ   2U
1154
1155 #define _IOC(dir,type,nr,size) \
1156     (((dir)  << _IOC_DIRSHIFT) | \
1157      ((type) << _IOC_TYPESHIFT) | \
1158      ((nr)   << _IOC_NRSHIFT) | \
1159      ((size) << _IOC_SIZESHIFT))
1160
1161 /* used to create numbers */
1162 #define _IO(type,nr)      _IOC(_IOC_NONE,(type),(nr),0)
1163 #define _IOR(type,nr,size)    _IOC(_IOC_READ,(type),(nr),sizeof(size))
1164 #define _IOW(type,nr,size)    _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
1165 #define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
1166
1167 /* used to decode ioctl numbers.. */
1168 #define _IOC_DIR(nr)        (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
1169 #define _IOC_TYPE(nr)       (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
1170 #define _IOC_NR(nr)         (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
1171 #define _IOC_SIZE(nr)       (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)
1172
1173 /* i/o vector sgructure ... */
1174 struct iovec {
1175     void *iov_base;
1176     size_t iov_len;
1177 };
1178
1179 /* idr support routines */
1180 struct idr_context *cfs_idr_init();
1181 int cfs_idr_remove(struct idr_context *idp, int id);
1182 int cfs_idr_get_new(struct idr_context *idp, void *ptr);
1183 int cfs_idr_get_new_above(struct idr_context *idp, void *ptr, int starting_id);
1184 void *cfs_idr_find(struct idr_context *idp, int id);
1185 void cfs_idr_exit(struct idr_context *idp);
1186
1187 /* runtime time routines for both kenrel and user mode */
1188 extern int cfs_isalpha(int);
1189 extern int cfs_isspace(int);
1190 extern int cfs_isupper(int);
1191 extern int cfs_isdigit(int);
1192 extern int cfs_isxdigit(int);
1193
1194 #define ULONG_LONG_MAX ((__u64)(0xFFFFFFFFFFFFFFFF))
1195 /*
1196  * Convert a string to an unsigned long long integer.
1197  *
1198  * Ignores `locale' stuff.  Assumes that the upper and lower case
1199  * alphabets and digits are each contiguous.
1200  */
1201 __u64 strtoull(char *nptr, char **endptr,int base);
1202
1203 /*
1204  *  getopt routines
1205  */
1206
1207 /* For communication from `getopt' to the caller.
1208    When `getopt' finds an option that takes an argument,
1209    the argument value is returned here.
1210    Also, when `ordering' is RETURN_IN_ORDER,
1211    each non-option ARGV-element is returned here.  */
1212
1213 extern char *optarg;
1214
1215 /* Index in ARGV of the next element to be scanned.
1216    This is used for communication to and from the caller
1217    and for communication between successive calls to `getopt'.
1218
1219    On entry to `getopt', zero means this is the first call; initialize.
1220
1221    When `getopt' returns -1, this is the index of the first of the
1222    non-option elements that the caller should itself scan.
1223
1224    Otherwise, `optind' communicates from one call to the next
1225    how much of ARGV has been scanned so far.  */
1226
1227 extern int optind;
1228
1229 /* Callers store zero here to inhibit the error message `getopt' prints
1230    for unrecognized options.  */
1231
1232 extern int opterr;
1233
1234 /* Set to an option character which was unrecognized.  */
1235
1236 extern int optopt;
1237
1238
1239 struct option
1240 {
1241   const char *name;
1242   /* has_arg can't be an enum because some compilers complain about
1243      type mismatches in all the code that assumes it is an int.  */
1244   int has_arg;
1245   int *flag;
1246   int val;
1247 };
1248
1249 /* Names for the values of the `has_arg' field of `struct option'.  */
1250 # define no_argument            0
1251 # define required_argument      1
1252 # define optional_argument      2
1253
1254 extern int getopt(int ___argc, char *const *___argv, const char *__shortopts);
1255 extern int getopt_long (int ___argc, char *const *___argv,
1256                         const char *__shortopts,
1257                         const struct option *__longopts, int *__longind);
1258 extern int getopt_long_only (int ___argc, char *const *___argv,
1259                              const char *__shortopts,
1260                              const struct option *__longopts, int *__longind);
1261
1262 extern char *strcasestr (const char *phaystack, const char *pneedle);
1263
1264 /*
1265  * global environment runtime routine
1266  */
1267
1268 static __inline char * __cdecl cfs_getenv(const char *ENV) {return NULL;}
1269 static __inline void   __cdecl set_getenv(const char *ENV, const char *value, int overwrite) {}
1270
1271 int setenv(const char *envname, const char *envval, int overwrite);
1272
1273 typedef struct utsname {
1274          char sysname[64];
1275          char nodename[64];
1276          char release[128];
1277          char version[128];
1278          char machine[64];
1279 };
1280
1281 int uname(struct utsname *uts);
1282
1283 #endif