1dec19e57d488bca1236f84829426b17fa66d1fc
[kopensolaris-gnu/glibc.git] / nptl / sysdeps / unix / sysv / linux / internaltypes.h
1 /* Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Ulrich Drepper <drepper@redhat.com>, 2002.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #ifndef _INTERNALTYPES_H
21 #define _INTERNALTYPES_H        1
22
23 #include <stdint.h>
24
25
26 struct pthread_attr
27 {
28   /* Scheduler parameters and priority.  */
29   struct sched_param schedparam;
30   int schedpolicy;
31   /* Various flags like detachstate, scope, etc.  */
32   int flags;
33   /* Size of guard area.  */
34   size_t guardsize;
35   /* Stack handling.  */
36   void *stackaddr;
37   size_t stacksize;
38   /* Affinity map.  */
39   cpu_set_t *cpuset;
40   size_t cpusetsize;
41 };
42
43 #define ATTR_FLAG_DETACHSTATE           0x0001
44 #define ATTR_FLAG_NOTINHERITSCHED       0x0002
45 #define ATTR_FLAG_SCOPEPROCESS          0x0004
46 #define ATTR_FLAG_STACKADDR             0x0008
47 #define ATTR_FLAG_OLDATTR               0x0010
48 #define ATTR_FLAG_SCHED_SET             0x0020
49 #define ATTR_FLAG_POLICY_SET            0x0040
50
51
52 /* Mutex attribute data structure.  */
53 struct pthread_mutexattr
54 {
55   /* Identifier for the kind of mutex.
56
57      Bit 31 is set if the mutex is to be shared between processes.
58
59      Bit 0 to 30 contain one of the PTHREAD_MUTEX_ values to identify
60      the type of the mutex.  */
61   int mutexkind;
62 };
63
64
65 /* Conditional variable attribute data structure.  */
66 struct pthread_condattr
67 {
68   /* Combination of values:
69
70      Bit 0  : flag whether coditional variable will be shareable between
71               processes.
72
73      Bit 1-7: clock ID.  */
74   int value;
75 };
76
77
78 /* The __NWAITERS field is used as a counter and to house the number
79    of bits which represent the clock.  COND_CLOCK_BITS is the number
80    of bits reserved for the clock.  */
81 #define COND_CLOCK_BITS 1
82
83
84 /* Read-write lock variable attribute data structure.  */
85 struct pthread_rwlockattr
86 {
87   int lockkind;
88   int pshared;
89 };
90
91
92 /* Barrier data structure.  */
93 struct pthread_barrier
94 {
95   unsigned int curr_event;
96   int lock;
97   unsigned int left;
98   unsigned int init_count;
99 };
100
101
102 /* Barrier variable attribute data structure.  */
103 struct pthread_barrierattr
104 {
105   int pshared;
106 };
107
108
109 /* Thread-local data handling.  */
110 struct pthread_key_struct
111 {
112   /* Sequence numbers.  Even numbers indicated vacant entries.  Note
113      that zero is even.  We use uintptr_t to not require padding on
114      32- and 64-bit machines.  On 64-bit machines it helps to avoid
115      wrapping, too.  */
116   uintptr_t seq;
117
118   /* Destructor for the data.  */
119   void (*destr) (void *);
120 };
121
122 /* Check whether an entry is unused.  */
123 #define KEY_UNUSED(p) (((p) & 1) == 0)
124 /* Check whether a key is usable.  We cannot reuse an allocated key if
125    the sequence counter would overflow after the next destroy call.
126    This would mean that we potentially free memory for a key with the
127    same sequence.  This is *very* unlikely to happen, A program would
128    have to create and destroy a key 2^31 times (on 32-bit platforms,
129    on 64-bit platforms that would be 2^63).  If it should happen we
130    simply don't use this specific key anymore.  */
131 #define KEY_USABLE(p) (((uintptr_t) (p)) < ((uintptr_t) ((p) + 2)))
132
133
134 /* Handling of read-write lock data.  */
135 // XXX For now there is only one flag.  Maybe more in future.
136 #define RWLOCK_RECURSIVE(rwlock) ((rwlock)->__data.__flags != 0)
137
138
139 /* Semaphore variable structure.  */
140 struct sem
141 {
142   unsigned int count;
143 };
144
145
146 /* Compatibility type for old conditional variable interfaces.  */
147 typedef struct
148 {
149   pthread_cond_t *cond;
150 } pthread_cond_2_0_t;
151
152 #endif  /* internaltypes.h */