3 .Dt PTHREAD_TESTCANCEL 3
6 .Nm pthread_setcancelstate ,
7 .Nm pthread_setcanceltype ,
9 .Nd set cancelability state
15 .Fn pthread_setcancelstate "int state" "int *oldstate"
17 .Fn pthread_setcanceltype "int type" "int *oldtype"
19 .Fn pthread_testcancel "void"
22 .Fn pthread_setcancelstate
23 function atomically both sets the calling thread's cancelability state
30 returns the previous cancelability state at the location referenced by
35 .Dv PTHREAD_CANCEL_ENABLE
37 .Dv PTHREAD_CANCEL_DISABLE .
40 .Fn pthread_setcanceltype
41 function atomically both sets the calling thread's cancelability type
48 returns the previous cancelability type at the location referenced by
53 .Dv PTHREAD_CANCEL_DEFERRED
55 .Dv PTHREAD_CANCEL_ASYNCHRONOUS .
57 The cancelability state and type of any newly created threads, including the
60 was first invoked, are
61 .Dv PTHREAD_CANCEL_ENABLE
63 .Dv PTHREAD_CANCEL_DEFERRED
67 .Fn pthread_testcancel
68 function creates a cancellation point in the calling thread.
70 .Fn pthread_testcancel
71 function has no effect if cancelability is disabled.
73 .Ss Cancelability States
74 The cancelability state of a thread determines the action taken upon
75 receipt of a cancellation request.
76 The thread may control cancellation in
79 Each thread maintains its own
80 .Dq cancelability state
81 which may be encoded in two bits:
83 .It Em Cancelability Enable
85 .Dv PTHREAD_CANCEL_DISABLE ,
86 cancellation requests against the target thread are held pending.
87 .It Em Cancelability Type
88 When cancelability is enabled and the cancelability type is
89 .Dv PTHREAD_CANCEL_ASYNCHRONOUS ,
90 new or pending cancellation requests may be acted upon at any time.
91 When cancelability is enabled and the cancelability type is
92 .Dv PTHREAD_CANCEL_DEFERRED ,
93 cancellation requests are held pending until a cancellation point (see
95 If cancelability is disabled, the setting of the
96 cancelability type has no immediate effect as all cancellation requests
97 are held pending; however, once cancelability is enabled again the new
98 type will be in effect.
100 .Ss Cancellation Points
101 Cancellation points will occur when a thread is executing the following
103 .Bl -tag -width "Fn pthread_cond_timedwait" -compact
113 function is a cancellation point if
121 function is a cancellation point if it is potentially blocking,
124 argument is non-zero.
127 .It Fn mq_timedreceive
137 .It Fn pthread_cond_timedwait
138 .It Fn pthread_cond_wait
140 .It Fn pthread_testcancel
171 .Fn pthread_setcancelstate
173 .Fn pthread_setcanceltype
174 functions are used to control the points at which a thread may be
175 asynchronously canceled.
176 For cancellation control to be usable in modular
177 fashion, some rules must be followed.
179 For purposes of this discussion, consider an object to be a generalization
181 It is a set of procedures and global variables written as
182 a unit and called by clients not known by the object.
186 First, cancelability should only be disabled on entry to an object, never
188 On exit from an object, the cancelability state should
189 always be restored to its value on entry to the object.
191 This follows from a modularity argument: if the client of an object (or the
192 client of an object that uses that object) has disabled cancelability, it is
193 because the client does not want to have to worry about how to clean up if the
194 thread is canceled while executing some sequence of actions.
196 is called in such a state and it enables cancelability and a cancellation
197 request is pending for that thread, then the thread will be canceled,
198 contrary to the wish of the client that disabled.
200 Second, the cancelability type may be explicitly set to either
204 upon entry to an object.
205 But as with the cancelability state, on exit from
206 an object that cancelability type should always be restored to its value on
209 Finally, only functions that are cancel-safe may be called from a thread that
210 is asynchronously cancelable.
213 .Fn pthread_setcancelstate
215 .Fn pthread_setcanceltype
216 functions will return zero.
217 Otherwise, an error number shall be returned to
221 .Fn pthread_setcancelstate
225 The specified state is not
226 .Dv PTHREAD_CANCEL_ENABLE
228 .Dv PTHREAD_CANCEL_DISABLE .
232 .Fn pthread_setcanceltype
236 The specified state is not
237 .Dv PTHREAD_CANCEL_DEFERRED
239 .Dv PTHREAD_CANCEL_ASYNCHRONOUS .
245 .Fn pthread_testcancel
248 The standard allows implementations to make many more functions
251 This manual page was written by
252 .An David Leonard Aq d@openbsd.org
256 .Xr pthread_cancel 3 .