Annotation of src/include/pthread.h, Revision 1.3
1.2 guenther 1: /* $OpenBSD: pthread.h,v 1.1 2017/10/15 23:40:33 guenther Exp $ */
1.1 guenther 2:
3: /*
4: * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
5: * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
6: * All rights reserved.
7: *
8: * Redistribution and use in source and binary forms, with or without
9: * modification, are permitted provided that the following conditions
10: * are met:
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in the
15: * documentation and/or other materials provided with the distribution.
16: * 3. All advertising materials mentioning features or use of this software
17: * must display the following acknowledgement:
18: * This product includes software developed by Chris Provenzano.
19: * 4. The name of Chris Provenzano may not be used to endorse or promote
20: * products derived from this software without specific prior written
21: * permission.
22: *
23: * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND
24: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY
27: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30: * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: * SUCH DAMAGE.
34: *
35: * $FreeBSD: pthread.h,v 1.13 1999/07/31 08:36:07 rse Exp $
36: */
37: #ifndef _PTHREAD_H_
38: #define _PTHREAD_H_
39:
40: /*
41: * Header files.
42: */
43: #include <sys/types.h>
44: #include <sys/time.h>
45: #include <sys/signal.h>
46: #include <limits.h>
47: #include <sched.h>
48:
49: /*
50: * Run-time invariant values:
51: */
52: #define PTHREAD_DESTRUCTOR_ITERATIONS 4
53: #define PTHREAD_KEYS_MAX 256
54: #define PTHREAD_STACK_MIN 2048
55: #define PTHREAD_THREADS_MAX ULONG_MAX
56:
57: /*
58: * Flags for threads and thread attributes.
59: */
60: #define PTHREAD_DETACHED 0x1
61: #define PTHREAD_SCOPE_SYSTEM 0x2
62: #define PTHREAD_INHERIT_SCHED 0x4
63: #define PTHREAD_NOFLOAT 0x8
64:
65: #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED
66: #define PTHREAD_CREATE_JOINABLE 0
67: #define PTHREAD_SCOPE_PROCESS 0
68: #define PTHREAD_EXPLICIT_SCHED 0
69:
70: /*
71: * Flags for read/write lock attributes
72: */
73: #define PTHREAD_PROCESS_PRIVATE 0
74: #define PTHREAD_PROCESS_SHARED 1
75:
76: /*
77: * Flags for cancelling threads
78: */
79: #define PTHREAD_CANCEL_ENABLE 0
80: #define PTHREAD_CANCEL_DISABLE 1
81: #define PTHREAD_CANCEL_DEFERRED 0
82: #define PTHREAD_CANCEL_ASYNCHRONOUS 2
83: #define PTHREAD_CANCELED ((void *) 1)
84:
85: /*
86: * Barrier flags
87: */
88: #define PTHREAD_BARRIER_SERIAL_THREAD -1
89:
90: /*
91: * Forward structure definitions.
92: *
93: * These are mostly opaque to the user.
94: */
95: struct pthread;
96: struct pthread_attr;
97: struct pthread_cond;
98: struct pthread_cond_attr;
99: struct pthread_mutex;
100: struct pthread_mutex_attr;
101: struct pthread_once;
102: struct pthread_rwlock;
103: struct pthread_rwlockattr;
104:
105: /*
106: * Primitive system data type definitions required by P1003.1c.
107: *
108: * Note that P1003.1c specifies that there are no defined comparison
109: * or assignment operators for the types pthread_attr_t, pthread_cond_t,
110: * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
111: */
112: typedef struct pthread *pthread_t;
113: typedef struct pthread_attr *pthread_attr_t;
114: typedef volatile struct pthread_mutex *pthread_mutex_t;
115: typedef struct pthread_mutex_attr *pthread_mutexattr_t;
116: typedef struct pthread_cond *pthread_cond_t;
117: typedef struct pthread_cond_attr *pthread_condattr_t;
118: typedef int pthread_key_t;
119: typedef struct pthread_once pthread_once_t;
120: typedef struct pthread_rwlock *pthread_rwlock_t;
121: typedef struct pthread_rwlockattr *pthread_rwlockattr_t;
122: typedef struct pthread_barrier *pthread_barrier_t;
123: typedef struct pthread_barrierattr *pthread_barrierattr_t;
124: typedef struct pthread_spinlock *pthread_spinlock_t;
125:
126: /*
127: * Additional type definitions:
128: *
129: * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
130: * use in header symbols.
131: */
132: typedef void *pthread_addr_t;
133: typedef void *(*pthread_startroutine_t)(void *);
134:
135: /*
136: * Once definitions.
137: */
138: struct pthread_once {
139: int state;
140: pthread_mutex_t mutex;
141: };
142:
143: /*
144: * Flags for once initialization.
145: */
146: #define PTHREAD_NEEDS_INIT 0
147: #define PTHREAD_DONE_INIT 1
148:
149: /*
150: * Static once initialization values.
151: */
152: #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, PTHREAD_MUTEX_INITIALIZER }
153:
154: /*
155: * Static initialization values.
156: */
157: #define PTHREAD_MUTEX_INITIALIZER NULL
158: #define PTHREAD_COND_INITIALIZER NULL
159: #define PTHREAD_RWLOCK_INITIALIZER NULL
160:
161: #define PTHREAD_PRIO_NONE 0
162: #define PTHREAD_PRIO_INHERIT 1
163: #define PTHREAD_PRIO_PROTECT 2
164:
165: /*
166: * Mutex types.
167: */
168: enum pthread_mutextype {
169: PTHREAD_MUTEX_ERRORCHECK = 1, /* Error checking mutex */
170: PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */
171: PTHREAD_MUTEX_NORMAL = 3, /* No error checking */
172: PTHREAD_MUTEX_STRICT_NP = 4, /* Strict error checking */
173: PTHREAD_MUTEX_TYPE_MAX
174: };
175:
176: #define PTHREAD_MUTEX_ERRORCHECK PTHREAD_MUTEX_ERRORCHECK
177: #define PTHREAD_MUTEX_RECURSIVE PTHREAD_MUTEX_RECURSIVE
178: #define PTHREAD_MUTEX_NORMAL PTHREAD_MUTEX_NORMAL
179: #define PTHREAD_MUTEX_STRICT_NP PTHREAD_MUTEX_STRICT_NP
180: #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_STRICT_NP
181:
182: /*
183: * Thread function prototype definitions:
184: */
185: __BEGIN_DECLS
186: int pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
187: int pthread_attr_destroy(pthread_attr_t *);
188: int pthread_attr_getstack(const pthread_attr_t *,
189: void **, size_t *);
190: int pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
191: int pthread_attr_getstackaddr(const pthread_attr_t *, void **);
192: int pthread_attr_getguardsize(const pthread_attr_t *, size_t *);
193: int pthread_attr_getdetachstate(const pthread_attr_t *, int *);
194: int pthread_attr_init(pthread_attr_t *);
195: int pthread_attr_setstacksize(pthread_attr_t *, size_t);
196: int pthread_attr_setstack(pthread_attr_t *, void *, size_t);
197: int pthread_attr_setstackaddr(pthread_attr_t *, void *);
198: int pthread_attr_setguardsize(pthread_attr_t *, size_t);
199: int pthread_attr_setdetachstate(pthread_attr_t *, int);
1.3 ! jca 200: void pthread_cleanup_pop(int);
! 201: void pthread_cleanup_push(void (*) (void *), void *routine_arg);
1.1 guenther 202: int pthread_condattr_destroy(pthread_condattr_t *);
203: int pthread_condattr_init(pthread_condattr_t *);
204:
205: int pthread_cond_broadcast(pthread_cond_t *);
206: int pthread_cond_destroy(pthread_cond_t *);
207: int pthread_cond_init(pthread_cond_t *,
208: const pthread_condattr_t *);
209: int pthread_cond_signal(pthread_cond_t *);
210: int pthread_cond_timedwait(pthread_cond_t *,
211: pthread_mutex_t *, const struct timespec *);
212: int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
213: int pthread_create(pthread_t *, const pthread_attr_t *,
214: void *(*) (void *), void *);
215: int pthread_detach(pthread_t);
216: int pthread_equal(pthread_t, pthread_t);
217: __dead void pthread_exit(void *);
218: void *pthread_getspecific(pthread_key_t);
219: int pthread_join(pthread_t, void **);
220: int pthread_key_create(pthread_key_t *,
221: void (*) (void *));
222: int pthread_key_delete(pthread_key_t);
223: int pthread_kill(pthread_t, int);
224: int pthread_mutexattr_init(pthread_mutexattr_t *);
225: int pthread_mutexattr_destroy(pthread_mutexattr_t *);
226: int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
227: int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
228: int pthread_mutex_destroy(pthread_mutex_t *);
229: int pthread_mutex_init(pthread_mutex_t *,
230: const pthread_mutexattr_t *);
231: int pthread_mutex_lock(pthread_mutex_t *);
232: int pthread_mutex_timedlock(pthread_mutex_t *,
233: const struct timespec *);
234: int pthread_mutex_trylock(pthread_mutex_t *);
235: int pthread_mutex_unlock(pthread_mutex_t *);
236: int pthread_once(pthread_once_t *, void (*) (void));
237: int pthread_rwlock_destroy(pthread_rwlock_t *);
238: int pthread_rwlock_init(pthread_rwlock_t *,
239: const pthread_rwlockattr_t *);
240: int pthread_rwlock_rdlock(pthread_rwlock_t *);
241: int pthread_rwlock_timedrdlock(pthread_rwlock_t *,
242: const struct timespec *);
243: int pthread_rwlock_timedwrlock(pthread_rwlock_t *,
244: const struct timespec *);
245: int pthread_rwlock_tryrdlock(pthread_rwlock_t *);
246: int pthread_rwlock_trywrlock(pthread_rwlock_t *);
247: int pthread_rwlock_unlock(pthread_rwlock_t *);
248: int pthread_rwlock_wrlock(pthread_rwlock_t *);
249: int pthread_rwlockattr_init(pthread_rwlockattr_t *);
250: int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
251: int *);
252: int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
253: int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
254: pthread_t pthread_self(void);
255: int pthread_setspecific(pthread_key_t, const void *);
256:
257: int pthread_cancel(pthread_t);
258: int pthread_setcancelstate(int, int *);
259: int pthread_setcanceltype(int, int *);
260: void pthread_testcancel(void);
261:
262: int pthread_getprio(pthread_t);
263: int pthread_setprio(pthread_t, int);
264: void pthread_yield(void);
265:
266: int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *,
267: int *);
268: int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *,
269: int);
270: int pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
271: int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
272:
273: int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
274: int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
275:
276: int pthread_condattr_getclock(const pthread_condattr_t *,
277: clockid_t *);
278: int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
279:
280: int pthread_attr_getinheritsched(const pthread_attr_t *, int *);
281: int pthread_attr_getschedparam(const pthread_attr_t *,
282: struct sched_param *);
283: int pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
284: int pthread_attr_getscope(const pthread_attr_t *, int *);
285: int pthread_attr_setinheritsched(pthread_attr_t *, int);
286: int pthread_attr_setschedparam(pthread_attr_t *,
287: const struct sched_param *);
288: int pthread_attr_setschedpolicy(pthread_attr_t *, int);
289: int pthread_attr_setscope(pthread_attr_t *, int);
290: int pthread_getschedparam(pthread_t pthread, int *,
291: struct sched_param *);
292: int pthread_setschedparam(pthread_t, int,
293: const struct sched_param *);
294: int pthread_getconcurrency(void);
295: int pthread_setconcurrency(int);
296: int pthread_barrier_init(pthread_barrier_t *,
297: pthread_barrierattr_t *, unsigned int);
298: int pthread_barrier_destroy(pthread_barrier_t *);
299: int pthread_barrier_wait(pthread_barrier_t *);
300: int pthread_barrierattr_init(pthread_barrierattr_t *);
301: int pthread_barrierattr_destroy(pthread_barrierattr_t *);
302: int pthread_barrierattr_getpshared(pthread_barrierattr_t *, int *);
303: int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
304: int pthread_spin_init(pthread_spinlock_t *, int);
305: int pthread_spin_destroy(pthread_spinlock_t *);
306: int pthread_spin_trylock(pthread_spinlock_t *);
307: int pthread_spin_lock(pthread_spinlock_t *);
308: int pthread_spin_unlock(pthread_spinlock_t *);
309:
310: #if __POSIX_VISIBLE >= 200112
311: int pthread_getcpuclockid(pthread_t, clockid_t *);
312: #endif
313: __END_DECLS
314:
315: #endif /* _PTHREAD_H_ */
![[BACK]](/icons/back.gif){kind=icon}
Return to pthread.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / include