blob: 947f911a6377db851404d297a2a2e0e8507cf339 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/* Linuxthreads - a simple clone()-based implementation of Posix */
2/* threads for Linux. */
3/* Copyright (C) 1996 Xavier Leroy (Xavier.Leroy@inria.fr) */
4/* */
5/* This program is free software; you can redistribute it and/or */
6/* modify it under the terms of the GNU Library General Public License */
7/* as published by the Free Software Foundation; either version 2 */
8/* of the License, or (at your option) any later version. */
9/* */
10/* This program 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 */
13/* GNU Library General Public License for more details. */
14
15#ifndef _PTHREAD_H
16#define _PTHREAD_H 1
17
18#include <features.h>
19
20#include <sched.h>
21#include <time.h>
22
23#define __need_sigset_t
24#include <signal.h>
25#include <bits/pthreadtypes.h>
26#include <bits/initspin.h>
27
28
29__BEGIN_DECLS
30
31/* Initializers. */
32
33#define PTHREAD_MUTEX_INITIALIZER \
34 {0, 0, 0, PTHREAD_MUTEX_TIMED_NP, __LOCK_INITIALIZER}
35#ifdef __USE_GNU
36# define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP \
37 {0, 0, 0, PTHREAD_MUTEX_RECURSIVE_NP, __LOCK_INITIALIZER}
38# define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP \
39 {0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, __LOCK_INITIALIZER}
40# define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP \
41 {0, 0, 0, PTHREAD_MUTEX_ADAPTIVE_NP, __LOCK_INITIALIZER}
42#endif
43
44#define PTHREAD_COND_INITIALIZER {__LOCK_INITIALIZER, 0, "", 0}
45
46#if defined __USE_UNIX98 || defined __USE_XOPEN2K
47# define PTHREAD_RWLOCK_INITIALIZER \
48 { __LOCK_INITIALIZER, 0, NULL, NULL, NULL, \
49 PTHREAD_RWLOCK_DEFAULT_NP, PTHREAD_PROCESS_PRIVATE }
50#endif
51#ifdef __USE_GNU
52# define PTHREAD_RWLOCK_WRITER_NONRECURSIVE_INITIALIZER_NP \
53 { __LOCK_INITIALIZER, 0, NULL, NULL, NULL, \
54 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP, PTHREAD_PROCESS_PRIVATE }
55#endif
56
57/* Values for attributes. */
58
59enum
60{
61 PTHREAD_CREATE_JOINABLE,
62#define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
63 PTHREAD_CREATE_DETACHED
64#define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
65};
66
67enum
68{
69 PTHREAD_INHERIT_SCHED,
70#define PTHREAD_INHERIT_SCHED PTHREAD_INHERIT_SCHED
71 PTHREAD_EXPLICIT_SCHED
72#define PTHREAD_EXPLICIT_SCHED PTHREAD_EXPLICIT_SCHED
73};
74
75enum
76{
77 PTHREAD_SCOPE_SYSTEM,
78#define PTHREAD_SCOPE_SYSTEM PTHREAD_SCOPE_SYSTEM
79 PTHREAD_SCOPE_PROCESS
80#define PTHREAD_SCOPE_PROCESS PTHREAD_SCOPE_PROCESS
81};
82
83enum
84{
85 PTHREAD_MUTEX_TIMED_NP,
86 PTHREAD_MUTEX_RECURSIVE_NP,
87 PTHREAD_MUTEX_ERRORCHECK_NP,
88 PTHREAD_MUTEX_ADAPTIVE_NP
89#ifdef __USE_UNIX98
90 ,
91 PTHREAD_MUTEX_NORMAL = PTHREAD_MUTEX_TIMED_NP,
92 PTHREAD_MUTEX_RECURSIVE = PTHREAD_MUTEX_RECURSIVE_NP,
93 PTHREAD_MUTEX_ERRORCHECK = PTHREAD_MUTEX_ERRORCHECK_NP,
94 PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
95#endif
96#ifdef __USE_GNU
97 /* For compatibility. */
98 , PTHREAD_MUTEX_FAST_NP = PTHREAD_MUTEX_ADAPTIVE_NP
99#endif
100};
101
102enum
103{
104 PTHREAD_PROCESS_PRIVATE,
105#define PTHREAD_PROCESS_PRIVATE PTHREAD_PROCESS_PRIVATE
106 PTHREAD_PROCESS_SHARED
107#define PTHREAD_PROCESS_SHARED PTHREAD_PROCESS_SHARED
108};
109
110#if defined __USE_UNIX98 || defined __USE_XOPEN2K
111enum
112{
113 PTHREAD_RWLOCK_PREFER_READER_NP,
114 PTHREAD_RWLOCK_PREFER_WRITER_NP,
115 PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP,
116 PTHREAD_RWLOCK_DEFAULT_NP = PTHREAD_RWLOCK_PREFER_WRITER_NP
117};
118#endif /* Unix98 */
119
120#define PTHREAD_ONCE_INIT 0
121
122/* Special constants */
123
124#ifdef __USE_XOPEN2K
125/* -1 is distinct from 0 and all errno constants */
126# define PTHREAD_BARRIER_SERIAL_THREAD -1
127#endif
128
129/* Cleanup buffers */
130
131struct _pthread_cleanup_buffer
132{
133 void (*__routine) (void *); /* Function to call. */
134 void *__arg; /* Its argument. */
135 int __canceltype; /* Saved cancellation type. */
136 struct _pthread_cleanup_buffer *__prev; /* Chaining of cleanup functions. */
137};
138
139/* Cancellation */
140
141enum
142{
143 PTHREAD_CANCEL_ENABLE,
144#define PTHREAD_CANCEL_ENABLE PTHREAD_CANCEL_ENABLE
145 PTHREAD_CANCEL_DISABLE
146#define PTHREAD_CANCEL_DISABLE PTHREAD_CANCEL_DISABLE
147};
148enum
149{
150 PTHREAD_CANCEL_DEFERRED,
151#define PTHREAD_CANCEL_DEFERRED PTHREAD_CANCEL_DEFERRED
152 PTHREAD_CANCEL_ASYNCHRONOUS
153#define PTHREAD_CANCEL_ASYNCHRONOUS PTHREAD_CANCEL_ASYNCHRONOUS
154};
155#define PTHREAD_CANCELED ((void *) -1)
156
157
158/* Function for handling threads. */
159
160/* Create a thread with given attributes ATTR (or default attributes
161 if ATTR is NULL), and call function START_ROUTINE with given
162 arguments ARG. */
163extern int pthread_create (pthread_t *__restrict __threadp,
164 __const pthread_attr_t *__restrict __attr,
165 void *(*__start_routine) (void *),
166 void *__restrict __arg) __THROW;
167
168/* Obtain the identifier of the current thread. */
169extern pthread_t pthread_self (void) __THROW;
170
171/* Compare two thread identifiers. */
172extern int pthread_equal (pthread_t __thread1, pthread_t __thread2) __THROW;
173
174/* Terminate calling thread. */
175extern void pthread_exit (void *__retval) __attribute__ ((__noreturn__));
176
177/* Make calling thread wait for termination of the thread TH. The
178 exit status of the thread is stored in *THREAD_RETURN, if THREAD_RETURN
179 is not NULL. */
180extern int pthread_join (pthread_t __th, void **__thread_return);
181
182/* Indicate that the thread TH is never to be joined with PTHREAD_JOIN.
183 The resources of TH will therefore be freed immediately when it
184 terminates, instead of waiting for another thread to perform PTHREAD_JOIN
185 on it. */
186extern int pthread_detach (pthread_t __th) __THROW;
187
188
189/* Functions for handling attributes. */
190
191/* Initialize thread attribute *ATTR with default attributes
192 (detachstate is PTHREAD_JOINABLE, scheduling policy is SCHED_OTHER,
193 no user-provided stack). */
194extern int pthread_attr_init (pthread_attr_t *__attr) __THROW;
195
196/* Destroy thread attribute *ATTR. */
197extern int pthread_attr_destroy (pthread_attr_t *__attr) __THROW;
198
199/* Set the `detachstate' attribute in *ATTR according to DETACHSTATE. */
200extern int pthread_attr_setdetachstate (pthread_attr_t *__attr,
201 int __detachstate) __THROW;
202
203/* Return in *DETACHSTATE the `detachstate' attribute in *ATTR. */
204extern int pthread_attr_getdetachstate (__const pthread_attr_t *__attr,
205 int *__detachstate) __THROW;
206
207/* Set scheduling parameters (priority, etc) in *ATTR according to PARAM. */
208extern int pthread_attr_setschedparam (pthread_attr_t *__restrict __attr,
209 __const struct sched_param *__restrict
210 __param) __THROW;
211
212/* Return in *PARAM the scheduling parameters of *ATTR. */
213extern int pthread_attr_getschedparam (__const pthread_attr_t *__restrict
214 __attr,
215 struct sched_param *__restrict __param)
216 __THROW;
217
218/* Set scheduling policy in *ATTR according to POLICY. */
219extern int pthread_attr_setschedpolicy (pthread_attr_t *__attr, int __policy)
220 __THROW;
221
222/* Return in *POLICY the scheduling policy of *ATTR. */
223extern int pthread_attr_getschedpolicy (__const pthread_attr_t *__restrict
224 __attr, int *__restrict __policy)
225 __THROW;
226
227/* Set scheduling inheritance mode in *ATTR according to INHERIT. */
228extern int pthread_attr_setinheritsched (pthread_attr_t *__attr,
229 int __inherit) __THROW;
230
231/* Return in *INHERIT the scheduling inheritance mode of *ATTR. */
232extern int pthread_attr_getinheritsched (__const pthread_attr_t *__restrict
233 __attr, int *__restrict __inherit)
234 __THROW;
235
236/* Set scheduling contention scope in *ATTR according to SCOPE. */
237extern int pthread_attr_setscope (pthread_attr_t *__attr, int __scope)
238 __THROW;
239
240/* Return in *SCOPE the scheduling contention scope of *ATTR. */
241extern int pthread_attr_getscope (__const pthread_attr_t *__restrict __attr,
242 int *__restrict __scope) __THROW;
243
244#ifdef __USE_UNIX98
245/* Set the size of the guard area at the bottom of the thread. */
246extern int pthread_attr_setguardsize (pthread_attr_t *__attr,
247 size_t __guardsize) __THROW;
248
249/* Get the size of the guard area at the bottom of the thread. */
250extern int pthread_attr_getguardsize (__const pthread_attr_t *__restrict
251 __attr, size_t *__restrict __guardsize)
252 __THROW;
253#endif
254
255#if 0 /* uClibc: deprecated stuff disabled. def __UCLIBC_SUSV3_LEGACY__ */
256/* Set the starting address of the stack of the thread to be created.
257 Depending on whether the stack grows up or down the value must either
258 be higher or lower than all the address in the memory block. The
259 minimal size of the block must be PTHREAD_STACK_MIN. */
260extern int pthread_attr_setstackaddr (pthread_attr_t *__attr,
261 void *__stackaddr) __THROW;
262
263/* Return the previously set address for the stack. */
264extern int pthread_attr_getstackaddr (__const pthread_attr_t *__restrict
265 __attr, void **__restrict __stackaddr)
266 __THROW;
267#endif
268
269#ifdef __USE_XOPEN2K
270/* The following two interfaces are intended to replace the last two. They
271 require setting the address as well as the size since only setting the
272 address will make the implementation on some architectures impossible. */
273extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
274 size_t __stacksize) __THROW;
275
276/* Return the previously set address for the stack. */
277extern int pthread_attr_getstack (__const pthread_attr_t *__restrict __attr,
278 void **__restrict __stackaddr,
279 size_t *__restrict __stacksize) __THROW;
280#endif
281
282/* Add information about the minimum stack size needed for the thread
283 to be started. This size must never be less than PTHREAD_STACK_MIN
284 and must also not exceed the system limits. */
285extern int pthread_attr_setstacksize (pthread_attr_t *__attr,
286 size_t __stacksize) __THROW;
287
288/* Return the currently used minimal stack size. */
289extern int pthread_attr_getstacksize (__const pthread_attr_t *__restrict
290 __attr, size_t *__restrict __stacksize)
291 __THROW;
292
293#ifdef __USE_GNU
294/* Initialize thread attribute *ATTR with attributes corresponding to the
295 already running thread TH. It shall be called on uninitialized ATTR
296 and destroyed with pthread_attr_destroy when no longer needed. */
297extern int pthread_getattr_np (pthread_t __th, pthread_attr_t *__attr) __THROW;
298#endif
299
300/* Functions for scheduling control. */
301
302/* Set the scheduling parameters for TARGET_THREAD according to POLICY
303 and *PARAM. */
304extern int pthread_setschedparam (pthread_t __target_thread, int __policy,
305 __const struct sched_param *__param)
306 __THROW;
307
308/* Return in *POLICY and *PARAM the scheduling parameters for TARGET_THREAD. */
309extern int pthread_getschedparam (pthread_t __target_thread,
310 int *__restrict __policy,
311 struct sched_param *__restrict __param)
312 __THROW;
313
314#ifdef __USE_UNIX98
315/* Determine level of concurrency. */
316extern int pthread_getconcurrency (void) __THROW;
317
318/* Set new concurrency level to LEVEL. */
319extern int pthread_setconcurrency (int __level) __THROW;
320#endif
321
322/* Functions for mutex handling. */
323
324/* Initialize MUTEX using attributes in *MUTEX_ATTR, or use the
325 default values if later is NULL. */
326extern int pthread_mutex_init (pthread_mutex_t *__restrict __mutex,
327 __const pthread_mutexattr_t *__restrict
328 __mutex_attr) __THROW;
329
330/* Destroy MUTEX. */
331extern int pthread_mutex_destroy (pthread_mutex_t *__mutex) __THROW;
332
333/* Try to lock MUTEX. */
334extern int pthread_mutex_trylock (pthread_mutex_t *__mutex) __THROW;
335
336/* Wait until lock for MUTEX becomes available and lock it. */
337extern int pthread_mutex_lock (pthread_mutex_t *__mutex) __THROW;
338
339#ifdef __USE_XOPEN2K
340/* Wait until lock becomes available, or specified time passes. */
341extern int pthread_mutex_timedlock (pthread_mutex_t *__restrict __mutex,
342 __const struct timespec *__restrict
343 __abstime) __THROW;
344#endif
345
346/* Unlock MUTEX. */
347extern int pthread_mutex_unlock (pthread_mutex_t *__mutex) __THROW;
348
349
350/* Functions for handling mutex attributes. */
351
352/* Initialize mutex attribute object ATTR with default attributes
353 (kind is PTHREAD_MUTEX_TIMED_NP). */
354extern int pthread_mutexattr_init (pthread_mutexattr_t *__attr) __THROW;
355
356/* Destroy mutex attribute object ATTR. */
357extern int pthread_mutexattr_destroy (pthread_mutexattr_t *__attr) __THROW;
358
359/* Get the process-shared flag of the mutex attribute ATTR. */
360extern int pthread_mutexattr_getpshared (__const pthread_mutexattr_t *
361 __restrict __attr,
362 int *__restrict __pshared) __THROW;
363
364/* Set the process-shared flag of the mutex attribute ATTR. */
365extern int pthread_mutexattr_setpshared (pthread_mutexattr_t *__attr,
366 int __pshared) __THROW;
367
368#ifdef __USE_UNIX98
369/* Set the mutex kind attribute in *ATTR to KIND (either PTHREAD_MUTEX_NORMAL,
370 PTHREAD_MUTEX_RECURSIVE, PTHREAD_MUTEX_ERRORCHECK, or
371 PTHREAD_MUTEX_DEFAULT). */
372extern int pthread_mutexattr_settype (pthread_mutexattr_t *__attr, int __kind)
373 __THROW;
374
375/* Return in *KIND the mutex kind attribute in *ATTR. */
376extern int pthread_mutexattr_gettype (__const pthread_mutexattr_t *__restrict
377 __attr, int *__restrict __kind) __THROW;
378#endif
379
380
381/* Functions for handling conditional variables. */
382
383/* Initialize condition variable COND using attributes ATTR, or use
384 the default values if later is NULL. */
385extern int pthread_cond_init (pthread_cond_t *__restrict __cond,
386 __const pthread_condattr_t *__restrict
387 __cond_attr) __THROW;
388
389/* Destroy condition variable COND. */
390extern int pthread_cond_destroy (pthread_cond_t *__cond) __THROW;
391
392/* Wake up one thread waiting for condition variable COND. */
393extern int pthread_cond_signal (pthread_cond_t *__cond) __THROW;
394
395/* Wake up all threads waiting for condition variables COND. */
396extern int pthread_cond_broadcast (pthread_cond_t *__cond) __THROW;
397
398/* Wait for condition variable COND to be signaled or broadcast.
399 MUTEX is assumed to be locked before. */
400extern int pthread_cond_wait (pthread_cond_t *__restrict __cond,
401 pthread_mutex_t *__restrict __mutex);
402
403/* Wait for condition variable COND to be signaled or broadcast until
404 ABSTIME. MUTEX is assumed to be locked before. ABSTIME is an
405 absolute time specification; zero is the beginning of the epoch
406 (00:00:00 GMT, January 1, 1970). */
407extern int pthread_cond_timedwait (pthread_cond_t *__restrict __cond,
408 pthread_mutex_t *__restrict __mutex,
409 __const struct timespec *__restrict
410 __abstime);
411
412/* Functions for handling condition variable attributes. */
413
414/* Initialize condition variable attribute ATTR. */
415extern int pthread_condattr_init (pthread_condattr_t *__attr) __THROW;
416
417/* Destroy condition variable attribute ATTR. */
418extern int pthread_condattr_destroy (pthread_condattr_t *__attr) __THROW;
419
420/* Get the process-shared flag of the condition variable attribute ATTR. */
421extern int pthread_condattr_getpshared (__const pthread_condattr_t *
422 __restrict __attr,
423 int *__restrict __pshared) __THROW;
424
425/* Set the process-shared flag of the condition variable attribute ATTR. */
426extern int pthread_condattr_setpshared (pthread_condattr_t *__attr,
427 int __pshared) __THROW;
428
429
430#if defined __USE_UNIX98 || defined __USE_XOPEN2K
431/* Functions for handling read-write locks. */
432
433/* Initialize read-write lock RWLOCK using attributes ATTR, or use
434 the default values if later is NULL. */
435extern int pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
436 __const pthread_rwlockattr_t *__restrict
437 __attr) __THROW;
438
439/* Destroy read-write lock RWLOCK. */
440extern int pthread_rwlock_destroy (pthread_rwlock_t *__rwlock) __THROW;
441
442/* Acquire read lock for RWLOCK. */
443extern int pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock) __THROW;
444
445/* Try to acquire read lock for RWLOCK. */
446extern int pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock) __THROW;
447
448# ifdef __USE_XOPEN2K
449/* Try to acquire read lock for RWLOCK or return after specfied time. */
450extern int pthread_rwlock_timedrdlock (pthread_rwlock_t *__restrict __rwlock,
451 __const struct timespec *__restrict
452 __abstime) __THROW;
453# endif
454
455/* Acquire write lock for RWLOCK. */
456extern int pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock) __THROW;
457
458/* Try to acquire write lock for RWLOCK. */
459extern int pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock) __THROW;
460
461# ifdef __USE_XOPEN2K
462/* Try to acquire write lock for RWLOCK or return after specfied time. */
463extern int pthread_rwlock_timedwrlock (pthread_rwlock_t *__restrict __rwlock,
464 __const struct timespec *__restrict
465 __abstime) __THROW;
466# endif
467
468/* Unlock RWLOCK. */
469extern int pthread_rwlock_unlock (pthread_rwlock_t *__rwlock) __THROW;
470
471
472/* Functions for handling read-write lock attributes. */
473
474/* Initialize attribute object ATTR with default values. */
475extern int pthread_rwlockattr_init (pthread_rwlockattr_t *__attr) __THROW;
476
477/* Destroy attribute object ATTR. */
478extern int pthread_rwlockattr_destroy (pthread_rwlockattr_t *__attr) __THROW;
479
480/* Return current setting of process-shared attribute of ATTR in PSHARED. */
481extern int pthread_rwlockattr_getpshared (__const pthread_rwlockattr_t *
482 __restrict __attr,
483 int *__restrict __pshared) __THROW;
484
485/* Set process-shared attribute of ATTR to PSHARED. */
486extern int pthread_rwlockattr_setpshared (pthread_rwlockattr_t *__attr,
487 int __pshared) __THROW;
488
489/* Return current setting of reader/writer preference. */
490extern int pthread_rwlockattr_getkind_np (__const pthread_rwlockattr_t *__attr,
491 int *__pref) __THROW;
492
493/* Set reader/write preference. */
494extern int pthread_rwlockattr_setkind_np (pthread_rwlockattr_t *__attr,
495 int __pref) __THROW;
496#endif
497
498#ifdef __USE_XOPEN2K
499/* The IEEE Std. 1003.1j-2000 introduces functions to implement
500 spinlocks. */
501
502/* Initialize the spinlock LOCK. If PSHARED is nonzero the spinlock can
503 be shared between different processes. */
504extern int pthread_spin_init (pthread_spinlock_t *__lock, int __pshared)
505 __THROW;
506
507/* Destroy the spinlock LOCK. */
508extern int pthread_spin_destroy (pthread_spinlock_t *__lock) __THROW;
509
510/* Wait until spinlock LOCK is retrieved. */
511extern int pthread_spin_lock (pthread_spinlock_t *__lock) __THROW;
512
513/* Try to lock spinlock LOCK. */
514extern int pthread_spin_trylock (pthread_spinlock_t *__lock) __THROW;
515
516/* Release spinlock LOCK. */
517extern int pthread_spin_unlock (pthread_spinlock_t *__lock) __THROW;
518
519
520/* Barriers are a also a new feature in 1003.1j-2000. */
521
522extern int pthread_barrier_init (pthread_barrier_t *__restrict __barrier,
523 __const pthread_barrierattr_t *__restrict
524 __attr, unsigned int __count) __THROW;
525
526extern int pthread_barrier_destroy (pthread_barrier_t *__barrier) __THROW;
527
528extern int pthread_barrierattr_init (pthread_barrierattr_t *__attr) __THROW;
529
530extern int pthread_barrierattr_destroy (pthread_barrierattr_t *__attr) __THROW;
531
532extern int pthread_barrierattr_getpshared (__const pthread_barrierattr_t *
533 __restrict __attr,
534 int *__restrict __pshared) __THROW;
535
536extern int pthread_barrierattr_setpshared (pthread_barrierattr_t *__attr,
537 int __pshared) __THROW;
538
539extern int pthread_barrier_wait (pthread_barrier_t *__barrier) __THROW;
540#endif
541
542
543/* Functions for handling thread-specific data. */
544
545/* Create a key value identifying a location in the thread-specific
546 data area. Each thread maintains a distinct thread-specific data
547 area. DESTR_FUNCTION, if non-NULL, is called with the value
548 associated to that key when the key is destroyed.
549 DESTR_FUNCTION is not called if the value associated is NULL when
550 the key is destroyed. */
551extern int pthread_key_create (pthread_key_t *__key,
552 void (*__destr_function) (void *)) __THROW;
553
554/* Destroy KEY. */
555extern int pthread_key_delete (pthread_key_t __key) __THROW;
556
557/* Store POINTER in the thread-specific data slot identified by KEY. */
558extern int pthread_setspecific (pthread_key_t __key,
559 __const void *__pointer) __THROW;
560
561/* Return current value of the thread-specific data slot identified by KEY. */
562extern void *pthread_getspecific (pthread_key_t __key) __THROW;
563
564
565/* Functions for handling initialization. */
566
567/* Guarantee that the initialization function INIT_ROUTINE will be called
568 only once, even if pthread_once is executed several times with the
569 same ONCE_CONTROL argument. ONCE_CONTROL must point to a static or
570 extern variable initialized to PTHREAD_ONCE_INIT.
571
572 The initialization functions might throw exception which is why
573 this function is not marked with __THROW. */
574extern int pthread_once (pthread_once_t *__once_control,
575 void (*__init_routine) (void));
576
577
578/* Functions for handling cancellation. */
579
580/* Set cancelability state of current thread to STATE, returning old
581 state in *OLDSTATE if OLDSTATE is not NULL. */
582extern int pthread_setcancelstate (int __state, int *__oldstate);
583
584/* Set cancellation state of current thread to TYPE, returning the old
585 type in *OLDTYPE if OLDTYPE is not NULL. */
586extern int pthread_setcanceltype (int __type, int *__oldtype);
587
588/* Cancel THREAD immediately or at the next possibility. */
589extern int pthread_cancel (pthread_t __cancelthread);
590
591/* Test for pending cancellation for the current thread and terminate
592 the thread as per pthread_exit(PTHREAD_CANCELED) if it has been
593 cancelled. */
594extern void pthread_testcancel (void);
595
596
597/* Install a cleanup handler: ROUTINE will be called with arguments ARG
598 when the thread is cancelled or calls pthread_exit. ROUTINE will also
599 be called with arguments ARG when the matching pthread_cleanup_pop
600 is executed with non-zero EXECUTE argument.
601 pthread_cleanup_push and pthread_cleanup_pop are macros and must always
602 be used in matching pairs at the same nesting level of braces. */
603
604#define pthread_cleanup_push(routine,arg) \
605 { struct _pthread_cleanup_buffer _buffer; \
606 _pthread_cleanup_push (&_buffer, (routine), (arg));
607
608extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *__buffer,
609 void (*__routine) (void *),
610 void *__arg) __THROW;
611
612/* Remove a cleanup handler installed by the matching pthread_cleanup_push.
613 If EXECUTE is non-zero, the handler function is called. */
614
615#define pthread_cleanup_pop(execute) \
616 _pthread_cleanup_pop (&_buffer, (execute)); }
617
618extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *__buffer,
619 int __execute) __THROW;
620
621/* Install a cleanup handler as pthread_cleanup_push does, but also
622 saves the current cancellation type and set it to deferred cancellation. */
623
624#ifdef __USE_GNU
625# define pthread_cleanup_push_defer_np(routine,arg) \
626 { struct _pthread_cleanup_buffer _buffer; \
627 _pthread_cleanup_push_defer (&_buffer, (routine), (arg));
628
629extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *__buffer,
630 void (*__routine) (void *),
631 void *__arg) __THROW;
632
633/* Remove a cleanup handler as pthread_cleanup_pop does, but also
634 restores the cancellation type that was in effect when the matching
635 pthread_cleanup_push_defer was called. */
636
637# define pthread_cleanup_pop_restore_np(execute) \
638 _pthread_cleanup_pop_restore (&_buffer, (execute)); }
639
640extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *__buffer,
641 int __execute) __THROW;
642#endif
643
644
645#ifdef __USE_XOPEN2K
646/* Get ID of CPU-time clock for thread THREAD_ID. */
647extern int pthread_getcpuclockid (pthread_t __thread_id,
648 __clockid_t *__clock_id) __THROW;
649#endif
650
651
652/* Functions for handling signals. */
653#include <bits/sigthread.h>
654
655
656/* Functions for handling process creation and process execution. */
657
658/* Install handlers to be called when a new process is created with FORK.
659 The PREPARE handler is called in the parent process just before performing
660 FORK. The PARENT handler is called in the parent process just after FORK.
661 The CHILD handler is called in the child process. Each of the three
662 handlers can be NULL, meaning that no handler needs to be called at that
663 point.
664 PTHREAD_ATFORK can be called several times, in which case the PREPARE
665 handlers are called in LIFO order (last added with PTHREAD_ATFORK,
666 first called before FORK), and the PARENT and CHILD handlers are called
667 in FIFO (first added, first called). */
668
669extern int pthread_atfork (void (*__prepare) (void),
670 void (*__parent) (void),
671 void (*__child) (void)) __THROW;
672
673/* Terminate all threads in the program except the calling process.
674 Should be called just before invoking one of the exec*() functions. */
675
676extern void pthread_kill_other_threads_np (void) __THROW;
677
678__END_DECLS
679
680#endif /* pthread.h */