libcfs/include/libcfs/darwin/darwin-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 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  */
  34
  35 #ifndef __LIBCFS_DARWIN_CFS_PRIM_H__
  36 #define __LIBCFS_DARWIN_CFS_PRIM_H__
  37
  38 #ifndef __LIBCFS_LIBCFS_H__
  39 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  40 #endif
  41
  42 #ifdef __KERNEL__
  43 #include <sys/types.h>
  44 #include <sys/systm.h>
  45
  46 #ifndef __DARWIN8__
  47 # ifndef __APPLE_API_PRIVATE
  48 #  define __APPLE_API_PRIVATE
  49 #  include <sys/user.h>
  50 #  undef __APPLE_API_PRIVATE
  51 # else
  52 #  include <sys/user.h>
  53 # endif
  54 # include <mach/mach_traps.h>
  55 # include <mach/thread_switch.h>
  56 # include <machine/cpu_number.h>
  57 #endif /* !__DARWIN8__ */
  58
  59 #include <sys/kernel.h>
  60
  61 #include <mach/thread_act.h>
  62 #include <mach/mach_types.h>
  63 #include <mach/time_value.h>
  64 #include <kern/sched_prim.h>
  65 #include <vm/pmap.h>
  66 #include <vm/vm_kern.h>
  67 #include <mach/machine/vm_param.h>
  68 #include <machine/machine_routines.h>
  69 #include <kern/clock.h>
  70 #include <kern/thread_call.h>
  71 #include <sys/param.h>
  72 #include <sys/vm.h>
  73
  74 #include <libcfs/darwin/darwin-types.h>
  75 #include <libcfs/darwin/darwin-utils.h>
  76 #include <libcfs/darwin/darwin-lock.h>
  77
  78 /*
  79  * Symbol functions for libcfs
  80  *
  81  * OSX has no facility for use to register symbol.
  82  * So we have to implement it.
  83  */
  84 #define CFS_SYMBOL_LEN     64
  85
  86 struct  cfs_symbol {
  87         char    name[CFS_SYMBOL_LEN];
  88         void    *value;
  89         int     ref;
  90         struct  list_head sym_list;
  91 };
  92
  93 extern kern_return_t            cfs_symbol_register(const char *, const void *);
  94 extern kern_return_t            cfs_symbol_unregister(const char *);
  95 extern void *                   cfs_symbol_get(const char *);
  96 extern kern_return_t            cfs_symbol_put(const char *);
  97
  98 /*
  99  * sysctl typedef
 100  *
 101  * User can register/unregister a list of sysctl_oids
 102  * sysctl_oid is data struct of osx's sysctl-entry
 103  */
 104 #define         CONFIG_SYSCTL   1
 105
 106 typedef struct sysctl_oid *     cfs_sysctl_table_t;
 107 typedef cfs_sysctl_table_t      cfs_sysctl_table_header_t;
 108 cfs_sysctl_table_header_t       *cfs_register_sysctl_table (cfs_sysctl_table_t *table, int arg);
 109 void cfs_unregister_sysctl_table (cfs_sysctl_table_header_t *table);
 110
 111 /*
 112  * Proc file system APIs, no /proc fs support in OSX
 113  */
 114 typedef struct cfs_proc_dir_entry {
 115         void            *data;
 116 } cfs_proc_dir_entry_t;
 117
 118 cfs_proc_dir_entry_t * cfs_create_proc_entry(char *name, int mod,
 119                                           cfs_proc_dir_entry_t *parent);
 120 void cfs_free_proc_entry(cfs_proc_dir_entry_t *de);
 121 void cfs_remove_proc_entry(char *name, cfs_proc_dir_entry_t *entry);
 122
 123 typedef int (cfs_read_proc_t)(char *page, char **start, off_t off,
 124                           int count, int *eof, void *data);
 125 typedef int (cfs_write_proc_t)(struct file *file, const char *buffer,
 126                            unsigned long count, void *data);
 127
 128 /*
 129  * cfs pseudo device
 130  *
 131  * cfs_psdev_t
 132  * cfs_psdev_register:
 133  * cfs_psdev_deregister:
 134  */
 135 typedef struct {
 136         int             index;
 137         void            *handle;
 138         const char      *name;
 139         struct cdevsw   *devsw;
 140         void            *private;
 141 } cfs_psdev_t;
 142
 143 extern kern_return_t            cfs_psdev_register(cfs_psdev_t *);
 144 extern kern_return_t            cfs_psdev_deregister(cfs_psdev_t *);
 145
 146 /*
 147  * Task struct and ...
 148  *
 149  * Using BSD current_proc in Darwin
 150  */
 151 extern boolean_t        assert_wait_possible(void);
 152 extern void             *get_bsdtask_info(task_t);
 153
 154 #ifdef __DARWIN8__
 155
 156 typedef struct {}               cfs_task_t;
 157 #define cfs_current()           ((cfs_task_t *)current_thread())
 158 #else   /* !__DARWIN8__ */
 159
 160 typedef struct uthread          cfs_task_t;
 161
 162 #define current_uthread()       ((struct uthread *)get_bsdthread_info(current_act()))
 163 #define cfs_current()           current_uthread()
 164
 165 #endif /* !__DARWIN8__ */
 166
 167 #define cfs_task_lock(t)        do {;} while (0)
 168 #define cfs_task_unlock(t)      do {;} while (0)
 169
 170 #define set_current_state(s)    do {;} while (0)
 171
 172 #define CFS_DECL_JOURNAL_DATA
 173 #define CFS_PUSH_JOURNAL        do {;} while(0)
 174 #define CFS_POP_JOURNAL         do {;} while(0)
 175
 176 #define THREAD_NAME(comm, fmt, a...)
 177 /*
 178  * Kernel thread:
 179  *
 180  * OSX kernel thread can not be created with args,
 181  * so we have to implement new APIs to create thread with args
 182  */
 183
 184 typedef int (*cfs_thread_t)(void *);
 185
 186 extern task_t   kernel_task;
 187
 188 /*
 189  * cloning flags, no use in OSX, just copy them from Linux
 190  */
 191 #define CSIGNAL         0x000000ff      /* signal mask to be sent at exit */
 192 #define CLONE_VM        0x00000100      /* set if VM shared between processes */
 193 #define CLONE_FS        0x00000200      /* set if fs info shared between processes */
 194 #define CLONE_FILES     0x00000400      /* set if open files shared between processes */
 195 #define CLONE_SIGHAND   0x00000800      /* set if signal handlers and blocked signals shared */
 196 #define CLONE_PID       0x00001000      /* set if pid shared */
 197 #define CLONE_PTRACE    0x00002000      /* set if we want to let tracing continue on the child too */
 198 #define CLONE_VFORK     0x00004000      /* set if the parent wants the child to wake it up on mm_release */
 199 #define CLONE_PARENT    0x00008000      /* set if we want to have the same parent as the cloner */
 200 #define CLONE_THREAD    0x00010000      /* Same thread group? */
 201 #define CLONE_NEWNS     0x00020000      /* New namespace group? */
 202
 203 #define CLONE_SIGNAL    (CLONE_SIGHAND | CLONE_THREAD)
 204
 205 extern cfs_task_t kthread_run(cfs_thread_t func, void *arg,
 206                               const char namefmt[], ...);
 207
 208 /*
 209  * Wait Queue implementation
 210  *
 211  * Like wait_queue in Linux
 212  */
 213 typedef struct cfs_waitq {
 214         struct ksleep_chan wq_ksleep_chan;
 215 } cfs_waitq_t;
 216
 217 typedef struct cfs_waitlink {
 218         struct cfs_waitq   *wl_waitq;
 219         struct ksleep_link  wl_ksleep_link;
 220 } cfs_waitlink_t;
 221
 222 typedef int cfs_task_state_t;
 223
 224 #define CFS_TASK_INTERRUPTIBLE  THREAD_ABORTSAFE
 225 #define CFS_TASK_UNINT          THREAD_UNINT
 226
 227 void cfs_waitq_init(struct cfs_waitq *waitq);
 228 void cfs_waitlink_init(struct cfs_waitlink *link);
 229
 230 void cfs_waitq_add(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 231 void cfs_waitq_add_exclusive(struct cfs_waitq *waitq,
 232                              struct cfs_waitlink *link);
 233 void cfs_waitq_del(struct cfs_waitq *waitq, struct cfs_waitlink *link);
 234 int  cfs_waitq_active(struct cfs_waitq *waitq);
 235
 236 void cfs_waitq_signal(struct cfs_waitq *waitq);
 237 void cfs_waitq_signal_nr(struct cfs_waitq *waitq, int nr);
 238 void cfs_waitq_broadcast(struct cfs_waitq *waitq);
 239
 240 void cfs_waitq_wait(struct cfs_waitlink *link, cfs_task_state_t state);
 241 cfs_duration_t cfs_waitq_timedwait(struct cfs_waitlink *link,
 242                                    cfs_task_state_t state,
 243                                    cfs_duration_t timeout);
 244
 245 /*
 246  * Thread schedule APIs.
 247  */
 248 #define MAX_SCHEDULE_TIMEOUT    ((long)(~0UL>>12))
 249 extern void thread_set_timer_deadline(__u64 deadline);
 250 extern void thread_cancel_timer(void);
 251
 252 static inline int cfs_schedule_timeout(int state, int64_t timeout)
 253 {
 254         int          result;
 255
 256 #ifdef __DARWIN8__
 257         result = assert_wait((event_t)current_thread(), state);
 258 #else
 259         result = assert_wait((event_t)current_uthread(), state);
 260 #endif
 261         if (timeout > 0) {
 262                 __u64 expire;
 263                 nanoseconds_to_absolutetime(timeout, &expire);
 264                 clock_absolutetime_interval_to_deadline(expire, &expire);
 265                 thread_set_timer_deadline(expire);
 266         }
 267         if (result == THREAD_WAITING)
 268                 result = thread_block(THREAD_CONTINUE_NULL);
 269         if (timeout > 0)
 270                 thread_cancel_timer();
 271         if (result == THREAD_TIMED_OUT)
 272                 result = 0;
 273         else
 274                 result = 1;
 275         return result;
 276 }
 277
 278 #define cfs_schedule()  cfs_schedule_timeout(CFS_TASK_UNINT, CFS_TICK)
 279 #define cfs_pause(tick) cfs_schedule_timeout(CFS_TASK_UNINT, tick)
 280
 281 #define __wait_event(wq, condition)                             \
 282 do {                                                            \
 283         struct cfs_waitlink __wait;                             \
 284                                                                 \
 285         cfs_waitlink_init(&__wait);                             \
 286         for (;;) {                                              \
 287                 cfs_waitq_add(&wq, &__wait);                    \
 288                 if (condition)                                  \
 289                         break;                                  \
 290                 cfs_waitq_wait(&__wait, CFS_TASK_UNINT);        \
 291                 cfs_waitq_del(&wq, &__wait);                    \
 292         }                                                       \
 293         cfs_waitq_del(&wq, &__wait);                            \
 294 } while (0)
 295
 296 #define wait_event(wq, condition)                               \
 297 do {                                                            \
 298         if (condition)                                          \
 299                 break;                                          \
 300         __wait_event(wq, condition);                            \
 301 } while (0)
 302
 303 #define __wait_event_interruptible(wq, condition, ex, ret)      \
 304 do {                                                            \
 305         struct cfs_waitlink __wait;                             \
 306                                                                 \
 307         cfs_waitlink_init(&__wait);                             \
 308         for (;;) {                                              \
 309                 if (ex == 0)                                    \
 310                         cfs_waitq_add(&wq, &__wait);            \
 311                 else                                            \
 312                         cfs_waitq_add_exclusive(&wq, &__wait);  \
 313                 if (condition)                                  \
 314                         break;                                  \
 315                 if (!cfs_signal_pending()) {                    \
 316                         cfs_waitq_wait(&__wait,                 \
 317                                        CFS_TASK_INTERRUPTIBLE); \
 318                         cfs_waitq_del(&wq, &__wait);            \
 319                         continue;                               \
 320                 }                                               \
 321                 ret = -ERESTARTSYS;                             \
 322                 break;                                          \
 323         }                                                       \
 324         cfs_waitq_del(&wq, &__wait);                            \
 325 } while (0)
 326
 327 #define wait_event_interruptible(wq, condition)                 \
 328 ({                                                              \
 329         int __ret = 0;                                          \
 330         if (!condition)                                         \
 331                 __wait_event_interruptible(wq, condition,       \
 332                                            0, __ret);           \
 333         __ret;                                                  \
 334 })
 335
 336 #define wait_event_interruptible_exclusive(wq, condition)       \
 337 ({                                                              \
 338         int __ret = 0;                                          \
 339         if (!condition)                                         \
 340                 __wait_event_interruptible(wq, condition,       \
 341                                            1, __ret);           \
 342         __ret;                                                  \
 343 })
 344
 345 #ifndef __DARWIN8__
 346 extern void     wakeup_one __P((void * chan));
 347 #endif
 348 /* only used in tests */
 349 #define wake_up_process(p)                                      \
 350         do {                                                    \
 351                 wakeup_one((caddr_t)p);                         \
 352         } while (0)
 353
 354 /* used in couple of places */
 355 static inline void sleep_on(cfs_waitq_t *waitq)
 356 {
 357         cfs_waitlink_t link;
 358
 359         cfs_waitlink_init(&link);
 360         cfs_waitq_add(waitq, &link);
 361         cfs_waitq_wait(&link, CFS_TASK_UNINT);
 362         cfs_waitq_del(waitq, &link);
 363 }
 364
 365 /*
 366  * Signal
 367  */
 368 typedef sigset_t        cfs_sigset_t;
 369
 370 #define SIGNAL_MASK_ASSERT()
 371 /*
 372  * Timer
 373  */
 374 typedef struct cfs_timer {
 375         struct ktimer t;
 376 } cfs_timer_t;
 377
 378 #define cfs_init_timer(t)       do {} while(0)
 379 void cfs_timer_init(struct cfs_timer *t, void (*func)(unsigned long), void *arg);
 380 void cfs_timer_done(struct cfs_timer *t);
 381 void cfs_timer_arm(struct cfs_timer *t, cfs_time_t deadline);
 382 void cfs_timer_disarm(struct cfs_timer *t);
 383 int  cfs_timer_is_armed(struct cfs_timer *t);
 384
 385 cfs_time_t cfs_timer_deadline(struct cfs_timer *t);
 386
 387 /*
 388  * Ioctl
 389  * We don't need to copy out everything in osx
 390  */
 391 #define cfs_ioctl_data_out(a, d, l)                     \
 392         ({                                              \
 393                 int __size;                             \
 394                 int __rc = 0;                           \
 395                 assert((l) >= sizeof(*d));              \
 396                 __size = (l) - sizeof(*d);              \
 397                 if (__size > 0)                         \
 398                         __rc = copy_to_user((void *)a + __size, \
 399                              (void *)d + __size,        \
 400                              __size);                   \
 401                 __rc;                                   \
 402         })
 403
 404 /*
 405  * CPU
 406  */
 407 /* Run in PowerG5 who is PPC64 */
 408 #define SMP_CACHE_BYTES                         128
 409 #define __cacheline_aligned                     __attribute__((__aligned__(SMP_CACHE_BYTES)))
 410 #define NR_CPUS                                 2
 411
 412 /*
 413  * XXX Liang: patch xnu and export current_processor()?
 414  *
 415  * #define smp_processor_id()                   current_processor()
 416  */
 417 #define smp_processor_id()                      0
 418 /* XXX smp_call_function is not supported in xnu */
 419 #define smp_call_function(f, a, n, w)           do {} while(0)
 420 int cfs_online_cpus(void);
 421 #define smp_num_cpus                            cfs_online_cpus()
 422
 423 /*
 424  * Misc
 425  */
 426 extern int is_suser(void);
 427
 428 #ifndef likely
 429 #define likely(exp) (exp)
 430 #endif
 431 #ifndef unlikely
 432 #define unlikely(exp) (exp)
 433 #endif
 434
 435 #define lock_kernel()                           do {} while(0)
 436 #define unlock_kernel()                         do {} while(0)
 437
 438 #define USERMODEHELPER(path, argv, envp)        (0)
 439
 440 #define cfs_module(name, version, init, fini)                           \
 441 extern kern_return_t _start(kmod_info_t *ki, void *data);               \
 442 extern kern_return_t _stop(kmod_info_t *ki, void *data);                \
 443 __private_extern__ kern_return_t name##_start(kmod_info_t *ki, void *data); \
 444 __private_extern__ kern_return_t name##_stop(kmod_info_t *ki, void *data); \
 445                                                                         \
 446 kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1,                \
 447                                { "com.clusterfs.lustre." #name }, { version }, \
 448                                -1, 0, 0, 0, 0, name##_start, name##_stop }; \
 449                                                                         \
 450 __private_extern__ kmod_start_func_t *_realmain = name##_start;         \
 451 __private_extern__ kmod_stop_func_t *_antimain = name##_stop;           \
 452 __private_extern__ int _kext_apple_cc = __APPLE_CC__ ;                  \
 453                                                                         \
 454 kern_return_t name##_start(kmod_info_t *ki, void *d)                    \
 455 {                                                                       \
 456         return init();                                                  \
 457 }                                                                       \
 458                                                                         \
 459 kern_return_t name##_stop(kmod_info_t *ki, void *d)                     \
 460 {                                                                       \
 461         fini();                                                         \
 462         return KERN_SUCCESS;                                            \
 463 }                                                                       \
 464                                                                         \
 465 /*                                                                      \
 466  * to allow semicolon after cfs_module(...)                             \
 467  */                                                                     \
 468 struct __dummy_ ## name ## _struct {}
 469
 470 #define inter_module_get(n)                     cfs_symbol_get(n)
 471 #define inter_module_put(n)                     cfs_symbol_put(n)
 472
 473 static inline int request_module(const char *name, ...)
 474 {
 475         return (-EINVAL);
 476 }
 477
 478 #ifndef __exit
 479 #define __exit
 480 #endif
 481 #ifndef __init
 482 #define __init
 483 #endif
 484
 485 #define EXPORT_SYMBOL(s)
 486 #define MODULE_AUTHOR(s)
 487 #define MODULE_DESCRIPTION(s)
 488 #define MODULE_LICENSE(s)
 489 #define MODULE_PARM(a, b)
 490 #define MODULE_PARM_DESC(a, b)
 491
 492 #define NR_IRQS                         512
 493 #define in_interrupt()                  ml_at_interrupt_context()
 494
 495 #define KERN_EMERG      "<0>"   /* system is unusable                   */
 496 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
 497 #define KERN_CRIT       "<2>"   /* critical conditions                  */
 498 #define KERN_ERR        "<3>"   /* error conditions                     */
 499 #define KERN_WARNING    "<4>"   /* warning conditions                   */
 500 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
 501 #define KERN_INFO       "<6>"   /* informational                        */
 502 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
 503
 504 static inline long PTR_ERR(const void *ptr)
 505 {
 506         return (long) ptr;
 507 }
 508
 509 #define ERR_PTR(err)    ((void *)err)
 510 #define IS_ERR(p)       ((unsigned long)(p) + 1000 < 1000)
 511
 512 #else   /* !__KERNEL__ */
 513
 514 typedef struct cfs_proc_dir_entry {
 515         void            *data;
 516 } cfs_proc_dir_entry_t;
 517
 518 #include <libcfs/user-prim.h>
 519 #define __WORDSIZE      32
 520
 521 #endif  /* END __KERNEL__ */
 522 /*
 523  * Error number
 524  */
 525 #ifndef EPROTO
 526 #define EPROTO          EPROTOTYPE
 527 #endif
 528 #ifndef EBADR
 529 #define EBADR           EBADRPC
 530 #endif
 531 #ifndef ERESTARTSYS
 532 #define ERESTARTSYS     512
 533 #endif
 534 #ifndef EDEADLOCK
 535 #define EDEADLOCK       EDEADLK
 536 #endif
 537 #ifndef ECOMM
 538 #define ECOMM           EINVAL
 539 #endif
 540 #ifndef ENODATA
 541 #define ENODATA         EINVAL
 542 #endif
 543 #ifndef ENOTSUPP
 544 #define ENOTSUPP        EINVAL
 545 #endif
 546
 547 #if BYTE_ORDER == BIG_ENDIAN
 548 # define __BIG_ENDIAN
 549 #else
 550 # define __LITTLE_ENDIAN
 551 #endif
 552
 553 #endif  /* __LIBCFS_DARWIN_CFS_PRIM_H__ */