1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2014-04-17 13:14+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man3/getcontext.3:25
26 #: build/C/man3/getcontext.3:25
32 #: build/C/man3/getcontext.3:25 build/C/man3/pthread_attr_init.3:26 build/C/man3/pthread_attr_setaffinity_np.3:26 build/C/man3/pthread_attr_setdetachstate.3:26 build/C/man3/pthread_attr_setguardsize.3:26 build/C/man3/pthread_attr_setinheritsched.3:26 build/C/man3/pthread_attr_setschedparam.3:26 build/C/man3/pthread_attr_setschedpolicy.3:26 build/C/man3/pthread_attr_setscope.3:26 build/C/man3/pthread_attr_setstack.3:26 build/C/man3/pthread_attr_setstackaddr.3:26 build/C/man3/pthread_attr_setstacksize.3:26 build/C/man3/pthread_cancel.3:26 build/C/man3/pthread_cleanup_push.3:26 build/C/man3/pthread_cleanup_push_defer_np.3:26 build/C/man3/pthread_create.3:26 build/C/man3/pthread_detach.3:26 build/C/man3/pthread_equal.3:26 build/C/man3/pthread_exit.3:26 build/C/man3/pthread_getattr_np.3:26 build/C/man3/pthread_getcpuclockid.3:26 build/C/man3/pthread_join.3:26 build/C/man3/pthread_kill.3:26 build/C/man3/pthread_kill_other_threads_np.3:26 build/C/man3/pthread_self.3:26 build/C/man3/pthread_setaffinity_np.3:26 build/C/man3/pthread_setcancelstate.3:26 build/C/man3/pthread_setconcurrency.3:25 build/C/man3/pthread_setname_np.3:26 build/C/man3/pthread_setschedparam.3:26 build/C/man3/pthread_setschedprio.3:26 build/C/man3/pthread_sigmask.3:26 build/C/man3/pthread_sigqueue.3:25 build/C/man3/pthread_testcancel.3:26 build/C/man3/pthread_tryjoin_np.3:26 build/C/man3/pthread_yield.3:25 build/C/man7/pthreads.7:26
38 #: build/C/man3/getcontext.3:25 build/C/man3/makecontext.3:28 build/C/man3/pthread_attr_init.3:26 build/C/man3/pthread_attr_setaffinity_np.3:26 build/C/man3/pthread_attr_setdetachstate.3:26 build/C/man3/pthread_attr_setguardsize.3:26 build/C/man3/pthread_attr_setinheritsched.3:26 build/C/man3/pthread_attr_setschedparam.3:26 build/C/man3/pthread_attr_setschedpolicy.3:26 build/C/man3/pthread_attr_setscope.3:26 build/C/man3/pthread_attr_setstack.3:26 build/C/man3/pthread_attr_setstackaddr.3:26 build/C/man3/pthread_attr_setstacksize.3:26 build/C/man3/pthread_cancel.3:26 build/C/man3/pthread_cleanup_push.3:26 build/C/man3/pthread_cleanup_push_defer_np.3:26 build/C/man3/pthread_create.3:26 build/C/man3/pthread_detach.3:26 build/C/man3/pthread_equal.3:26 build/C/man3/pthread_exit.3:26 build/C/man3/pthread_getattr_np.3:26 build/C/man3/pthread_getcpuclockid.3:26 build/C/man3/pthread_join.3:26 build/C/man3/pthread_kill.3:26 build/C/man3/pthread_kill_other_threads_np.3:26 build/C/man3/pthread_self.3:26 build/C/man3/pthread_setaffinity_np.3:26 build/C/man3/pthread_setcancelstate.3:26 build/C/man3/pthread_setconcurrency.3:25 build/C/man3/pthread_setname_np.3:26 build/C/man3/pthread_setschedparam.3:26 build/C/man3/pthread_setschedprio.3:26 build/C/man3/pthread_sigmask.3:26 build/C/man3/pthread_sigqueue.3:25 build/C/man3/pthread_testcancel.3:26 build/C/man3/pthread_tryjoin_np.3:26 build/C/man3/pthread_yield.3:25 build/C/man7/pthreads.7:26
40 msgid "Linux Programmer's Manual"
44 #: build/C/man3/getcontext.3:26 build/C/man3/makecontext.3:29 build/C/man3/pthread_attr_init.3:27 build/C/man3/pthread_attr_setaffinity_np.3:27 build/C/man3/pthread_attr_setdetachstate.3:27 build/C/man3/pthread_attr_setguardsize.3:27 build/C/man3/pthread_attr_setinheritsched.3:27 build/C/man3/pthread_attr_setschedparam.3:27 build/C/man3/pthread_attr_setschedpolicy.3:27 build/C/man3/pthread_attr_setscope.3:27 build/C/man3/pthread_attr_setstack.3:27 build/C/man3/pthread_attr_setstackaddr.3:27 build/C/man3/pthread_attr_setstacksize.3:27 build/C/man3/pthread_cancel.3:27 build/C/man3/pthread_cleanup_push.3:27 build/C/man3/pthread_cleanup_push_defer_np.3:27 build/C/man3/pthread_create.3:27 build/C/man3/pthread_detach.3:27 build/C/man3/pthread_equal.3:27 build/C/man3/pthread_exit.3:27 build/C/man3/pthread_getattr_np.3:27 build/C/man3/pthread_getcpuclockid.3:27 build/C/man3/pthread_join.3:27 build/C/man3/pthread_kill.3:27 build/C/man3/pthread_kill_other_threads_np.3:27 build/C/man3/pthread_self.3:27 build/C/man3/pthread_setaffinity_np.3:27 build/C/man3/pthread_setcancelstate.3:27 build/C/man3/pthread_setconcurrency.3:26 build/C/man3/pthread_setname_np.3:27 build/C/man3/pthread_setschedparam.3:27 build/C/man3/pthread_setschedprio.3:27 build/C/man3/pthread_sigmask.3:27 build/C/man3/pthread_sigqueue.3:26 build/C/man3/pthread_testcancel.3:27 build/C/man3/pthread_tryjoin_np.3:27 build/C/man3/pthread_yield.3:26 build/C/man7/pthreads.7:27
50 #: build/C/man3/getcontext.3:28
51 msgid "getcontext, setcontext - get or set the user context"
55 #: build/C/man3/getcontext.3:28 build/C/man3/makecontext.3:31 build/C/man3/pthread_attr_init.3:30 build/C/man3/pthread_attr_setaffinity_np.3:30 build/C/man3/pthread_attr_setdetachstate.3:30 build/C/man3/pthread_attr_setguardsize.3:30 build/C/man3/pthread_attr_setinheritsched.3:30 build/C/man3/pthread_attr_setschedparam.3:30 build/C/man3/pthread_attr_setschedpolicy.3:30 build/C/man3/pthread_attr_setscope.3:30 build/C/man3/pthread_attr_setstack.3:30 build/C/man3/pthread_attr_setstackaddr.3:30 build/C/man3/pthread_attr_setstacksize.3:30 build/C/man3/pthread_cancel.3:29 build/C/man3/pthread_cleanup_push.3:30 build/C/man3/pthread_cleanup_push_defer_np.3:30 build/C/man3/pthread_create.3:29 build/C/man3/pthread_detach.3:29 build/C/man3/pthread_equal.3:29 build/C/man3/pthread_exit.3:29 build/C/man3/pthread_getattr_np.3:29 build/C/man3/pthread_getcpuclockid.3:29 build/C/man3/pthread_join.3:29 build/C/man3/pthread_kill.3:29 build/C/man3/pthread_kill_other_threads_np.3:29 build/C/man3/pthread_self.3:29 build/C/man3/pthread_setaffinity_np.3:30 build/C/man3/pthread_setcancelstate.3:30 build/C/man3/pthread_setconcurrency.3:29 build/C/man3/pthread_setname_np.3:29 build/C/man3/pthread_setschedparam.3:30 build/C/man3/pthread_setschedprio.3:29 build/C/man3/pthread_sigmask.3:29 build/C/man3/pthread_sigqueue.3:28 build/C/man3/pthread_testcancel.3:29 build/C/man3/pthread_tryjoin_np.3:30 build/C/man3/pthread_yield.3:28
61 #: build/C/man3/getcontext.3:30 build/C/man3/makecontext.3:33
62 msgid "B<#include E<lt>ucontext.hE<gt>>"
66 #: build/C/man3/getcontext.3:32
67 msgid "B<int getcontext(ucontext_t *>I<ucp>B<);>"
71 #: build/C/man3/getcontext.3:34
72 msgid "B<int setcontext(const ucontext_t *>I<ucp>B<);>"
76 #: build/C/man3/getcontext.3:34 build/C/man3/makecontext.3:38 build/C/man3/pthread_attr_init.3:39 build/C/man3/pthread_attr_setaffinity_np.3:42 build/C/man3/pthread_attr_setdetachstate.3:41 build/C/man3/pthread_attr_setguardsize.3:41 build/C/man3/pthread_attr_setinheritsched.3:41 build/C/man3/pthread_attr_setschedparam.3:41 build/C/man3/pthread_attr_setschedpolicy.3:41 build/C/man3/pthread_attr_setscope.3:41 build/C/man3/pthread_attr_setstack.3:54 build/C/man3/pthread_attr_setstackaddr.3:41 build/C/man3/pthread_attr_setstacksize.3:41 build/C/man3/pthread_cancel.3:37 build/C/man3/pthread_cleanup_push.3:40 build/C/man3/pthread_cleanup_push_defer_np.3:40 build/C/man3/pthread_create.3:38 build/C/man3/pthread_detach.3:37 build/C/man3/pthread_equal.3:37 build/C/man3/pthread_exit.3:37 build/C/man3/pthread_getattr_np.3:38 build/C/man3/pthread_getcpuclockid.3:38 build/C/man3/pthread_join.3:37 build/C/man3/pthread_kill.3:49 build/C/man3/pthread_kill_other_threads_np.3:35 build/C/man3/pthread_self.3:37 build/C/man3/pthread_setaffinity_np.3:42 build/C/man3/pthread_setcancelstate.3:39 build/C/man3/pthread_setconcurrency.3:38 build/C/man3/pthread_setname_np.3:39 build/C/man3/pthread_setschedparam.3:41 build/C/man3/pthread_setschedprio.3:37 build/C/man3/pthread_sigmask.3:50 build/C/man3/pthread_sigqueue.3:45 build/C/man3/pthread_testcancel.3:37 build/C/man3/pthread_tryjoin_np.3:42 build/C/man3/pthread_yield.3:37 build/C/man7/pthreads.7:29
82 #: build/C/man3/getcontext.3:49
84 "In a System V-like environment, one has the two types I<mcontext_t> and "
85 "I<ucontext_t> defined in I<E<lt>ucontext.hE<gt>> and the four functions "
86 "B<getcontext>(), B<setcontext>(), B<makecontext>(3) and B<swapcontext>(3) "
87 "that allow user-level context switching between multiple threads of control "
92 #: build/C/man3/getcontext.3:57
94 "The I<mcontext_t> type is machine-dependent and opaque. The I<ucontext_t> "
95 "type is a structure that has at least the following fields:"
99 #: build/C/man3/getcontext.3:67
102 "typedef struct ucontext {\n"
103 " struct ucontext *uc_link;\n"
104 " sigset_t uc_sigmask;\n"
105 " stack_t uc_stack;\n"
106 " mcontext_t uc_mcontext;\n"
112 #: build/C/man3/getcontext.3:94
114 "with I<sigset_t> and I<stack_t> defined in I<E<lt>signal.hE<gt>>. Here "
115 "I<uc_link> points to the context that will be resumed when the current "
116 "context terminates (in case the current context was created using "
117 "B<makecontext>(3)), I<uc_sigmask> is the set of signals blocked in this "
118 "context (see B<sigprocmask>(2)), I<uc_stack> is the stack used by this "
119 "context (see B<sigaltstack>(2)), and I<uc_mcontext> is the machine-specific "
120 "representation of the saved context, that includes the calling thread's "
125 #: build/C/man3/getcontext.3:101
127 "The function B<getcontext>() initializes the structure pointed at by I<ucp> "
128 "to the currently active context."
132 #: build/C/man3/getcontext.3:114
134 "The function B<setcontext>() restores the user context pointed at by "
135 "I<ucp>. A successful call does not return. The context should have been "
136 "obtained by a call of B<getcontext>(), or B<makecontext>(3), or passed as "
137 "third argument to a signal handler."
141 #: build/C/man3/getcontext.3:118
143 "If the context was obtained by a call of B<getcontext>(), program execution "
144 "continues as if this call just returned."
148 #: build/C/man3/getcontext.3:135
150 "If the context was obtained by a call of B<makecontext>(3), program "
151 "execution continues by a call to the function I<func> specified as the "
152 "second argument of that call to B<makecontext>(3). When the function "
153 "I<func> returns, we continue with the I<uc_link> member of the structure "
154 "I<ucp> specified as the first argument of that call to B<makecontext>(3). "
155 "When this member is NULL, the thread exits."
159 #: build/C/man3/getcontext.3:142
161 "If the context was obtained by a call to a signal handler, then old standard "
162 "text says that \"program execution continues with the program instruction "
163 "following the instruction interrupted by the signal\". However, this "
164 "sentence was removed in SUSv2, and the present verdict is \"the result is "
169 #: build/C/man3/getcontext.3:142 build/C/man3/makecontext.3:84 build/C/man3/pthread_attr_init.3:68 build/C/man3/pthread_attr_setaffinity_np.3:76 build/C/man3/pthread_attr_setdetachstate.3:77 build/C/man3/pthread_attr_setguardsize.3:90 build/C/man3/pthread_attr_setinheritsched.3:93 build/C/man3/pthread_attr_setschedparam.3:85 build/C/man3/pthread_attr_setschedpolicy.3:83 build/C/man3/pthread_attr_setscope.3:103 build/C/man3/pthread_attr_setstack.3:85 build/C/man3/pthread_attr_setstackaddr.3:74 build/C/man3/pthread_attr_setstacksize.3:61 build/C/man3/pthread_cancel.3:112 build/C/man3/pthread_cleanup_push.3:121 build/C/man3/pthread_create.3:115 build/C/man3/pthread_detach.3:49 build/C/man3/pthread_equal.3:41 build/C/man3/pthread_exit.3:71 build/C/man3/pthread_getattr_np.3:73 build/C/man3/pthread_getcpuclockid.3:46 build/C/man3/pthread_join.3:70 build/C/man3/pthread_kill.3:63 build/C/man3/pthread_self.3:46 build/C/man3/pthread_setaffinity_np.3:77 build/C/man3/pthread_setcancelstate.3:92 build/C/man3/pthread_setconcurrency.3:56 build/C/man3/pthread_setname_np.3:72 build/C/man3/pthread_setschedparam.3:104 build/C/man3/pthread_setschedprio.3:53 build/C/man3/pthread_sigmask.3:61 build/C/man3/pthread_sigqueue.3:65 build/C/man3/pthread_testcancel.3:50 build/C/man3/pthread_tryjoin_np.3:85 build/C/man3/pthread_yield.3:44
175 #: build/C/man3/getcontext.3:151
177 "When successful, B<getcontext>() returns 0 and B<setcontext>() does not "
178 "return. On error, both return -1 and set I<errno> appropriately."
182 #: build/C/man3/getcontext.3:151 build/C/man3/makecontext.3:96 build/C/man3/pthread_attr_init.3:71 build/C/man3/pthread_attr_setaffinity_np.3:79 build/C/man3/pthread_attr_setdetachstate.3:80 build/C/man3/pthread_attr_setguardsize.3:93 build/C/man3/pthread_attr_setinheritsched.3:96 build/C/man3/pthread_attr_setschedparam.3:88 build/C/man3/pthread_attr_setschedpolicy.3:86 build/C/man3/pthread_attr_setscope.3:106 build/C/man3/pthread_attr_setstack.3:88 build/C/man3/pthread_attr_setstackaddr.3:77 build/C/man3/pthread_attr_setstacksize.3:64 build/C/man3/pthread_cancel.3:117 build/C/man3/pthread_cleanup_push.3:123 build/C/man3/pthread_create.3:122 build/C/man3/pthread_detach.3:54 build/C/man3/pthread_equal.3:45 build/C/man3/pthread_exit.3:73 build/C/man3/pthread_getattr_np.3:76 build/C/man3/pthread_getcpuclockid.3:49 build/C/man3/pthread_join.3:75 build/C/man3/pthread_kill.3:68 build/C/man3/pthread_self.3:48 build/C/man3/pthread_setaffinity_np.3:80 build/C/man3/pthread_setcancelstate.3:95 build/C/man3/pthread_setconcurrency.3:68 build/C/man3/pthread_setname_np.3:75 build/C/man3/pthread_setschedparam.3:112 build/C/man3/pthread_setschedprio.3:61 build/C/man3/pthread_sigmask.3:66 build/C/man3/pthread_sigqueue.3:70 build/C/man3/pthread_testcancel.3:54 build/C/man3/pthread_tryjoin_np.3:89 build/C/man3/pthread_yield.3:49
188 #: build/C/man3/getcontext.3:153
189 msgid "None defined."
193 #: build/C/man3/getcontext.3:153 build/C/man3/makecontext.3:105 build/C/man3/pthread_attr_init.3:79 build/C/man3/pthread_attr_setaffinity_np.3:108 build/C/man3/pthread_attr_setdetachstate.3:87 build/C/man3/pthread_attr_setguardsize.3:106 build/C/man3/pthread_attr_setinheritsched.3:110 build/C/man3/pthread_attr_setschedparam.3:100 build/C/man3/pthread_attr_setschedpolicy.3:100 build/C/man3/pthread_attr_setscope.3:119 build/C/man3/pthread_attr_setstack.3:112 build/C/man3/pthread_attr_setstackaddr.3:83 build/C/man3/pthread_attr_setstacksize.3:83 build/C/man3/pthread_cancel.3:125 build/C/man3/pthread_cleanup_push.3:127 build/C/man3/pthread_cleanup_push_defer_np.3:101 build/C/man3/pthread_create.3:146 build/C/man3/pthread_detach.3:64 build/C/man3/pthread_equal.3:47 build/C/man3/pthread_exit.3:75 build/C/man3/pthread_getattr_np.3:98 build/C/man3/pthread_getcpuclockid.3:65 build/C/man3/pthread_join.3:98 build/C/man3/pthread_kill.3:72 build/C/man3/pthread_kill_other_threads_np.3:47 build/C/man3/pthread_self.3:50 build/C/man3/pthread_setaffinity_np.3:121 build/C/man3/pthread_setcancelstate.3:113 build/C/man3/pthread_setconcurrency.3:83 build/C/man3/pthread_setname_np.3:102 build/C/man3/pthread_setschedparam.3:141 build/C/man3/pthread_setschedprio.3:83 build/C/man3/pthread_sigmask.3:69 build/C/man3/pthread_sigqueue.3:93 build/C/man3/pthread_testcancel.3:58 build/C/man3/pthread_tryjoin_np.3:112 build/C/man3/pthread_yield.3:53
195 msgid "CONFORMING TO"
199 #: build/C/man3/getcontext.3:159
201 "SUSv2, POSIX.1-2001. POSIX.1-2008 removes the specification of "
202 "B<getcontext>(), citing portability issues, and recommending that "
203 "applications be rewritten to use POSIX threads instead."
207 #: build/C/man3/getcontext.3:159 build/C/man3/makecontext.3:113 build/C/man3/pthread_attr_init.3:81 build/C/man3/pthread_attr_setaffinity_np.3:111 build/C/man3/pthread_attr_setdetachstate.3:89 build/C/man3/pthread_attr_setguardsize.3:108 build/C/man3/pthread_attr_setschedparam.3:102 build/C/man3/pthread_attr_setscope.3:121 build/C/man3/pthread_attr_setstack.3:114 build/C/man3/pthread_attr_setstackaddr.3:86 build/C/man3/pthread_attr_setstacksize.3:85 build/C/man3/pthread_cancel.3:127 build/C/man3/pthread_cleanup_push.3:129 build/C/man3/pthread_create.3:148 build/C/man3/pthread_detach.3:66 build/C/man3/pthread_equal.3:49 build/C/man3/pthread_exit.3:77 build/C/man3/pthread_getcpuclockid.3:67 build/C/man3/pthread_join.3:100 build/C/man3/pthread_kill.3:74 build/C/man3/pthread_kill_other_threads_np.3:50 build/C/man3/pthread_self.3:52 build/C/man3/pthread_setaffinity_np.3:124 build/C/man3/pthread_setcancelstate.3:115 build/C/man3/pthread_setconcurrency.3:85 build/C/man3/pthread_setname_np.3:104 build/C/man3/pthread_setschedparam.3:143 build/C/man3/pthread_setschedprio.3:85 build/C/man3/pthread_sigmask.3:71 build/C/man3/pthread_yield.3:59
213 #: build/C/man3/getcontext.3:176
215 "The earliest incarnation of this mechanism was the "
216 "B<setjmp>(3)/B<longjmp>(3) mechanism. Since that does not define the "
217 "handling of the signal context, the next stage was the "
218 "B<sigsetjmp>(3)/B<siglongjmp>(3) pair. The present mechanism gives much "
219 "more control. On the other hand, there is no easy way to detect whether a "
220 "return from B<getcontext>() is from the first call, or via a "
221 "B<setcontext>() call. The user has to invent her own bookkeeping device, "
222 "and a register variable won't do since registers are restored."
226 #: build/C/man3/getcontext.3:187
228 "When a signal occurs, the current user context is saved and a new context is "
229 "created by the kernel for the signal handler. Do not leave the handler "
230 "using B<longjmp>(3): it is undefined what would happen with contexts. Use "
231 "B<siglongjmp>(3) or B<setcontext>() instead."
235 #: build/C/man3/getcontext.3:187 build/C/man3/makecontext.3:220 build/C/man3/pthread_attr_init.3:297 build/C/man3/pthread_attr_setaffinity_np.3:118 build/C/man3/pthread_attr_setdetachstate.3:111 build/C/man3/pthread_attr_setguardsize.3:158 build/C/man3/pthread_attr_setinheritsched.3:131 build/C/man3/pthread_attr_setschedparam.3:109 build/C/man3/pthread_attr_setschedpolicy.3:105 build/C/man3/pthread_attr_setscope.3:132 build/C/man3/pthread_attr_setstack.3:155 build/C/man3/pthread_attr_setstackaddr.3:110 build/C/man3/pthread_attr_setstacksize.3:111 build/C/man3/pthread_cancel.3:226 build/C/man3/pthread_cleanup_push.3:315 build/C/man3/pthread_cleanup_push_defer_np.3:104 build/C/man3/pthread_create.3:369 build/C/man3/pthread_detach.3:97 build/C/man3/pthread_equal.3:56 build/C/man3/pthread_exit.3:105 build/C/man3/pthread_getattr_np.3:345 build/C/man3/pthread_getcpuclockid.3:170 build/C/man3/pthread_join.3:127 build/C/man3/pthread_kill.3:94 build/C/man3/pthread_kill_other_threads_np.3:66 build/C/man3/pthread_self.3:76 build/C/man3/pthread_setaffinity_np.3:206 build/C/man3/pthread_setcancelstate.3:177 build/C/man3/pthread_setconcurrency.3:100 build/C/man3/pthread_setname_np.3:200 build/C/man3/pthread_setschedparam.3:431 build/C/man3/pthread_setschedprio.3:91 build/C/man3/pthread_sigmask.3:147 build/C/man3/pthread_sigqueue.3:95 build/C/man3/pthread_testcancel.3:63 build/C/man3/pthread_tryjoin_np.3:135 build/C/man3/pthread_yield.3:62 build/C/man7/pthreads.7:895
241 #: build/C/man3/getcontext.3:194
243 "B<sigaction>(2), B<sigaltstack>(2), B<sigprocmask>(2), B<longjmp>(3), "
244 "B<makecontext>(3), B<sigsetjmp>(3)"
248 #: build/C/man3/getcontext.3:194 build/C/man3/makecontext.3:226 build/C/man3/pthread_attr_init.3:313 build/C/man3/pthread_attr_setaffinity_np.3:124 build/C/man3/pthread_attr_setdetachstate.3:117 build/C/man3/pthread_attr_setguardsize.3:166 build/C/man3/pthread_attr_setinheritsched.3:143 build/C/man3/pthread_attr_setschedparam.3:121 build/C/man3/pthread_attr_setschedpolicy.3:116 build/C/man3/pthread_attr_setscope.3:142 build/C/man3/pthread_attr_setstack.3:167 build/C/man3/pthread_attr_setstackaddr.3:116 build/C/man3/pthread_attr_setstacksize.3:118 build/C/man3/pthread_cancel.3:238 build/C/man3/pthread_cleanup_push.3:321 build/C/man3/pthread_cleanup_push_defer_np.3:110 build/C/man3/pthread_create.3:382 build/C/man3/pthread_detach.3:104 build/C/man3/pthread_equal.3:60 build/C/man3/pthread_exit.3:109 build/C/man3/pthread_getattr_np.3:361 build/C/man3/pthread_getcpuclockid.3:178 build/C/man3/pthread_join.3:134 build/C/man3/pthread_kill.3:103 build/C/man3/pthread_kill_other_threads_np.3:72 build/C/man3/pthread_self.3:80 build/C/man3/pthread_setaffinity_np.3:214 build/C/man3/pthread_setcancelstate.3:182 build/C/man3/pthread_setconcurrency.3:103 build/C/man3/pthread_setname_np.3:206 build/C/man3/pthread_setschedparam.3:445 build/C/man3/pthread_setschedprio.3:105 build/C/man3/pthread_sigmask.3:156 build/C/man3/pthread_sigqueue.3:103 build/C/man3/pthread_testcancel.3:68 build/C/man3/pthread_tryjoin_np.3:140 build/C/man3/pthread_yield.3:66 build/C/man7/pthreads.7:929
254 #: build/C/man3/getcontext.3:201 build/C/man3/makecontext.3:233 build/C/man3/pthread_attr_init.3:320 build/C/man3/pthread_attr_setaffinity_np.3:131 build/C/man3/pthread_attr_setdetachstate.3:124 build/C/man3/pthread_attr_setguardsize.3:173 build/C/man3/pthread_attr_setinheritsched.3:150 build/C/man3/pthread_attr_setschedparam.3:128 build/C/man3/pthread_attr_setschedpolicy.3:123 build/C/man3/pthread_attr_setscope.3:149 build/C/man3/pthread_attr_setstack.3:174 build/C/man3/pthread_attr_setstackaddr.3:123 build/C/man3/pthread_attr_setstacksize.3:125 build/C/man3/pthread_cancel.3:245 build/C/man3/pthread_cleanup_push.3:328 build/C/man3/pthread_cleanup_push_defer_np.3:117 build/C/man3/pthread_create.3:389 build/C/man3/pthread_detach.3:111 build/C/man3/pthread_equal.3:67 build/C/man3/pthread_exit.3:116 build/C/man3/pthread_getattr_np.3:368 build/C/man3/pthread_getcpuclockid.3:185 build/C/man3/pthread_join.3:141 build/C/man3/pthread_kill.3:110 build/C/man3/pthread_kill_other_threads_np.3:79 build/C/man3/pthread_self.3:87 build/C/man3/pthread_setaffinity_np.3:221 build/C/man3/pthread_setcancelstate.3:189 build/C/man3/pthread_setconcurrency.3:110 build/C/man3/pthread_setname_np.3:213 build/C/man3/pthread_setschedparam.3:452 build/C/man3/pthread_setschedprio.3:112 build/C/man3/pthread_sigmask.3:163 build/C/man3/pthread_sigqueue.3:110 build/C/man3/pthread_testcancel.3:75 build/C/man3/pthread_tryjoin_np.3:147 build/C/man3/pthread_yield.3:73 build/C/man7/pthreads.7:936
256 "This page is part of release 3.64 of the Linux I<man-pages> project. A "
257 "description of the project, and information about reporting bugs, can be "
258 "found at \\%http://www.kernel.org/doc/man-pages/."
262 #: build/C/man3/makecontext.3:28
268 #: build/C/man3/makecontext.3:28
274 #: build/C/man3/makecontext.3:28
280 #: build/C/man3/makecontext.3:31
281 msgid "makecontext, swapcontext - manipulate user context"
285 #: build/C/man3/makecontext.3:36
287 "B<void makecontext(ucontext_t *>I<ucp>B<, void (*>I<func>B<)(),> B<int "
292 #: build/C/man3/makecontext.3:38
293 msgid "B<int swapcontext(ucontext_t *>I<oucp>B<, ucontext_t *>I<ucp>B<);>"
297 #: build/C/man3/makecontext.3:49
299 "In a System V-like environment, one has the type I<ucontext_t> defined in "
300 "I<E<lt>ucontext.hE<gt>> and the four functions B<getcontext>(3), "
301 "B<setcontext>(3), B<makecontext>() and B<swapcontext>() that allow "
302 "user-level context switching between multiple threads of control within a "
307 #: build/C/man3/makecontext.3:52
308 msgid "For the type and the first two functions, see B<getcontext>(3)."
312 #: build/C/man3/makecontext.3:64
314 "The B<makecontext>() function modifies the context pointed to by I<ucp> "
315 "(which was obtained from a call to B<getcontext>(3)). Before invoking "
316 "B<makecontext>(), the caller must allocate a new stack for this context and "
317 "assign its address to I<ucp-E<gt>uc_stack>, and define a successor context "
318 "and assign its address to I<ucp-E<gt>uc_link>."
322 #: build/C/man3/makecontext.3:78
324 "When this context is later activated (using B<setcontext>(3) or "
325 "B<swapcontext>()) the function I<func> is called, and passed the series of "
326 "integer (I<int>) arguments that follow I<argc>; the caller must specify the "
327 "number of these arguments in I<argc>. When this function returns, the "
328 "successor context is activated. If the successor context pointer is NULL, "
333 #: build/C/man3/makecontext.3:84
335 "The B<swapcontext>() function saves the current context in the structure "
336 "pointed to by I<oucp>, and then activates the context pointed to by I<ucp>."
340 #: build/C/man3/makecontext.3:96
342 "When successful, B<swapcontext>() does not return. (But we may return "
343 "later, in case I<oucp> is activated, in which case it looks like "
344 "B<swapcontext>() returns 0.) On error, B<swapcontext>() returns -1 and "
345 "sets I<errno> appropriately."
349 #: build/C/man3/makecontext.3:97 build/C/man3/pthread_attr_setaffinity_np.3:102 build/C/man3/pthread_getattr_np.3:77
355 #: build/C/man3/makecontext.3:100
356 msgid "Insufficient stack space left."
360 #: build/C/man3/makecontext.3:100 build/C/man3/pthread_attr_setaffinity_np.3:106 build/C/man3/pthread_attr_setguardsize.3:104 build/C/man3/pthread_attr_setstack.3:110 build/C/man3/pthread_attr_setstackaddr.3:81 build/C/man3/pthread_attr_setstacksize.3:81 build/C/man3/pthread_getattr_np.3:96 build/C/man3/pthread_getcpuclockid.3:63 build/C/man3/pthread_setaffinity_np.3:119 build/C/man3/pthread_setconcurrency.3:81 build/C/man3/pthread_setname_np.3:100 build/C/man3/pthread_setschedprio.3:81 build/C/man3/pthread_sigqueue.3:89 build/C/man3/pthread_tryjoin_np.3:110
366 #: build/C/man3/makecontext.3:105
368 "B<makecontext>() and B<swapcontext>() are provided in glibc since version "
373 #: build/C/man3/makecontext.3:113
375 "SUSv2, POSIX.1-2001. POSIX.1-2008 removes the specifications of "
376 "B<makecontext>() and B<swapcontext>(), citing portability issues, and "
377 "recommending that applications be rewritten to use POSIX threads instead."
381 #: build/C/man3/makecontext.3:121
383 "The interpretation of I<ucp-E<gt>uc_stack> is just as in B<sigaltstack>(2), "
384 "namely, this struct contains the start and length of a memory area to be "
385 "used as the stack, regardless of the direction of growth of the stack. "
386 "Thus, it is not necessary for the user program to worry about this "
391 #: build/C/man3/makecontext.3:137
393 "On architectures where I<int> and pointer types are the same size (e.g., "
394 "x86-32, where both types are 32 bits), you may be able to get away with "
395 "passing pointers as arguments to B<makecontext>() following I<argc>. "
396 "However, doing this is not guaranteed to be portable, is undefined according "
397 "to the standards, and won't work on architectures where pointers are larger "
398 "than I<int>s. Nevertheless, starting with version 2.8, glibc makes some "
399 "changes to B<makecontext>(), to permit this on some 64-bit architectures "
404 #: build/C/man3/makecontext.3:137 build/C/man3/pthread_attr_init.3:87 build/C/man3/pthread_attr_setdetachstate.3:108 build/C/man3/pthread_attr_setguardsize.3:155 build/C/man3/pthread_attr_setinheritsched.3:128 build/C/man3/pthread_attr_setschedparam.3:106 build/C/man3/pthread_attr_setschedpolicy.3:102 build/C/man3/pthread_attr_setstack.3:152 build/C/man3/pthread_attr_setstacksize.3:108 build/C/man3/pthread_cancel.3:135 build/C/man3/pthread_cleanup_push.3:155 build/C/man3/pthread_create.3:202 build/C/man3/pthread_detach.3:93 build/C/man3/pthread_getattr_np.3:101 build/C/man3/pthread_getcpuclockid.3:78 build/C/man3/pthread_join.3:124 build/C/man3/pthread_setaffinity_np.3:154 build/C/man3/pthread_setcancelstate.3:174 build/C/man3/pthread_setname_np.3:114 build/C/man3/pthread_setschedparam.3:149 build/C/man3/pthread_sigmask.3:73 build/C/man3/pthread_testcancel.3:60 build/C/man3/pthread_tryjoin_np.3:115
410 #: build/C/man3/makecontext.3:145
412 "The example program below demonstrates the use of B<getcontext>(3), "
413 "B<makecontext>(), and B<swapcontext>(). Running the program produces the "
418 #: build/C/man3/makecontext.3:157
422 "main: swapcontext(&uctx_main, &uctx_func2)\n"
424 "func2: swapcontext(&uctx_func2, &uctx_func1)\n"
426 "func1: swapcontext(&uctx_func1, &uctx_func2)\n"
433 #: build/C/man3/makecontext.3:159 build/C/man3/pthread_attr_init.3:148 build/C/man3/pthread_cancel.3:151 build/C/man3/pthread_cleanup_push.3:231 build/C/man3/pthread_create.3:241 build/C/man3/pthread_getattr_np.3:179 build/C/man3/pthread_getcpuclockid.3:96 build/C/man3/pthread_setname_np.3:140 build/C/man3/pthread_setschedparam.3:224 build/C/man3/pthread_sigmask.3:91
435 msgid "Program source"
439 #: build/C/man3/makecontext.3:165
442 "#include E<lt>ucontext.hE<gt>\n"
443 "#include E<lt>stdio.hE<gt>\n"
444 "#include E<lt>stdlib.hE<gt>\n"
448 #: build/C/man3/makecontext.3:167
450 msgid "static ucontext_t uctx_main, uctx_func1, uctx_func2;\n"
454 #: build/C/man3/makecontext.3:170
457 "#define handle_error(msg) \\e\n"
458 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
462 #: build/C/man3/makecontext.3:180
468 " printf(\"func1: started\\en\");\n"
469 " printf(\"func1: swapcontext(&uctx_func1, &uctx_func2)\\en\");\n"
470 " if (swapcontext(&uctx_func1, &uctx_func2) == -1)\n"
471 " handle_error(\"swapcontext\");\n"
472 " printf(\"func1: returning\\en\");\n"
477 #: build/C/man3/makecontext.3:190
483 " printf(\"func2: started\\en\");\n"
484 " printf(\"func2: swapcontext(&uctx_func2, &uctx_func1)\\en\");\n"
485 " if (swapcontext(&uctx_func2, &uctx_func1) == -1)\n"
486 " handle_error(\"swapcontext\");\n"
487 " printf(\"func2: returning\\en\");\n"
492 #: build/C/man3/makecontext.3:196
496 "main(int argc, char *argv[])\n"
498 " char func1_stack[16384];\n"
499 " char func2_stack[16384];\n"
503 #: build/C/man3/makecontext.3:203
506 " if (getcontext(&uctx_func1) == -1)\n"
507 " handle_error(\"getcontext\");\n"
508 " uctx_func1.uc_stack.ss_sp = func1_stack;\n"
509 " uctx_func1.uc_stack.ss_size = sizeof(func1_stack);\n"
510 " uctx_func1.uc_link = &uctx_main;\n"
511 " makecontext(&uctx_func1, func1, 0);\n"
515 #: build/C/man3/makecontext.3:211
518 " if (getcontext(&uctx_func2) == -1)\n"
519 " handle_error(\"getcontext\");\n"
520 " uctx_func2.uc_stack.ss_sp = func2_stack;\n"
521 " uctx_func2.uc_stack.ss_size = sizeof(func2_stack);\n"
522 " /* Successor context is f1(), unless argc E<gt> 1 */\n"
523 " uctx_func2.uc_link = (argc E<gt> 1) ? NULL : &uctx_func1;\n"
524 " makecontext(&uctx_func2, func2, 0);\n"
528 #: build/C/man3/makecontext.3:215
531 " printf(\"main: swapcontext(&uctx_main, &uctx_func2)\\en\");\n"
532 " if (swapcontext(&uctx_main, &uctx_func2) == -1)\n"
533 " handle_error(\"swapcontext\");\n"
537 #: build/C/man3/makecontext.3:219
540 " printf(\"main: exiting\\en\");\n"
541 " exit(EXIT_SUCCESS);\n"
546 #: build/C/man3/makecontext.3:226
548 "B<sigaction>(2), B<sigaltstack>(2), B<sigprocmask>(2), B<getcontext>(3), "
553 #: build/C/man3/pthread_attr_init.3:26
555 msgid "PTHREAD_ATTR_INIT"
559 #: build/C/man3/pthread_attr_init.3:26
565 #: build/C/man3/pthread_attr_init.3:30
567 "pthread_attr_init, pthread_attr_destroy - initialize and destroy thread "
572 #: build/C/man3/pthread_attr_init.3:33 build/C/man3/pthread_attr_setdetachstate.3:33 build/C/man3/pthread_attr_setguardsize.3:33 build/C/man3/pthread_attr_setinheritsched.3:33 build/C/man3/pthread_attr_setschedparam.3:33 build/C/man3/pthread_attr_setschedpolicy.3:33 build/C/man3/pthread_attr_setscope.3:33 build/C/man3/pthread_attr_setstack.3:33 build/C/man3/pthread_attr_setstackaddr.3:33 build/C/man3/pthread_attr_setstacksize.3:33 build/C/man3/pthread_cancel.3:32 build/C/man3/pthread_cleanup_push.3:33 build/C/man3/pthread_cleanup_push_defer_np.3:33 build/C/man3/pthread_create.3:32 build/C/man3/pthread_detach.3:32 build/C/man3/pthread_equal.3:32 build/C/man3/pthread_exit.3:32 build/C/man3/pthread_join.3:32 build/C/man3/pthread_kill_other_threads_np.3:32 build/C/man3/pthread_self.3:32 build/C/man3/pthread_setcancelstate.3:33 build/C/man3/pthread_setconcurrency.3:32 build/C/man3/pthread_setschedparam.3:33 build/C/man3/pthread_setschedprio.3:32 build/C/man3/pthread_sigqueue.3:31 build/C/man3/pthread_testcancel.3:32
574 msgid "B<#include E<lt>pthread.hE<gt>>\n"
578 #: build/C/man3/pthread_attr_init.3:36
581 "B<int pthread_attr_init(pthread_attr_t *>I<attr>B<);>\n"
582 "B<int pthread_attr_destroy(pthread_attr_t *>I<attr>B<);>\n"
586 #: build/C/man3/pthread_attr_init.3:38 build/C/man3/pthread_attr_setaffinity_np.3:41 build/C/man3/pthread_attr_setdetachstate.3:40 build/C/man3/pthread_attr_setguardsize.3:40 build/C/man3/pthread_attr_setinheritsched.3:40 build/C/man3/pthread_attr_setschedparam.3:40 build/C/man3/pthread_attr_setschedpolicy.3:40 build/C/man3/pthread_attr_setscope.3:40 build/C/man3/pthread_attr_setstack.3:40 build/C/man3/pthread_attr_setstackaddr.3:40 build/C/man3/pthread_attr_setstacksize.3:40 build/C/man3/pthread_cancel.3:36 build/C/man3/pthread_cleanup_push.3:39 build/C/man3/pthread_equal.3:36 build/C/man3/pthread_exit.3:36 build/C/man3/pthread_getattr_np.3:37 build/C/man3/pthread_getcpuclockid.3:37 build/C/man3/pthread_self.3:36 build/C/man3/pthread_setaffinity_np.3:41 build/C/man3/pthread_setcancelstate.3:38 build/C/man3/pthread_setconcurrency.3:37 build/C/man3/pthread_setschedparam.3:40 build/C/man3/pthread_setschedprio.3:36 build/C/man3/pthread_testcancel.3:36
588 msgid "Compile and link with I<-pthread>.\n"
592 #: build/C/man3/pthread_attr_init.3:50
594 "The B<pthread_attr_init>() function initializes the thread attributes "
595 "object pointed to by I<attr> with default attribute values. After this "
596 "call, individual attributes of the object can be set using various related "
597 "functions (listed under SEE ALSO), and then the object can be used in one or "
598 "more B<pthread_create>(3) calls that create threads."
602 #: build/C/man3/pthread_attr_init.3:55
604 "Calling B<pthread_attr_init>() on a thread attributes object that has "
605 "already been initialized results in undefined behavior."
609 #: build/C/man3/pthread_attr_init.3:62
611 "When a thread attributes object is no longer required, it should be "
612 "destroyed using the B<pthread_attr_destroy>() function. Destroying a "
613 "thread attributes object has no effect on threads that were created using "
618 #: build/C/man3/pthread_attr_init.3:68
620 "Once a thread attributes object has been destroyed, it can be reinitialized "
621 "using B<pthread_attr_init>(). Any other use of a destroyed thread "
622 "attributes object has undefined results."
626 #: build/C/man3/pthread_attr_init.3:71 build/C/man3/pthread_attr_setaffinity_np.3:79 build/C/man3/pthread_attr_setdetachstate.3:80 build/C/man3/pthread_attr_setguardsize.3:93 build/C/man3/pthread_attr_setinheritsched.3:96 build/C/man3/pthread_attr_setschedparam.3:88 build/C/man3/pthread_attr_setschedpolicy.3:86 build/C/man3/pthread_attr_setscope.3:106 build/C/man3/pthread_attr_setstack.3:88 build/C/man3/pthread_attr_setstackaddr.3:77 build/C/man3/pthread_attr_setstacksize.3:64 build/C/man3/pthread_setaffinity_np.3:80 build/C/man3/pthread_setcancelstate.3:95 build/C/man3/pthread_setname_np.3:75
628 "On success, these functions return 0; on error, they return a nonzero error "
633 #: build/C/man3/pthread_attr_init.3:79
635 "POSIX.1-2001 documents an B<ENOMEM> error for B<pthread_attr_init>(); on "
636 "Linux these functions always succeed (but portable and future-proof "
637 "applications should nevertheless handle a possible error return)."
641 #: build/C/man3/pthread_attr_init.3:81 build/C/man3/pthread_attr_setdetachstate.3:89 build/C/man3/pthread_attr_setguardsize.3:108 build/C/man3/pthread_attr_setinheritsched.3:112 build/C/man3/pthread_attr_setschedparam.3:102 build/C/man3/pthread_attr_setschedpolicy.3:102 build/C/man3/pthread_attr_setscope.3:121 build/C/man3/pthread_attr_setstack.3:114 build/C/man3/pthread_attr_setstacksize.3:85 build/C/man3/pthread_cancel.3:127 build/C/man3/pthread_cleanup_push.3:129 build/C/man3/pthread_create.3:148 build/C/man3/pthread_detach.3:66 build/C/man3/pthread_equal.3:49 build/C/man3/pthread_exit.3:77 build/C/man3/pthread_getcpuclockid.3:67 build/C/man3/pthread_join.3:100 build/C/man3/pthread_self.3:52 build/C/man3/pthread_setcancelstate.3:115 build/C/man3/pthread_setconcurrency.3:85 build/C/man3/pthread_setschedparam.3:143 build/C/man3/pthread_setschedprio.3:85 build/C/man3/pthread_sigmask.3:71 build/C/man3/pthread_testcancel.3:60
642 msgid "POSIX.1-2001."
646 #: build/C/man3/pthread_attr_init.3:87
648 "The I<pthread_attr_t> type should be treated as opaque: any access to the "
649 "object other than via pthreads functions is nonportable and produces "
654 #: build/C/man3/pthread_attr_init.3:96
656 "The program below optionally makes use of B<pthread_attr_init>() and "
657 "various related functions to initialize a thread attributes object that is "
658 "used to create a single thread. Once created, the thread uses the "
659 "B<pthread_getattr_np>(3) function (a nonstandard GNU extension) to retrieve "
660 "the thread's attributes, and then displays those attributes."
664 #: build/C/man3/pthread_attr_init.3:105
666 "If the program is run with no command-line argument, then it passes NULL as "
667 "the I<attr> argument of B<pthread_create>(3), so that the thread is created "
668 "with default attributes. Running the program on Linux/x86-32 with the NPTL "
669 "threading implementation, we see the following:"
672 #. Results from glibc 2.8, SUSE 11.0; Oct 2008
674 #: build/C/man3/pthread_attr_init.3:121
677 "$B< ulimit -s> # No stack imit ==E<gt> default stack size is 2MB\n"
680 "Thread attributes:\n"
681 " Detach state = PTHREAD_CREATE_JOINABLE\n"
682 " Scope = PTHREAD_SCOPE_SYSTEM\n"
683 " Inherit scheduler = PTHREAD_INHERIT_SCHED\n"
684 " Scheduling policy = SCHED_OTHER\n"
685 " Scheduling priority = 0\n"
686 " Guard size = 4096 bytes\n"
687 " Stack address = 0x40196000\n"
688 " Stack size = 0x201000 bytes\n"
692 #: build/C/man3/pthread_attr_init.3:131
694 "When we supply a stack size as a command-line argument, the program "
695 "initializes a thread attributes object, sets various attributes in that "
696 "object, and passes a pointer to the object in the call to "
697 "B<pthread_create>(3). Running the program on Linux/x86-32 with the NPTL "
698 "threading implementation, we see the following:"
701 #. Results from glibc 2.8, SUSE 11.0; Oct 2008
703 #: build/C/man3/pthread_attr_init.3:146
706 "$B< ./a.out 0x3000000>\n"
707 "posix_memalign() allocated at 0x40197000\n"
708 "Thread attributes:\n"
709 " Detach state = PTHREAD_CREATE_DETACHED\n"
710 " Scope = PTHREAD_SCOPE_SYSTEM\n"
711 " Inherit scheduler = PTHREAD_EXPLICIT_SCHED\n"
712 " Scheduling policy = SCHED_OTHER\n"
713 " Scheduling priority = 0\n"
714 " Guard size = 0 bytes\n"
715 " Stack address = 0x40197000\n"
716 " Stack size = 0x3000000 bytes\n"
720 #: build/C/man3/pthread_attr_init.3:157 build/C/man3/pthread_getattr_np.3:188
723 "#define _GNU_SOURCE /* To get pthread_getattr_np() declaration */\n"
724 "#include E<lt>pthread.hE<gt>\n"
725 "#include E<lt>stdio.hE<gt>\n"
726 "#include E<lt>stdlib.hE<gt>\n"
727 "#include E<lt>unistd.hE<gt>\n"
728 "#include E<lt>errno.hE<gt>\n"
732 #: build/C/man3/pthread_attr_init.3:160 build/C/man3/pthread_cancel.3:162 build/C/man3/pthread_cleanup_push.3:243 build/C/man3/pthread_create.3:254 build/C/man3/pthread_getattr_np.3:191 build/C/man3/pthread_getcpuclockid.3:114 build/C/man3/pthread_setaffinity_np.3:172 build/C/man3/pthread_setschedparam.3:237 build/C/man3/pthread_sigmask.3:105
735 "#define handle_error_en(en, msg) \\e\n"
736 " do { errno = en; perror(msg); exit(EXIT_FAILURE); } while (0)\n"
740 #: build/C/man3/pthread_attr_init.3:168
744 "display_pthread_attr(pthread_attr_t *attr, char *prefix)\n"
749 " struct sched_param sp;\n"
753 #: build/C/man3/pthread_attr_init.3:176
756 " s = pthread_attr_getdetachstate(attr, &i);\n"
758 " handle_error_en(s, \"pthread_attr_getdetachstate\");\n"
759 " printf(\"%sDetach state = %s\\en\", prefix,\n"
760 " (i == PTHREAD_CREATE_DETACHED) ? \"PTHREAD_CREATE_DETACHED\" :\n"
761 " (i == PTHREAD_CREATE_JOINABLE) ? \"PTHREAD_CREATE_JOINABLE\" :\n"
766 #: build/C/man3/pthread_attr_init.3:184
769 " s = pthread_attr_getscope(attr, &i);\n"
771 " handle_error_en(s, \"pthread_attr_getscope\");\n"
772 " printf(\"%sScope = %s\\en\", prefix,\n"
773 " (i == PTHREAD_SCOPE_SYSTEM) ? \"PTHREAD_SCOPE_SYSTEM\" :\n"
774 " (i == PTHREAD_SCOPE_PROCESS) ? \"PTHREAD_SCOPE_PROCESS\" :\n"
779 #: build/C/man3/pthread_attr_init.3:192
782 " s = pthread_attr_getinheritsched(attr, &i);\n"
784 " handle_error_en(s, \"pthread_attr_getinheritsched\");\n"
785 " printf(\"%sInherit scheduler = %s\\en\", prefix,\n"
786 " (i == PTHREAD_INHERIT_SCHED) ? \"PTHREAD_INHERIT_SCHED\" :\n"
787 " (i == PTHREAD_EXPLICIT_SCHED) ? \"PTHREAD_EXPLICIT_SCHED\" :\n"
792 #: build/C/man3/pthread_attr_init.3:201
795 " s = pthread_attr_getschedpolicy(attr, &i);\n"
797 " handle_error_en(s, \"pthread_attr_getschedpolicy\");\n"
798 " printf(\"%sScheduling policy = %s\\en\", prefix,\n"
799 " (i == SCHED_OTHER) ? \"SCHED_OTHER\" :\n"
800 " (i == SCHED_FIFO) ? \"SCHED_FIFO\" :\n"
801 " (i == SCHED_RR) ? \"SCHED_RR\" :\n"
806 #: build/C/man3/pthread_attr_init.3:206
809 " s = pthread_attr_getschedparam(attr, &sp);\n"
811 " handle_error_en(s, \"pthread_attr_getschedparam\");\n"
812 " printf(\"%sScheduling priority = %d\\en\", prefix, sp.sched_priority);\n"
816 #: build/C/man3/pthread_attr_init.3:211
819 " s = pthread_attr_getguardsize(attr, &v);\n"
821 " handle_error_en(s, \"pthread_attr_getguardsize\");\n"
822 " printf(\"%sGuard size = %d bytes\\en\", prefix, v);\n"
826 #: build/C/man3/pthread_attr_init.3:218
829 " s = pthread_attr_getstack(attr, &stkaddr, &v);\n"
831 " handle_error_en(s, \"pthread_attr_getstack\");\n"
832 " printf(\"%sStack address = %p\\en\", prefix, stkaddr);\n"
833 " printf(\"%sStack size = 0x%x bytes\\en\", prefix, v);\n"
838 #: build/C/man3/pthread_attr_init.3:224
842 "thread_start(void *arg)\n"
845 " pthread_attr_t gattr;\n"
849 #: build/C/man3/pthread_attr_init.3:228
852 " /* pthread_getattr_np() is a non-standard GNU extension that\n"
853 " retrieves the attributes of the thread specified in its\n"
854 " first argument */\n"
858 #: build/C/man3/pthread_attr_init.3:232
861 " s = pthread_getattr_np(pthread_self(), &gattr);\n"
863 " handle_error_en(s, \"pthread_getattr_np\");\n"
867 #: build/C/man3/pthread_attr_init.3:235
870 " printf(\"Thread attributes:\\en\");\n"
871 " display_pthread_attr(&gattr, \"\\et\");\n"
875 #: build/C/man3/pthread_attr_init.3:238 build/C/man3/pthread_getattr_np.3:240
878 " exit(EXIT_SUCCESS); /* Terminate all threads */\n"
883 #: build/C/man3/pthread_attr_init.3:246
887 "main(int argc, char *argv[])\n"
890 " pthread_attr_t attr;\n"
891 " pthread_attr_t *attrp; /* NULL or &attr */\n"
896 #: build/C/man3/pthread_attr_init.3:248 build/C/man3/pthread_setschedparam.3:355
898 msgid " attrp = NULL;\n"
902 #: build/C/man3/pthread_attr_init.3:252
905 " /* If a command-line argument was supplied, use it to set the\n"
906 " stack-size attribute and set a few other thread attributes,\n"
907 " and set attrp pointing to thread attributes object */\n"
911 #: build/C/man3/pthread_attr_init.3:256
914 " if (argc E<gt> 1) {\n"
920 #: build/C/man3/pthread_attr_init.3:258
922 msgid " attrp = &attr;\n"
926 #: build/C/man3/pthread_attr_init.3:262
929 " s = pthread_attr_init(&attr);\n"
931 " handle_error_en(s, \"pthread_attr_init\");\n"
935 #: build/C/man3/pthread_attr_init.3:266
938 " s = pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);\n"
940 " handle_error_en(s, \"pthread_attr_setdetachstate\");\n"
944 #: build/C/man3/pthread_attr_init.3:270
947 " s = pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED);\n"
949 " handle_error_en(s, \"pthread_attr_setinheritsched\");\n"
953 #: build/C/man3/pthread_attr_init.3:272
955 msgid " stack_size = strtoul(argv[1], NULL, 0);\n"
959 #: build/C/man3/pthread_attr_init.3:276
962 " s = posix_memalign(&sp, sysconf(_SC_PAGESIZE), stack_size);\n"
964 " handle_error_en(s, \"posix_memalign\");\n"
968 #: build/C/man3/pthread_attr_init.3:278
970 msgid " printf(\"posix_memalign() allocated at %p\\en\", sp);\n"
974 #: build/C/man3/pthread_attr_init.3:283
977 " s = pthread_attr_setstack(&attr, sp, stack_size);\n"
979 " handle_error_en(s, \"pthread_attr_setstack\");\n"
984 #: build/C/man3/pthread_attr_init.3:287 build/C/man3/pthread_getattr_np.3:335
987 " s = pthread_create(&thr, attrp, &thread_start, NULL);\n"
989 " handle_error_en(s, \"pthread_create\");\n"
993 #: build/C/man3/pthread_attr_init.3:293 build/C/man3/pthread_getattr_np.3:341
996 " if (attrp != NULL) {\n"
997 " s = pthread_attr_destroy(attrp);\n"
999 " handle_error_en(s, \"pthread_attr_destroy\");\n"
1004 #: build/C/man3/pthread_attr_init.3:296 build/C/man3/pthread_getattr_np.3:344
1007 " pause(); /* Terminates when other thread calls exit() */\n"
1012 #: build/C/man3/pthread_attr_init.3:313
1014 "B<pthread_attr_setaffinity_np>(3), B<pthread_attr_setdetachstate>(3), "
1015 "B<pthread_attr_setguardsize>(3), B<pthread_attr_setinheritsched>(3), "
1016 "B<pthread_attr_setschedparam>(3), B<pthread_attr_setschedpolicy>(3), "
1017 "B<pthread_attr_setscope>(3), B<pthread_attr_setstack>(3), "
1018 "B<pthread_attr_setstackaddr>(3), B<pthread_attr_setstacksize>(3), "
1019 "B<pthread_create>(3), B<pthread_getattr_np>(3), B<pthreads>(7)"
1023 #: build/C/man3/pthread_attr_setaffinity_np.3:26
1025 msgid "PTHREAD_ATTR_SETAFFINITY_NP"
1029 #: build/C/man3/pthread_attr_setaffinity_np.3:26 build/C/man3/pthread_getattr_np.3:26 build/C/man3/pthread_setaffinity_np.3:26 build/C/man3/pthread_tryjoin_np.3:26
1035 #: build/C/man3/pthread_attr_setaffinity_np.3:30
1037 "pthread_attr_setaffinity_np, pthread_attr_getaffinity_np - set/get CPU "
1038 "affinity attribute in thread attributes object"
1042 #: build/C/man3/pthread_attr_setaffinity_np.3:34 build/C/man3/pthread_getattr_np.3:33 build/C/man3/pthread_setaffinity_np.3:34 build/C/man3/pthread_tryjoin_np.3:34 build/C/man3/pthread_yield.3:32
1045 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
1046 "B<#include E<lt>pthread.hE<gt>>\n"
1050 #: build/C/man3/pthread_attr_setaffinity_np.3:39
1053 "B<int pthread_attr_setaffinity_np(pthread_attr_t *>I<attr>B<,>\n"
1054 "B< size_t >I<cpusetsize>B<, const cpu_set_t "
1055 "*>I<cpuset>B<);>\n"
1056 "B<int pthread_attr_getaffinity_np(pthread_attr_t *>I<attr>B<,>\n"
1057 "B< size_t >I<cpusetsize>B<, cpu_set_t *>I<cpuset>B<);>\n"
1061 #: build/C/man3/pthread_attr_setaffinity_np.3:54
1063 "The B<pthread_attr_setaffinity_np>() function sets the CPU affinity mask "
1064 "attribute of the thread attributes object referred to by I<attr> to the "
1065 "value specified in I<cpuset>. This attribute determines the CPU affinity "
1066 "mask of a thread created using the thread attributes object I<attr>."
1070 #: build/C/man3/pthread_attr_setaffinity_np.3:63
1072 "The B<pthread_attr_getaffinity_np>() function returns the CPU affinity mask "
1073 "attribute of the thread attributes object referred to by I<attr> in the "
1074 "buffer pointed to by I<cpuset>."
1078 #: build/C/man3/pthread_attr_setaffinity_np.3:70
1080 "The argument I<cpusetsize> is the length (in bytes) of the buffer pointed to "
1081 "by I<cpuset>. Typically, this argument would be specified as "
1082 "I<sizeof(cpu_set_t)>."
1086 #: build/C/man3/pthread_attr_setaffinity_np.3:76 build/C/man3/pthread_setaffinity_np.3:67
1088 "For more details on CPU affinity masks, see B<sched_setaffinity>(2). For a "
1089 "description of a set of macros that can be used to manipulate and inspect "
1090 "CPU sets, see B<CPU_SET>(3)."
1094 #: build/C/man3/pthread_attr_setaffinity_np.3:80 build/C/man3/pthread_attr_setaffinity_np.3:92 build/C/man3/pthread_attr_setdetachstate.3:83 build/C/man3/pthread_attr_setinheritsched.3:99 build/C/man3/pthread_attr_setschedpolicy.3:89 build/C/man3/pthread_attr_setscope.3:109 build/C/man3/pthread_attr_setstack.3:91 build/C/man3/pthread_attr_setstacksize.3:67 build/C/man3/pthread_create.3:137 build/C/man3/pthread_detach.3:55 build/C/man3/pthread_join.3:85 build/C/man3/pthread_join.3:89 build/C/man3/pthread_kill.3:69 build/C/man3/pthread_setaffinity_np.3:84 build/C/man3/pthread_setaffinity_np.3:93 build/C/man3/pthread_setaffinity_np.3:109 build/C/man3/pthread_setcancelstate.3:99 build/C/man3/pthread_setcancelstate.3:107 build/C/man3/pthread_setconcurrency.3:71 build/C/man3/pthread_setschedparam.3:122 build/C/man3/pthread_setschedprio.3:62 build/C/man3/pthread_sigqueue.3:77
1100 #. The raw sched_getaffinity() system call returns the size (in bytes)
1101 #. of the cpumask_t type.
1103 #: build/C/man3/pthread_attr_setaffinity_np.3:92
1105 "(B<pthread_attr_setaffinity_np>()) I<cpuset> specified a CPU that was "
1106 "outside the set supported by the kernel. (The kernel configuration option "
1107 "B<CONFIG_NR_CPUS> defines the range of the set supported by the kernel data "
1108 "type used to represent CPU sets.)"
1112 #: build/C/man3/pthread_attr_setaffinity_np.3:102
1114 "(B<pthread_attr_getaffinity_np>()) A CPU in the affinity mask of the thread "
1115 "attributes object referred to by I<attr> lies outside the range specified by "
1116 "I<cpusetsize> (i.e., I<cpuset>/I<cpusetsize> is too small)."
1120 #: build/C/man3/pthread_attr_setaffinity_np.3:106
1121 msgid "(B<pthread_attr_setaffinity_np>()) Could not allocate memory."
1125 #: build/C/man3/pthread_attr_setaffinity_np.3:108 build/C/man3/pthread_setaffinity_np.3:121
1126 msgid "These functions are provided by glibc since version 2.3.4."
1130 #: build/C/man3/pthread_attr_setaffinity_np.3:111 build/C/man3/pthread_cleanup_push_defer_np.3:104 build/C/man3/pthread_setaffinity_np.3:124 build/C/man3/pthread_tryjoin_np.3:115
1132 "These functions are nonstandard GNU extensions; hence the suffix \"_np\" "
1133 "(nonportable) in the names."
1137 #: build/C/man3/pthread_attr_setaffinity_np.3:118 build/C/man3/pthread_setaffinity_np.3:150
1139 "In glibc 2.3.3 only, versions of these functions were provided that did not "
1140 "have a I<cpusetsize> argument. Instead the CPU set size given to the "
1141 "underlying system calls was always I<sizeof(cpu_set_t)>."
1145 #: build/C/man3/pthread_attr_setaffinity_np.3:124
1147 "B<sched_setaffinity>(2), B<pthread_attr_init>(3), "
1148 "B<pthread_setaffinity_np>(3), B<cpuset>(7), B<pthreads>(7)"
1152 #: build/C/man3/pthread_attr_setdetachstate.3:26
1154 msgid "PTHREAD_ATTR_SETDETACHSTATE"
1158 #: build/C/man3/pthread_attr_setdetachstate.3:26
1164 #: build/C/man3/pthread_attr_setdetachstate.3:30
1166 "pthread_attr_setdetachstate, pthread_attr_getdetachstate - set/get detach "
1167 "state attribute in thread attributes object"
1171 #: build/C/man3/pthread_attr_setdetachstate.3:38
1174 "B<int pthread_attr_setdetachstate(pthread_attr_t *>I<attr>B<, int "
1175 ">I<detachstate>B<);>\n"
1176 "B<int pthread_attr_getdetachstate(pthread_attr_t *>I<attr>B<, int "
1177 "*>I<detachstate>B<);>\n"
1181 #: build/C/man3/pthread_attr_setdetachstate.3:53
1183 "The B<pthread_attr_setdetachstate>() function sets the detach state "
1184 "attribute of the thread attributes object referred to by I<attr> to the "
1185 "value specified in I<detachstate>. The detach state attribute determines "
1186 "whether a thread created using the thread attributes object I<attr> will be "
1187 "created in a joinable or a detached state."
1191 #: build/C/man3/pthread_attr_setdetachstate.3:56
1192 msgid "The following values may be specified in I<detachstate>:"
1196 #: build/C/man3/pthread_attr_setdetachstate.3:56
1198 msgid "B<PTHREAD_CREATE_DETACHED>"
1202 #: build/C/man3/pthread_attr_setdetachstate.3:61
1203 msgid "Threads that are created using I<attr> will be created in a detached state."
1207 #: build/C/man3/pthread_attr_setdetachstate.3:61
1209 msgid "B<PTHREAD_CREATE_JOINABLE>"
1213 #: build/C/man3/pthread_attr_setdetachstate.3:66
1214 msgid "Threads that are created using I<attr> will be created in a joinable state."
1218 #: build/C/man3/pthread_attr_setdetachstate.3:70
1220 "The default setting of the detach state attribute in a newly initialized "
1221 "thread attributes object is B<PTHREAD_CREATE_JOINABLE>."
1225 #: build/C/man3/pthread_attr_setdetachstate.3:77
1227 "The B<pthread_attr_getdetachstate>() returns the detach state attribute of "
1228 "the thread attributes object I<attr> in the buffer pointed to by "
1233 #: build/C/man3/pthread_attr_setdetachstate.3:83
1234 msgid "B<pthread_attr_setdetachstate>() can fail with the following error:"
1238 #: build/C/man3/pthread_attr_setdetachstate.3:87
1239 msgid "An invalid value was specified in I<detachstate>."
1243 #: build/C/man3/pthread_attr_setdetachstate.3:93
1244 msgid "See B<pthread_create>(3) for more details on detached and joinable threads."
1248 #: build/C/man3/pthread_attr_setdetachstate.3:101
1250 "A thread that is created in a joinable state should eventually either be "
1251 "joined using B<pthread_join>(3) or detached using B<pthread_detach>(3); see "
1252 "B<pthread_create>(3)."
1256 #: build/C/man3/pthread_attr_setdetachstate.3:108
1258 "It is an error to specify the thread ID of a thread that was created in a "
1259 "detached state in a later call to B<pthread_detach>(3) or "
1260 "B<pthread_join>(3)."
1264 #: build/C/man3/pthread_attr_setdetachstate.3:111 build/C/man3/pthread_attr_setstack.3:155
1265 msgid "See B<pthread_attr_init>(3)."
1269 #: build/C/man3/pthread_attr_setdetachstate.3:117
1271 "B<pthread_attr_init>(3), B<pthread_create>(3), B<pthread_detach>(3), "
1272 "B<pthread_join>(3), B<pthreads>(7)"
1276 #: build/C/man3/pthread_attr_setguardsize.3:26
1278 msgid "PTHREAD_ATTR_SETGUARDSIZE"
1282 #: build/C/man3/pthread_attr_setguardsize.3:26 build/C/man3/pthread_attr_setstack.3:26 build/C/man3/pthread_attr_setstackaddr.3:26 build/C/man3/pthread_self.3:26
1288 #: build/C/man3/pthread_attr_setguardsize.3:30
1290 "pthread_attr_setguardsize, pthread_attr_getguardsize - set/get guard size "
1291 "attribute in thread attributes object"
1295 #: build/C/man3/pthread_attr_setguardsize.3:38
1298 "B<int pthread_attr_setguardsize(pthread_attr_t *>I<attr>B<, size_t "
1299 ">I<guardsize>B<);>\n"
1300 "B<int pthread_attr_getguardsize(pthread_attr_t *>I<attr>B<, size_t "
1301 "*>I<guardsize>B<);>\n"
1305 #: build/C/man3/pthread_attr_setguardsize.3:49
1307 "The B<pthread_attr_setguardsize>() function sets the guard size attribute "
1308 "of the thread attributes object referred to by I<attr> to the value "
1309 "specified in I<guardsize>."
1313 #: build/C/man3/pthread_attr_setguardsize.3:59
1315 "If I<guardsize> is greater than 0, then for each new thread created using "
1316 "I<attr> the system allocates an additional region of at least I<guardsize> "
1317 "bytes at the end of the thread's stack to act as the guard area for the "
1318 "stack (but see BUGS)."
1322 #: build/C/man3/pthread_attr_setguardsize.3:65
1324 "If I<guardsize> is 0, then new threads created with I<attr> will not have a "
1329 #: build/C/man3/pthread_attr_setguardsize.3:67
1330 msgid "The default guard size is the same as the system page size."
1334 #: build/C/man3/pthread_attr_setguardsize.3:82
1336 "If the stack address attribute has been set in I<attr> (using "
1337 "B<pthread_attr_setstack>(3) or B<pthread_attr_setstackaddr>(3)), meaning "
1338 "that the caller is allocating the thread's stack, then the guard size "
1339 "attribute is ignored (i.e., no guard area is created by the system): it is "
1340 "the application's responsibility to handle stack overflow (perhaps by using "
1341 "B<mprotect>(2) to manually define a guard area at the end of the stack that "
1342 "it has allocated)."
1346 #: build/C/man3/pthread_attr_setguardsize.3:90
1348 "The B<pthread_attr_getguardsize>() function returns the guard size "
1349 "attribute of the thread attributes object referred to by I<attr> in the "
1350 "buffer pointed to by I<guardsize>."
1354 #: build/C/man3/pthread_attr_setguardsize.3:104
1356 "POSIX.1-2001 documents an B<EINVAL> error if I<attr> or I<guardsize> is "
1357 "invalid. On Linux these functions always succeed (but portable and "
1358 "future-proof applications should nevertheless handle a possible error "
1363 #: build/C/man3/pthread_attr_setguardsize.3:106 build/C/man3/pthread_attr_setstackaddr.3:83 build/C/man3/pthread_attr_setstacksize.3:83
1364 msgid "These functions are provided by glibc since version 2.1."
1368 #: build/C/man3/pthread_attr_setguardsize.3:122
1370 "A guard area consists of virtual memory pages that are protected to prevent "
1371 "read and write access. If a thread overflows its stack into the guard area, "
1372 "then, on most hard architectures, it receives a B<SIGSEGV> signal, thus "
1373 "notifying it of the overflow. Guard areas start on page boundaries, and the "
1374 "guard size is internally rounded up to the system page size when creating a "
1375 "thread. (Nevertheless, B<pthread_attr_getguardsize>() returns the guard "
1376 "size that was set by B<pthread_attr_setguardsize>().)"
1380 #: build/C/man3/pthread_attr_setguardsize.3:126
1382 "Setting a guard size of 0 may be useful to save memory in an application "
1383 "that creates many threads and knows that stack overflow can never occur."
1387 #: build/C/man3/pthread_attr_setguardsize.3:130
1389 "Choosing a guard size larger than the default size may be necessary for "
1390 "detecting stack overflows if a thread allocates large data structures on the "
1395 #: build/C/man3/pthread_attr_setguardsize.3:130 build/C/man3/pthread_attr_setinheritsched.3:112 build/C/man3/pthread_attr_setstacksize.3:96 build/C/man3/pthread_create.3:196 build/C/man3/pthread_exit.3:93
1401 #: build/C/man3/pthread_attr_setguardsize.3:141
1403 "As at glibc 2.8, the NPTL threading implementation includes the guard area "
1404 "within the stack size allocation, rather than allocating extra space at the "
1405 "end of the stack, as POSIX.1 requires. (This can result in an B<EINVAL> "
1406 "error from B<pthread_create>(3) if the guard size value is too large, "
1407 "leaving no space for the actual stack.)"
1410 #. glibc includes the guardsize within the allocated stack size,
1411 #. which looks pretty clearly to be in violation of POSIX.
1413 #. Filed bug, 22 Oct 2008:
1414 #. http://sources.redhat.com/bugzilla/show_bug.cgi?id=6973
1417 #. https//bugzilla.redhat.com/show_bug.cgi?id=435337
1418 #. Reportedly, LinuxThreads did the right thing, allocating
1419 #. extra space at the end of the stack:
1420 #. http://sourceware.org/ml/libc-alpha/2008-05/msg00086.html
1422 #: build/C/man3/pthread_attr_setguardsize.3:155
1424 "The obsolete LinuxThreads implementation did the right thing, allocating "
1425 "extra space at the end of the stack for the guard area."
1429 #: build/C/man3/pthread_attr_setguardsize.3:158
1430 msgid "See B<pthread_getattr_np>(3)."
1434 #: build/C/man3/pthread_attr_setguardsize.3:166
1436 "B<mmap>(2), B<mprotect>(2), B<pthread_attr_init>(3), "
1437 "B<pthread_attr_setstack>(3), B<pthread_attr_setstacksize>(3), "
1438 "B<pthread_create>(3), B<pthreads>(7)"
1442 #: build/C/man3/pthread_attr_setinheritsched.3:26
1444 msgid "PTHREAD_ATTR_SETINHERITSCHED"
1448 #: build/C/man3/pthread_attr_setinheritsched.3:26 build/C/man3/pthread_attr_setscope.3:26
1454 #: build/C/man3/pthread_attr_setinheritsched.3:30
1456 "pthread_attr_setinheritsched, pthread_attr_getinheritsched - set/get "
1457 "inherit-scheduler attribute in thread attributes object"
1461 #: build/C/man3/pthread_attr_setinheritsched.3:38
1464 "B<int pthread_attr_setinheritsched(pthread_attr_t *>I<attr>B<,>\n"
1465 "B< int >I<inheritsched>B<);>\n"
1466 "B<int pthread_attr_getinheritsched(pthread_attr_t *>I<attr>B<,>\n"
1467 "B< int *>I<inheritsched>B<);>\n"
1471 #: build/C/man3/pthread_attr_setinheritsched.3:55
1473 "The B<pthread_attr_setinheritsched>() function sets the inherit-scheduler "
1474 "attribute of the thread attributes object referred to by I<attr> to the "
1475 "value specified in I<inheritsched>. The inherit-scheduler attribute "
1476 "determines whether a thread created using the thread attributes object "
1477 "I<attr> will inherit its scheduling attributes from the calling thread or "
1478 "whether it will take them from I<attr>."
1482 #: build/C/man3/pthread_attr_setinheritsched.3:64
1484 "The following scheduling attributes are affected by the inherit-scheduler "
1485 "attribute: scheduling policy (B<pthread_attr_setschedpolicy>(3)), scheduling "
1486 "priority (B<pthread_attr_setschedparam>(3)), and contention scope "
1487 "(B<pthread_attr_setscope>(3))."
1491 #: build/C/man3/pthread_attr_setinheritsched.3:67
1492 msgid "The following values may be specified in I<inheritsched>:"
1496 #: build/C/man3/pthread_attr_setinheritsched.3:67
1498 msgid "B<PTHREAD_INHERIT_SCHED>"
1502 #: build/C/man3/pthread_attr_setinheritsched.3:75
1504 "Threads that are created using I<attr> inherit scheduling attributes from "
1505 "the creating thread; the scheduling attributes in I<attr> are ignored."
1509 #: build/C/man3/pthread_attr_setinheritsched.3:75
1511 msgid "B<PTHREAD_EXPLICIT_SCHED>"
1514 #. FIXME what are the defaults for scheduler settings?
1516 #: build/C/man3/pthread_attr_setinheritsched.3:82
1518 "Threads that are created using I<attr> take their scheduling attributes from "
1519 "the values specified by the attributes object."
1523 #: build/C/man3/pthread_attr_setinheritsched.3:86
1525 "The default setting of the inherit-scheduler attribute in a newly "
1526 "initialized thread attributes object is B<PTHREAD_INHERIT_SCHED>."
1530 #: build/C/man3/pthread_attr_setinheritsched.3:93
1532 "The B<pthread_attr_getinheritsched>() returns the inherit-scheduler "
1533 "attribute of the thread attributes object I<attr> in the buffer pointed to "
1534 "by I<inheritsched>."
1538 #: build/C/man3/pthread_attr_setinheritsched.3:99
1539 msgid "B<pthread_attr_setinheritsched>() can fail with the following error:"
1543 #: build/C/man3/pthread_attr_setinheritsched.3:103
1544 msgid "Invalid value in I<inheritsched>."
1548 #. Available since glibc 2.0.
1550 #: build/C/man3/pthread_attr_setinheritsched.3:110
1552 "POSIX.1-2001 also documents an optional B<ENOTSUP> error (\"attempt was made "
1553 "to set the attribute to an unsupported value\") for "
1554 "B<pthread_attr_setinheritsched>()."
1557 #. FIXME . Track status of the following bug:
1558 #. http://sourceware.org/bugzilla/show_bug.cgi?id=7007
1560 #: build/C/man3/pthread_attr_setinheritsched.3:128
1562 "As at glibc 2.8, if a thread attributes object is initialized using "
1563 "B<pthread_attr_init>(3), then the scheduling policy of the attributes object "
1564 "is set to B<SCHED_OTHER> and the scheduling priority is set to 0. However, "
1565 "if the inherit-scheduler attribute is then set to B<PTHREAD_EXPLICIT_SCHED>, "
1566 "then a thread created using the attribute object wrongly inherits its "
1567 "scheduling attributes from the creating thread. This bug does not occur if "
1568 "either the scheduling policy or scheduling priority attribute is explicitly "
1569 "set in the thread attributes object before calling B<pthread_create>(3)."
1573 #: build/C/man3/pthread_attr_setinheritsched.3:131 build/C/man3/pthread_attr_setschedparam.3:109 build/C/man3/pthread_attr_setschedpolicy.3:105
1574 msgid "See B<pthread_setschedparam>(3)."
1578 #: build/C/man3/pthread_attr_setinheritsched.3:143
1580 "B<sched_setscheduler>(2), B<pthread_attr_init>(3), "
1581 "B<pthread_attr_setschedparam>(3), B<pthread_attr_setschedpolicy>(3), "
1582 "B<pthread_attr_setscope>(3), B<pthread_create>(3), "
1583 "B<pthread_setschedparam>(3), B<pthread_setschedprio>(3), B<pthreads>(7)"
1587 #: build/C/man3/pthread_attr_setschedparam.3:26
1589 msgid "PTHREAD_ATTR_SETSCHEDPARAM"
1593 #: build/C/man3/pthread_attr_setschedparam.3:26 build/C/man3/pthread_attr_setschedpolicy.3:26 build/C/man3/pthread_setname_np.3:26
1599 #: build/C/man3/pthread_attr_setschedparam.3:30
1601 "pthread_attr_setschedparam, pthread_attr_getschedparam - set/get scheduling "
1602 "parameter attributes in thread attributes object"
1606 #: build/C/man3/pthread_attr_setschedparam.3:38
1609 "B<int pthread_attr_setschedparam(pthread_attr_t *>I<attr>B<,>\n"
1610 "B< const struct sched_param *>I<param>B<);>\n"
1611 "B<int pthread_attr_getschedparam(pthread_attr_t *>I<attr>B<,>\n"
1612 "B< struct sched_param *>I<param>B<);>\n"
1616 #: build/C/man3/pthread_attr_setschedparam.3:52
1618 "The B<pthread_attr_setschedparam>() function sets the scheduling parameter "
1619 "attributes of the thread attributes object referred to by I<attr> to the "
1620 "values specified in the buffer pointed to by I<param>. These attributes "
1621 "determine the scheduling parameters of a thread created using the thread "
1622 "attributes object I<attr>."
1626 #: build/C/man3/pthread_attr_setschedparam.3:59
1628 "The B<pthread_attr_getschedparam>() returns the scheduling parameter "
1629 "attributes of the thread attributes object I<attr> in the buffer pointed to "
1634 #: build/C/man3/pthread_attr_setschedparam.3:61
1635 msgid "Scheduling parameters are maintained in the following structure:"
1639 #: build/C/man3/pthread_attr_setschedparam.3:67 build/C/man3/pthread_setschedparam.3:69
1642 "struct sched_param {\n"
1643 " int sched_priority; /* Scheduling priority */\n"
1648 #: build/C/man3/pthread_attr_setschedparam.3:74 build/C/man3/pthread_setschedparam.3:76
1650 "As can be seen, only one scheduling parameter is supported. For details of "
1651 "the permitted ranges for scheduling priorities in each scheduling policy, "
1652 "see B<sched_setscheduler>(2)."
1656 #: build/C/man3/pthread_attr_setschedparam.3:85
1658 "In order for the parameter setting made by B<pthread_attr_setschedparam>() "
1659 "to have effect when calling B<pthread_create>(3), the caller must use "
1660 "B<pthread_attr_setinheritsched>(3) to set the inherit-scheduler attribute "
1661 "of the attributes object I<attr> to B<PTHREAD_EXPLICIT_SCHED>."
1665 #. Available since glibc 2.0.
1667 #: build/C/man3/pthread_attr_setschedparam.3:100
1669 "POSIX.1 documents B<EINVAL> and B<ENOTSUP> errors for "
1670 "B<pthread_attr_setschedparam>(). On Linux these functions always succeed "
1671 "(but portable and future-proof applications should nevertheless handle a "
1672 "possible error return)."
1676 #: build/C/man3/pthread_attr_setschedparam.3:106
1678 "See B<pthread_attr_setschedpolicy>(3) for a list of the thread scheduling "
1679 "policies supported on Linux."
1683 #: build/C/man3/pthread_attr_setschedparam.3:121
1685 "B<sched_get_priority_min>(2), B<sched_setscheduler>(2), "
1686 "B<pthread_attr_init>(3), B<pthread_attr_setinheritsched>(3), "
1687 "B<pthread_attr_setschedpolicy>(3), B<pthread_create>(3), "
1688 "B<pthread_setschedparam>(3), B<pthread_setschedprio>(3), B<pthreads>(7)"
1692 #: build/C/man3/pthread_attr_setschedpolicy.3:26
1694 msgid "PTHREAD_ATTR_SETSCHEDPOLICY"
1698 #: build/C/man3/pthread_attr_setschedpolicy.3:30
1700 "pthread_attr_setschedpolicy, pthread_attr_getschedpolicy - set/get "
1701 "scheduling policy attribute in thread attributes object"
1705 #: build/C/man3/pthread_attr_setschedpolicy.3:38
1708 "B<int pthread_attr_setschedpolicy(pthread_attr_t *>I<attr>B<, int "
1710 "B<int pthread_attr_getschedpolicy(pthread_attr_t *>I<attr>B<, int "
1711 ">I<*policy>B<);>\n"
1715 #: build/C/man3/pthread_attr_setschedpolicy.3:52
1717 "The B<pthread_attr_setschedpolicy>() function sets the scheduling policy "
1718 "attribute of the thread attributes object referred to by I<attr> to the "
1719 "value specified in I<policy>. This attribute determines the scheduling "
1720 "policy of a thread created using the thread attributes object I<attr>."
1723 #. FIXME . pthread_setschedparam() places no restriction on the policy,
1724 #. but pthread_attr_setschedpolicy() restricts policy to RR/FIFO/OTHER
1725 #. http://sourceware.org/bugzilla/show_bug.cgi?id=7013
1727 #: build/C/man3/pthread_attr_setschedpolicy.3:65
1729 "The supported values for I<policy> are B<SCHED_FIFO>, B<SCHED_RR>, and "
1730 "B<SCHED_OTHER>, with the semantics described in B<sched_setscheduler>(2)."
1734 #: build/C/man3/pthread_attr_setschedpolicy.3:72
1736 "The B<pthread_attr_getschedpolicy>() returns the scheduling policy "
1737 "attribute of the thread attributes object I<attr> in the buffer pointed to "
1742 #: build/C/man3/pthread_attr_setschedpolicy.3:83
1744 "In order for the policy setting made by B<pthread_attr_setschedpolicy>() to "
1745 "have effect when calling B<pthread_create>(3), the caller must use "
1746 "B<pthread_attr_setinheritsched>(3) to set the inherit-scheduler attribute "
1747 "of the attributes object I<attr> to B<PTHREAD_EXPLICIT_SCHED>."
1751 #: build/C/man3/pthread_attr_setschedpolicy.3:89
1752 msgid "B<pthread_attr_setschedpolicy>() can fail with the following error:"
1756 #: build/C/man3/pthread_attr_setschedpolicy.3:93
1757 msgid "Invalid value in I<policy>."
1761 #. Available since glibc 2.0.
1763 #: build/C/man3/pthread_attr_setschedpolicy.3:100
1765 "POSIX.1-2001 also documents an optional B<ENOTSUP> error (\"attempt was made "
1766 "to set the attribute to an unsupported value\") for "
1767 "B<pthread_attr_setschedpolicy>()."
1771 #: build/C/man3/pthread_attr_setschedpolicy.3:116
1773 "B<sched_setscheduler>(2), B<pthread_attr_init>(3), "
1774 "B<pthread_attr_setinheritsched>(3), B<pthread_attr_setschedparam>(3), "
1775 "B<pthread_create>(3), B<pthread_setschedparam>(3), "
1776 "B<pthread_setschedprio>(3), B<pthreads>(7)"
1780 #: build/C/man3/pthread_attr_setscope.3:26
1782 msgid "PTHREAD_ATTR_SETSCOPE"
1786 #: build/C/man3/pthread_attr_setscope.3:30
1788 "pthread_attr_setscope, pthread_attr_getscope - set/get contention scope "
1789 "attribute in thread attributes object"
1793 #: build/C/man3/pthread_attr_setscope.3:38
1796 "B<int pthread_attr_setscope(pthread_attr_t *>I<attr>B<, int >I<scope>B<);>\n"
1797 "B<int pthread_attr_getscope(pthread_attr_t *>I<attr>B<, int "
1802 #: build/C/man3/pthread_attr_setscope.3:53
1804 "The B<pthread_attr_setscope>() function sets the contention scope attribute "
1805 "of the thread attributes object referred to by I<attr> to the value "
1806 "specified in I<scope>. The contention scope attribute defines the set of "
1807 "threads against which a thread competes for resources such as the CPU. "
1808 "POSIX.1-2001 specifies two possible values for I<scope>:"
1812 #: build/C/man3/pthread_attr_setscope.3:53
1814 msgid "B<PTHREAD_SCOPE_SYSTEM>"
1818 #: build/C/man3/pthread_attr_setscope.3:61
1820 "The thread competes for resources with all other threads in all processes on "
1821 "the system that are in the same scheduling allocation domain (a group of one "
1822 "or more processors). B<PTHREAD_SCOPE_SYSTEM> threads are scheduled relative "
1823 "to one another according to their scheduling policy and priority."
1827 #: build/C/man3/pthread_attr_setscope.3:61
1829 msgid "B<PTHREAD_SCOPE_PROCESS>"
1833 #: build/C/man3/pthread_attr_setscope.3:76
1835 "The thread competes for resources with all other threads in the same process "
1836 "that were also created with the B<PTHREAD_SCOPE_PROCESS> contention scope. "
1837 "B<PTHREAD_SCOPE_PROCESS> threads are scheduled relative to other threads in "
1838 "the process according to their scheduling policy and priority. POSIX.1-2001 "
1839 "leaves it unspecified how these threads contend with other threads in other "
1840 "process on the system or with other threads in the same process that were "
1841 "created with the B<PTHREAD_SCOPE_SYSTEM> contention scope."
1845 #: build/C/man3/pthread_attr_setscope.3:83
1847 "POSIX.1-2001 requires that an implementation support at least one of these "
1848 "contention scopes. Linux supports B<PTHREAD_SCOPE_SYSTEM>, but not "
1849 "B<PTHREAD_SCOPE_PROCESS>."
1853 #: build/C/man3/pthread_attr_setscope.3:95
1855 "On systems that support multiple contention scopes, then, in order for the "
1856 "parameter setting made by B<pthread_attr_setscope>() to have effect when "
1857 "calling B<pthread_create>(3), the caller must use "
1858 "B<pthread_attr_setinheritsched>(3) to set the inherit-scheduler attribute "
1859 "of the attributes object I<attr> to B<PTHREAD_EXPLICIT_SCHED>."
1863 #: build/C/man3/pthread_attr_setscope.3:103
1865 "The B<pthread_attr_getscope>() function returns the contention scope "
1866 "attribute of the thread attributes object referred to by I<attr> in the "
1867 "buffer pointed to by I<scope>."
1871 #: build/C/man3/pthread_attr_setscope.3:109
1872 msgid "B<pthread_attr_setscope>() can fail with the following errors:"
1876 #: build/C/man3/pthread_attr_setscope.3:113
1877 msgid "An invalid value was specified in I<scope>."
1881 #: build/C/man3/pthread_attr_setscope.3:113
1887 #: build/C/man3/pthread_attr_setscope.3:119
1889 "I<scope> specified the value B<PTHREAD_SCOPE_PROCESS>, which is not "
1890 "supported on Linux."
1894 #: build/C/man3/pthread_attr_setscope.3:129
1896 "The B<PTHREAD_SCOPE_SYSTEM> contention scope typically indicates that a "
1897 "user-space thread is bound directly to a single kernel-scheduling entity. "
1898 "This is the case on Linux for the obsolete LinuxThreads implementation and "
1899 "the modern NPTL implementation, which are both 1:1 threading "
1904 #: build/C/man3/pthread_attr_setscope.3:132
1906 "POSIX.1-2001 specifies that the default contention scope is "
1907 "implementation-defined."
1911 #: build/C/man3/pthread_attr_setscope.3:142
1913 "B<pthread_attr_init>(3), B<pthread_attr_setaffinity_np>(3), "
1914 "B<pthread_attr_setinheritsched>(3), B<pthread_attr_setschedparam>(3), "
1915 "B<pthread_attr_setschedpolicy>(3), B<pthread_create>(3), B<pthreads>(7)"
1919 #: build/C/man3/pthread_attr_setstack.3:26
1921 msgid "PTHREAD_ATTR_SETSTACK"
1925 #: build/C/man3/pthread_attr_setstack.3:30
1927 "pthread_attr_setstack, pthread_attr_getstack - set/get stack attributes in "
1928 "thread attributes object"
1932 #: build/C/man3/pthread_attr_setstack.3:38
1935 "B<int pthread_attr_setstack(pthread_attr_t *>I<attr>B<,>\n"
1936 "B< void *>I<stackaddr>B<, size_t "
1937 ">I<stacksize>B<);>\n"
1938 "B<int pthread_attr_getstack(pthread_attr_t *>I<attr>B<,>\n"
1939 "B< void **>I<stackaddr>B<, size_t "
1940 "*>I<stacksize>B<);>\n"
1944 #: build/C/man3/pthread_attr_setstack.3:45 build/C/man3/pthread_kill.3:41 build/C/man3/pthread_sigmask.3:42 build/C/man3/pthread_sigqueue.3:41
1945 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
1949 #: build/C/man3/pthread_attr_setstack.3:50
1950 msgid "B<pthread_attr_getstack>(), B<pthread_attr_setstack>():"
1954 #: build/C/man3/pthread_attr_setstack.3:52
1955 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 200112L || _XOPEN_SOURCE\\ E<gt>=\\ 600"
1959 #: build/C/man3/pthread_attr_setstack.3:68
1961 "The B<pthread_attr_setstack>() function sets the stack address and stack "
1962 "size attributes of the thread attributes object referred to by I<attr> to "
1963 "the values specified in I<stackaddr> and I<stacksize>, respectively. These "
1964 "attributes specify the location and size of the stack that should be used by "
1965 "a thread that is created using the thread attributes object I<attr>."
1969 #: build/C/man3/pthread_attr_setstack.3:74
1971 "I<stackaddr> should point to the lowest addressable byte of a buffer of "
1972 "I<stacksize> bytes that was allocated by the caller. The pages of the "
1973 "allocated buffer should be both readable and writable."
1977 #: build/C/man3/pthread_attr_setstack.3:85
1979 "The B<pthread_attr_getstack>() function returns the stack address and stack "
1980 "size attributes of the thread attributes object referred to by I<attr> in "
1981 "the buffers pointed to by I<stackaddr> and I<stacksize>, respectively."
1985 #: build/C/man3/pthread_attr_setstack.3:91
1986 msgid "B<pthread_attr_setstack>() can fail with the following error:"
1990 #: build/C/man3/pthread_attr_setstack.3:102
1992 "I<stacksize> is less than B<PTHREAD_STACK_MIN> (16384) bytes. On some "
1993 "systems, this error may also occur if I<stackaddr> or I<stackaddr\\ +\\ "
1994 "stacksize> is not suitably aligned."
1998 #: build/C/man3/pthread_attr_setstack.3:110
2000 "POSIX.1-2001 also documents an B<EACCES> error if the stack area described "
2001 "by I<stackaddr> and I<stacksize> is not both readable and writable by the "
2006 #: build/C/man3/pthread_attr_setstack.3:112
2007 msgid "These functions are provided by glibc since version 2.2."
2011 #: build/C/man3/pthread_attr_setstack.3:122
2013 "These functions are provided for applications that must ensure that a "
2014 "thread's stack is placed in a particular location. For most applications, "
2015 "this is not necessary, and the use of these functions should be avoided. "
2016 "(Use B<pthread_attr_setstacksize>(3) if an application simply requires a "
2017 "stack size other than the default.)"
2021 #: build/C/man3/pthread_attr_setstack.3:133
2023 "When an application employs B<pthread_attr_setstack>(), it takes over the "
2024 "responsibility of allocating the stack. Any guard size value that was set "
2025 "using B<pthread_attr_setguardsize>(3) is ignored. If deemed necessary, it "
2026 "is the application's responsibility to allocate a guard area (one or more "
2027 "pages protected against reading and writing) to handle the possibility of "
2032 #: build/C/man3/pthread_attr_setstack.3:144
2034 "The address specified in I<stackaddr> should be suitably aligned: for full "
2035 "portability, align it on a page boundary (I<sysconf(_SC_PAGESIZE)>). "
2036 "B<posix_memalign>(3) may be useful for allocation. Probably, I<stacksize> "
2037 "should also be a multiple of the system page size."
2041 #: build/C/man3/pthread_attr_setstack.3:152
2043 "If I<attr> is used to create multiple threads, then the caller must change "
2044 "the stack address attribute between calls to B<pthread_create>(3); "
2045 "otherwise, the threads will attempt to use the same memory area for their "
2046 "stacks, and chaos will ensue."
2050 #: build/C/man3/pthread_attr_setstack.3:167
2052 "B<mmap>(2), B<mprotect>(2), B<posix_memalign>(3), B<pthread_attr_init>(3), "
2053 "B<pthread_attr_setguardsize>(3), B<pthread_attr_setstackaddr>(3), "
2054 "B<pthread_attr_setstacksize>(3), B<pthread_create>(3), B<pthreads>(7)"
2058 #: build/C/man3/pthread_attr_setstackaddr.3:26
2060 msgid "PTHREAD_ATTR_SETSTACKADDR"
2064 #: build/C/man3/pthread_attr_setstackaddr.3:30
2066 "pthread_attr_setstackaddr, pthread_attr_getstackaddr - set/get stack address "
2067 "attribute in thread attributes object"
2071 #: build/C/man3/pthread_attr_setstackaddr.3:38
2074 "B<int pthread_attr_setstackaddr(pthread_attr_t *>I<attr>B<, void "
2075 "*>I<stackaddr>B<);>\n"
2076 "B<int pthread_attr_getstackaddr(pthread_attr_t *>I<attr>B<, void "
2077 "**>I<stackaddr>B<);>\n"
2081 #: build/C/man3/pthread_attr_setstackaddr.3:49
2083 "These functions are obsolete: B<do not use them.> Use "
2084 "B<pthread_attr_setstack>(3) and B<pthread_attr_getstack>(3) instead."
2088 #: build/C/man3/pthread_attr_setstackaddr.3:60
2090 "The B<pthread_attr_setstackaddr>() function sets the stack address "
2091 "attribute of the thread attributes object referred to by I<attr> to the "
2092 "value specified in I<stackaddr>. This attribute specifies the location of "
2093 "the stack that should be used by a thread that is created using the thread "
2094 "attributes object I<attr>."
2098 #: build/C/man3/pthread_attr_setstackaddr.3:66
2100 "I<stackaddr> should point to a buffer of at least B<PTHREAD_STACK_MIN> bytes "
2101 "that was allocated by the caller. The pages of the allocated buffer should "
2102 "be both readable and writable."
2106 #: build/C/man3/pthread_attr_setstackaddr.3:74
2108 "The B<pthread_attr_getstackaddr>() function returns the stack address "
2109 "attribute of the thread attributes object referred to by I<attr> in the "
2110 "buffer pointed to by I<stackaddr>."
2114 #: build/C/man3/pthread_attr_setstackaddr.3:81
2116 "No errors are defined (but applications should nevertheless handle a "
2117 "possible error return)."
2121 #: build/C/man3/pthread_attr_setstackaddr.3:86
2123 "POSIX.1-2001 specifies these functions but marks them as obsolete. "
2124 "POSIX.1-2008 removes the specification of these functions."
2128 #: build/C/man3/pthread_attr_setstackaddr.3:110
2130 "I<Do not use these functions!> They cannot be portably used, since they "
2131 "provide no way of specifying the direction of growth or the range of the "
2132 "stack. For example, on architectures with a stack that grows downward, "
2133 "I<stackaddr> specifies the next address past the I<highest> address of the "
2134 "allocated stack area. However, on architectures with a stack that grows "
2135 "upward, I<stackaddr> specifies the I<lowest> address in the allocated stack "
2136 "area. By contrast, the I<stackaddr> used by B<pthread_attr_setstack>(3) "
2137 "and B<pthread_attr_getstack>(3), is always a pointer to the lowest address "
2138 "in the allocated stack area (and the I<stacksize> argument specifies the "
2139 "range of the stack)."
2143 #: build/C/man3/pthread_attr_setstackaddr.3:116
2145 "B<pthread_attr_init>(3), B<pthread_attr_setstack>(3), "
2146 "B<pthread_attr_setstacksize>(3), B<pthread_create>(3), B<pthreads>(7)"
2150 #: build/C/man3/pthread_attr_setstacksize.3:26
2152 msgid "PTHREAD_ATTR_SETSTACKSIZE"
2156 #: build/C/man3/pthread_attr_setstacksize.3:26
2162 #: build/C/man3/pthread_attr_setstacksize.3:30
2164 "pthread_attr_setstacksize, pthread_attr_getstacksize - set/get stack size "
2165 "attribute in thread attributes object"
2169 #: build/C/man3/pthread_attr_setstacksize.3:38
2172 "B<int pthread_attr_setstacksize(pthread_attr_t *>I<attr>B<, size_t "
2173 ">I<stacksize>B<);>\n"
2174 "B<int pthread_attr_getstacksize(pthread_attr_t *>I<attr>B<, size_t "
2175 "*>I<stacksize>B<);>\n"
2179 #: build/C/man3/pthread_attr_setstacksize.3:49
2181 "The B<pthread_attr_setstacksize>() function sets the stack size attribute "
2182 "of the thread attributes object referred to by I<attr> to the value "
2183 "specified in I<stacksize>."
2187 #: build/C/man3/pthread_attr_setstacksize.3:53
2189 "The stack size attribute determines the minimum size (in bytes) that will be "
2190 "allocated for threads created using the thread attributes object I<attr>."
2194 #: build/C/man3/pthread_attr_setstacksize.3:61
2196 "The B<pthread_attr_getstacksize>() function returns the stack size "
2197 "attribute of the thread attributes object referred to by I<attr> in the "
2198 "buffer pointed to by I<stacksize>."
2202 #: build/C/man3/pthread_attr_setstacksize.3:67
2203 msgid "B<pthread_attr_setstacksize>() can fail with the following error:"
2207 #: build/C/man3/pthread_attr_setstacksize.3:72
2208 msgid "The stack size is less than B<PTHREAD_STACK_MIN> (16384) bytes."
2213 #: build/C/man3/pthread_attr_setstacksize.3:81
2215 "On some systems, B<pthread_attr_setstacksize>() can fail with the error "
2216 "B<EINVAL> if I<stacksize> is not a multiple of the system page size."
2220 #: build/C/man3/pthread_attr_setstacksize.3:88
2222 "For details on the default stack size of new threads, see "
2223 "B<pthread_create>(3)."
2227 #: build/C/man3/pthread_attr_setstacksize.3:91
2229 "A thread's stack size is fixed at the time of thread creation. Only the "
2230 "main thread can dynamically grow its stack."
2234 #: build/C/man3/pthread_attr_setstacksize.3:96
2236 "The B<pthread_attr_setstack>(3) function allows an application to set both "
2237 "the size and location of a caller-allocated stack that is to be used by a "
2242 #: build/C/man3/pthread_attr_setstacksize.3:108
2244 "As at glibc 2.8, if the specified I<stacksize> is not a multiple of "
2245 "B<STACK_ALIGN> (16 bytes on most architectures), it may be rounded "
2246 "I<downward>, in violation of POSIX.1-2001, which says that the allocated "
2247 "stack will be at least I<stacksize> bytes."
2251 #: build/C/man3/pthread_attr_setstacksize.3:111 build/C/man3/pthread_join.3:127
2252 msgid "See B<pthread_create>(3)."
2256 #: build/C/man3/pthread_attr_setstacksize.3:118
2258 "B<getrlimit>(2), B<pthread_attr_init>(3), B<pthread_attr_setguardsize>(3), "
2259 "B<pthread_attr_setstack>(3), B<pthread_create>(3), B<pthreads>(7)"
2263 #: build/C/man3/pthread_cancel.3:26
2265 msgid "PTHREAD_CANCEL"
2269 #: build/C/man3/pthread_cancel.3:26 build/C/man3/pthread_setschedparam.3:26
2275 #: build/C/man3/pthread_cancel.3:29
2276 msgid "pthread_cancel - send a cancellation request to a thread"
2280 #: build/C/man3/pthread_cancel.3:34
2282 msgid "B<int pthread_cancel(pthread_t >I<thread>B<);>\n"
2286 #: build/C/man3/pthread_cancel.3:49
2288 "The B<pthread_cancel>() function sends a cancellation request to the thread "
2289 "I<thread>. Whether and when the target thread reacts to the cancellation "
2290 "request depends on two attributes that are under the control of that thread: "
2291 "its cancelability I<state> and I<type>."
2295 #: build/C/man3/pthread_cancel.3:61
2297 "A thread's cancelability state, determined by B<pthread_setcancelstate>(3), "
2298 "can be I<enabled> (the default for new threads) or I<disabled>. If a thread "
2299 "has disabled cancellation, then a cancellation request remains queued until "
2300 "the thread enables cancellation. If a thread has enabled cancellation, then "
2301 "its cancelability type determines when cancellation occurs."
2305 #: build/C/man3/pthread_cancel.3:77
2307 "A thread's cancellation type, determined by B<pthread_setcanceltype>(3), may "
2308 "be either I<asynchronous> or I<deferred> (the default for new threads). "
2309 "Asynchronous cancelability means that the thread can be canceled at any time "
2310 "(usually immediately, but the system does not guarantee this). Deferred "
2311 "cancelability means that cancellation will be delayed until the thread next "
2312 "calls a function that is a I<cancellation point>. A list of functions that "
2313 "are or may be cancellation points is provided in B<pthreads>(7)."
2317 #: build/C/man3/pthread_cancel.3:81
2319 "When a cancellation requested is acted on, the following steps occur for "
2320 "I<thread> (in this order):"
2324 #: build/C/man3/pthread_cancel.3:81 build/C/man3/pthread_cleanup_push.3:69
2330 #: build/C/man3/pthread_cancel.3:86
2332 "Cancellation clean-up handlers are popped (in the reverse of the order in "
2333 "which they were pushed) and called. (See B<pthread_cleanup_push>(3).)"
2337 #: build/C/man3/pthread_cancel.3:86 build/C/man3/pthread_cleanup_push.3:73
2343 #: build/C/man3/pthread_cancel.3:91
2345 "Thread-specific data destructors are called, in an unspecified order. (See "
2346 "B<pthread_key_create>(3).)"
2350 #: build/C/man3/pthread_cancel.3:91 build/C/man3/pthread_cleanup_push.3:83
2356 #: build/C/man3/pthread_cancel.3:95
2357 msgid "The thread is terminated. (See B<pthread_exit>(3).)"
2361 #: build/C/man3/pthread_cancel.3:103
2363 "The above steps happen asynchronously with respect to the "
2364 "B<pthread_cancel>() call; the return status of B<pthread_cancel>() merely "
2365 "informs the caller whether the cancellation request was successfully queued."
2369 #: build/C/man3/pthread_cancel.3:112
2371 "After a canceled thread has terminated, a join with that thread using "
2372 "B<pthread_join>(3) obtains B<PTHREAD_CANCELED> as the thread's exit "
2373 "status. (Joining with a thread is the only way to know that cancellation "
2378 #: build/C/man3/pthread_cancel.3:117
2380 "On success, B<pthread_cancel>() returns 0; on error, it returns a nonzero "
2385 #: build/C/man3/pthread_cancel.3:118 build/C/man3/pthread_detach.3:59 build/C/man3/pthread_getcpuclockid.3:58 build/C/man3/pthread_join.3:93 build/C/man3/pthread_setaffinity_np.3:114 build/C/man3/pthread_setschedparam.3:114 build/C/man3/pthread_setschedprio.3:70 build/C/man3/pthread_sigqueue.3:85
2391 #: build/C/man3/pthread_cancel.3:125 build/C/man3/pthread_detach.3:64 build/C/man3/pthread_getcpuclockid.3:63 build/C/man3/pthread_join.3:98 build/C/man3/pthread_setaffinity_np.3:119 build/C/man3/pthread_setschedparam.3:119 build/C/man3/pthread_setschedprio.3:75
2392 msgid "No thread with the ID I<thread> could be found."
2396 #: build/C/man3/pthread_cancel.3:135
2398 "On Linux, cancellation is implemented using signals. Under the NPTL "
2399 "threading implementation, the first real-time signal (i.e., signal 32) is "
2400 "used for this purpose. On LinuxThreads, the second real-time signal is "
2401 "used, if real-time signals are available, otherwise B<SIGUSR2> is used."
2405 #: build/C/man3/pthread_cancel.3:141
2407 "The program below creates a thread and then cancels it. The main thread "
2408 "joins with the canceled thread to check that its exit status was "
2409 "B<PTHREAD_CANCELED>. The following shell session shows what happens when we "
2414 #: build/C/man3/pthread_cancel.3:149
2418 "thread_func(): started; cancellation disabled\n"
2419 "main(): sending cancellation request\n"
2420 "thread_func(): about to enable cancellation\n"
2421 "main(): thread was canceled\n"
2425 #: build/C/man3/pthread_cancel.3:159
2428 "#include E<lt>pthread.hE<gt>\n"
2429 "#include E<lt>stdio.hE<gt>\n"
2430 "#include E<lt>errno.hE<gt>\n"
2431 "#include E<lt>stdlib.hE<gt>\n"
2432 "#include E<lt>unistd.hE<gt>\n"
2436 #: build/C/man3/pthread_cancel.3:167
2440 "thread_func(void *ignored_argument)\n"
2446 #: build/C/man3/pthread_cancel.3:170
2449 " /* Disable cancellation for a while, so that we don\\(aqt\n"
2450 " immediately react to a cancellation request */\n"
2454 #: build/C/man3/pthread_cancel.3:174
2457 " s = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);\n"
2459 " handle_error_en(s, \"pthread_setcancelstate\");\n"
2463 #: build/C/man3/pthread_cancel.3:178
2466 " printf(\"thread_func(): started; cancellation disabled\\en\");\n"
2468 " printf(\"thread_func(): about to enable cancellation\\en\");\n"
2472 #: build/C/man3/pthread_cancel.3:182
2475 " s = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);\n"
2477 " handle_error_en(s, \"pthread_setcancelstate\");\n"
2481 #: build/C/man3/pthread_cancel.3:184
2483 msgid " /* sleep() is a cancellation point */\n"
2487 #: build/C/man3/pthread_cancel.3:186
2489 msgid " sleep(1000); /* Should get canceled while we sleep */\n"
2493 #: build/C/man3/pthread_cancel.3:188
2495 msgid " /* Should never get here */\n"
2499 #: build/C/man3/pthread_cancel.3:192
2502 " printf(\"thread_func(): not canceled!\\en\");\n"
2508 #: build/C/man3/pthread_cancel.3:199
2520 #: build/C/man3/pthread_cancel.3:201
2522 msgid " /* Start a thread and then send it a cancellation request */\n"
2526 #: build/C/man3/pthread_cancel.3:205
2529 " s = pthread_create(&thr, NULL, &thread_func, NULL);\n"
2531 " handle_error_en(s, \"pthread_create\");\n"
2535 #: build/C/man3/pthread_cancel.3:207
2537 msgid " sleep(2); /* Give thread a chance to get started */\n"
2541 #: build/C/man3/pthread_cancel.3:212
2544 " printf(\"main(): sending cancellation request\\en\");\n"
2545 " s = pthread_cancel(thr);\n"
2547 " handle_error_en(s, \"pthread_cancel\");\n"
2551 #: build/C/man3/pthread_cancel.3:214
2553 msgid " /* Join with thread to see what its exit status was */\n"
2557 #: build/C/man3/pthread_cancel.3:218 build/C/man3/pthread_cleanup_push.3:307
2560 " s = pthread_join(thr, &res);\n"
2562 " handle_error_en(s, \"pthread_join\");\n"
2566 #: build/C/man3/pthread_cancel.3:225
2569 " if (res == PTHREAD_CANCELED)\n"
2570 " printf(\"main(): thread was canceled\\en\");\n"
2572 " printf(\"main(): thread wasn\\(aqt canceled (shouldn\\(aqt "
2573 "happen!)\\en\");\n"
2574 " exit(EXIT_SUCCESS);\n"
2579 #: build/C/man3/pthread_cancel.3:238
2581 "B<pthread_cleanup_push>(3), B<pthread_create>(3), B<pthread_exit>(3), "
2582 "B<pthread_join>(3), B<pthread_key_create>(3), B<pthread_setcancelstate>(3), "
2583 "B<pthread_setcanceltype>(3), B<pthread_testcancel>(3), B<pthreads>(7)"
2587 #: build/C/man3/pthread_cleanup_push.3:26
2589 msgid "PTHREAD_CLEANUP_PUSH"
2593 #: build/C/man3/pthread_cleanup_push.3:26 build/C/man3/pthread_setcancelstate.3:26
2599 #: build/C/man3/pthread_cleanup_push.3:30
2601 "pthread_cleanup_push, pthread_cleanup_pop - push and pop thread cancellation "
2606 #: build/C/man3/pthread_cleanup_push.3:37
2609 "B<void pthread_cleanup_push(void (*>I<routine>B<)(void *),>\n"
2610 "B< void *>I<arg>B<);>\n"
2611 "B<void pthread_cleanup_pop(int >I<execute>B<);>\n"
2615 #: build/C/man3/pthread_cleanup_push.3:48
2617 "These functions manipulate the calling thread's stack of thread-cancellation "
2618 "clean-up handlers. A clean-up handler is a function that is automatically "
2619 "executed when a thread is canceled (or in various other circumstances "
2620 "described below); it might, for example, unlock a mutex so that it becomes "
2621 "available to other threads in the process."
2625 #: build/C/man3/pthread_cleanup_push.3:59
2627 "The B<pthread_cleanup_push>() function pushes I<routine> onto the top of "
2628 "the stack of clean-up handlers. When I<routine> is later invoked, it will "
2629 "be given I<arg> as its argument."
2633 #: build/C/man3/pthread_cleanup_push.3:66
2635 "The B<pthread_cleanup_pop>() function removes the routine at the top of the "
2636 "stack of clean-up handlers, and optionally executes it if I<execute> is "
2641 #: build/C/man3/pthread_cleanup_push.3:69
2643 "A cancellation clean-up handler is popped from the stack and executed in the "
2644 "following circumstances:"
2648 #: build/C/man3/pthread_cleanup_push.3:73
2650 "When a thread is canceled, all of the stacked clean-up handlers are popped "
2651 "and executed in the reverse of the order in which they were pushed onto the "
2656 #: build/C/man3/pthread_cleanup_push.3:83
2658 "When a thread terminates by calling B<pthread_exit>(3), all clean-up "
2659 "handlers are executed as described in the preceding point. (Clean-up "
2660 "handlers are I<not> called if the thread terminates by performing a "
2661 "I<return> from the thread start function.)"
2665 #: build/C/man3/pthread_cleanup_push.3:89
2667 "When a thread calls B<pthread_cleanup_pop>() with a nonzero I<execute> "
2668 "argument, the top-most clean-up handler is popped and executed."
2672 #: build/C/man3/pthread_cleanup_push.3:101
2674 "POSIX.1 permits B<pthread_cleanup_push>() and B<pthread_cleanup_pop>() to "
2675 "be implemented as macros that expand to text containing \\(aqB<{>\\(aq and "
2676 "\\(aqB<}>\\(aq, respectively. For this reason, the caller must ensure that "
2677 "calls to these functions are paired within the same function, and at the "
2678 "same lexical nesting level. (In other words, a clean-up handler is "
2679 "established only during the execution of a specified section of code.)"
2683 #: build/C/man3/pthread_cleanup_push.3:121
2685 "Calling B<longjmp>(3) (B<siglongjmp>(3)) produces undefined results if any "
2686 "call has been made to B<pthread_cleanup_push>() or B<pthread_cleanup_pop>() "
2687 "without the matching call of the pair since the jump buffer was filled by "
2688 "B<setjmp>(3) (B<sigsetjmp>(3)). Likewise, calling B<longjmp>(3) "
2689 "(B<siglongjmp>(3)) from inside a clean-up handler produces undefined "
2690 "results unless the jump buffer was also filled by B<setjmp>(3) "
2691 "(B<sigsetjmp>(3)) inside the handler."
2695 #: build/C/man3/pthread_cleanup_push.3:123
2696 msgid "These functions do not return a value."
2700 #. Available since glibc 2.0
2702 #: build/C/man3/pthread_cleanup_push.3:127
2703 msgid "There are no errors."
2707 #: build/C/man3/pthread_cleanup_push.3:140
2709 "On Linux, the B<pthread_cleanup_push>() and B<pthread_cleanup_pop>() "
2710 "functions I<are> implemented as macros that expand to text containing "
2711 "\\(aqB<{>\\(aq and \\(aqB<}>\\(aq, respectively. This means that variables "
2712 "declared within the scope of paired calls to these functions will be visible "
2713 "within only that scope."
2716 #. The text was actually added in the 2004 TC2
2718 #: build/C/man3/pthread_cleanup_push.3:155
2720 "POSIX.1 says that the effect of using I<return>, I<break>, I<continue>, or "
2721 "I<goto> to prematurely leave a block bracketed B<pthread_cleanup_push>() "
2722 "and B<pthread_cleanup_pop>() is undefined. Portable applications should "
2727 #: build/C/man3/pthread_cleanup_push.3:170
2729 "The program below provides a simple example of the use of the functions "
2730 "described in this page. The program creates a thread that executes a loop "
2731 "bracketed by B<pthread_cleanup_push>() and B<pthread_cleanup_pop>(). This "
2732 "loop increments a global variable, I<cnt>, once each second. Depending on "
2733 "what command-line arguments are supplied, the main thread sends the other "
2734 "thread a cancellation request, or sets a global variable that causes the "
2735 "other thread to exit its loop and terminate normally (by doing a I<return>)."
2739 #: build/C/man3/pthread_cleanup_push.3:173
2741 "In the following shell session, the main thread sends a cancellation request "
2742 "to the other thread:"
2746 #: build/C/man3/pthread_cleanup_push.3:183
2750 "New thread started\n"
2753 "Canceling thread\n"
2754 "Called clean-up handler\n"
2755 "Thread was canceled; cnt = 0\n"
2759 #: build/C/man3/pthread_cleanup_push.3:191
2761 "From the above, we see that the thread was canceled, and that the "
2762 "cancellation clean-up handler was called and it reset the value of the "
2763 "global variable I<cnt> to 0."
2767 #: build/C/man3/pthread_cleanup_push.3:194
2769 "In the next run, the main program sets a global variable that causes other "
2770 "thread to terminate normally:"
2774 #: build/C/man3/pthread_cleanup_push.3:202
2778 "New thread started\n"
2781 "Thread terminated normally; cnt = 2\n"
2785 #: build/C/man3/pthread_cleanup_push.3:210
2787 "From the above, we see that the clean-up handler was not executed (because "
2788 "I<cleanup_pop_arg> was 0), and therefore the value of I<cnt> was not reset."
2792 #: build/C/man3/pthread_cleanup_push.3:215
2794 "In the next run, the main program sets a global variable that causes the "
2795 "other thread to terminate normally, and supplies a nonzero value for "
2796 "I<cleanup_pop_arg>:"
2800 #: build/C/man3/pthread_cleanup_push.3:224
2803 "$ B<./a.out x 1>\n"
2804 "New thread started\n"
2807 "Called clean-up handler\n"
2808 "Thread terminated normally; cnt = 0\n"
2812 #: build/C/man3/pthread_cleanup_push.3:231
2814 "In the above, we see that although the thread was not canceled, the clean-up "
2815 "handler was executed, because the argument given to B<pthread_cleanup_pop>() "
2820 #: build/C/man3/pthread_cleanup_push.3:240
2823 "#include E<lt>pthread.hE<gt>\n"
2824 "#include E<lt>sys/types.hE<gt>\n"
2825 "#include E<lt>stdio.hE<gt>\n"
2826 "#include E<lt>stdlib.hE<gt>\n"
2827 "#include E<lt>unistd.hE<gt>\n"
2828 "#include E<lt>errno.hE<gt>\n"
2832 #: build/C/man3/pthread_cleanup_push.3:247
2835 "static int done = 0;\n"
2836 "static int cleanup_pop_arg = 0;\n"
2837 "static int cnt = 0;\n"
2841 #: build/C/man3/pthread_cleanup_push.3:254
2845 "cleanup_handler(void *arg)\n"
2847 " printf(\"Called clean-up handler\\en\");\n"
2853 #: build/C/man3/pthread_cleanup_push.3:259
2857 "thread_start(void *arg)\n"
2859 " time_t start, curr;\n"
2863 #: build/C/man3/pthread_cleanup_push.3:261
2865 msgid " printf(\"New thread started\\en\");\n"
2869 #: build/C/man3/pthread_cleanup_push.3:263
2871 msgid " pthread_cleanup_push(cleanup_handler, NULL);\n"
2875 #: build/C/man3/pthread_cleanup_push.3:265
2877 msgid " curr = start = time(NULL);\n"
2881 #: build/C/man3/pthread_cleanup_push.3:274
2884 " while (!done) {\n"
2885 " pthread_testcancel(); /* A cancellation point */\n"
2886 " if (curr E<lt> time(NULL)) {\n"
2887 " curr = time(NULL);\n"
2888 " printf(\"cnt = %d\\en\", cnt); /* A cancellation point */\n"
2895 #: build/C/man3/pthread_cleanup_push.3:278
2898 " pthread_cleanup_pop(cleanup_pop_arg);\n"
2904 #: build/C/man3/pthread_cleanup_push.3:285
2908 "main(int argc, char *argv[])\n"
2916 #: build/C/man3/pthread_cleanup_push.3:289
2919 " s = pthread_create(&thr, NULL, thread_start, NULL);\n"
2921 " handle_error_en(s, \"pthread_create\");\n"
2925 #: build/C/man3/pthread_cleanup_push.3:291
2927 msgid " sleep(2); /* Allow new thread to run a while */\n"
2931 #: build/C/man3/pthread_cleanup_push.3:296
2934 " if (argc E<gt> 1) {\n"
2935 " if (argc E<gt> 2)\n"
2936 " cleanup_pop_arg = atoi(argv[2]);\n"
2941 #: build/C/man3/pthread_cleanup_push.3:303
2945 " printf(\"Canceling thread\\en\");\n"
2946 " s = pthread_cancel(thr);\n"
2948 " handle_error_en(s, \"pthread_cancel\");\n"
2953 #: build/C/man3/pthread_cleanup_push.3:314
2956 " if (res == PTHREAD_CANCELED)\n"
2957 " printf(\"Thread was canceled; cnt = %d\\en\", cnt);\n"
2959 " printf(\"Thread terminated normally; cnt = %d\\en\", cnt);\n"
2960 " exit(EXIT_SUCCESS);\n"
2965 #: build/C/man3/pthread_cleanup_push.3:321
2967 "B<pthread_cancel>(3), B<pthread_cleanup_push_defer_np>(3), "
2968 "B<pthread_setcancelstate>(3), B<pthread_testcancel>(3), B<pthreads>(7)"
2972 #: build/C/man3/pthread_cleanup_push_defer_np.3:26
2974 msgid "PTHREAD_CLEANUP_PUSH_DEFER_NP"
2978 #: build/C/man3/pthread_cleanup_push_defer_np.3:26
2984 #: build/C/man3/pthread_cleanup_push_defer_np.3:30
2986 "pthread_cleanup_push_defer_np, pthread_cleanup_pop_restore_np - push and pop "
2987 "thread cancellation clean-up handlers while saving cancelability type"
2991 #: build/C/man3/pthread_cleanup_push_defer_np.3:37
2994 "B<void pthread_cleanup_push_defer_np(void (*>I<routine>B<)(void *),>\n"
2995 "B< void *>I<arg>B<);>\n"
2996 "B<void pthread_cleanup_pop_restore_np(int >I<execute>B<);>\n"
3000 #: build/C/man3/pthread_cleanup_push_defer_np.3:40 build/C/man3/pthread_create.3:38 build/C/man3/pthread_detach.3:37 build/C/man3/pthread_join.3:37 build/C/man3/pthread_kill.3:37 build/C/man3/pthread_setname_np.3:39 build/C/man3/pthread_sigmask.3:38 build/C/man3/pthread_sigqueue.3:37 build/C/man3/pthread_tryjoin_np.3:42 build/C/man3/pthread_yield.3:37
3001 msgid "Compile and link with I<-pthread>."
3005 #: build/C/man3/pthread_cleanup_push_defer_np.3:46
3007 "These functions are the same as B<pthread_cleanup_push>(3) and "
3008 "B<pthread_cleanup_pop>(3), except for the differences noted on this page."
3012 #: build/C/man3/pthread_cleanup_push_defer_np.3:59
3014 "Like B<pthread_cleanup_push>(3), B<pthread_cleanup_push_defer_np>() pushes "
3015 "I<routine> onto the thread's stack of cancellation clean-up handlers. In "
3016 "addition, it also saves the thread's current cancelability type, and sets "
3017 "the cancelability type to \"deferred\" (see B<pthread_setcanceltype>(3)); "
3018 "this ensures that cancellation clean-up will occur even if the thread's "
3019 "cancelability type was \"asynchronous\" before the call."
3023 #: build/C/man3/pthread_cleanup_push_defer_np.3:68
3025 "Like B<pthread_cleanup_pop>(3), B<pthread_cleanup_pop_restore_np>() pops "
3026 "the top-most clean-up handler from the thread's stack of cancellation "
3027 "clean-up handlers. In addition, it restores the thread's cancelability type "
3028 "to its value at the time of the matching B<pthread_cleanup_push_defer_np>()."
3032 #: build/C/man3/pthread_cleanup_push_defer_np.3:74
3034 "The caller must ensure that calls to these functions are paired within the "
3035 "same function, and at the same lexical nesting level. Other restrictions "
3036 "apply, as described in B<pthread_cleanup_push>(3)."
3040 #: build/C/man3/pthread_cleanup_push_defer_np.3:76
3041 msgid "This sequence of calls:"
3045 #: build/C/man3/pthread_cleanup_push_defer_np.3:81
3048 "pthread_cleanup_push_defer_np(routine, arg);\n"
3049 "pthread_cleanup_pop_restore_np(execute);\n"
3053 #: build/C/man3/pthread_cleanup_push_defer_np.3:85
3054 msgid "is equivalent to (but shorter and more efficient than):"
3058 #: build/C/man3/pthread_cleanup_push_defer_np.3:91
3060 msgid "int oldtype;\n"
3064 #: build/C/man3/pthread_cleanup_push_defer_np.3:97
3067 "pthread_cleanup_push(routine, arg);\n"
3068 "pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldtype);\n"
3070 "pthread_setcanceltype(oldtype, NULL);\n"
3071 "pthread_cleanup_pop(execute);\n"
3075 #: build/C/man3/pthread_cleanup_push_defer_np.3:110
3077 "B<pthread_cancel>(3), B<pthread_cleanup_push>(3), "
3078 "B<pthread_setcancelstate>(3), B<pthread_testcancel>(3), B<pthreads>(7)"
3082 #: build/C/man3/pthread_create.3:26
3084 msgid "PTHREAD_CREATE"
3088 #: build/C/man3/pthread_create.3:26
3094 #: build/C/man3/pthread_create.3:29
3095 msgid "pthread_create - create a new thread"
3099 #: build/C/man3/pthread_create.3:35
3102 "B<int pthread_create(pthread_t *>I<thread>B<, const pthread_attr_t "
3104 "B< void *(*>I<start_routine>B<) (void *), void "
3109 #: build/C/man3/pthread_create.3:47
3111 "The B<pthread_create>() function starts a new thread in the calling "
3112 "process. The new thread starts execution by invoking I<start_routine>(); "
3113 "I<arg> is passed as the sole argument of I<start_routine>()."
3117 #: build/C/man3/pthread_create.3:49
3118 msgid "The new thread terminates in one of the following ways:"
3122 #: build/C/man3/pthread_create.3:49 build/C/man3/pthread_create.3:55 build/C/man3/pthread_create.3:63 build/C/man3/pthread_create.3:66 build/C/man3/pthread_getattr_np.3:52 build/C/man3/pthread_getattr_np.3:55 build/C/man3/pthread_getattr_np.3:58
3128 #: build/C/man3/pthread_create.3:55
3130 "It calls B<pthread_exit>(3), specifying an exit status value that is "
3131 "available to another thread in the same process that calls "
3132 "B<pthread_join>(3)."
3136 #: build/C/man3/pthread_create.3:63
3138 "It returns from I<start_routine>(). This is equivalent to calling "
3139 "B<pthread_exit>(3) with the value supplied in the I<return> statement."
3143 #: build/C/man3/pthread_create.3:66
3144 msgid "It is canceled (see B<pthread_cancel>(3))."
3148 #: build/C/man3/pthread_create.3:72
3150 "Any of the threads in the process calls B<exit>(3), or the main thread "
3151 "performs a return from I<main>(). This causes the termination of all "
3152 "threads in the process."
3156 #: build/C/man3/pthread_create.3:86
3158 "The I<attr> argument points to a I<pthread_attr_t> structure whose contents "
3159 "are used at thread creation time to determine attributes for the new thread; "
3160 "this structure is initialized using B<pthread_attr_init>(3) and related "
3161 "functions. If I<attr> is NULL, then the thread is created with default "
3166 #: build/C/man3/pthread_create.3:93
3168 "Before returning, a successful call to B<pthread_create>() stores the ID of "
3169 "the new thread in the buffer pointed to by I<thread>; this identifier is "
3170 "used to refer to the thread in subsequent calls to other pthreads functions."
3174 #: build/C/man3/pthread_create.3:101
3176 "The new thread inherits a copy of the creating thread's signal mask "
3177 "(B<pthread_sigmask>(3)). The set of pending signals for the new thread is "
3178 "empty (B<sigpending>(2)). The new thread does not inherit the creating "
3179 "thread's alternate signal stack (B<sigaltstack>(2))."
3183 #: build/C/man3/pthread_create.3:104
3185 "The new thread inherits the calling thread's floating-point environment "
3189 #. CLOCK_THREAD_CPUTIME_ID in clock_gettime(2)
3191 #: build/C/man3/pthread_create.3:109
3193 "The initial value of the new thread's CPU-time clock is 0 (see "
3194 "B<pthread_getcpuclockid>(3))."
3198 #: build/C/man3/pthread_create.3:109
3200 msgid "Linux-specific details"
3204 #: build/C/man3/pthread_create.3:115
3206 "The new thread inherits copies of the calling thread's capability sets (see "
3207 "B<capabilities>(7)) and CPU affinity mask (see B<sched_setaffinity>(2))."
3211 #: build/C/man3/pthread_create.3:122
3213 "On success, B<pthread_create>() returns 0; on error, it returns an error "
3214 "number, and the contents of I<*thread> are undefined."
3218 #: build/C/man3/pthread_create.3:123 build/C/man3/pthread_sigqueue.3:71
3224 #: build/C/man3/pthread_create.3:137
3226 "Insufficient resources to create another thread, or a system-imposed limit "
3227 "on the number of threads was encountered. The latter case may occur in two "
3228 "ways: the B<RLIMIT_NPROC> soft resource limit (set via B<setrlimit>(2)), "
3229 "which limits the number of process for a real user ID, was reached; or the "
3230 "kernel's system-wide limit on the number of threads, "
3231 "I</proc/sys/kernel/threads-max>, was reached."
3235 #: build/C/man3/pthread_create.3:141
3236 msgid "Invalid settings in I<attr>."
3240 #: build/C/man3/pthread_create.3:141 build/C/man3/pthread_setschedparam.3:129 build/C/man3/pthread_setschedprio.3:66
3246 #: build/C/man3/pthread_create.3:146
3248 "No permission to set the scheduling policy and parameters specified in "
3253 #: build/C/man3/pthread_create.3:160
3255 "See B<pthread_self>(3) for further information on the thread ID returned in "
3256 "I<*thread> by B<pthread_create>(). Unless real-time scheduling policies are "
3257 "being employed, after a call to B<pthread_create>(), it is indeterminate "
3258 "which thread\\(emthe caller or the new thread\\(emwill next execute."
3262 #: build/C/man3/pthread_create.3:180
3264 "A thread may either be I<joinable> or I<detached>. If a thread is joinable, "
3265 "then another thread can call B<pthread_join>(3) to wait for the thread to "
3266 "terminate and fetch its exit status. Only when a terminated joinable thread "
3267 "has been joined are the last of its resources released back to the system. "
3268 "When a detached thread terminates, its resources are automatically released "
3269 "back to the system: it is not possible to join with the thread in order to "
3270 "obtain its exit status. Making a thread detached is useful for some types "
3271 "of daemon threads whose exit status the application does not need to care "
3272 "about. By default, a new thread is created in a joinable state, unless "
3273 "I<attr> was set to create the thread in a detached state (using "
3274 "B<pthread_attr_setdetachstate>(3))."
3277 #. FIXME . Perhaps some of the following detail should be in
3278 #. a future pthread_attr_setstacksize(3) page.
3280 #: build/C/man3/pthread_create.3:196
3282 "On Linux/x86-32, the default stack size for a new thread is 2 megabytes. "
3283 "Under the NPTL threading implementation, if the B<RLIMIT_STACK> soft "
3284 "resource limit I<at the time the program started> has any value other than "
3285 "\"unlimited\", then it determines the default stack size of new threads. "
3286 "Using B<pthread_attr_setstacksize>(3), the stack size attribute can be "
3287 "explicitly set in the I<attr> argument used to create a thread, in order to "
3288 "obtain a stack size other than the default."
3292 #: build/C/man3/pthread_create.3:202
3294 "In the obsolete LinuxThreads implementation, each of the threads in a "
3295 "process has a different process ID. This is in violation of the POSIX "
3296 "threads specification, and is the source of many other nonconformances to "
3297 "the standard; see B<pthreads>(7)."
3301 #: build/C/man3/pthread_create.3:206
3303 "The program below demonstrates the use of B<pthread_create>(), as well as a "
3304 "number of other functions in the pthreads API."
3308 #: build/C/man3/pthread_create.3:211
3310 "In the following run, on a system providing the NPTL threading "
3311 "implementation, the stack size defaults to the value given by the \"stack "
3312 "size\" resource limit:"
3316 #: build/C/man3/pthread_create.3:223
3320 "8192 # The stack size limit is 8 MB (0x800000 bytes)\n"
3321 "$B< ./a.out hola salut servus>\n"
3322 "Thread 1: top of stack near 0xb7dd03b8; argv_string=hola\n"
3323 "Thread 2: top of stack near 0xb75cf3b8; argv_string=salut\n"
3324 "Thread 3: top of stack near 0xb6dce3b8; argv_string=servus\n"
3325 "Joined with thread 1; returned value was HOLA\n"
3326 "Joined with thread 2; returned value was SALUT\n"
3327 "Joined with thread 3; returned value was SERVUS\n"
3331 #: build/C/man3/pthread_create.3:229
3333 "In the next run, the program explicitly sets a stack size of 1MB (using "
3334 "B<pthread_attr_setstacksize>(3)) for the created threads:"
3338 #: build/C/man3/pthread_create.3:239
3341 "$B< ./a.out -s 0x100000 hola salut servus>\n"
3342 "Thread 1: top of stack near 0xb7d723b8; argv_string=hola\n"
3343 "Thread 2: top of stack near 0xb7c713b8; argv_string=salut\n"
3344 "Thread 3: top of stack near 0xb7b703b8; argv_string=servus\n"
3345 "Joined with thread 1; returned value was HOLA\n"
3346 "Joined with thread 2; returned value was SALUT\n"
3347 "Joined with thread 3; returned value was SERVUS\n"
3351 #: build/C/man3/pthread_create.3:251
3354 "#include E<lt>pthread.hE<gt>\n"
3355 "#include E<lt>string.hE<gt>\n"
3356 "#include E<lt>stdio.hE<gt>\n"
3357 "#include E<lt>stdlib.hE<gt>\n"
3358 "#include E<lt>unistd.hE<gt>\n"
3359 "#include E<lt>errno.hE<gt>\n"
3360 "#include E<lt>ctype.hE<gt>\n"
3364 #: build/C/man3/pthread_create.3:257 build/C/man3/pthread_getcpuclockid.3:111
3367 "#define handle_error(msg) \\e\n"
3368 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
3372 #: build/C/man3/pthread_create.3:263
3375 "struct thread_info { /* Used as argument to thread_start() */\n"
3376 " pthread_t thread_id; /* ID returned by pthread_create() */\n"
3377 " int thread_num; /* Application-defined thread # */\n"
3378 " char *argv_string; /* From command-line argument */\n"
3383 #: build/C/man3/pthread_create.3:266
3386 "/* Thread start function: display address near top of our stack,\n"
3387 " and return upper-cased copy of argv_string */\n"
3391 #: build/C/man3/pthread_create.3:272
3395 "thread_start(void *arg)\n"
3397 " struct thread_info *tinfo = arg;\n"
3398 " char *uargv, *p;\n"
3402 #: build/C/man3/pthread_create.3:275
3405 " printf(\"Thread %d: top of stack near %p; argv_string=%s\\en\",\n"
3406 " tinfo-E<gt>thread_num, &p, tinfo-E<gt>argv_string);\n"
3410 #: build/C/man3/pthread_create.3:279
3413 " uargv = strdup(tinfo-E<gt>argv_string);\n"
3414 " if (uargv == NULL)\n"
3415 " handle_error(\"strdup\");\n"
3419 #: build/C/man3/pthread_create.3:282
3422 " for (p = uargv; *p != \\(aq\\e0\\(aq; p++)\n"
3423 " *p = toupper(*p);\n"
3427 #: build/C/man3/pthread_create.3:285
3435 #: build/C/man3/pthread_create.3:294
3439 "main(int argc, char *argv[])\n"
3441 " int s, tnum, opt, num_threads;\n"
3442 " struct thread_info *tinfo;\n"
3443 " pthread_attr_t attr;\n"
3444 " int stack_size;\n"
3449 #: build/C/man3/pthread_create.3:296
3451 msgid " /* The \"-s\" option specifies a stack size for our threads */\n"
3455 #: build/C/man3/pthread_create.3:303
3458 " stack_size = -1;\n"
3459 " while ((opt = getopt(argc, argv, \"s:\")) != -1) {\n"
3461 " case \\(aqs\\(aq:\n"
3462 " stack_size = strtoul(optarg, NULL, 0);\n"
3467 #: build/C/man3/pthread_create.3:310
3471 " fprintf(stderr, \"Usage: %s [-s stack-size] arg...\\en\",\n"
3473 " exit(EXIT_FAILURE);\n"
3479 #: build/C/man3/pthread_create.3:312
3481 msgid " num_threads = argc - optind;\n"
3485 #: build/C/man3/pthread_create.3:314
3487 msgid " /* Initialize thread creation attributes */\n"
3491 #: build/C/man3/pthread_create.3:318
3494 " s = pthread_attr_init(&attr);\n"
3496 " handle_error_en(s, \"pthread_attr_init\");\n"
3500 #: build/C/man3/pthread_create.3:324
3503 " if (stack_size E<gt> 0) {\n"
3504 " s = pthread_attr_setstacksize(&attr, stack_size);\n"
3506 " handle_error_en(s, \"pthread_attr_setstacksize\");\n"
3511 #: build/C/man3/pthread_create.3:326
3513 msgid " /* Allocate memory for pthread_create() arguments */\n"
3517 #: build/C/man3/pthread_create.3:330
3520 " tinfo = calloc(num_threads, sizeof(struct thread_info));\n"
3521 " if (tinfo == NULL)\n"
3522 " handle_error(\"calloc\");\n"
3526 #: build/C/man3/pthread_create.3:332
3528 msgid " /* Create one thread for each command-line argument */\n"
3532 #: build/C/man3/pthread_create.3:336
3535 " for (tnum = 0; tnum E<lt> num_threads; tnum++) {\n"
3536 " tinfo[tnum].thread_num = tnum + 1;\n"
3537 " tinfo[tnum].argv_string = argv[optind + tnum];\n"
3541 #: build/C/man3/pthread_create.3:339
3544 " /* The pthread_create() call stores the thread ID into\n"
3545 " corresponding element of tinfo[] */\n"
3549 #: build/C/man3/pthread_create.3:345
3552 " s = pthread_create(&tinfo[tnum].thread_id, &attr,\n"
3553 " &thread_start, &tinfo[tnum]);\n"
3555 " handle_error_en(s, \"pthread_create\");\n"
3560 #: build/C/man3/pthread_create.3:348
3563 " /* Destroy the thread attributes object, since it is no\n"
3564 " longer needed */\n"
3568 #: build/C/man3/pthread_create.3:352 build/C/man3/pthread_setschedparam.3:423
3571 " s = pthread_attr_destroy(&attr);\n"
3573 " handle_error_en(s, \"pthread_attr_destroy\");\n"
3577 #: build/C/man3/pthread_create.3:354
3579 msgid " /* Now join with each thread, and display its returned value */\n"
3583 #: build/C/man3/pthread_create.3:359
3586 " for (tnum = 0; tnum E<lt> num_threads; tnum++) {\n"
3587 " s = pthread_join(tinfo[tnum].thread_id, &res);\n"
3589 " handle_error_en(s, \"pthread_join\");\n"
3593 #: build/C/man3/pthread_create.3:364
3596 " printf(\"Joined with thread %d; returned value was %s\\en\",\n"
3597 " tinfo[tnum].thread_num, (char *) res);\n"
3598 " free(res); /* Free memory allocated by thread */\n"
3603 #: build/C/man3/pthread_create.3:368
3607 " exit(EXIT_SUCCESS);\n"
3612 #: build/C/man3/pthread_create.3:382
3614 "B<getrlimit>(2), B<pthread_attr_init>(3), B<pthread_cancel>(3), "
3615 "B<pthread_detach>(3), B<pthread_equal>(3), B<pthread_exit>(3), "
3616 "B<pthread_getattr_np>(3), B<pthread_join>(3), B<pthread_self>(3), "
3621 #: build/C/man3/pthread_detach.3:26
3623 msgid "PTHREAD_DETACH"
3627 #: build/C/man3/pthread_detach.3:26 build/C/man3/pthread_join.3:26
3633 #: build/C/man3/pthread_detach.3:29
3634 msgid "pthread_detach - detach a thread"
3638 #: build/C/man3/pthread_detach.3:34
3640 msgid "B<int pthread_detach(pthread_t >I<thread>B<);>\n"
3644 #: build/C/man3/pthread_detach.3:46
3646 "The B<pthread_detach>() function marks the thread identified by I<thread> "
3647 "as detached. When a detached thread terminates, its resources are "
3648 "automatically released back to the system without the need for another "
3649 "thread to join with the terminated thread."
3653 #: build/C/man3/pthread_detach.3:49
3655 "Attempting to detach an already detached thread results in unspecified "
3660 #: build/C/man3/pthread_detach.3:54
3662 "On success, B<pthread_detach>() returns 0; on error, it returns an error "
3667 #: build/C/man3/pthread_detach.3:59 build/C/man3/pthread_join.3:89
3668 msgid "I<thread> is not a joinable thread."
3672 #: build/C/man3/pthread_detach.3:70
3674 "Once a thread has been detached, it can't be joined with B<pthread_join>(3) "
3675 "or be made joinable again."
3679 #: build/C/man3/pthread_detach.3:77
3681 "A new thread can be created in a detached state using "
3682 "B<pthread_attr_setdetachstate>(3) to set the detached attribute of the "
3683 "I<attr> argument of B<pthread_create>(3)."
3687 #: build/C/man3/pthread_detach.3:84
3689 "The detached attribute merely determines the behavior of the system when the "
3690 "thread terminates; it does not prevent the thread from being terminated if "
3691 "the process terminates using B<exit>(3) (or equivalently, if the main "
3696 #: build/C/man3/pthread_detach.3:93
3698 "Either B<pthread_join>(3) or B<pthread_detach>() should be called for each "
3699 "thread that an application creates, so that system resources for the thread "
3700 "can be released. (But note that the resources of all threads are freed when "
3701 "the process terminates.)"
3705 #: build/C/man3/pthread_detach.3:95
3706 msgid "The following statement detaches the calling thread:"
3710 #: build/C/man3/pthread_detach.3:97
3712 msgid " pthread_detach(pthread_self());\n"
3716 #: build/C/man3/pthread_detach.3:104
3718 "B<pthread_attr_setdetachstate>(3), B<pthread_cancel>(3), "
3719 "B<pthread_create>(3), B<pthread_exit>(3), B<pthread_join>(3), B<pthreads>(7)"
3723 #: build/C/man3/pthread_equal.3:26
3725 msgid "PTHREAD_EQUAL"
3729 #: build/C/man3/pthread_equal.3:26 build/C/man3/pthread_exit.3:26
3735 #: build/C/man3/pthread_equal.3:29
3736 msgid "pthread_equal - compare thread IDs"
3740 #: build/C/man3/pthread_equal.3:34
3742 msgid "B<int pthread_equal(pthread_t >I<t1>B<, pthread_t >I<t2>B<);>\n"
3746 #: build/C/man3/pthread_equal.3:41
3747 msgid "The B<pthread_equal>() function compares two thread identifiers."
3751 #: build/C/man3/pthread_equal.3:45
3753 "If the two thread IDs are equal, B<pthread_equal>() returns a nonzero "
3754 "value; otherwise, it returns 0."
3758 #. Available since glibc 2.0
3760 #: build/C/man3/pthread_equal.3:47 build/C/man3/pthread_exit.3:75 build/C/man3/pthread_self.3:50 build/C/man3/pthread_testcancel.3:58
3761 msgid "This function always succeeds."
3765 #: build/C/man3/pthread_equal.3:56
3767 "The B<pthread_equal>() function is necessary because thread IDs should be "
3768 "considered opaque: there is no portable way for applications to directly "
3769 "compare two I<pthread_t> values."
3773 #: build/C/man3/pthread_equal.3:60
3774 msgid "B<pthread_create>(3), B<pthread_self>(3), B<pthreads>(7)"
3778 #: build/C/man3/pthread_exit.3:26
3780 msgid "PTHREAD_EXIT"
3784 #: build/C/man3/pthread_exit.3:29
3785 msgid "pthread_exit - terminate calling thread"
3789 #: build/C/man3/pthread_exit.3:34
3791 msgid "B<void pthread_exit(void *>I<retval>B<);>\n"
3795 #: build/C/man3/pthread_exit.3:45
3797 "The B<pthread_exit>() function terminates the calling thread and returns a "
3798 "value via I<retval> that (if the thread is joinable) is available to "
3799 "another thread in the same process that calls B<pthread_join>(3)."
3803 #: build/C/man3/pthread_exit.3:55
3805 "Any clean-up handlers established by B<pthread_cleanup_push>(3) that have "
3806 "not yet been popped, are popped (in the reverse of the order in which they "
3807 "were pushed) and executed. If the thread has any thread-specific data, "
3808 "then, after the clean-up handlers have been executed, the corresponding "
3809 "destructor functions are called, in an unspecified order."
3813 #: build/C/man3/pthread_exit.3:62
3815 "When a thread terminates, process-shared resources (e.g., mutexes, condition "
3816 "variables, semaphores, and file descriptors) are not released, and functions "
3817 "registered using B<atexit>(3) are not called."
3821 #: build/C/man3/pthread_exit.3:71
3823 "After the last thread in a process terminates, the process terminates as by "
3824 "calling B<exit>(3) with an exit status of zero; thus, process-shared "
3825 "resources are released and functions registered using B<atexit>(3) are "
3830 #: build/C/man3/pthread_exit.3:73
3831 msgid "This function does not return to the caller."
3835 #: build/C/man3/pthread_exit.3:82
3837 "Performing a return from the start function of any thread other than the "
3838 "main thread results in an implicit call to B<pthread_exit>(), using the "
3839 "function's return value as the thread's exit status."
3843 #: build/C/man3/pthread_exit.3:88
3845 "To allow other threads to continue execution, the main thread should "
3846 "terminate by calling B<pthread_exit>() rather than B<exit>(3)."
3850 #: build/C/man3/pthread_exit.3:93
3852 "The value pointed to by I<retval> should not be located on the calling "
3853 "thread's stack, since the contents of that stack are undefined after the "
3854 "thread terminates."
3858 #. FIXME . review a later kernel to see if this gets fixed
3859 #. http://thread.gmane.org/gmane.linux.kernel/611611
3860 #. http://marc.info/?l=linux-kernel&m=122525468300823&w=2
3862 #: build/C/man3/pthread_exit.3:105
3864 "Currently, there are limitations in the kernel implementation logic for "
3865 "B<wait>(2)ing on a stopped thread group with a dead thread group leader. "
3866 "This can manifest in problems such as a locked terminal if a stop signal is "
3867 "sent to a foreground process whose thread group leader has already called "
3868 "B<pthread_exit>()."
3872 #: build/C/man3/pthread_exit.3:109
3873 msgid "B<pthread_create>(3), B<pthread_join>(3), B<pthreads>(7)"
3877 #: build/C/man3/pthread_getattr_np.3:26
3879 msgid "PTHREAD_GETATTR_NP"
3883 #: build/C/man3/pthread_getattr_np.3:29
3884 msgid "pthread_getattr_np - get attributes of created thread"
3888 #: build/C/man3/pthread_getattr_np.3:35
3891 "B<int pthread_getattr_np(pthread_t >I<thread>B<, pthread_attr_t "
3896 #: build/C/man3/pthread_getattr_np.3:45
3898 "The B<pthread_getattr_np>() function initializes the thread attributes "
3899 "object referred to by I<attr> so that it contains actual attribute values "
3900 "describing the running thread I<thread>."
3904 #: build/C/man3/pthread_getattr_np.3:52
3906 "The returned attribute values may differ from the corresponding attribute "
3907 "values passed in the I<attr> object that was used to create the thread using "
3908 "B<pthread_create>(3). In particular, the following attributes may differ:"
3912 #: build/C/man3/pthread_getattr_np.3:55
3914 "the detach state, since a joinable thread may have detached itself after "
3919 #: build/C/man3/pthread_getattr_np.3:58
3920 msgid "the stack size, which the implementation may align to a suitable boundary."
3924 #: build/C/man3/pthread_getattr_np.3:63
3926 "and the guard size, which the implementation may round upward to a multiple "
3927 "of the page size, or ignore (i.e., treat as 0), if the application is "
3928 "allocating its own stack."
3932 #: build/C/man3/pthread_getattr_np.3:68
3934 "Furthermore, if the stack address attribute was not set in the thread "
3935 "attributes object used to create the thread, then the returned thread "
3936 "attributes object will report the actual stack address that the "
3937 "implementation selected for the thread."
3941 #: build/C/man3/pthread_getattr_np.3:73
3943 "When the thread attributes object returned by B<pthread_getattr_np>() is no "
3944 "longer required, it should be destroyed using B<pthread_attr_destroy>(3)."
3948 #: build/C/man3/pthread_getattr_np.3:76 build/C/man3/pthread_getcpuclockid.3:49
3950 "On success, this function returns 0; on error, it returns a nonzero error "
3954 #. Can happen (but unlikely) while trying to allocate memory for cpuset
3956 #: build/C/man3/pthread_getattr_np.3:81
3957 msgid "Insufficient memory."
3961 #: build/C/man3/pthread_getattr_np.3:96
3963 "In addition, if I<thread> refers to the main thread, then "
3964 "B<pthread_getattr_np>() can fail because of errors from various underlying "
3965 "calls: B<fopen>(3), if I</proc/self/maps> can't be opened; and "
3966 "B<getrlimit>(2), if the B<RLIMIT_STACK> resource limit is not supported."
3970 #: build/C/man3/pthread_getattr_np.3:98
3971 msgid "This function is available in glibc since version 2.2.3."
3975 #: build/C/man3/pthread_getattr_np.3:101 build/C/man3/pthread_kill_other_threads_np.3:50
3977 "This function is a nonstandard GNU extension; hence the suffix \"_np\" "
3978 "(nonportable) in the name."
3982 #: build/C/man3/pthread_getattr_np.3:111
3984 "The program below demonstrates the use of B<pthread_getattr_np>(). The "
3985 "program creates a thread that then uses B<pthread_getattr_np>() to retrieve "
3986 "and display its guard size, stack address, and stack size attributes. "
3987 "Command-line arguments can be used to set these attributes to values other "
3988 "than the default when creating the thread. The shell sessions below "
3989 "demonstrate the use of the program."
3993 #: build/C/man3/pthread_getattr_np.3:114
3995 "In the first run, on an x86-32 system, a thread is created using default "
4000 #: build/C/man3/pthread_getattr_np.3:124
4003 "$B< ulimit -s> # No stack limit ==E<gt> default stack size is 2MB\n"
4006 "Attributes of created thread:\n"
4007 " Guard size = 4096 bytes\n"
4008 " Stack address = 0x40196000 (EOS = 0x40397000)\n"
4009 " Stack size = 0x201000 (2101248) bytes\n"
4013 #: build/C/man3/pthread_getattr_np.3:130
4015 "In the following run, we see that if a guard size is specified, it is "
4016 "rounded up to the next multiple of the system page size (4096 bytes on "
4021 #: build/C/man3/pthread_getattr_np.3:138
4024 "$B< ./a.out -g 4097>\n"
4025 "Thread attributes object after initializations:\n"
4026 " Guard size = 4097 bytes\n"
4027 " Stack address = (nil)\n"
4028 " Stack size = 0x0 (0) bytes\n"
4032 #: build/C/man3/pthread_getattr_np.3:143
4035 "Attributes of created thread:\n"
4036 " Guard size = 8192 bytes\n"
4037 " Stack address = 0x40196000 (EOS = 0x40397000)\n"
4038 " Stack size = 0x201000 (2101248) bytes\n"
4043 #. $ ./a.out \-s 0x8000
4044 #. Thread attributes object after initializations:
4045 #. Guard size = 4096 bytes
4046 #. Stack address = 0xffff8000 (EOS = (nil))
4047 #. Stack size = 0x8000 (32768) bytes
4049 #. Attributes of created thread:
4050 #. Guard size = 4096 bytes
4051 #. Stack address = 0x4001e000 (EOS = 0x40026000)
4052 #. Stack size = 0x8000 (32768) bytes
4056 #: build/C/man3/pthread_getattr_np.3:162
4058 "In the last run, the program manually allocates a stack for the thread. In "
4059 "this case, the guard size attribute is ignored."
4063 #: build/C/man3/pthread_getattr_np.3:167
4066 "$B< ./a.out -g 4096 -s 0x8000 -a>\n"
4067 "Allocated thread stack at 0x804d000\n"
4071 #: build/C/man3/pthread_getattr_np.3:172
4074 "Thread attributes object after initializations:\n"
4075 " Guard size = 4096 bytes\n"
4076 " Stack address = 0x804d000 (EOS = 0x8055000)\n"
4077 " Stack size = 0x8000 (32768) bytes\n"
4081 #: build/C/man3/pthread_getattr_np.3:177
4084 "Attributes of created thread:\n"
4085 " Guard size = 0 bytes\n"
4086 " Stack address = 0x804d000 (EOS = 0x8055000)\n"
4087 " Stack size = 0x8000 (32768) bytes\n"
4091 #: build/C/man3/pthread_getattr_np.3:198
4095 "display_stack_related_attributes(pthread_attr_t *attr, char *prefix)\n"
4098 " size_t stack_size, guard_size;\n"
4099 " void *stack_addr;\n"
4103 #: build/C/man3/pthread_getattr_np.3:203
4106 " s = pthread_attr_getguardsize(attr, &guard_size);\n"
4108 " handle_error_en(s, \"pthread_attr_getguardsize\");\n"
4109 " printf(\"%sGuard size = %d bytes\\en\", prefix, guard_size);\n"
4113 #: build/C/man3/pthread_getattr_np.3:214
4116 " s = pthread_attr_getstack(attr, &stack_addr, &stack_size);\n"
4118 " handle_error_en(s, \"pthread_attr_getstack\");\n"
4119 " printf(\"%sStack address = %p\", prefix, stack_addr);\n"
4120 " if (stack_size E<gt> 0)\n"
4121 " printf(\" (EOS = %p)\", (char *) stack_addr + stack_size);\n"
4122 " printf(\"\\en\");\n"
4123 " printf(\"%sStack size = 0x%x (%d) bytes\\en\",\n"
4124 " prefix, stack_size, stack_size);\n"
4129 #: build/C/man3/pthread_getattr_np.3:220
4133 "display_thread_attributes(pthread_t thread, char *prefix)\n"
4136 " pthread_attr_t attr;\n"
4140 #: build/C/man3/pthread_getattr_np.3:224
4143 " s = pthread_getattr_np(thread, &attr);\n"
4145 " handle_error_en(s, \"pthread_getattr_np\");\n"
4149 #: build/C/man3/pthread_getattr_np.3:226
4151 msgid " display_stack_related_attributes(&attr, prefix);\n"
4155 #: build/C/man3/pthread_getattr_np.3:231
4158 " s = pthread_attr_destroy(&attr);\n"
4160 " handle_error_en(s, \"pthread_attr_destroy\");\n"
4165 #: build/C/man3/pthread_getattr_np.3:237
4168 "static void * /* Start function for thread we create */\n"
4169 "thread_start(void *arg)\n"
4171 " printf(\"Attributes of created thread:\\en\");\n"
4172 " display_thread_attributes(pthread_self(), \"\\et\");\n"
4176 #: build/C/man3/pthread_getattr_np.3:251
4180 "usage(char *pname, char *msg)\n"
4182 " if (msg != NULL)\n"
4183 " fputs(msg, stderr);\n"
4184 " fprintf(stderr, \"Usage: %s [-s stack-size [-a]]\"\n"
4185 " \" [-g guard-size]\\en\", pname);\n"
4186 " fprintf(stderr, \"\\et\\et-a means program should allocate "
4188 " exit(EXIT_FAILURE);\n"
4193 #: build/C/man3/pthread_getattr_np.3:264
4196 "static pthread_attr_t * /* Get thread attributes from command line */\n"
4197 "get_thread_attributes_from_cl(int argc, char *argv[],\n"
4198 " pthread_attr_t *attrp)\n"
4200 " int s, opt, allocate_stack;\n"
4201 " long stack_size, guard_size;\n"
4202 " void *stack_addr;\n"
4203 " pthread_attr_t *ret_attrp = NULL; /* Set to attrp if we initialize\n"
4204 " a thread attributes object */\n"
4205 " allocate_stack = 0;\n"
4206 " stack_size = -1;\n"
4207 " guard_size = -1;\n"
4211 #: build/C/man3/pthread_getattr_np.3:273
4214 " while ((opt = getopt(argc, argv, \"ag:s:\")) != -1) {\n"
4216 " case \\(aqa\\(aq: allocate_stack = 1; break;\n"
4217 " case \\(aqg\\(aq: guard_size = strtoul(optarg, NULL, 0); break;\n"
4218 " case \\(aqs\\(aq: stack_size = strtoul(optarg, NULL, 0); break;\n"
4219 " default: usage(argv[0], NULL);\n"
4225 #: build/C/man3/pthread_getattr_np.3:276
4228 " if (allocate_stack && stack_size == -1)\n"
4229 " usage(argv[0], \"Specifying -a without -s makes no sense\\en\");\n"
4233 #: build/C/man3/pthread_getattr_np.3:279
4236 " if (argc E<gt> optind)\n"
4237 " usage(argv[0], \"Extraneous command-line arguments\\en\");\n"
4241 #: build/C/man3/pthread_getattr_np.3:282
4244 " if (stack_size E<gt>= 0 || guard_size E<gt> 0) {\n"
4245 " ret_attrp = attrp;\n"
4249 #: build/C/man3/pthread_getattr_np.3:287
4252 " s = pthread_attr_init(attrp);\n"
4254 " handle_error_en(s, \"pthread_attr_init\");\n"
4259 #: build/C/man3/pthread_getattr_np.3:299
4262 " if (stack_size E<gt>= 0) {\n"
4263 " if (!allocate_stack) {\n"
4264 " s = pthread_attr_setstacksize(attrp, stack_size);\n"
4266 " handle_error_en(s, \"pthread_attr_setstacksize\");\n"
4268 " s = posix_memalign(&stack_addr, sysconf(_SC_PAGESIZE),\n"
4271 " handle_error_en(s, \"posix_memalign\");\n"
4272 " printf(\"Allocated thread stack at %p\\en\\en\", stack_addr);\n"
4276 #: build/C/man3/pthread_getattr_np.3:305
4279 " s = pthread_attr_setstack(attrp, stack_addr, stack_size);\n"
4281 " handle_error_en(s, \"pthread_attr_setstacksize\");\n"
4287 #: build/C/man3/pthread_getattr_np.3:311
4290 " if (guard_size E<gt>= 0) {\n"
4291 " s = pthread_attr_setguardsize(attrp, guard_size);\n"
4293 " handle_error_en(s, \"pthread_attr_setstacksize\");\n"
4298 #: build/C/man3/pthread_getattr_np.3:314
4301 " return ret_attrp;\n"
4306 #: build/C/man3/pthread_getattr_np.3:323
4310 "main(int argc, char *argv[])\n"
4314 " pthread_attr_t attr;\n"
4315 " pthread_attr_t *attrp = NULL; /* Set to &attr if we initialize\n"
4316 " a thread attributes object */\n"
4320 #: build/C/man3/pthread_getattr_np.3:325
4322 msgid " attrp = get_thread_attributes_from_cl(argc, argv, &attr);\n"
4326 #: build/C/man3/pthread_getattr_np.3:331
4329 " if (attrp != NULL) {\n"
4330 " printf(\"Thread attributes object after initializations:\\en\");\n"
4331 " display_stack_related_attributes(attrp, \"\\et\");\n"
4332 " printf(\"\\en\");\n"
4337 #: build/C/man3/pthread_getattr_np.3:361
4339 "B<pthread_attr_getaffinity_np>(3), B<pthread_attr_getdetachstate>(3), "
4340 "B<pthread_attr_getguardsize>(3), B<pthread_attr_getinheritsched>(3), "
4341 "B<pthread_attr_getschedparam>(3), B<pthread_attr_getschedpolicy>(3), "
4342 "B<pthread_attr_getscope>(3), B<pthread_attr_getstack>(3), "
4343 "B<pthread_attr_getstackaddr>(3), B<pthread_attr_getstacksize>(3), "
4344 "B<pthread_attr_init>(3), B<pthread_create>(3), B<pthreads>(7)"
4348 #: build/C/man3/pthread_getcpuclockid.3:26
4350 msgid "PTHREAD_GETCPUCLOCKID"
4354 #: build/C/man3/pthread_getcpuclockid.3:26
4360 #: build/C/man3/pthread_getcpuclockid.3:29
4361 msgid "pthread_getcpuclockid - retrieve ID of a thread's CPU time clock"
4365 #: build/C/man3/pthread_getcpuclockid.3:33
4368 "B<#include E<lt>pthread.hE<gt>>\n"
4369 "B<#include E<lt>time.hE<gt>>\n"
4373 #: build/C/man3/pthread_getcpuclockid.3:35
4376 "B<int pthread_getcpuclockid(pthread_t >I<thread>B<, clockid_t "
4380 #. The clockid is constructed as follows:
4381 #. *clockid = CLOCK_THREAD_CPUTIME_ID | (pd->tid << CLOCK_IDFIELD_SIZE)
4382 #. where CLOCK_IDFIELD_SIZE is 3.
4384 #: build/C/man3/pthread_getcpuclockid.3:46
4386 "The B<pthread_getcpuclockid>() function returns the clock ID for the CPU "
4387 "time clock of the thread I<thread>."
4391 #: build/C/man3/pthread_getcpuclockid.3:50
4396 #. CLOCK_THREAD_CPUTIME_ID not defined
4398 #. Looking at nptl/pthread_getcpuclockid.c an ERANGE error would
4399 #. be possible if kernel thread IDs took more than 29 bits (which
4400 #. they currently cannot).
4402 #: build/C/man3/pthread_getcpuclockid.3:58
4403 msgid "Per-thread CPU time clocks are not supported by the system."
4407 #: build/C/man3/pthread_getcpuclockid.3:65
4408 msgid "This function is available in glibc since version 2.2."
4412 #: build/C/man3/pthread_getcpuclockid.3:78
4414 "When I<thread> refers to the calling thread, this function returns an "
4415 "identifier that refers to the same clock manipulated by B<clock_gettime>(2) "
4416 "and B<clock_settime>(2) when given the clock ID B<CLOCK_THREAD_CPUTIME_ID>."
4420 #: build/C/man3/pthread_getcpuclockid.3:84
4422 "The program below creates a thread and then uses B<clock_gettime>(2) to "
4423 "retrieve the total process CPU time, and the per-thread CPU time consumed by "
4424 "the two threads. The following shell session shows an example run:"
4428 #: build/C/man3/pthread_getcpuclockid.3:94
4432 "Main thread sleeping\n"
4433 "Subthread starting infinite loop\n"
4434 "Main thread consuming some CPU time...\n"
4435 "Process total CPU time: 1.368\n"
4436 "Main thread CPU time: 0.376\n"
4437 "Subthread CPU time: 0.992\n"
4441 #: build/C/man3/pthread_getcpuclockid.3:100
4443 msgid "/* Link with \"-lrt\" */\n"
4447 #: build/C/man3/pthread_getcpuclockid.3:108
4450 "#include E<lt>time.hE<gt>\n"
4451 "#include E<lt>stdio.hE<gt>\n"
4452 "#include E<lt>stdlib.hE<gt>\n"
4453 "#include E<lt>unistd.hE<gt>\n"
4454 "#include E<lt>pthread.hE<gt>\n"
4455 "#include E<lt>string.hE<gt>\n"
4456 "#include E<lt>errno.hE<gt>\n"
4460 #: build/C/man3/pthread_getcpuclockid.3:122
4464 "thread_start(void *arg)\n"
4466 " printf(\"Subthread starting infinite loop\\en\");\n"
4473 #: build/C/man3/pthread_getcpuclockid.3:127
4477 "pclock(char *msg, clockid_t cid)\n"
4479 " struct timespec ts;\n"
4483 #: build/C/man3/pthread_getcpuclockid.3:133
4486 " printf(\"%s\", msg);\n"
4487 " if (clock_gettime(cid, &ts) == -1)\n"
4488 " handle_error(\"clock_gettime\");\n"
4489 " printf(\"%4ld.%03ld\\en\", ts.tv_sec, ts.tv_nsec / 1000000);\n"
4494 #: build/C/man3/pthread_getcpuclockid.3:140
4498 "main(int argc, char *argv[])\n"
4500 " pthread_t thread;\n"
4506 #: build/C/man3/pthread_getcpuclockid.3:144
4509 " s = pthread_create(&thread, NULL, thread_start, NULL);\n"
4511 " handle_error_en(s, \"pthread_create\");\n"
4515 #: build/C/man3/pthread_getcpuclockid.3:147
4518 " printf(\"Main thread sleeping\\en\");\n"
4523 #: build/C/man3/pthread_getcpuclockid.3:151
4526 " printf(\"Main thread consuming some CPU time...\\en\");\n"
4527 " for (j = 0; j E<lt> 2000000; j++)\n"
4532 #: build/C/man3/pthread_getcpuclockid.3:153
4534 msgid " pclock(\"Process total CPU time: \", CLOCK_PROCESS_CPUTIME_ID);\n"
4538 #: build/C/man3/pthread_getcpuclockid.3:158
4541 " s = pthread_getcpuclockid(pthread_self(), &cid);\n"
4543 " handle_error_en(s, \"pthread_getcpuclockid\");\n"
4544 " pclock(\"Main thread CPU time: \", cid);\n"
4548 #: build/C/man3/pthread_getcpuclockid.3:161
4551 " /* The preceding 4 lines of code could have been replaced by:\n"
4552 " pclock(\"Main thread CPU time: \", CLOCK_THREAD_CPUTIME_ID); */\n"
4556 #: build/C/man3/pthread_getcpuclockid.3:166
4559 " s = pthread_getcpuclockid(thread, &cid);\n"
4561 " handle_error_en(s, \"pthread_getcpuclockid\");\n"
4562 " pclock(\"Subthread CPU time: 1 \", cid);\n"
4566 #: build/C/man3/pthread_getcpuclockid.3:169
4569 " exit(EXIT_SUCCESS); /* Terminates both threads */\n"
4574 #: build/C/man3/pthread_getcpuclockid.3:178
4576 "B<clock_gettime>(2), B<clock_settime>(2), B<timer_create>(2), "
4577 "B<clock_getcpuclockid>(3), B<pthread_self>(3), B<pthreads>(7), B<time>(7)"
4581 #: build/C/man3/pthread_join.3:26
4583 msgid "PTHREAD_JOIN"
4587 #: build/C/man3/pthread_join.3:29
4588 msgid "pthread_join - join with a terminated thread"
4592 #: build/C/man3/pthread_join.3:34
4594 msgid "B<int pthread_join(pthread_t >I<thread>B<, void **>I<retval>B<);>\n"
4598 #: build/C/man3/pthread_join.3:49
4600 "The B<pthread_join>() function waits for the thread specified by I<thread> "
4601 "to terminate. If that thread has already terminated, then B<pthread_join>() "
4602 "returns immediately. The thread specified by I<thread> must be joinable."
4606 #: build/C/man3/pthread_join.3:63
4608 "If I<retval> is not NULL, then B<pthread_join>() copies the exit status of "
4609 "the target thread (i.e., the value that the target thread supplied to "
4610 "B<pthread_exit>(3)) into the location pointed to by I<*retval>. If the "
4611 "target thread was canceled, then B<PTHREAD_CANCELED> is placed in "
4616 #: build/C/man3/pthread_join.3:70
4618 "If multiple threads simultaneously try to join with the same thread, the "
4619 "results are undefined. If the thread calling B<pthread_join>() is "
4620 "canceled, then the target thread will remain joinable (i.e., it will not be "
4625 #: build/C/man3/pthread_join.3:75
4627 "On success, B<pthread_join>() returns 0; on error, it returns an error "
4632 #: build/C/man3/pthread_join.3:76
4637 #. The following verified by testing on glibc 2.8/NPTL:
4638 #. The following verified by testing on glibc 2.8/NPTL:
4640 #: build/C/man3/pthread_join.3:85
4642 "A deadlock was detected (e.g., two threads tried to join with each other); "
4643 "or I<thread> specifies the calling thread."
4646 #. POSIX.1-2001 does not specify this error case.
4648 #: build/C/man3/pthread_join.3:93
4649 msgid "Another thread is already waiting to join with this thread."
4653 #: build/C/man3/pthread_join.3:104
4655 "After a successful call to B<pthread_join>(), the caller is guaranteed that "
4656 "the target thread has terminated."
4660 #: build/C/man3/pthread_join.3:107
4662 "Joining with a thread that has previously been joined results in undefined "
4667 #: build/C/man3/pthread_join.3:115
4669 "Failure to join with a thread that is joinable (i.e., one that is not "
4670 "detached), produces a \"zombie thread\". Avoid doing this, since each "
4671 "zombie thread consumes some system resources, and when enough zombie threads "
4672 "have accumulated, it will no longer be possible to create new threads (or "
4677 #: build/C/man3/pthread_join.3:121
4679 "There is no pthreads analog of I<waitpid(-1,\\ &status,\\ 0)>, that is, "
4680 "\"join with any terminated thread\". If you believe you need this "
4681 "functionality, you probably need to rethink your application design."
4685 #: build/C/man3/pthread_join.3:124
4687 "All of the threads in a process are peers: any thread can join with any "
4688 "other thread in the process."
4692 #: build/C/man3/pthread_join.3:134
4694 "B<pthread_cancel>(3), B<pthread_create>(3), B<pthread_detach>(3), "
4695 "B<pthread_exit>(3), B<pthread_tryjoin_np>(3), B<pthreads>(7)"
4699 #: build/C/man3/pthread_kill.3:26
4701 msgid "PTHREAD_KILL"
4705 #: build/C/man3/pthread_kill.3:26 build/C/man3/pthread_sigmask.3:26
4711 #: build/C/man3/pthread_kill.3:29
4712 msgid "pthread_kill - send a signal to a thread"
4716 #: build/C/man3/pthread_kill.3:32 build/C/man3/pthread_sigmask.3:32
4718 msgid "B<#include E<lt>signal.hE<gt>>\n"
4722 #: build/C/man3/pthread_kill.3:34
4724 msgid "B<int pthread_kill(pthread_t >I<thread>B<, int >I<sig>B<);>\n"
4728 #: build/C/man3/pthread_kill.3:45
4729 msgid "B<pthread_kill>():"
4733 #: build/C/man3/pthread_kill.3:47 build/C/man3/pthread_sigmask.3:48
4734 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 199506L || _XOPEN_SOURCE\\ E<gt>=\\ 500"
4738 #: build/C/man3/pthread_kill.3:59
4740 "The B<pthread_kill>() function sends the signal I<sig> to I<thread>, a "
4741 "thread in the same process as the caller. The signal is asynchronously "
4742 "directed to I<thread>."
4746 #: build/C/man3/pthread_kill.3:63
4748 "If I<sig> is 0, then no signal is sent, but error checking is still "
4753 #: build/C/man3/pthread_kill.3:68
4755 "On success, B<pthread_kill>() returns 0; on error, it returns an error "
4756 "number, and no signal is sent."
4760 #: build/C/man3/pthread_kill.3:72
4761 msgid "An invalid signal was specified."
4765 #: build/C/man3/pthread_kill.3:74
4766 msgid "POSIX.1-2008."
4770 #: build/C/man3/pthread_kill.3:81
4772 "Signal dispositions are process-wide: if a signal handler is installed, the "
4773 "handler will be invoked in the thread I<thread>, but if the disposition of "
4774 "the signal is \"stop\", \"continue\", or \"terminate\", this action will "
4775 "affect the whole process."
4779 #: build/C/man3/pthread_kill.3:94
4781 "POSIX.1-2008 recommends that if an implementation detects the use of a "
4782 "thread ID after the end of its lifetime, B<pthread_kill>() should return "
4783 "the error B<ESRCH>. The glibc implementation returns this error in the "
4784 "cases where an invalid thread ID can be detected. But note also that POSIX "
4785 "says that an attempt to use a thread ID whose lifetime has ended produces "
4786 "undefined behavior, and an attempt to use an invalid thread ID in a call to "
4787 "B<pthread_kill>() can, for example, cause a segmentation fault."
4791 #: build/C/man3/pthread_kill.3:103
4793 "B<kill>(2), B<sigaction>(2), B<sigpending>(2), B<pthread_self>(3), "
4794 "B<pthread_sigmask>(3), B<raise>(3), B<pthreads>(7), B<signal>(7)"
4798 #: build/C/man3/pthread_kill_other_threads_np.3:26
4800 msgid "PTHREAD_KILL_OTHER_THREADS_NP"
4804 #: build/C/man3/pthread_kill_other_threads_np.3:26
4810 #: build/C/man3/pthread_kill_other_threads_np.3:29
4811 msgid "pthread_kill_other_threads_np - terminate all other threads in process"
4815 #: build/C/man3/pthread_kill_other_threads_np.3:34
4817 msgid "B<void pthread_kill_other_threads_np(void);>\n"
4821 #. Available since glibc 2.0
4823 #: build/C/man3/pthread_kill_other_threads_np.3:47
4825 "B<pthread_kill_other_threads_np>() has an effect only in the LinuxThreads "
4826 "threading implementation. On that implementation, calling this function "
4827 "causes the immediate termination of all threads in the application, except "
4828 "the calling thread. The cancellation state and cancellation type of the "
4829 "to-be-terminated threads are ignored, and the cleanup handlers are not "
4830 "called in those threads."
4834 #: build/C/man3/pthread_kill_other_threads_np.3:59
4836 "B<pthread_kill_other_threads_np>() is intended to be called just before a "
4837 "thread calls B<execve>(2) or a similar function. This function is designed "
4838 "to address a limitation in the obsolete LinuxThreads implementation whereby "
4839 "the other threads of an application are not automatically terminated (as "
4840 "POSIX.1-2001 requires) during B<execve>(2)."
4844 #: build/C/man3/pthread_kill_other_threads_np.3:66
4846 "In the NPTL threading implementation, B<pthread_kill_other_threads_np>() "
4847 "exists, but does nothing. (Nothing needs to be done, because the "
4848 "implementation does the right thing during an B<execve>(2).)"
4852 #: build/C/man3/pthread_kill_other_threads_np.3:72
4854 "B<execve>(2), B<pthread_cancel>(3), B<pthread_setcancelstate>(3), "
4855 "B<pthread_setcanceltype>(3), B<pthreads>(7)"
4859 #: build/C/man3/pthread_self.3:26
4861 msgid "PTHREAD_SELF"
4865 #: build/C/man3/pthread_self.3:29
4866 msgid "pthread_self - obtain ID of the calling thread"
4870 #: build/C/man3/pthread_self.3:34
4872 msgid "B<pthread_t pthread_self(void);>\n"
4876 #: build/C/man3/pthread_self.3:46
4878 "The B<pthread_self>() function returns the ID of the calling thread. This "
4879 "is the same value that is returned in I<*thread> in the B<pthread_create>(3) "
4880 "call that created this thread."
4884 #: build/C/man3/pthread_self.3:48
4885 msgid "This function always succeeds, returning the calling thread's ID."
4889 #: build/C/man3/pthread_self.3:63
4891 "POSIX.1 allows an implementation wide freedom in choosing the type used to "
4892 "represent a thread ID; for example, representation using either an "
4893 "arithmetic type or a structure is permitted. Therefore, variables of type "
4894 "I<pthread_t> can't portably be compared using the C equality operator "
4895 "(B<==>); use B<pthread_equal>(3) instead."
4899 #: build/C/man3/pthread_self.3:67
4901 "Thread identifiers should be considered opaque: any attempt to use a thread "
4902 "ID other than in pthreads calls is nonportable and can lead to unspecified "
4907 #: build/C/man3/pthread_self.3:71
4909 "Thread IDs are guaranteed to be unique only within a process. A thread ID "
4910 "may be reused after a terminated thread has been joined, or a detached "
4911 "thread has terminated."
4915 #: build/C/man3/pthread_self.3:76
4917 "The thread ID returned by B<pthread_self>() is not the same thing as the "
4918 "kernel thread ID returned by a call to B<gettid>(2)."
4922 #: build/C/man3/pthread_self.3:80
4923 msgid "B<pthread_create>(3), B<pthread_equal>(3), B<pthreads>(7)"
4927 #: build/C/man3/pthread_setaffinity_np.3:26
4929 msgid "PTHREAD_SETAFFINITY_NP"
4933 #: build/C/man3/pthread_setaffinity_np.3:30
4935 "pthread_setaffinity_np, pthread_getaffinity_np - set/get CPU affinity of a "
4940 #: build/C/man3/pthread_setaffinity_np.3:39
4943 "B<int pthread_setaffinity_np(pthread_t >I<thread>B<, size_t "
4944 ">I<cpusetsize>B<,>\n"
4945 "B< const cpu_set_t *>I<cpuset>B<);>\n"
4946 "B<int pthread_getaffinity_np(pthread_t >I<thread>B<, size_t "
4947 ">I<cpusetsize>B<,>\n"
4948 "B< cpu_set_t *>I<cpuset>B<);>\n"
4952 #: build/C/man3/pthread_setaffinity_np.3:54
4954 "The B<pthread_setaffinity_np>() function sets the CPU affinity mask of the "
4955 "thread I<thread> to the CPU set pointed to by I<cpuset>. If the call is "
4956 "successful, and the thread is not currently running on one of the CPUs in "
4957 "I<cpuset>, then it is migrated to one of those CPUs."
4961 #: build/C/man3/pthread_setaffinity_np.3:61
4963 "The B<pthread_getaffinity_np>() function returns the CPU affinity mask of "
4964 "the thread I<thread> in the buffer pointed to by I<cpuset>."
4968 #: build/C/man3/pthread_setaffinity_np.3:77
4970 "The argument I<cpusetsize> is the length (in bytes) of the buffer pointed to "
4971 "by I<cpuset>. Typically, this argument would be specified as "
4972 "I<sizeof(cpu_set_t)>. (It may be some other value, if using the macros "
4973 "described in B<CPU_SET>(3) for dynamically allocating a CPU set.)"
4977 #: build/C/man3/pthread_setaffinity_np.3:81
4983 #: build/C/man3/pthread_setaffinity_np.3:84
4984 msgid "A supplied memory address was invalid."
4988 #: build/C/man3/pthread_setaffinity_np.3:93
4990 "(B<pthread_setaffinity_np>()) The affinity bit mask I<mask> contains no "
4991 "processors that are currently physically on the system and permitted to the "
4992 "thread according to any restrictions that may be imposed by the \"cpuset\" "
4993 "mechanism described in B<cpuset>(7)."
4997 #. Loic Domaigne commented: it seems that in the future the
4998 #. kernel developers want to make cpumask_t dynamic, so
4999 #. CONFIG_NR_CPUS might become obsolete in the future.
5001 #. The raw sched_getaffinity() system call returns the size (in bytes)
5002 #. of the cpumask_t type.
5004 #: build/C/man3/pthread_setaffinity_np.3:109
5006 "(B<pthread_setaffinity_np>()) I<cpuset> specified a CPU that was outside "
5007 "the set supported by the kernel. (The kernel configuration option "
5008 "B<CONFIG_NR_CPUS> defines the range of the set supported by the kernel data "
5009 "type used to represent CPU sets.)"
5013 #: build/C/man3/pthread_setaffinity_np.3:114
5015 "(B<pthread_getaffinity_np>()) I<cpusetsize> is smaller than the size of the "
5016 "affinity mask used by the kernel."
5020 #: build/C/man3/pthread_setaffinity_np.3:137
5022 "After a call to B<pthread_setaffinity_np>(), the set of CPUs on which the "
5023 "thread will actually run is the intersection of the set specified in the "
5024 "I<cpuset> argument and the set of CPUs actually present on the system. The "
5025 "system may further restrict the set of CPUs on which the thread runs if the "
5026 "\"cpuset\" mechanism described in B<cpuset>(7) is being used. These "
5027 "restrictions on the actual set of CPUs on which the thread will run are "
5028 "silently imposed by the kernel."
5032 #: build/C/man3/pthread_setaffinity_np.3:143
5034 "These functions are implemented on top of the B<sched_setaffinity>(2) and "
5035 "B<sched_getaffinity>(2) system calls."
5039 #: build/C/man3/pthread_setaffinity_np.3:154
5041 "A new thread created by B<pthread_create>(3) inherits a copy of its "
5042 "creator's CPU affinity mask."
5046 #: build/C/man3/pthread_setaffinity_np.3:162
5048 "In the following program, the main thread uses B<pthread_setaffinity_np>() "
5049 "to set its CPU affinity mask to include CPUs 0 to 7 (which may not all be "
5050 "available on the system), and then calls B<pthread_getaffinity_np>() to "
5051 "check the resulting CPU affinity mask of the thread."
5055 #: build/C/man3/pthread_setaffinity_np.3:169
5058 "#define _GNU_SOURCE\n"
5059 "#include E<lt>pthread.hE<gt>\n"
5060 "#include E<lt>stdio.hE<gt>\n"
5061 "#include E<lt>stdlib.hE<gt>\n"
5062 "#include E<lt>errno.hE<gt>\n"
5066 #: build/C/man3/pthread_setaffinity_np.3:179
5070 "main(int argc, char *argv[])\n"
5073 " cpu_set_t cpuset;\n"
5074 " pthread_t thread;\n"
5078 #: build/C/man3/pthread_setaffinity_np.3:181
5080 msgid " thread = pthread_self();\n"
5084 #: build/C/man3/pthread_setaffinity_np.3:183
5086 msgid " /* Set affinity mask to include CPUs 0 to 7 */\n"
5090 #: build/C/man3/pthread_setaffinity_np.3:187
5093 " CPU_ZERO(&cpuset);\n"
5094 " for (j = 0; j E<lt> 8; j++)\n"
5095 " CPU_SET(j, &cpuset);\n"
5099 #: build/C/man3/pthread_setaffinity_np.3:191
5102 " s = pthread_setaffinity_np(thread, sizeof(cpu_set_t), &cpuset);\n"
5104 " handle_error_en(s, \"pthread_setaffinity_np\");\n"
5108 #: build/C/man3/pthread_setaffinity_np.3:193
5110 msgid " /* Check the actual affinity mask assigned to the thread */\n"
5114 #: build/C/man3/pthread_setaffinity_np.3:197
5117 " s = pthread_getaffinity_np(thread, sizeof(cpu_set_t), &cpuset);\n"
5119 " handle_error_en(s, \"pthread_getaffinity_np\");\n"
5123 #: build/C/man3/pthread_setaffinity_np.3:202
5126 " printf(\"Set returned by pthread_getaffinity_np() contained:\\en\");\n"
5127 " for (j = 0; j E<lt> CPU_SETSIZE; j++)\n"
5128 " if (CPU_ISSET(j, &cpuset))\n"
5129 " printf(\" CPU %d\\en\", j);\n"
5133 #: build/C/man3/pthread_setaffinity_np.3:205 build/C/man3/pthread_setschedparam.3:430
5136 " exit(EXIT_SUCCESS);\n"
5141 #: build/C/man3/pthread_setaffinity_np.3:214
5143 "B<sched_setaffinity>(2), B<sched_setscheduler>(2), "
5144 "B<pthread_attr_setaffinity_np>(3), B<pthread_self>(3), B<sched_getcpu>(3), "
5145 "B<cpuset>(7), B<pthreads>(7)"
5149 #: build/C/man3/pthread_setcancelstate.3:26
5151 msgid "PTHREAD_SETCANCELSTATE"
5155 #: build/C/man3/pthread_setcancelstate.3:30
5157 "pthread_setcancelstate, pthread_setcanceltype - set cancelability state and "
5162 #: build/C/man3/pthread_setcancelstate.3:36
5165 "B<int pthread_setcancelstate(int >I<state>B<, int *>I<oldstate>B<);>\n"
5166 "B<int pthread_setcanceltype(int >I<type>B<, int *>I<oldtype>B<);>\n"
5170 #: build/C/man3/pthread_setcancelstate.3:51
5172 "The B<pthread_setcancelstate>() sets the cancelability state of the calling "
5173 "thread to the value given in I<state>. The previous cancelability state of "
5174 "the thread is returned in the buffer pointed to by I<oldstate>. The "
5175 "I<state> argument must have one of the following values:"
5179 #: build/C/man3/pthread_setcancelstate.3:51
5181 msgid "B<PTHREAD_CANCEL_ENABLE>"
5185 #: build/C/man3/pthread_setcancelstate.3:58
5187 "The thread is cancelable. This is the default cancelability state in all "
5188 "new threads, including the initial thread. The thread's cancelability type "
5189 "determines when a cancelable thread will respond to a cancellation request."
5193 #: build/C/man3/pthread_setcancelstate.3:58
5195 msgid "B<PTHREAD_CANCEL_DISABLE>"
5199 #: build/C/man3/pthread_setcancelstate.3:63
5201 "The thread is not cancelable. If a cancellation request is received, it is "
5202 "blocked until cancelability is enabled."
5206 #: build/C/man3/pthread_setcancelstate.3:75
5208 "The B<pthread_setcanceltype>() sets the cancelability type of the calling "
5209 "thread to the value given in I<type>. The previous cancelability type of "
5210 "the thread is returned in the buffer pointed to by I<oldtype>. The I<type> "
5211 "argument must have one of the following values:"
5215 #: build/C/man3/pthread_setcancelstate.3:75
5217 msgid "B<PTHREAD_CANCEL_DEFERRED>"
5221 #: build/C/man3/pthread_setcancelstate.3:82
5223 "A cancellation request is deferred until the thread next calls a function "
5224 "that is a cancellation point (see B<pthreads>(7)). This is the default "
5225 "cancelability type in all new threads, including the initial thread."
5229 #: build/C/man3/pthread_setcancelstate.3:82
5231 msgid "B<PTHREAD_CANCEL_ASYNCHRONOUS>"
5235 #: build/C/man3/pthread_setcancelstate.3:88
5237 "The thread can be canceled at any time. (Typically, it will be canceled "
5238 "immediately upon receiving a cancellation request, but the system doesn't "
5243 #: build/C/man3/pthread_setcancelstate.3:92
5245 "The set-and-get operation performed by each of these functions is atomic "
5246 "with respect to other threads in the process calling the same function."
5250 #: build/C/man3/pthread_setcancelstate.3:99
5251 msgid "The B<pthread_setcancelstate>() can fail with the following error:"
5255 #: build/C/man3/pthread_setcancelstate.3:103
5256 msgid "Invalid value for I<state>."
5260 #: build/C/man3/pthread_setcancelstate.3:107
5261 msgid "The B<pthread_setcanceltype>() can fail with the following error:"
5265 #. Available since glibc 2.0
5267 #: build/C/man3/pthread_setcancelstate.3:113
5268 msgid "Invalid value for I<type>."
5272 #: build/C/man3/pthread_setcancelstate.3:118
5274 "For details of what happens when a thread is canceled, see "
5275 "B<pthread_cancel>(3)."
5279 #: build/C/man3/pthread_setcancelstate.3:125
5281 "Briefly disabling cancelability is useful if a thread performs some critical "
5282 "action that must not be interrupted by a cancellation request. Beware of "
5283 "disabling cancelability for long periods, or around operations that may "
5284 "block for long periods, since that will render the thread unresponsive to "
5285 "cancellation requests."
5289 #: build/C/man3/pthread_setcancelstate.3:156
5291 "Setting the cancelability type to B<PTHREAD_CANCEL_ASYNCHRONOUS> is rarely "
5292 "useful. Since the thread could be canceled at I<any> time, it cannot safely "
5293 "reserve resources (e.g., allocating memory with B<malloc>(3)), acquire "
5294 "mutexes, semaphores, or locks, and so on. Reserving resources is unsafe "
5295 "because the application has no way of knowing what the state of these "
5296 "resources is when the thread is canceled; that is, did cancellation occur "
5297 "before the resources were reserved, while they were reserved, or after they "
5298 "were released? Furthermore, some internal data structures (e.g., the linked "
5299 "list of free blocks managed by the B<malloc>(3) family of functions) may be "
5300 "left in an inconsistent state if cancellation occurs in the middle of the "
5301 "function call. Consequently, clean-up handlers cease to be useful. "
5302 "Functions that can be safely asynchronously canceled are called "
5303 "I<async-cancel-safe functions>. POSIX.1-2001 requires only that "
5304 "B<pthread_cancel>(3), B<pthread_setcancelstate>(), and "
5305 "B<pthread_setcanceltype>() be async-cancel-safe. In general, other library "
5306 "functions can't be safely called from an asynchronously cancelable thread. "
5307 "One of the few circumstances in which asynchronous cancelability is useful "
5308 "is for cancellation of a thread that is in a pure compute-bound loop."
5311 #. It looks like at least Solaris, FreeBSD and Tru64 support this.
5313 #: build/C/man3/pthread_setcancelstate.3:174
5315 "The Linux threading implementations permit the I<oldstate> argument of "
5316 "B<pthread_setcancelstate>() to be NULL, in which case the information about "
5317 "the previous cancelability state is not returned to the caller. Many other "
5318 "implementations also permit a NULL I<oldstat> argument, but POSIX.1-2001 "
5319 "does not specify this point, so portable applications should always specify "
5320 "a non-NULL value in I<oldstate>. A precisely analogous set of statements "
5321 "applies for the I<oldtype> argument of B<pthread_setcanceltype>()."
5325 #: build/C/man3/pthread_setcancelstate.3:177
5326 msgid "See B<pthread_cancel>(3)."
5330 #: build/C/man3/pthread_setcancelstate.3:182
5332 "B<pthread_cancel>(3), B<pthread_cleanup_push>(3), B<pthread_testcancel>(3), "
5337 #: build/C/man3/pthread_setconcurrency.3:25
5339 msgid "PTHREAD_SETCONCURRENCY"
5343 #: build/C/man3/pthread_setconcurrency.3:25
5349 #: build/C/man3/pthread_setconcurrency.3:29
5351 "pthread_setconcurrency, pthread_getconcurrency - set/get the concurrency "
5356 #: build/C/man3/pthread_setconcurrency.3:35
5359 "B<int pthread_setconcurrency(int >I<new_level>B<);>\n"
5360 "B<int pthread_getconcurrency(void);>\n"
5364 #: build/C/man3/pthread_setconcurrency.3:48
5366 "The B<pthread_setconcurrency>() function informs the implementation of the "
5367 "application's desired concurrency level, specified in I<new_level>. The "
5368 "implementation takes this only as a hint: POSIX.1 does not specify the level "
5369 "of concurrency that should be provided as a result of calling "
5370 "B<pthread_setconcurrency>()."
5374 #: build/C/man3/pthread_setconcurrency.3:53
5376 "Specifying I<new_level> as 0 instructs the implementation to manage the "
5377 "concurrency level as it deems appropriate."
5381 #: build/C/man3/pthread_setconcurrency.3:56
5383 "B<pthread_getconcurrency>() returns the current value of the concurrency "
5384 "level for this process."
5388 #: build/C/man3/pthread_setconcurrency.3:61
5390 "On success, B<pthread_setconcurrency>() returns 0; on error, it returns a "
5391 "nonzero error number."
5395 #: build/C/man3/pthread_setconcurrency.3:68
5397 "B<pthread_getconcurrency>() always succeeds, returning the concurrency "
5398 "level set by a previous call to B<pthread_setconcurrency>(), or 0, if "
5399 "B<pthread_setconcurrency>() has not previously been called."
5403 #: build/C/man3/pthread_setconcurrency.3:71
5404 msgid "B<pthread_setconcurrency>() can fail with the following error:"
5408 #: build/C/man3/pthread_setconcurrency.3:75
5409 msgid "I<new_level> is negative."
5413 #: build/C/man3/pthread_setconcurrency.3:81
5415 "POSIX.1-2001 also documents an B<EAGAIN> error (\"the value specified by "
5416 "I<new_level> would cause a system resource to be exceeded\")."
5420 #: build/C/man3/pthread_setconcurrency.3:83
5421 msgid "These functions are available in glibc since version 2.1."
5425 #: build/C/man3/pthread_setconcurrency.3:87
5426 msgid "The default concurrency level is 0."
5430 #: build/C/man3/pthread_setconcurrency.3:94
5432 "Concurrency levels are meaningful only for M:N threading implementations, "
5433 "where at any moment a subset of a process's set of user-level threads may be "
5434 "bound to a smaller number of kernel-scheduling entities. Setting the "
5435 "concurrency level allows the application to give the system a hint as to the "
5436 "number of kernel-scheduling entities that should be provided for efficient "
5437 "execution of the application."
5441 #: build/C/man3/pthread_setconcurrency.3:100
5443 "Both LinuxThreads and NPTL are 1:1 threading implementations, so setting the "
5444 "concurrency level has no meaning. In other words, on Linux these functions "
5445 "merely exist for compatibility with other systems, and they have no effect "
5446 "on the execution of a program."
5450 #: build/C/man3/pthread_setconcurrency.3:103
5451 msgid "B<pthread_attr_setscope>(3), B<pthreads>(7)"
5455 #: build/C/man3/pthread_setname_np.3:26
5457 msgid "PTHREAD_SETNAME_NP"
5461 #: build/C/man3/pthread_setname_np.3:29
5462 msgid "pthread_setname_np, pthread_getname_np - set/get the name of a thread"
5466 #: build/C/man3/pthread_setname_np.3:36
5469 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
5470 "B<#include E<lt>pthread.hE<gt>>\n"
5471 "B<int pthread_setname_np(pthread_t >I<thread>B<, const char *>I<name>B<);>\n"
5472 "B<int pthread_getname_np(pthread_t >I<thread>B<,>\n"
5473 "B< const char *>I<name>B<, size_t >I<len>B<);>\n"
5477 #: build/C/man3/pthread_setname_np.3:55
5479 "By default, all the threads created using B<pthread_create>() inherit the "
5480 "program name. The B<pthread_setname_np>() function can be used to set a "
5481 "unique name for a thread, which can be useful for debugging multithreaded "
5482 "applications. The thread name is a meaningful C language string, whose "
5483 "length is restricted to 16 characters, including the terminating null byte "
5484 "(\\(aq\\e0\\(aq). The I<thread> argument specifies the thread whose name is "
5485 "to be changed; I<name> specifies the new name."
5489 #: build/C/man3/pthread_setname_np.3:72
5491 "The B<pthread_getname_np>() function can be used to retrieve the name of "
5492 "the thread. The I<thread> argument specifies the thread whose name is to be "
5493 "retrieved. The buffer I<name> is used to return the thread name; I<len> "
5494 "specifies the number of bytes available in I<name>. The buffer specified by "
5495 "I<name> should be at least 16 characters in length. The returned thread "
5496 "name in the output buffer will be null terminated."
5500 #: build/C/man3/pthread_setname_np.3:79
5501 msgid "The B<pthread_setname_np>() function can fail with the following error:"
5505 #: build/C/man3/pthread_setname_np.3:79 build/C/man3/pthread_setname_np.3:88
5511 #: build/C/man3/pthread_setname_np.3:84
5513 "The length of the string specified pointed to by I<name> exceeds the allowed "
5518 #: build/C/man3/pthread_setname_np.3:88
5519 msgid "The B<pthread_getname_np>() function can fail with the following error:"
5523 #: build/C/man3/pthread_setname_np.3:95
5525 "The buffer specified by I<name> and I<len> is too small to hold the thread "
5530 #: build/C/man3/pthread_setname_np.3:100
5532 "If either of these functions fails to open I</proc/self/task/[tid]/comm>, "
5533 "then the call may fail with one of the errors described in B<open>(2)."
5537 #: build/C/man3/pthread_setname_np.3:102
5538 msgid "These functions first appeared in glibc in version 2.12."
5542 #: build/C/man3/pthread_setname_np.3:104
5543 msgid "These functions are nonstandard GNU extensions."
5547 #: build/C/man3/pthread_setname_np.3:114
5549 "B<pthread_setname_np>() internally writes to the thread-specific I<comm> "
5550 "file under the I</proc> filesystem: I</proc/self/task/[tid]/comm>. "
5551 "B<pthread_getname_np>() retrieves it from the same location."
5555 #: build/C/man3/pthread_setname_np.3:120
5557 "The program below demonstrates the use of B<pthread_setname_np>() and "
5558 "B<pthread_getname_np>()."
5562 #: build/C/man3/pthread_setname_np.3:122
5563 msgid "The following shell session shows a sample run of the program:"
5567 #: build/C/man3/pthread_setname_np.3:138
5571 "Created a thread. Default name is: a.out\n"
5572 "The thread name after setting it is THREADFOO.\n"
5573 "B<^Z> # Suspend the program\n"
5574 "[1]+ Stopped ./a.out\n"
5575 "$ B<ps H -C a.out -o 'pid tid cmd comm'>\n"
5576 " PID TID CMD COMMAND\n"
5577 " 5990 5990 ./a.out a.out\n"
5578 " 5990 5991 ./a.out THREADFOO\n"
5579 "$ B<cat /proc/5990/task/5990/comm>\n"
5581 "$ B<cat /proc/5990/task/5991/comm>\n"
5586 #: build/C/man3/pthread_setname_np.3:150
5589 "#define _GNU_SOURCE\n"
5590 "#include E<lt>pthread.hE<gt>\n"
5591 "#include E<lt>stdio.hE<gt>\n"
5592 "#include E<lt>string.hE<gt>\n"
5593 "#include E<lt>unistd.hE<gt>\n"
5594 "#include E<lt>errno.hE<gt>\n"
5595 "#include E<lt>stdlib.hE<gt>\n"
5599 #: build/C/man3/pthread_setname_np.3:152
5601 msgid "#define NAMELEN 16\n"
5605 #: build/C/man3/pthread_setname_np.3:156
5608 "#define errExitEN(en, msg) \\e\n"
5609 " do { errno = en; perror(msg); exit(EXIT_FAILURE); \\e\n"
5614 #: build/C/man3/pthread_setname_np.3:163
5618 "threadfunc(void *parm)\n"
5620 " sleep(5); // allow main program to set the thread name\n"
5626 #: build/C/man3/pthread_setname_np.3:170
5630 "main(int argc, char **argv)\n"
5632 " pthread_t thread;\n"
5634 " char thread_name[NAMELEN];\n"
5638 #: build/C/man3/pthread_setname_np.3:174
5641 " rc = pthread_create(&thread, NULL, threadfunc, NULL);\n"
5643 " errExitEN(rc, \"pthread_create\");\n"
5647 #: build/C/man3/pthread_setname_np.3:178
5650 " rc = pthread_getname_np(thread, thread_name, NAMELEN);\n"
5652 " errExitEN(rc, \"pthread_getname_np\");\n"
5656 #: build/C/man3/pthread_setname_np.3:183
5659 " printf(\"Created a thread. Default name is: %s\\en\", thread_name);\n"
5660 " rc = pthread_setname_np(thread, (argc E<gt> 1) ? argv[1] : "
5663 " errExitEN(rc, \"pthread_setname_np\");\n"
5667 #: build/C/man3/pthread_setname_np.3:185
5669 msgid " sleep(2);\n"
5673 #: build/C/man3/pthread_setname_np.3:191
5676 " rc = pthread_getname_np(thread, thread_name,\n"
5677 " (argc E<gt> 2) ? atoi(argv[1]) : NAMELEN);\n"
5679 " errExitEN(rc, \"pthread_getname_np\");\n"
5680 " printf(\"The thread name after setting it is %s.\\en\", thread_name);\n"
5684 #: build/C/man3/pthread_setname_np.3:195
5687 " rc = pthread_join(thread, NULL);\n"
5689 " errExitEN(rc, \"pthread_join\");\n"
5693 #: build/C/man3/pthread_setname_np.3:199
5696 " printf(\"Done\\en\");\n"
5697 " exit(EXIT_SUCCESS);\n"
5702 #: build/C/man3/pthread_setname_np.3:206
5703 msgid "B<prctl>(2), B<pthread_create>(3), B<pthreads>(7)"
5707 #: build/C/man3/pthread_setschedparam.3:26
5709 msgid "PTHREAD_SETSCHEDPARAM"
5713 #: build/C/man3/pthread_setschedparam.3:30
5715 "pthread_setschedparam, pthread_getschedparam - set/get scheduling policy and "
5716 "parameters of a thread"
5720 #: build/C/man3/pthread_setschedparam.3:38
5723 "B<pthread_setschedparam(pthread_t >I<thread>B<, int >I<policy>B<,>\n"
5724 "B< const struct sched_param *>I<param>B<);>\n"
5725 "B<pthread_getschedparam(pthread_t >I<thread>B<, int *>I<policy>B<,>\n"
5726 "B< struct sched_param *>I<param>B<);>\n"
5730 #: build/C/man3/pthread_setschedparam.3:46
5732 "The B<pthread_setschedparam>() function sets the scheduling policy and "
5733 "parameters of the thread I<thread>."
5736 #. FIXME . pthread_setschedparam() places no restriction on the policy,
5737 #. but pthread_attr_setschedpolicy() restricts policy to RR/FIFO/OTHER
5738 #. http://sourceware.org/bugzilla/show_bug.cgi?id=7013
5740 #: build/C/man3/pthread_setschedparam.3:57
5742 "I<policy> specifies the new scheduling policy for I<thread>. The supported "
5743 "values for I<policy>, and their semantics, are described in "
5744 "B<sched_setscheduler>(2)."
5748 #: build/C/man3/pthread_setschedparam.3:63
5750 "The structure pointed to by I<param> specifies the new scheduling parameters "
5751 "for I<thread>. Scheduling parameters are maintained in the following "
5755 #. FIXME . nptl/pthread_setschedparam.c has the following
5756 #. /* If the thread should have higher priority because of some
5757 #. PTHREAD_PRIO_PROTECT mutexes it holds, adjust the priority. */
5758 #. Eventually (perhaps after writing the mutexattr pages), we
5759 #. may want to add something on the topic to this page.
5761 #: build/C/man3/pthread_setschedparam.3:104
5763 "The B<pthread_getschedparam>() function returns the scheduling policy and "
5764 "parameters of the thread I<thread>, in the buffers pointed to by I<policy> "
5765 "and I<param>, respectively. The returned priority value is that set by the "
5766 "most recent B<pthread_setschedparam>(), B<pthread_setschedprio>(3), or "
5767 "B<pthread_create>(3) call that affected I<thread>. The returned priority "
5768 "does not reflect any temporary priority adjustments as a result of calls to "
5769 "any priority inheritance or priority ceiling functions (see, for example, "
5770 "B<pthread_mutexattr_setprioceiling>(3) and "
5771 "B<pthread_mutexattr_setprotocol>(3))."
5775 #: build/C/man3/pthread_setschedparam.3:112
5777 "On success, these functions return 0; on error, they return a nonzero error "
5778 "number. If B<pthread_setschedparam>() fails, the scheduling policy and "
5779 "parameters of I<thread> are not changed."
5783 #: build/C/man3/pthread_setschedparam.3:114
5784 msgid "Both of these functions can fail with the following error:"
5788 #: build/C/man3/pthread_setschedparam.3:122
5789 msgid "B<pthread_setschedparam>() may additionally fail with the following errors:"
5793 #: build/C/man3/pthread_setschedparam.3:129
5795 "I<policy> is not a recognized policy, or I<param> does not make sense for "
5800 #: build/C/man3/pthread_setschedparam.3:133
5802 "The caller does not have appropriate privileges to set the specified "
5803 "scheduling policy and parameters."
5807 #. Available since glibc 2.0
5809 #: build/C/man3/pthread_setschedparam.3:141
5811 "POSIX.1-2001 also documents an B<ENOTSUP> (\"attempt was made to set the "
5812 "policy or scheduling parameters to an unsupported value\") error for "
5813 "B<pthread_setschedparam>()."
5817 #: build/C/man3/pthread_setschedparam.3:149
5819 "For a description of the permissions required to, and the effect of, "
5820 "changing a thread's scheduling policy and priority, and details of the "
5821 "permitted ranges for priorities in each scheduling policy, see "
5822 "B<sched_setscheduler>(2)."
5826 #: build/C/man3/pthread_setschedparam.3:156
5828 "The program below demonstrates the use of B<pthread_setschedparam>() and "
5829 "B<pthread_getschedparam>(), as well as the use of a number of other "
5830 "scheduling-related pthreads functions."
5834 #: build/C/man3/pthread_setschedparam.3:172
5836 "In the following run, the main thread sets its scheduling policy to "
5837 "B<SCHED_FIFO> with a priority of 10, and initializes a thread attributes "
5838 "object with a scheduling policy attribute of B<SCHED_RR> and a scheduling "
5839 "priority attribute of 20. The program then sets (using "
5840 "B<pthread_attr_setinheritsched>(3)) the inherit scheduler attribute of the "
5841 "thread attributes object to B<PTHREAD_EXPLICIT_SCHED>, meaning that threads "
5842 "created using this attributes object should take their scheduling attributes "
5843 "from the thread attributes object. The program then creates a thread using "
5844 "the thread attributes object, and that thread displays its scheduling policy "
5849 #: build/C/man3/pthread_setschedparam.3:180
5852 "$ B<su> # Need privilege to set real-time scheduling policies\n"
5854 "# B<./a.out -mf10 -ar20 -i e>\n"
5855 "Scheduler settings of main thread\n"
5856 " policy=SCHED_FIFO, priority=10\n"
5860 #: build/C/man3/pthread_setschedparam.3:184
5863 "Scheduler settings in \\(aqattr\\(aq\n"
5864 " policy=SCHED_RR, priority=20\n"
5865 " inheritsched is EXPLICIT\n"
5869 #: build/C/man3/pthread_setschedparam.3:187
5872 "Scheduler attributes of new thread\n"
5873 " policy=SCHED_RR, priority=20\n"
5877 #: build/C/man3/pthread_setschedparam.3:192
5879 "In the above output, one can see that the scheduling policy and priority "
5880 "were taken from the values specified in the thread attributes object."
5884 #: build/C/man3/pthread_setschedparam.3:199
5886 "The next run is the same as the previous, except that the inherit scheduler "
5887 "attribute is set to B<PTHREAD_INHERIT_SCHED>, meaning that threads created "
5888 "using the thread attributes object should ignore the scheduling attributes "
5889 "specified in the attributes object and instead take their scheduling "
5890 "attributes from the creating thread."
5894 #: build/C/man3/pthread_setschedparam.3:205
5897 "# B<./a.out -mf10 -ar20 -i i>\n"
5898 "Scheduler settings of main thread\n"
5899 " policy=SCHED_FIFO, priority=10\n"
5903 #: build/C/man3/pthread_setschedparam.3:209
5906 "Scheduler settings in \\(aqattr\\(aq\n"
5907 " policy=SCHED_RR, priority=20\n"
5908 " inheritsched is INHERIT\n"
5912 #: build/C/man3/pthread_setschedparam.3:212
5915 "Scheduler attributes of new thread\n"
5916 " policy=SCHED_FIFO, priority=10\n"
5920 #: build/C/man3/pthread_setschedparam.3:218
5922 "In the above output, one can see that the scheduling policy and priority "
5923 "were taken from the creating thread, rather than the thread attributes "
5928 #: build/C/man3/pthread_setschedparam.3:224
5930 "Note that if we had omitted the I<-i\\ i> option, the output would have been "
5931 "the same, since B<PTHREAD_INHERIT_SCHED> is the default for the inherit "
5932 "scheduler attribute."
5936 #: build/C/man3/pthread_setschedparam.3:228
5938 msgid "/* pthreads_sched_test.c */\n"
5942 #: build/C/man3/pthread_setschedparam.3:234
5945 "#include E<lt>pthread.hE<gt>\n"
5946 "#include E<lt>stdio.hE<gt>\n"
5947 "#include E<lt>stdlib.hE<gt>\n"
5948 "#include E<lt>unistd.hE<gt>\n"
5949 "#include E<lt>errno.hE<gt>\n"
5953 #: build/C/man3/pthread_setschedparam.3:243
5957 "usage(char *prog_name, char *msg)\n"
5959 " if (msg != NULL)\n"
5960 " fputs(msg, stderr);\n"
5964 #: build/C/man3/pthread_setschedparam.3:260
5967 " fprintf(stderr, \"Usage: %s [options]\\en\", prog_name);\n"
5968 " fprintf(stderr, \"Options are:\\en\");\n"
5969 "#define fpe(msg) fprintf(stderr, \"\\et%s\", msg); /* Shorter */\n"
5970 " fpe(\"-aE<lt>policyE<gt>E<lt>prioE<gt> Set scheduling policy and "
5971 "priority in\\en\");\n"
5972 " fpe(\" thread attributes object\\en\");\n"
5973 " fpe(\" E<lt>policyE<gt> can be\\en\");\n"
5974 " fpe(\" f SCHED_FIFO\\en\");\n"
5975 " fpe(\" r SCHED_RR\\en\");\n"
5976 " fpe(\" o SCHED_OTHER\\en\");\n"
5977 " fpe(\"-A Use default thread attributes object\\en\");\n"
5978 " fpe(\"-i {e|s} Set inherit scheduler attribute to\\en\");\n"
5979 " fpe(\" \\(aqexplicit\\(aq or \\(aqinherit\\(aq\\en\");\n"
5980 " fpe(\"-mE<lt>policyE<gt>E<lt>prioE<gt> Set scheduling policy and "
5981 "priority on\\en\");\n"
5982 " fpe(\" main thread before pthread_create() "
5984 " exit(EXIT_FAILURE);\n"
5989 #: build/C/man3/pthread_setschedparam.3:271
5993 "get_policy(char p, int *policy)\n"
5996 " case \\(aqf\\(aq: *policy = SCHED_FIFO; return 1;\n"
5997 " case \\(aqr\\(aq: *policy = SCHED_RR; return 1;\n"
5998 " case \\(aqo\\(aq: *policy = SCHED_OTHER; return 1;\n"
5999 " default: return 0;\n"
6005 #: build/C/man3/pthread_setschedparam.3:282
6009 "display_sched_attr(int policy, struct sched_param *param)\n"
6011 " printf(\" policy=%s, priority=%d\\en\",\n"
6012 " (policy == SCHED_FIFO) ? \"SCHED_FIFO\" :\n"
6013 " (policy == SCHED_RR) ? \"SCHED_RR\" :\n"
6014 " (policy == SCHED_OTHER) ? \"SCHED_OTHER\" :\n"
6016 " param-E<gt>sched_priority);\n"
6021 #: build/C/man3/pthread_setschedparam.3:288
6025 "display_thread_sched_attr(char *msg)\n"
6028 " struct sched_param param;\n"
6032 #: build/C/man3/pthread_setschedparam.3:292
6035 " s = pthread_getschedparam(pthread_self(), &policy, ¶m);\n"
6037 " handle_error_en(s, \"pthread_getschedparam\");\n"
6041 #: build/C/man3/pthread_setschedparam.3:296
6044 " printf(\"%s\\en\", msg);\n"
6045 " display_sched_attr(policy, ¶m);\n"
6050 #: build/C/man3/pthread_setschedparam.3:301
6054 "thread_start(void *arg)\n"
6056 " display_thread_sched_attr(\"Scheduler attributes of new thread\");\n"
6060 #: build/C/man3/pthread_setschedparam.3:304
6068 #: build/C/man3/pthread_setschedparam.3:314
6072 "main(int argc, char *argv[])\n"
6074 " int s, opt, inheritsched, use_null_attrib, policy;\n"
6075 " pthread_t thread;\n"
6076 " pthread_attr_t attr;\n"
6077 " pthread_attr_t *attrp;\n"
6078 " char *attr_sched_str, *main_sched_str, *inheritsched_str;\n"
6079 " struct sched_param param;\n"
6083 #: build/C/man3/pthread_setschedparam.3:316
6085 msgid " /* Process command-line options */\n"
6089 #: build/C/man3/pthread_setschedparam.3:321
6092 " use_null_attrib = 0;\n"
6093 " attr_sched_str = NULL;\n"
6094 " main_sched_str = NULL;\n"
6095 " inheritsched_str = NULL;\n"
6099 #: build/C/man3/pthread_setschedparam.3:331
6102 " while ((opt = getopt(argc, argv, \"a:Ai:m:\")) != -1) {\n"
6104 " case \\(aqa\\(aq: attr_sched_str = optarg; break;\n"
6105 " case \\(aqA\\(aq: use_null_attrib = 1; break;\n"
6106 " case \\(aqi\\(aq: inheritsched_str = optarg; break;\n"
6107 " case \\(aqm\\(aq: main_sched_str = optarg; break;\n"
6108 " default: usage(argv[0], \"Unrecognized option\\en\");\n"
6114 #: build/C/man3/pthread_setschedparam.3:335
6117 " if (use_null_attrib &&\n"
6118 " (inheritsched_str != NULL || attr_sched_str != NULL))\n"
6119 " usage(argv[0], \"Can\\(aqt specify -A with -i or -a\\en\");\n"
6123 #: build/C/man3/pthread_setschedparam.3:338
6126 " /* Optionally set scheduling attributes of main thread,\n"
6127 " and display the attributes */\n"
6131 #: build/C/man3/pthread_setschedparam.3:343
6134 " if (main_sched_str != NULL) {\n"
6135 " if (!get_policy(main_sched_str[0], &policy))\n"
6136 " usage(argv[0], \"Bad policy for main thread (-s)\\en\");\n"
6137 " param.sched_priority = strtol(&main_sched_str[1], NULL, 0);\n"
6141 #: build/C/man3/pthread_setschedparam.3:348
6144 " s = pthread_setschedparam(pthread_self(), policy, ¶m);\n"
6146 " handle_error_en(s, \"pthread_setschedparam\");\n"
6151 #: build/C/man3/pthread_setschedparam.3:351
6154 " display_thread_sched_attr(\"Scheduler settings of main thread\");\n"
6155 " printf(\"\\en\");\n"
6159 #: build/C/man3/pthread_setschedparam.3:353
6161 msgid " /* Initialize thread attributes object according to options */\n"
6165 #: build/C/man3/pthread_setschedparam.3:362
6168 " if (!use_null_attrib) {\n"
6169 " s = pthread_attr_init(&attr);\n"
6171 " handle_error_en(s, \"pthread_attr_init\");\n"
6177 #: build/C/man3/pthread_setschedparam.3:370
6180 " if (inheritsched_str != NULL) {\n"
6181 " if (inheritsched_str[0] == \\(aqe\\(aq)\n"
6182 " inheritsched = PTHREAD_EXPLICIT_SCHED;\n"
6183 " else if (inheritsched_str[0] == \\(aqi\\(aq)\n"
6184 " inheritsched = PTHREAD_INHERIT_SCHED;\n"
6186 " usage(argv[0], \"Value for -i must be \\(aqe\\(aq or "
6187 "\\(aqi\\(aq\\en\");\n"
6191 #: build/C/man3/pthread_setschedparam.3:375
6194 " s = pthread_attr_setinheritsched(&attr, inheritsched);\n"
6196 " handle_error_en(s, \"pthread_attr_setinheritsched\");\n"
6201 #: build/C/man3/pthread_setschedparam.3:381
6204 " if (attr_sched_str != NULL) {\n"
6205 " if (!get_policy(attr_sched_str[0], &policy))\n"
6207 " \"Bad policy for \\(aqattr\\(aq (-a)\\en\");\n"
6208 " param.sched_priority = strtol(&attr_sched_str[1], NULL, 0);\n"
6212 #: build/C/man3/pthread_setschedparam.3:389
6215 " s = pthread_attr_setschedpolicy(&attr, policy);\n"
6217 " handle_error_en(s, \"pthread_attr_setschedpolicy\");\n"
6218 " s = pthread_attr_setschedparam(&attr, ¶m);\n"
6220 " handle_error_en(s, \"pthread_attr_setschedparam\");\n"
6225 #: build/C/man3/pthread_setschedparam.3:392
6228 " /* If we initialized a thread attributes object, display\n"
6229 " the scheduling attributes that were set in the object */\n"
6233 #: build/C/man3/pthread_setschedparam.3:400
6236 " if (attrp != NULL) {\n"
6237 " s = pthread_attr_getschedparam(&attr, ¶m);\n"
6239 " handle_error_en(s, \"pthread_attr_getschedparam\");\n"
6240 " s = pthread_attr_getschedpolicy(&attr, &policy);\n"
6242 " handle_error_en(s, \"pthread_attr_getschedpolicy\");\n"
6246 #: build/C/man3/pthread_setschedparam.3:403
6249 " printf(\"Scheduler settings in \\(aqattr\\(aq\\en\");\n"
6250 " display_sched_attr(policy, ¶m);\n"
6254 #: build/C/man3/pthread_setschedparam.3:411
6257 " s = pthread_attr_getinheritsched(&attr, &inheritsched);\n"
6258 " printf(\" inheritsched is %s\\en\",\n"
6259 " (inheritsched == PTHREAD_INHERIT_SCHED) ? \"INHERIT\" :\n"
6260 " (inheritsched == PTHREAD_EXPLICIT_SCHED) ? \"EXPLICIT\" :\n"
6262 " printf(\"\\en\");\n"
6267 #: build/C/man3/pthread_setschedparam.3:413
6269 msgid " /* Create a thread that will display its scheduling attributes */\n"
6273 #: build/C/man3/pthread_setschedparam.3:417
6276 " s = pthread_create(&thread, attrp, &thread_start, NULL);\n"
6278 " handle_error_en(s, \"pthread_create\");\n"
6282 #: build/C/man3/pthread_setschedparam.3:419
6284 msgid " /* Destroy unneeded thread attributes object */\n"
6288 #: build/C/man3/pthread_setschedparam.3:427
6291 " s = pthread_join(thread, NULL);\n"
6293 " handle_error_en(s, \"pthread_join\");\n"
6297 #: build/C/man3/pthread_setschedparam.3:445
6299 "B<getrlimit>(2), B<sched_get_priority_min>(2), B<sched_setscheduler>(2), "
6300 "B<pthread_attr_init>(3), B<pthread_attr_setinheritsched>(3), "
6301 "B<pthread_attr_setschedparam>(3), B<pthread_attr_setschedpolicy>(3), "
6302 "B<pthread_create>(3), B<pthread_self>(3), B<pthread_setschedprio>(3), "
6307 #: build/C/man3/pthread_setschedprio.3:26
6309 msgid "PTHREAD_SETSCHEDPRIO"
6313 #: build/C/man3/pthread_setschedprio.3:26
6319 #: build/C/man3/pthread_setschedprio.3:29
6320 msgid "pthread_setschedprio - set scheduling priority of a thread"
6324 #: build/C/man3/pthread_setschedprio.3:34
6326 msgid "B<pthread_setschedprio(pthread_t >I<thread>B<, int >I<prio>B<);>\n"
6329 #. FIXME . nptl/pthread_setschedprio.c has the following
6330 #. /* If the thread should have higher priority because of some
6331 #. PTHREAD_PRIO_PROTECT mutexes it holds, adjust the priority. */
6332 #. Eventually (perhaps after writing the mutexattr pages), we
6333 #. may want to add something on the topic to this page.
6334 #. nptl/pthread_setschedparam.c has a similar case.
6336 #: build/C/man3/pthread_setschedprio.3:53
6338 "The B<pthread_setschedprio>() function sets the scheduling priority of the "
6339 "thread I<thread> to the value specified in I<prio>. (By contrast "
6340 "B<pthread_setschedparam>(3) changes both the scheduling policy and priority "
6345 #: build/C/man3/pthread_setschedprio.3:61
6347 "On success, this function returns 0; on error, it returns a nonzero error "
6348 "number. If B<pthread_setschedprio>() fails, the scheduling priority of "
6349 "I<thread> is not changed."
6353 #: build/C/man3/pthread_setschedprio.3:66
6354 msgid "I<prio> is not valid for the scheduling policy of the specified thread."
6358 #: build/C/man3/pthread_setschedprio.3:70
6360 "The caller does not have appropriate privileges to set the specified "
6365 #: build/C/man3/pthread_setschedprio.3:81
6367 "POSIX.1-2001 also documents an B<ENOTSUP> (\"attempt was made to set the "
6368 "priority to an unsupported value\") error for B<pthread_setschedparam>(3)."
6372 #: build/C/man3/pthread_setschedprio.3:83
6373 msgid "This function is available in glibc since version 2.3.4."
6377 #: build/C/man3/pthread_setschedprio.3:91
6379 "For a description of the permissions required to, and the effect of, "
6380 "changing a thread's scheduling priority, and details of the permitted ranges "
6381 "for priorities in each scheduling policy, see B<sched_setscheduler>(2)."
6385 #: build/C/man3/pthread_setschedprio.3:105
6387 "B<getrlimit>(2), B<sched_get_priority_min>(2), B<sched_setscheduler>(2), "
6388 "B<pthread_attr_init>(3), B<pthread_attr_setinheritsched>(3), "
6389 "B<pthread_attr_setschedparam>(3), B<pthread_attr_setschedpolicy>(3), "
6390 "B<pthread_create>(3), B<pthread_self>(3), B<pthread_setschedparam>(3), "
6395 #: build/C/man3/pthread_sigmask.3:26
6397 msgid "PTHREAD_SIGMASK"
6401 #: build/C/man3/pthread_sigmask.3:29
6402 msgid "pthread_sigmask - examine and change mask of blocked signals"
6406 #: build/C/man3/pthread_sigmask.3:35
6409 "B<int pthread_sigmask(int >I<how>B<, const sigset_t *>I<set>B<, sigset_t "
6410 "*>I<oldset>B<);>\n"
6414 #: build/C/man3/pthread_sigmask.3:46
6415 msgid "B<pthread_sigmask>():"
6419 #: build/C/man3/pthread_sigmask.3:58
6421 "The B<pthread_sigmask>() function is just like B<sigprocmask>(2), with the "
6422 "difference that its use in multithreaded programs is explicitly specified by "
6423 "POSIX.1-2001. Other differences are noted in this page."
6427 #: build/C/man3/pthread_sigmask.3:61
6429 "For a description of the arguments and operation of this function, see "
6430 "B<sigprocmask>(2)."
6434 #: build/C/man3/pthread_sigmask.3:66
6436 "On success, B<pthread_sigmask>() returns 0; on error, it returns an error "
6441 #: build/C/man3/pthread_sigmask.3:69
6442 msgid "See B<sigprocmask>(2)."
6446 #: build/C/man3/pthread_sigmask.3:73
6447 msgid "A new thread inherits a copy of its creator's signal mask."
6451 #: build/C/man3/pthread_sigmask.3:78
6453 "The program below blocks some signals in the main thread, and then creates a "
6454 "dedicated thread to fetch those signals via B<sigwait>(3). The following "
6455 "shell session demonstrates its use:"
6459 #: build/C/man3/pthread_sigmask.3:89
6464 "$B< kill -QUIT %1>\n"
6465 "Signal handling thread got signal 3\n"
6466 "$B< kill -USR1 %1>\n"
6467 "Signal handling thread got signal 10\n"
6468 "$B< kill -TERM %1>\n"
6469 "[1]+ Terminated ./a.out\n"
6473 #: build/C/man3/pthread_sigmask.3:100
6476 "#include E<lt>pthread.hE<gt>\n"
6477 "#include E<lt>stdio.hE<gt>\n"
6478 "#include E<lt>stdlib.hE<gt>\n"
6479 "#include E<lt>unistd.hE<gt>\n"
6480 "#include E<lt>signal.hE<gt>\n"
6481 "#include E<lt>errno.hE<gt>\n"
6485 #: build/C/man3/pthread_sigmask.3:102
6487 msgid "/* Simple error handling functions */\n"
6491 #: build/C/man3/pthread_sigmask.3:111
6495 "sig_thread(void *arg)\n"
6497 " sigset_t *set = arg;\n"
6502 #: build/C/man3/pthread_sigmask.3:119
6506 " s = sigwait(set, &sig);\n"
6508 " handle_error_en(s, \"sigwait\");\n"
6509 " printf(\"Signal handling thread got signal %d\\en\", sig);\n"
6515 #: build/C/man3/pthread_sigmask.3:126
6519 "main(int argc, char *argv[])\n"
6521 " pthread_t thread;\n"
6527 #: build/C/man3/pthread_sigmask.3:129
6530 " /* Block SIGQUIT and SIGUSR1; other threads created by main()\n"
6531 " will inherit a copy of the signal mask. */\n"
6535 #: build/C/man3/pthread_sigmask.3:136
6538 " sigemptyset(&set);\n"
6539 " sigaddset(&set, SIGQUIT);\n"
6540 " sigaddset(&set, SIGUSR1);\n"
6541 " s = pthread_sigmask(SIG_BLOCK, &set, NULL);\n"
6543 " handle_error_en(s, \"pthread_sigmask\");\n"
6547 #: build/C/man3/pthread_sigmask.3:140
6550 " s = pthread_create(&thread, NULL, &sig_thread, (void *) &set);\n"
6552 " handle_error_en(s, \"pthread_create\");\n"
6556 #: build/C/man3/pthread_sigmask.3:143
6559 " /* Main thread carries on to create other threads and/or do\n"
6564 #: build/C/man3/pthread_sigmask.3:146
6567 " pause(); /* Dummy pause so we can test program */\n"
6572 #: build/C/man3/pthread_sigmask.3:156
6574 "B<sigaction>(2), B<sigpending>(2), B<sigprocmask>(2), B<pthread_create>(3), "
6575 "B<pthread_kill>(3), B<sigsetops>(3), B<pthreads>(7), B<signal>(7)"
6579 #: build/C/man3/pthread_sigqueue.3:25
6581 msgid "PTHREAD_SIGQUEUE"
6585 #: build/C/man3/pthread_sigqueue.3:25
6591 #: build/C/man3/pthread_sigqueue.3:28
6592 msgid "pthread_sigqueue - queue a signal and data to a thread"
6596 #: build/C/man3/pthread_sigqueue.3:34
6599 "B<int pthread_sigqueue(pthread_t >I<thread>B<, int >I<sig>B<,>\n"
6600 "B< const union sigval >I<value>B<);>\n"
6604 #: build/C/man3/pthread_sigqueue.3:45
6605 msgid "B<pthread_sigqueue>(): _GNU_SOURCE"
6609 #: build/C/man3/pthread_sigqueue.3:53
6611 "The B<pthread_sigqueue>() function performs a similar task to "
6612 "B<sigqueue>(3), but, rather than sending a signal to a process, it sends a "
6613 "signal to a thread in the same process as the calling thread."
6617 #: build/C/man3/pthread_sigqueue.3:65
6619 "The I<thread> argument is the ID of a thread in the same process as the "
6620 "caller. The I<sig> argument specifies the signal to be sent. The I<value> "
6621 "argument specifies data to accompany the signal; see B<sigqueue>(3) for "
6626 #: build/C/man3/pthread_sigqueue.3:70
6628 "On success, B<pthread_sigqueue>() returns 0; on error, it returns an error "
6633 #: build/C/man3/pthread_sigqueue.3:77
6635 "The limit of signals which may be queued has been reached. (See "
6636 "B<signal>(7) for further information.)"
6640 #: build/C/man3/pthread_sigqueue.3:81
6641 msgid "I<sig> was invalid."
6645 #: build/C/man3/pthread_sigqueue.3:81
6651 #: build/C/man3/pthread_sigqueue.3:85
6652 msgid "B<pthread_sigqueue>() is not supported on this system."
6656 #: build/C/man3/pthread_sigqueue.3:89
6657 msgid "I<thread> is not valid."
6661 #: build/C/man3/pthread_sigqueue.3:93
6662 msgid "The B<pthread_sigqueue>() function first appeared in glibc 2.11."
6666 #: build/C/man3/pthread_sigqueue.3:95
6667 msgid "This function is a GNU extension."
6671 #: build/C/man3/pthread_sigqueue.3:103
6673 "B<rt_tgsigqueueinfo>(2), B<sigaction>(2), B<pthread_sigmask>(3), "
6674 "B<sigqueue>(3), B<sigwait>(3), B<pthreads>(7), B<signal>(7)"
6678 #: build/C/man3/pthread_testcancel.3:26
6680 msgid "PTHREAD_TESTCANCEL"
6684 #: build/C/man3/pthread_testcancel.3:26
6690 #: build/C/man3/pthread_testcancel.3:29
6691 msgid "pthread_testcancel - request delivery of any pending cancellation request"
6695 #: build/C/man3/pthread_testcancel.3:34
6697 msgid "B<void pthread_testcancel(void);>\n"
6701 #: build/C/man3/pthread_testcancel.3:43
6703 "Calling B<pthread_testcancel>() creates a cancellation point within the "
6704 "calling thread, so that a thread that is otherwise executing code that "
6705 "contains no cancellation points will respond to a cancellation request."
6709 #: build/C/man3/pthread_testcancel.3:50
6711 "If cancelability is disabled (using B<pthread_setcancelstate>(3)), or no "
6712 "cancellation request is pending, then a call to B<pthread_testcancel>() has "
6717 #: build/C/man3/pthread_testcancel.3:54
6719 "This function does not return a value. If the calling thread is canceled as "
6720 "a consequence of a call to this function, then the function does not return."
6724 #: build/C/man3/pthread_testcancel.3:63
6725 msgid "See B<pthread_cleanup_push>(3)."
6729 #: build/C/man3/pthread_testcancel.3:68
6731 "B<pthread_cancel>(3), B<pthread_cleanup_push>(3), "
6732 "B<pthread_setcancelstate>(3), B<pthreads>(7)"
6736 #: build/C/man3/pthread_tryjoin_np.3:26
6738 msgid "PTHREAD_TRYJOIN_NP"
6742 #: build/C/man3/pthread_tryjoin_np.3:30
6744 "pthread_tryjoin_np, pthread_timedjoin_np - try to join with a terminated "
6749 #: build/C/man3/pthread_tryjoin_np.3:36
6751 msgid "B<int pthread_tryjoin_np(pthread_t >I<thread>B<, void **>I<retval>B<);>\n"
6755 #: build/C/man3/pthread_tryjoin_np.3:39
6758 "B<int pthread_timedjoin_np(pthread_t >I<thread>B<, void **>I<retval>B<,>\n"
6759 "B< const struct timespec *>I<abstime>B<);>\n"
6763 #: build/C/man3/pthread_tryjoin_np.3:46
6765 "These functions operate in the same way as B<pthread_join>(3), except for "
6766 "the differences described on this page."
6770 #: build/C/man3/pthread_tryjoin_np.3:58
6772 "The B<pthread_tryjoin_np>() function performs a nonblocking join with the "
6773 "thread I<thread>, returning the exit status of the thread in I<*retval>. If "
6774 "I<thread> has not yet terminated, then instead of blocking, as is done by "
6775 "B<pthread_join>(3), the call returns an error."
6779 #: build/C/man3/pthread_tryjoin_np.3:76
6781 "The B<pthread_timedjoin_np>() function performs a join-with-timeout. If "
6782 "I<thread> has not yet terminated, then the call blocks until a maximum time, "
6783 "specified in I<abstime>. If the timeout expires before I<thread> "
6784 "terminates, the call returns an error. The I<abstime> argument is a "
6785 "structure of the following form, specifying an absolute time measured since "
6786 "the Epoch (see B<time>(2)):"
6790 #: build/C/man3/pthread_tryjoin_np.3:83
6793 "struct timespec {\n"
6794 " time_t tv_sec; /* seconds */\n"
6795 " long tv_nsec; /* nanoseconds */\n"
6800 #: build/C/man3/pthread_tryjoin_np.3:89
6801 msgid "On success, these functions return 0; on error, they return an error number."
6805 #: build/C/man3/pthread_tryjoin_np.3:94
6807 "These functions can fail with the same errors as B<pthread_join>(3). "
6808 "B<pthread_tryjoin_np>() can in addition fail with the following error:"
6812 #: build/C/man3/pthread_tryjoin_np.3:94
6818 #: build/C/man3/pthread_tryjoin_np.3:98
6819 msgid "I<thread> had not yet terminated at the time of the call."
6823 #: build/C/man3/pthread_tryjoin_np.3:101
6824 msgid "B<pthread_timedjoin_np>() can in addition fail with the following error:"
6828 #: build/C/man3/pthread_tryjoin_np.3:101
6830 msgid "B<ETIMEDOUT>"
6834 #: build/C/man3/pthread_tryjoin_np.3:106
6835 msgid "The call timed out before I<thread> terminated."
6839 #: build/C/man3/pthread_tryjoin_np.3:110
6840 msgid "B<pthread_timedjoin_np>() never returns the error B<EINTR>."
6844 #: build/C/man3/pthread_tryjoin_np.3:112
6845 msgid "These functions first appeared in glibc in version 2.3.3."
6849 #: build/C/man3/pthread_tryjoin_np.3:117
6850 msgid "The following code waits to join for up to 5 seconds:"
6854 #: build/C/man3/pthread_tryjoin_np.3:121
6857 " struct timespec ts;\n"
6862 #: build/C/man3/pthread_tryjoin_np.3:123
6868 #: build/C/man3/pthread_tryjoin_np.3:127
6871 " if (clock_gettime(CLOCK_REALTIME, &ts) == -1) {\n"
6872 "\t/* Handle error */\n"
6877 #: build/C/man3/pthread_tryjoin_np.3:129
6879 msgid " ts.tv_sec += 5;\n"
6883 #: build/C/man3/pthread_tryjoin_np.3:134
6886 " s = pthread_timedjoin_np(thread, NULL, &ts);\n"
6888 " /* Handle error */\n"
6893 #: build/C/man3/pthread_tryjoin_np.3:140
6894 msgid "B<clock_gettime>(2), B<pthread_exit>(3), B<pthread_join>(3), B<pthreads>(7)"
6898 #: build/C/man3/pthread_yield.3:25
6900 msgid "PTHREAD_YIELD"
6904 #: build/C/man3/pthread_yield.3:25
6910 #: build/C/man3/pthread_yield.3:28
6911 msgid "pthread_yield - yield the processor"
6915 #: build/C/man3/pthread_yield.3:34
6917 msgid "B<int pthread_yield(void);>\n"
6921 #: build/C/man3/pthread_yield.3:44
6923 "B<pthread_yield>() causes the calling thread to relinquish the CPU. The "
6924 "thread is placed at the end of the run queue for its static priority and "
6925 "another thread is scheduled to run. For further details, see "
6930 #: build/C/man3/pthread_yield.3:49
6932 "On success, B<pthread_yield>() returns 0; on error, it returns an error "
6937 #: build/C/man3/pthread_yield.3:53
6939 "On Linux, this call always succeeds (but portable and future-proof "
6940 "applications should nevertheless handle a possible error return)."
6943 #. e.g., the BSDs, Tru64, AIX, and Irix.
6945 #: build/C/man3/pthread_yield.3:59
6947 "This call is nonstandard, but present on several other systems. Use the "
6948 "standardized B<sched_yield>(2) instead."
6952 #: build/C/man3/pthread_yield.3:62
6953 msgid "On Linux, this function is implemented as a call to B<sched_yield>(2)."
6957 #: build/C/man3/pthread_yield.3:66
6958 msgid "B<sched_setscheduler>(2), B<sched_yield>(2), B<pthreads>(7)"
6962 #: build/C/man7/pthreads.7:26
6968 #: build/C/man7/pthreads.7:26
6974 #: build/C/man7/pthreads.7:29
6975 msgid "pthreads - POSIX threads"
6979 #: build/C/man7/pthreads.7:36
6981 "POSIX.1 specifies a set of interfaces (functions, header files) for threaded "
6982 "programming commonly known as POSIX threads, or Pthreads. A single process "
6983 "can contain multiple threads, all of which are executing the same program. "
6984 "These threads share the same global memory (data and heap segments), but "
6985 "each thread has its own stack (automatic variables)."
6989 #: build/C/man7/pthreads.7:39
6991 "POSIX.1 also requires that threads share a range of other attributes (i.e., "
6992 "these attributes are process-wide rather than per-thread):"
6996 #: build/C/man7/pthreads.7:39 build/C/man7/pthreads.7:41 build/C/man7/pthreads.7:43 build/C/man7/pthreads.7:45 build/C/man7/pthreads.7:47 build/C/man7/pthreads.7:49 build/C/man7/pthreads.7:51 build/C/man7/pthreads.7:54 build/C/man7/pthreads.7:56 build/C/man7/pthreads.7:59 build/C/man7/pthreads.7:65 build/C/man7/pthreads.7:70 build/C/man7/pthreads.7:73 build/C/man7/pthreads.7:76 build/C/man7/pthreads.7:84 build/C/man7/pthreads.7:88 build/C/man7/pthreads.7:91 build/C/man7/pthreads.7:95 build/C/man7/pthreads.7:98 build/C/man7/pthreads.7:105 build/C/man7/pthreads.7:108 build/C/man7/pthreads.7:685 build/C/man7/pthreads.7:692 build/C/man7/pthreads.7:704 build/C/man7/pthreads.7:714 build/C/man7/pthreads.7:718 build/C/man7/pthreads.7:727 build/C/man7/pthreads.7:737 build/C/man7/pthreads.7:744 build/C/man7/pthreads.7:751 build/C/man7/pthreads.7:753 build/C/man7/pthreads.7:756 build/C/man7/pthreads.7:762 build/C/man7/pthreads.7:765 build/C/man7/pthreads.7:767 build/C/man7/pthreads.7:769 build/C/man7/pthreads.7:779 build/C/man7/pthreads.7:799 build/C/man7/pthreads.7:808 build/C/man7/pthreads.7:814 build/C/man7/pthreads.7:816 build/C/man7/pthreads.7:818 build/C/man7/pthreads.7:822 build/C/man7/pthreads.7:827 build/C/man7/pthreads.7:835
7002 #: build/C/man7/pthreads.7:41
7007 #: build/C/man7/pthreads.7:43
7008 msgid "parent process ID"
7012 #: build/C/man7/pthreads.7:45
7013 msgid "process group ID and session ID"
7017 #: build/C/man7/pthreads.7:47
7018 msgid "controlling terminal"
7022 #: build/C/man7/pthreads.7:49
7023 msgid "user and group IDs"
7027 #: build/C/man7/pthreads.7:51
7028 msgid "open file descriptors"
7032 #: build/C/man7/pthreads.7:54
7033 msgid "record locks (see B<fcntl>(2))"
7037 #: build/C/man7/pthreads.7:56
7038 msgid "signal dispositions"
7042 #: build/C/man7/pthreads.7:59
7043 msgid "file mode creation mask (B<umask>(2))"
7047 #: build/C/man7/pthreads.7:65
7048 msgid "current directory (B<chdir>(2)) and root directory (B<chroot>(2))"
7052 #: build/C/man7/pthreads.7:70
7053 msgid "interval timers (B<setitimer>(2)) and POSIX timers (B<timer_create>(2))"
7057 #: build/C/man7/pthreads.7:73
7058 msgid "nice value (B<setpriority>(2))"
7062 #: build/C/man7/pthreads.7:76
7063 msgid "resource limits (B<setrlimit>(2))"
7067 #: build/C/man7/pthreads.7:81
7069 "measurements of the consumption of CPU time (B<times>(2)) and resources "
7074 #: build/C/man7/pthreads.7:84
7076 "As well as the stack, POSIX.1 specifies that various other attributes are "
7077 "distinct for each thread, including:"
7081 #: build/C/man7/pthreads.7:88
7082 msgid "thread ID (the I<pthread_t> data type)"
7086 #: build/C/man7/pthreads.7:91
7087 msgid "signal mask (B<pthread_sigmask>(3))"
7091 #: build/C/man7/pthreads.7:95
7092 msgid "the I<errno> variable"
7096 #: build/C/man7/pthreads.7:98
7097 msgid "alternate signal stack (B<sigaltstack>(2))"
7101 #: build/C/man7/pthreads.7:103
7103 "real-time scheduling policy and priority (B<sched_setscheduler>(2) and "
7104 "B<sched_setparam>(2))"
7108 #: build/C/man7/pthreads.7:105
7109 msgid "The following Linux-specific features are also per-thread:"
7113 #: build/C/man7/pthreads.7:108
7114 msgid "capabilities (see B<capabilities>(7))"
7118 #: build/C/man7/pthreads.7:111
7119 msgid "CPU affinity (B<sched_setaffinity>(2))"
7123 #: build/C/man7/pthreads.7:111
7125 msgid "Pthreads function return values"
7129 #: build/C/man7/pthreads.7:118
7131 "Most pthreads functions return 0 on success, and an error number of "
7132 "failure. Note that the pthreads functions do not set I<errno>. For each of "
7133 "the pthreads functions that can return an error, POSIX.1-2001 specifies that "
7134 "the function can never fail with the error B<EINTR>."
7138 #: build/C/man7/pthreads.7:118
7144 #: build/C/man7/pthreads.7:132
7146 "Each of the threads in a process has a unique thread identifier (stored in "
7147 "the type I<pthread_t>). This identifier is returned to the caller of "
7148 "B<pthread_create>(3), and a thread can obtain its own thread identifier "
7149 "using B<pthread_self>(3). Thread IDs are guaranteed to be unique only "
7150 "within a process. A thread ID may be reused after a terminated thread has "
7151 "been joined, or a detached thread has terminated. In all pthreads functions "
7152 "that accept a thread ID as an argument, that ID by definition refers to a "
7153 "thread in the same process as the caller."
7157 #: build/C/man7/pthreads.7:132
7159 msgid "Thread-safe functions"
7163 #: build/C/man7/pthreads.7:136
7165 "A thread-safe function is one that can be safely (i.e., it will deliver the "
7166 "same results regardless of whether it is) called from multiple threads at "
7171 #: build/C/man7/pthreads.7:140
7173 "POSIX.1-2001 and POSIX.1-2008 require that all functions specified in the "
7174 "standard shall be thread-safe, except for the following functions:"
7178 #: build/C/man7/pthreads.7:234
7185 "ctermid() if passed a non-NULL argument\n"
7199 "ecvt() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7204 "fcvt() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7206 "gcvt() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7208 "getchar_unlocked()\n"
7214 "gethostbyaddr() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7215 "gethostbyname() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7222 "getprotobyname()\n"
7223 "getprotobynumber()\n"
7251 "putchar_unlocked()\n"
7262 "strsignal() [Added in POSIX.1-2008]\n"
7264 "system() [Added in POSIX.1-2008]\n"
7265 "tmpnam() if passed a non-NULL argument\n"
7268 "wcrtomb() if its final argument is NULL\n"
7269 "wcsrtombs() if its final argument is NULL\n"
7275 #: build/C/man7/pthreads.7:236
7277 msgid "Async-cancel-safe functions"
7281 #: build/C/man7/pthreads.7:240
7283 "An async-cancel-safe function is one that can be safely called in an "
7284 "application where asynchronous cancelability is enabled (see "
7285 "B<pthread_setcancelstate>(3))."
7289 #: build/C/man7/pthreads.7:243
7291 "Only the following functions are required to be async-cancel-safe by "
7292 "POSIX.1-2001 and POSIX.1-2008:"
7296 #: build/C/man7/pthreads.7:249
7299 "pthread_cancel()\n"
7300 "pthread_setcancelstate()\n"
7301 "pthread_setcanceltype()\n"
7305 #: build/C/man7/pthreads.7:251
7307 msgid "Cancellation points"
7311 #: build/C/man7/pthreads.7:258
7313 "POSIX.1 specifies that certain functions must, and certain other functions "
7314 "may, be cancellation points. If a thread is cancelable, its cancelability "
7315 "type is deferred, and a cancellation request is pending for the thread, then "
7316 "the thread is canceled when it calls a function that is a cancellation "
7321 #: build/C/man7/pthreads.7:261
7323 "The following functions are required to be cancellation points by "
7324 "POSIX.1-2001 and/or POSIX.1-2008:"
7328 #: build/C/man7/pthreads.7:324
7333 "clock_nanosleep()\n"
7337 "fcntl() F_SETLKW\n"
7345 "mq_timedreceive()\n"
7352 "openat() [Added in POSIX.1-2008]\n"
7357 "pthread_cond_timedwait()\n"
7358 "pthread_cond_wait()\n"
7360 "pthread_testcancel()\n"
7375 "sigpause() [POSIX.1-2001 only (moves to \"may\" list in POSIX.1-2008)]\n"
7383 "usleep() [POSIX.1-2001 only (function removed in POSIX.1-2008)]\n"
7392 #: build/C/man7/pthreads.7:329
7394 "The following functions may be cancellation points according to POSIX.1-2001 "
7395 "and/or POSIX.1-2008:"
7399 #: build/C/man7/pthreads.7:557
7408 "chmod() [Added in POSIX.1-2008]\n"
7409 "chown() [Added in POSIX.1-2008]\n"
7423 "dprintf() [Added in POSIX.1-2008]\n"
7431 "faccessat() [Added in POSIX.1-2008]\n"
7432 "fchmod() [Added in POSIX.1-2008]\n"
7433 "fchmodat() [Added in POSIX.1-2008]\n"
7434 "fchown() [Added in POSIX.1-2008]\n"
7435 "fchownat() [Added in POSIX.1-2008]\n"
7437 "fcntl() (for any value of cmd argument)\n"
7459 "fstatat() [Added in POSIX.1-2008]\n"
7463 "futimens() [Added in POSIX.1-2008]\n"
7471 "getchar_unlocked()\n"
7474 "getdelim() [Added in POSIX.1-2008]\n"
7480 "gethostbyaddr() [SUSv3 only (function removed in POSIX.1-2008)]\n"
7481 "gethostbyname() [SUSv3 only (function removed in POSIX.1-2008)]\n"
7485 "getline() [Added in POSIX.1-2008]\n"
7492 "getopt() (if opterr is nonzero)\n"
7493 "getprotobyname()\n"
7494 "getprotobynumber()\n"
7510 "getwd() [SUSv3 only (function removed in POSIX.1-2008)]\n"
7516 "linkat() [Added in POSIX.1-2008]\n"
7517 "lio_listio() [Added in POSIX.1-2008]\n"
7520 "lockf() [Added in POSIX.1-2008]\n"
7523 "mkdir() [Added in POSIX.1-2008]\n"
7524 "mkdirat() [Added in POSIX.1-2008]\n"
7525 "mkdtemp() [Added in POSIX.1-2008]\n"
7526 "mkfifo() [Added in POSIX.1-2008]\n"
7527 "mkfifoat() [Added in POSIX.1-2008]\n"
7528 "mknod() [Added in POSIX.1-2008]\n"
7529 "mknodat() [Added in POSIX.1-2008]\n"
7540 "posix_fallocate()\n"
7545 "posix_trace_clear()\n"
7546 "posix_trace_close()\n"
7547 "posix_trace_create()\n"
7548 "posix_trace_create_withlog()\n"
7549 "posix_trace_eventtypelist_getnext_id()\n"
7550 "posix_trace_eventtypelist_rewind()\n"
7551 "posix_trace_flush()\n"
7552 "posix_trace_get_attr()\n"
7553 "posix_trace_get_filter()\n"
7554 "posix_trace_get_status()\n"
7555 "posix_trace_getnext_event()\n"
7556 "posix_trace_open()\n"
7557 "posix_trace_rewind()\n"
7558 "posix_trace_set_filter()\n"
7559 "posix_trace_shutdown()\n"
7560 "posix_trace_timedgetnext_event()\n"
7561 "posix_typed_mem_open()\n"
7563 "psiginfo() [Added in POSIX.1-2008]\n"
7564 "psignal() [Added in POSIX.1-2008]\n"
7565 "pthread_rwlock_rdlock()\n"
7566 "pthread_rwlock_timedrdlock()\n"
7567 "pthread_rwlock_timedwrlock()\n"
7568 "pthread_rwlock_wrlock()\n"
7572 "putchar_unlocked()\n"
7579 "readlink() [Added in POSIX.1-2008]\n"
7580 "readlinkat() [Added in POSIX.1-2008]\n"
7583 "renameat() [Added in POSIX.1-2008]\n"
7586 "scandir() [Added in POSIX.1-2008]\n"
7597 "sigpause() [Added in POSIX.1-2008]\n"
7603 "symlinkat() [Added in POSIX.1-2008]\n"
7614 "unlinkat() [Added in POSIX.1-2008]\n"
7615 "utime() [Added in POSIX.1-2008]\n"
7616 "utimensat() [Added in POSIX.1-2008]\n"
7617 "utimes() [Added in POSIX.1-2008]\n"
7618 "vdprintf() [Added in POSIX.1-2008]\n"
7629 #. So, scanning "cancellation point" comments in the glibc 2.8 header
7630 #. files, it looks as though at least the following nonstandard
7631 #. functions are cancellation points:
7671 #. getprotobynumber_r
7686 #. getwchar_unlocked
7693 #. pthread_timedjoin_np
7699 #. putwchar_unlocked
7720 #: build/C/man7/pthreads.7:655
7722 "An implementation may also mark other functions not specified in the "
7723 "standard as cancellation points. In particular, an implementation is likely "
7724 "to mark any nonstandard function that may block as a cancellation point. "
7725 "(This includes most functions that can touch files.)"
7729 #: build/C/man7/pthreads.7:655
7731 msgid "Compiling on Linux"
7735 #: build/C/man7/pthreads.7:658
7737 "On Linux, programs that use the Pthreads API should be compiled using I<cc "
7742 #: build/C/man7/pthreads.7:658
7744 msgid "Linux implementations of POSIX threads"
7748 #: build/C/man7/pthreads.7:661
7750 "Over time, two threading implementations have been provided by the GNU C "
7755 #: build/C/man7/pthreads.7:661
7757 msgid "B<LinuxThreads>"
7761 #: build/C/man7/pthreads.7:665
7763 "This is the original Pthreads implementation. Since glibc 2.4, this "
7764 "implementation is no longer supported."
7768 #: build/C/man7/pthreads.7:665
7770 msgid "B<NPTL> (Native POSIX Threads Library)"
7774 #: build/C/man7/pthreads.7:673
7776 "This is the modern Pthreads implementation. By comparison with "
7777 "LinuxThreads, NPTL provides closer conformance to the requirements of the "
7778 "POSIX.1 specification and better performance when creating large numbers of "
7779 "threads. NPTL is available since glibc 2.3.2, and requires features that "
7780 "are present in the Linux 2.6 kernel."
7784 #: build/C/man7/pthreads.7:683
7786 "Both of these are so-called 1:1 implementations, meaning that each thread "
7787 "maps to a kernel scheduling entity. Both threading implementations employ "
7788 "the Linux B<clone>(2) system call. In NPTL, thread synchronization "
7789 "primitives (mutexes, thread joining, and so on) are implemented using the "
7790 "Linux B<futex>(2) system call."
7794 #: build/C/man7/pthreads.7:683
7796 msgid "LinuxThreads"
7800 #: build/C/man7/pthreads.7:685
7801 msgid "The notable features of this implementation are the following:"
7805 #: build/C/man7/pthreads.7:692
7807 "In addition to the main (initial) thread, and the threads that the program "
7808 "creates using B<pthread_create>(3), the implementation creates a \"manager\" "
7809 "thread. This thread handles thread creation and termination. (Problems can "
7810 "result if this thread is inadvertently killed.)"
7814 #: build/C/man7/pthreads.7:704
7816 "Signals are used internally by the implementation. On Linux 2.2 and later, "
7817 "the first three real-time signals are used (see also B<signal>(7)). On "
7818 "older Linux kernels, B<SIGUSR1> and B<SIGUSR2> are used. Applications must "
7819 "avoid the use of whichever set of signals is employed by the implementation."
7823 #: build/C/man7/pthreads.7:711
7825 "Threads do not share process IDs. (In effect, LinuxThreads threads are "
7826 "implemented as processes which share more information than usual, but which "
7827 "do not share a common process ID.) LinuxThreads threads (including the "
7828 "manager thread) are visible as separate processes using B<ps>(1)."
7832 #: build/C/man7/pthreads.7:714
7834 "The LinuxThreads implementation deviates from the POSIX.1 specification in a "
7835 "number of ways, including the following:"
7839 #: build/C/man7/pthreads.7:718
7840 msgid "Calls to B<getpid>(2) return a different value in each thread."
7844 #: build/C/man7/pthreads.7:727
7846 "Calls to B<getppid>(2) in threads other than the main thread return the "
7847 "process ID of the manager thread; instead B<getppid>(2) in these threads "
7848 "should return the same value as B<getppid>(2) in the main thread."
7852 #: build/C/man7/pthreads.7:737
7854 "When one thread creates a new child process using B<fork>(2), any thread "
7855 "should be able to B<wait>(2) on the child. However, the implementation "
7856 "only allows the thread that created the child to B<wait>(2) on it."
7860 #: build/C/man7/pthreads.7:744
7862 "When a thread calls B<execve>(2), all other threads are terminated (as "
7863 "required by POSIX.1). However, the resulting process has the same PID as "
7864 "the thread that called B<execve>(2): it should have the same PID as the main "
7869 #: build/C/man7/pthreads.7:751
7871 "Threads do not share user and group IDs. This can cause complications with "
7872 "set-user-ID programs and can cause failures in Pthreads functions if an "
7873 "application changes its credentials using B<seteuid>(2) or similar."
7877 #: build/C/man7/pthreads.7:753
7878 msgid "Threads do not share a common session ID and process group ID."
7882 #: build/C/man7/pthreads.7:756
7883 msgid "Threads do not share record locks created using B<fcntl>(2)."
7887 #: build/C/man7/pthreads.7:762
7889 "The information returned by B<times>(2) and B<getrusage>(2) is per-thread "
7890 "rather than process-wide."
7894 #: build/C/man7/pthreads.7:765
7895 msgid "Threads do not share semaphore undo values (see B<semop>(2))."
7899 #: build/C/man7/pthreads.7:767
7900 msgid "Threads do not share interval timers."
7903 #. FIXME . bug report filed for NPTL nice nonconformance
7904 #. http://bugzilla.kernel.org/show_bug.cgi?id=6258
7905 #. Sep 08: there is a patch by Denys Vlasenko to address this
7906 #. "make setpriority POSIX compliant; introduce PRIO_THREAD extension"
7907 #. Monitor this to see if it makes it into mainline.
7909 #: build/C/man7/pthreads.7:769 build/C/man7/pthreads.7:806
7910 msgid "Threads do not share a common nice value."
7914 #: build/C/man7/pthreads.7:779
7916 "POSIX.1 distinguishes the notions of signals that are directed to the "
7917 "process as a whole and signals that are directed to individual threads. "
7918 "According to POSIX.1, a process-directed signal (sent using B<kill>(2), for "
7919 "example) should be handled by a single, arbitrarily selected thread within "
7920 "the process. LinuxThreads does not support the notion of process-directed "
7921 "signals: signals may be sent only to specific threads."
7925 #: build/C/man7/pthreads.7:788
7927 "Threads have distinct alternate signal stack settings. However, a new "
7928 "thread's alternate signal stack settings are copied from the thread that "
7929 "created it, so that the threads initially share an alternate signal stack. "
7930 "(A new thread should start with no alternate signal stack defined. If two "
7931 "threads handle signals on their shared alternate signal stack at the same "
7932 "time, unpredictable program failures are likely to occur.)"
7936 #: build/C/man7/pthreads.7:788
7942 #: build/C/man7/pthreads.7:797
7944 "With NPTL, all of the threads in a process are placed in the same thread "
7945 "group; all members of a thread group share the same PID. NPTL does not "
7946 "employ a manager thread. NPTL makes internal use of the first two real-time "
7947 "signals (see also B<signal>(7)); these signals cannot be used in "
7952 #: build/C/man7/pthreads.7:799
7953 msgid "NPTL still has at least one nonconformance with POSIX.1:"
7957 #: build/C/man7/pthreads.7:808
7958 msgid "Some NPTL nonconformances occur only with older kernels:"
7962 #: build/C/man7/pthreads.7:814
7964 "The information returned by B<times>(2) and B<getrusage>(2) is per-thread "
7965 "rather than process-wide (fixed in kernel 2.6.9)."
7969 #: build/C/man7/pthreads.7:816
7970 msgid "Threads do not share resource limits (fixed in kernel 2.6.10)."
7974 #: build/C/man7/pthreads.7:818
7975 msgid "Threads do not share interval timers (fixed in kernel 2.6.12)."
7979 #: build/C/man7/pthreads.7:822
7981 "Only the main thread is permitted to start a new session using B<setsid>(2) "
7982 "(fixed in kernel 2.6.16)."
7986 #: build/C/man7/pthreads.7:827
7988 "Only the main thread is permitted to make the process into a process group "
7989 "leader using B<setpgid>(2) (fixed in kernel 2.6.16)."
7993 #: build/C/man7/pthreads.7:833
7995 "Threads have distinct alternate signal stack settings. However, a new "
7996 "thread's alternate signal stack settings are copied from the thread that "
7997 "created it, so that the threads initially share an alternate signal stack "
7998 "(fixed in kernel 2.6.16)."
8002 #: build/C/man7/pthreads.7:835
8003 msgid "Note the following further points about the NPTL implementation:"
8007 #: build/C/man7/pthreads.7:849
8009 "If the stack size soft resource limit (see the description of "
8010 "B<RLIMIT_STACK> in B<setrlimit>(2)) is set to a value other than "
8011 "I<unlimited>, then this value defines the default stack size for new "
8012 "threads. To be effective, this limit must be set before the program is "
8013 "executed, perhaps using the I<ulimit -s> shell built-in command (I<limit "
8014 "stacksize> in the C shell)."
8018 #: build/C/man7/pthreads.7:849
8020 msgid "Determining the threading implementation"
8024 #: build/C/man7/pthreads.7:854
8026 "Since glibc 2.3.2, the B<getconf>(1) command can be used to determine the "
8027 "system's threading implementation, for example:"
8031 #: build/C/man7/pthreads.7:859
8034 "bash$ getconf GNU_LIBPTHREAD_VERSION\n"
8039 #: build/C/man7/pthreads.7:864
8041 "With older glibc versions, a command such as the following should be "
8042 "sufficient to determine the default threading implementation:"
8046 #: build/C/man7/pthreads.7:870
8049 "bash$ $( ldd /bin/ls | grep libc.so | awk \\(aq{print $3}\\(aq ) | \\e\n"
8050 " egrep -i \\(aqthreads|nptl\\(aq\n"
8051 " Native POSIX Threads Library by Ulrich Drepper et al\n"
8055 #: build/C/man7/pthreads.7:872
8057 msgid "Selecting the threading implementation: LD_ASSUME_KERNEL"
8061 #: build/C/man7/pthreads.7:887
8063 "On systems with a glibc that supports both LinuxThreads and NPTL (i.e., "
8064 "glibc 2.3.I<x>), the B<LD_ASSUME_KERNEL> environment variable can be used to "
8065 "override the dynamic linker's default choice of threading implementation. "
8066 "This variable tells the dynamic linker to assume that it is running on top "
8067 "of a particular kernel version. By specifying a kernel version that does "
8068 "not provide the support required by NPTL, we can force the use of "
8069 "LinuxThreads. (The most likely reason for doing this is to run a (broken) "
8070 "application that depends on some nonconformant behavior in LinuxThreads.) "
8075 #: build/C/man7/pthreads.7:893
8078 "bash$ $( LD_ASSUME_KERNEL=2.2.5 ldd /bin/ls | grep libc.so | \\e\n"
8079 " awk \\(aq{print $3}\\(aq ) | egrep -i "
8080 "\\(aqthreads|ntpl\\(aq\n"
8081 " linuxthreads-0.10 by Xavier Leroy\n"
8085 #: build/C/man7/pthreads.7:905
8087 "B<clone>(2), B<futex>(2), B<gettid>(2), B<proc>(5), B<futex>(7), "
8088 "B<sigevent>(7), B<signal>(7),"
8092 #: build/C/man7/pthreads.7:929
8094 "Various Pthreads manual pages, for example: B<pthread_attr_init>(3), "
8095 "B<pthread_atfork>(3), B<pthread_cancel>(3), B<pthread_cleanup_push>(3), "
8096 "B<pthread_cond_signal>(3), B<pthread_cond_wait>(3), B<pthread_create>(3), "
8097 "B<pthread_detach>(3), B<pthread_equal>(3), B<pthread_exit>(3), "
8098 "B<pthread_key_create>(3), B<pthread_kill>(3), B<pthread_mutex_lock>(3), "
8099 "B<pthread_mutex_unlock>(3), B<pthread_once>(3), "
8100 "B<pthread_setcancelstate>(3), B<pthread_setcanceltype>(3), "
8101 "B<pthread_setspecific>(3), B<pthread_sigmask>(3), B<pthread_sigqueue>(3), "
8102 "and B<pthread_testcancel>(3)"