Add notes on auxv_t and statically-linked executables
[kopensolaris-gnu/glibc.git] / NOTES.opensolaris
1 auxiliary vector (auxv_t):
2
3   Proper OpenSolaris does not support statically-linked executables (i.e. via
4   gcc -static). However, glibc does, but with certain restrictions. The kernel
5   only builds the auxv_t if the elf file is not of type ET_EXEC or if the
6   PT_INTERP program header exists. This means that dynamically-linked
7   executables and libaries get an auxv_t while statically-linked executables
8   don't. This means that statically-linked executables won't see PT_TLS, which
9   is needed for __thread support. We can test for the SHARED macro for libc
10   library code, but in general, __thread will not work.
11
12   In order to fix this, it should be a matter of changing the kernel to
13   unconditionally supply the auxv_t.
14
15 scheduling:
16
17   The OpenSolaris kernel allows for loadable schedule classes. A scheduling
18   class has an id (pc_cid), associated name (pc_clname), and class-specific
19   scheduling information. As new schedulers are loaded, they are incrementally
20   assigned new id's.
21
22   Since id's are assigned dynamically, there is no way to statically associate
23   a class id with a posix scheduler (i.e. SCHED_*). The only exception is
24   SCHED_SYS, which is guaranteed to have cid == 0.
25
26 threads:
27
28   The sun libpthread/libthread implementation assumes a 1:1 mapping between
29   pthread_t/thread_t and lwpid_t, while NPTL maps thread descriptors to
30   pthread_t. This behaviour was added to NPTL and maybe enabled by defining
31   PTHREAD_T_IS_TID.
32
33 mutex:
34
35   Recursive locks are represented by an 8-byte counter defined by the
36   mutex_rcount macro. The maximum number of recursive waiters is
37   UCHAR_MAX (255).
38
39   Various fields are defined in a 64-bit field. 32 of the bits are used to
40   hold the owner pid. 8-bits each are used for holding the lock byte, the
41   number of waiters, and the number of spinners. Solaris defines some macros
42   for accessing these (architecture dependent of course):
43
44     mutex_lockword (32-bits): This is used if only the lock bit needs to
45       touched.
46
47     mutex_lockword64 (64-bits): This is used if you need to atomically swap
48       both the lock bytes and the owner pid. Note that where the pid portion
49       is located is dependent on byte ordering.
50
51     mutex_lockbyte (8-bits): This is the actual lock byte. It is set to 1 when
52       the lock is locked, and 0 when unlocked.
53
54     mutex_waiters (8-bits): This is set to 1 when there is another thread
55       waiting and 0 when there are no other waiters.
56
57     mutex_spinners (8-bits): This byte is apparently unused. We reuse it (as
58       mutex_cond_waiters) to mark a mutex that has been unlocked by cond_wait
59       (hence it will be reacquired later).
60
61     mutex_ownerpid (32-bits):
62
63   The mutex_owner field is a 64-bit field that stores a pointer to the owning
64   thread descriptor. It is not checked in the kernel and is only cleared by
65   the kernel during cleanup.
66
67   The kernel does not handle recursive or error-checking mutexes.
68
69   The kernel does not set mutex_lockbyte for mutexes with the
70   LOCK_PRIO_INHERIT bit set.
71
72 semaphore:
73
74 condition variable:
75
76   The cond_waiters_kernel byte is set to 1 if there are waiters on the
77   condition variable and 0 otherwise. The cond_waiters_user byte is not
78   used by the kernel.
79
80   The only clock types supported are CLOCK_REALTIME and CLOCK_HIGHRES.
81
82 reader-writer lock:
83
84   The kernel only supports shared/process reader-writer locks; the private
85   rwlock implementation must be completely implemented in libc. For the shared
86   case, readercv and writercv are used to track the owner (thread and process).
87   The sun docs also state that the sun implementation favours writers over
88   readers[0].
89
90   There is no apparent advantage in using the rwlock syscalls since any
91   private implementation that used the embedded mutex and cv's would also work
92   correctly in the shared case.
93
94   Three additional fields are included for tracking the owner (thread and
95   process) of a reader-writer lock.
96
97 [0] http://docs.sun.com/app/docs/doc/819-2243/rwlock-init-3c?a=view