]> git.saurik.com Git - apple/libc.git/blobdiff - pthreads/pthread_internals.h
Libc-262.tar.gz
[apple/libc.git] / pthreads / pthread_internals.h
diff --git a/pthreads/pthread_internals.h b/pthreads/pthread_internals.h
new file mode 100644 (file)
index 0000000..6a26786
--- /dev/null
@@ -0,0 +1,277 @@
+/*
+ * Copyright 1996 1995 by Open Software Foundation, Inc. 1997 1996 1995 1994 1993 1992 1991  
+ *              All Rights Reserved 
+ *  
+ * Permission to use, copy, modify, and distribute this software and 
+ * its documentation for any purpose and without fee is hereby granted, 
+ * provided that the above copyright notice appears in all copies and 
+ * that both the copyright notice and this permission notice appear in 
+ * supporting documentation. 
+ *  
+ * OSF DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE 
+ * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+ * FOR A PARTICULAR PURPOSE. 
+ *  
+ * IN NO EVENT SHALL OSF BE LIABLE FOR ANY SPECIAL, INDIRECT, OR 
+ * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN ACTION OF CONTRACT, 
+ * NEGLIGENCE, OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION 
+ * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
+ * 
+ */
+/*
+ * MkLinux
+ */
+
+/*
+ * POSIX Threads - IEEE 1003.1c
+ */
+
+#ifndef _POSIX_PTHREAD_INTERNALS_H
+#define _POSIX_PTHREAD_INTERNALS_H
+
+
+#include <assert.h>
+#include <mach/port.h>
+#include <mach/mach_error.h>
+#include <mach/message.h>
+#include <mach/machine/vm_types.h>
+#include <mach/std_types.h>
+#include <mach/policy.h>
+#include <mach/sync.h>
+#include <mach/sync_policy.h>
+#include <mach/mach_traps.h>
+#include <mach/thread_switch.h>
+#include <mach/mach_host.h>
+#include <mach/mach.h>                 /* For generic MACH support */
+
+
+#ifndef __POSIX_LIB__
+#define __POSIX_LIB__
+#endif
+
+#include "posix_sched.h"               /* For POSIX scheduling policy & parameter */
+#include "pthread_machdep.h"           /* Machine-dependent definitions. */
+
+extern kern_return_t syscall_thread_switch(mach_port_name_t, int, mach_msg_timeout_t);
+
+/*
+ * Compiled-in limits
+ */
+#undef _POSIX_THREAD_KEYS_MAX
+#define _POSIX_THREAD_KEYS_MAX       128
+
+/*
+ * Threads
+ */
+typedef struct _pthread
+{
+       long           sig;           /* Unique signature for this structure */
+       struct _pthread_handler_rec *cleanup_stack;
+       pthread_lock_t lock;          /* Used for internal mutex on structure */
+       int            detached;
+       int            inherit;
+       int            policy;
+       struct sched_param param;
+       struct _pthread_mutex *mutexes;
+       struct _pthread *joiner;
+       int                     pad1;
+       void           *exit_value;
+       semaphore_t    death;           /* pthread_join() uses this to wait for death's call */
+       mach_port_t    kernel_thread; /* kernel thread this thread is bound to */
+       void           *(*fun)(void*);/* Thread start routine */
+        void          *arg;          /* Argment for thread start routine */
+       int            cancel_state;  /* Whether thread can be cancelled */
+       int            err_no;          /* thread-local errno */
+       void           *tsd[_POSIX_THREAD_KEYS_MAX];  /* Thread specific data */
+        void           *stackaddr;     /* Base of the stack (is aligned on vm_page_size boundary */
+        size_t         stacksize;      /* Size of the stack (is a multiple of vm_page_size and >= PTHREAD_STACK_MIN) */
+       mach_port_t    reply_port;     /* Cached MiG reply port */
+        void           *cthread_self;  /* cthread_self() if somebody calls cthread_set_self() */
+        boolean_t      freeStackOnExit;/* Should we free the stack when we're done? */
+} *pthread_t;
+
+
+/*
+ * Thread attributes
+ */
+typedef struct 
+{
+       long           sig;           /* Unique signature for this structure */
+       pthread_lock_t lock;          /* Used for internal mutex on structure */
+       int            detached;
+       int            inherit;
+       int            policy;
+       struct sched_param param;
+        void           *stackaddr;     /* Base of the stack (is aligned on vm_page_size boundary */
+        size_t         stacksize;      /* Size of the stack (is a multiple of vm_page_size and >= PTHREAD_STACK_MIN) */
+       boolean_t      freeStackOnExit;/* Should we free the stack when we exit? */
+} pthread_attr_t;
+
+/*
+ * Mutex attributes
+ */
+typedef struct 
+{
+       long sig;                    /* Unique signature for this structure */
+       int prioceiling;
+       u_int32_t protocol:2,           /* protocol attribute */
+               type:2,                 /* mutex type */
+               rfu:28;
+} pthread_mutexattr_t;
+
+/*
+ * Mutex variables
+ */
+typedef struct _pthread_mutex
+{
+       long           sig;           /* Unique signature for this structure */
+       pthread_lock_t lock;          /* Used for internal mutex on structure */
+       int            waiters:30,      /* Count of threads waiting for this mutex */
+                       def:1,
+                       cond_lock:1;    /* Is there a condition locking me? */
+       pthread_t      owner;         /* Which thread has this mutex locked */
+       mach_port_t    sem;           /* Semaphore used for waiting */
+       u_int32_t        protocol:2,            /* protocol */
+               type:2,                 /* mutex type */
+               rfu:12,
+               lock_count:16;
+       struct _pthread_mutex *next, *prev;  /* List of other mutexes he owns */
+       struct _pthread_cond *busy;   /* List of condition variables using this mutex */
+       int            prioceiling;
+       int            priority;      /* Priority to restore when mutex unlocked */
+} pthread_mutex_t;
+
+/*
+ * Condition variable attributes
+ */
+typedef struct 
+{
+       long           sig;          /* Unique signature for this structure */
+       int unsupported;
+} pthread_condattr_t;
+
+/*
+ * Condition variables
+ */
+typedef struct _pthread_cond
+{
+       long           sig;          /* Unique signature for this structure */
+       pthread_lock_t lock;         /* Used for internal mutex on structure */
+       mach_port_t    sem;          /* Kernel semaphore */
+       struct _pthread_cond *next, *prev;  /* List of condition variables using mutex */
+       struct _pthread_mutex *busy; /* mutex associated with variable */
+       int            waiters:16,      /* Number of threads waiting */
+                  sigspending:16;      /* Number of outstanding signals */
+} pthread_cond_t;
+
+/*
+ * Initialization control (once) variables
+ */
+typedef struct 
+{
+       long           sig;           /* Unique signature for this structure */
+       pthread_lock_t lock;          /* Used for internal mutex on structure */
+} pthread_once_t;
+
+typedef struct {
+       long           sig;           /* Unique signature for this structure */
+       int             pshared;
+       int             rfu[2];         /* reserved for future use */
+} pthread_rwlockattr_t;
+
+typedef struct {
+       long            sig;
+        pthread_mutex_t lock;   /* monitor lock */
+       int             state;
+       pthread_cond_t  read_signal;
+       pthread_cond_t  write_signal;
+       int             blocked_writers;
+       int             pshared;
+       int             rfu[3];
+} pthread_rwlock_t;
+
+#include "pthread.h"
+
+#define _PTHREAD_DEFAULT_INHERITSCHED  PTHREAD_INHERIT_SCHED
+#define _PTHREAD_DEFAULT_PROTOCOL      PTHREAD_PRIO_NONE
+#define _PTHREAD_DEFAULT_PRIOCEILING   0
+#define _PTHREAD_DEFAULT_POLICY                SCHED_OTHER
+#define _PTHREAD_DEFAULT_STACKSIZE     0x80000   /* 512K */
+
+#define _PTHREAD_NO_SIG                        0x00000000
+#define _PTHREAD_MUTEX_ATTR_SIG                0x4D545841  /* 'MTXA' */
+#define _PTHREAD_MUTEX_SIG             0x4D555458  /* 'MUTX' */
+#define _PTHREAD_MUTEX_SIG_init                0x32AAABA7  /* [almost] ~'MUTX' */
+#define _PTHREAD_COND_ATTR_SIG         0x434E4441  /* 'CNDA' */
+#define _PTHREAD_COND_SIG              0x434F4E44  /* 'COND' */
+#define _PTHREAD_COND_SIG_init         0x3CB0B1BB  /* [almost] ~'COND' */
+#define _PTHREAD_ATTR_SIG              0x54484441  /* 'THDA' */
+#define _PTHREAD_ONCE_SIG              0x4F4E4345  /* 'ONCE' */
+#define _PTHREAD_ONCE_SIG_init         0x30B1BCBA  /* [almost] ~'ONCE' */
+#define _PTHREAD_SIG                   0x54485244  /* 'THRD' */
+#define _PTHREAD_RWLOCK_ATTR_SIG       0x52574C41  /* 'RWLA' */
+#define _PTHREAD_RWLOCK_SIG            0x52574C4B  /* 'RWLK' */
+#define _PTHREAD_RWLOCK_SIG_init       0x2DA8B3B4  /* [almost] ~'RWLK' */
+
+#define _PTHREAD_CREATE_PARENT      4
+#define _PTHREAD_EXITED                     8
+
+#define _PTHREAD_CANCEL_STATE_MASK   0xFE
+#define _PTHREAD_CANCEL_TYPE_MASK    0xFD
+#define _PTHREAD_CANCEL_PENDING             0x10  /* pthread_cancel() has been called for this thread */
+
+extern boolean_t swtch_pri(int);
+
+/* Number of times to spin when the lock is unavailable and we are on a
+   multiprocessor.  On a uniprocessor we yield the processor immediately.  */
+#define        MP_SPIN_TRIES   1000
+extern int _spin_tries;
+extern int __is_threaded;
+extern int _cpu_has_altivec;
+
+/* Internal mutex locks for data structures */
+#define TRY_LOCK(v) (!__is_threaded || _spin_lock_try((pthread_lock_t *)&(v)))
+#define LOCK(v)                                                                                                                                \
+do {                                                                                                                                           \
+       if (__is_threaded) {                                                                                                    \
+               int             tries = _spin_tries;                                                                            \
+                                                                                                                                                       \
+               while (!_spin_lock_try((pthread_lock_t *)&(v))) {                                       \
+                       if (tries-- > 0)                                                                                                \
+                               continue;                                                                                                       \
+                                                                                                                                                       \
+                       syscall_thread_switch(THREAD_NULL, SWITCH_OPTION_DEPRESS, 1);   \
+                       tries = _spin_tries;                                                                                    \
+               }                                                                                                                                       \
+       }                                                                                                                                               \
+} while (0)
+#define UNLOCK(v)                                                              \
+do {                                                                                   \
+       if (__is_threaded)                                                      \
+               _spin_unlock((pthread_lock_t *)&(v));   \
+} while (0)
+
+#ifndef ESUCCESS
+#define ESUCCESS 0
+#endif
+
+#ifndef PTHREAD_MACH_CALL
+#define        PTHREAD_MACH_CALL(expr, ret) (ret) = (expr)
+#endif
+
+/* Prototypes. */
+
+/* Functions defined in machine-dependent files. */
+extern vm_address_t _sp(void);
+extern vm_address_t _adjust_sp(vm_address_t sp);
+extern void _spin_lock(pthread_lock_t *lockp);
+extern int  _spin_lock_try(pthread_lock_t *lockp);
+extern void _spin_unlock(pthread_lock_t *lockp);
+extern void _pthread_setup(pthread_t th, void (*f)(pthread_t), void *sp, int suspended, int needresume);
+
+extern void _pthread_tsd_cleanup(pthread_t self);
+
+__private_extern__ semaphore_t new_sem_from_pool(void);
+__private_extern__ void restore_sem_to_pool(semaphore_t);
+#endif /* _POSIX_PTHREAD_INTERNALS_H */