lib/libpthread/pthread_testcancel.3

   1 .\" $FreeBSD: src/share/man/man3/pthread_testcancel.3,v 1.15 2007/10/22 10:08:01 ru Exp $
   2 .Dd September 14, 2021
   3 .Dt PTHREAD_TESTCANCEL 3
   4 .Os
   5 .Sh NAME
   6 .Nm pthread_setcancelstate ,
   7 .Nm pthread_setcanceltype ,
   8 .Nm pthread_testcancel
   9 .Nd set cancelability state
  10 .Sh LIBRARY
  11 .Lb libpthread
  12 .Sh SYNOPSIS
  13 .In pthread.h
  14 .Ft int
  15 .Fn pthread_setcancelstate "int state" "int *oldstate"
  16 .Ft int
  17 .Fn pthread_setcanceltype "int type" "int *oldtype"
  18 .Ft void
  19 .Fn pthread_testcancel "void"
  20 .Sh DESCRIPTION
  21 The
  22 .Fn pthread_setcancelstate
  23 function atomically both sets the calling thread's cancelability state
  24 to the indicated
  25 .Fa state
  26 and, if
  27 .Fa oldstate
  28 is not
  29 .Dv NULL ,
  30 returns the previous cancelability state at the location referenced by
  31 .Fa oldstate .
  32 Legal values for
  33 .Fa state
  34 are
  35 .Dv PTHREAD_CANCEL_ENABLE
  36 and
  37 .Dv PTHREAD_CANCEL_DISABLE .
  38 .Pp
  39 The
  40 .Fn pthread_setcanceltype
  41 function atomically both sets the calling thread's cancelability type
  42 to the indicated
  43 .Fa type
  44 and, if
  45 .Fa oldtype
  46 is not
  47 .Dv NULL ,
  48 returns the previous cancelability type at the location referenced by
  49 .Fa oldtype .
  50 Legal values for
  51 .Fa type
  52 are
  53 .Dv PTHREAD_CANCEL_DEFERRED
  54 and
  55 .Dv PTHREAD_CANCEL_ASYNCHRONOUS .
  56 .Pp
  57 The cancelability state and type of any newly created threads, including the
  58 thread in which
  59 .Fn main
  60 was first invoked, are
  61 .Dv PTHREAD_CANCEL_ENABLE
  62 and
  63 .Dv PTHREAD_CANCEL_DEFERRED
  64 respectively.
  65 .Pp
  66 The
  67 .Fn pthread_testcancel
  68 function creates a cancellation point in the calling thread.
  69 The
  70 .Fn pthread_testcancel
  71 function has no effect if cancelability is disabled.
  72 .Ss Cancelability States
  73 The cancelability state of a thread determines the action taken upon
  74 receipt of a cancellation request.
  75 The thread may control cancellation in
  76 a number of ways.
  77 .Pp
  78 Each thread maintains its own
  79 .Dq cancelability state
  80 which may be encoded in two bits:
  81 .Bl -hang
  82 .It Em Cancelability Enable
  83 When cancelability is
  84 .Dv PTHREAD_CANCEL_DISABLE ,
  85 cancellation requests against the target thread are held pending.
  86 .It Em Cancelability Type
  87 When cancelability is enabled and the cancelability type is
  88 .Dv PTHREAD_CANCEL_ASYNCHRONOUS ,
  89 new or pending cancellation requests may be acted upon at any time.
  90 When cancelability is enabled and the cancelability type is
  91 .Dv PTHREAD_CANCEL_DEFERRED ,
  92 cancellation requests are held pending until a cancellation point (see
  93 below) is reached.
  94 If cancelability is disabled, the setting of the
  95 cancelability type has no immediate effect as all cancellation requests
  96 are held pending; however, once cancelability is enabled again the new
  97 type will be in effect.
  98 .El
  99 .Ss Cancellation Points
 100 Cancellation points will occur when a thread is executing the following
 101 functions:
 102 .Fn clock_nanosleep ,
 103 .Fn close ,
 104 .Fn creat ,
 105 .Fn fcntl ,
 106 .Fn fdatasync ,
 107 .Fn fsync ,
 108 .Fn msync ,
 109 .Fn nanosleep ,
 110 .Fn open ,
 111 .Fn pause ,
 112 .Fn pthread_cond_timedwait ,
 113 .Fn pthread_cond_wait ,
 114 .Fn pthread_join ,
 115 .Fn pthread_testcancel ,
 116 .Fn read ,
 117 .Fn sigwaitinfo ,
 118 .Fn sigsuspend ,
 119 .Fn sigwait ,
 120 .Fn sleep ,
 121 .Fn system ,
 122 .Fn tcdrain ,
 123 .Fn wait ,
 124 .Fn waitpid ,
 125 .Fn write .
 126 .Sh RETURN VALUES
 127 If successful, the
 128 .Fn pthread_setcancelstate
 129 and
 130 .Fn pthread_setcanceltype
 131 functions will return zero.
 132 Otherwise, an error number shall be returned to
 133 indicate the error.
 134 .Pp
 135 The
 136 .Fn pthread_setcancelstate
 137 and
 138 .Fn pthread_setcanceltype
 139 functions are used to control the points at which a thread may be
 140 asynchronously canceled.
 141 For cancellation control to be usable in modular
 142 fashion, some rules must be followed.
 143 .Pp
 144 For purposes of this discussion, consider an object to be a generalization
 145 of a procedure.
 146 It is a set of procedures and global variables written as
 147 a unit and called by clients not known by the object.
 148 Objects may depend
 149 on other objects.
 150 .Pp
 151 First, cancelability should only be disabled on entry to an object, never
 152 explicitly enabled.
 153 On exit from an object, the cancelability state should
 154 always be restored to its value on entry to the object.
 155 .Pp
 156 This follows from a modularity argument: if the client of an object (or the
 157 client of an object that uses that object) has disabled cancelability, it is
 158 because the client does not want to have to worry about how to clean up if the
 159 thread is canceled while executing some sequence of actions.
 160 If an object
 161 is called in such a state and it enables cancelability and a cancellation
 162 request is pending for that thread, then the thread will be canceled,
 163 contrary to the wish of the client that disabled.
 164 .Pp
 165 Second, the cancelability type may be explicitly set to either
 166 .Em deferred
 167 or
 168 .Em asynchronous
 169 upon entry to an object.
 170 But as with the cancelability state, on exit from
 171 an object that cancelability type should always be restored to its value on
 172 entry to the object.
 173 .Pp
 174 Finally, only functions that are cancel-safe may be called from a thread that
 175 is asynchronously cancelable.
 176 .Sh ERRORS
 177 The function
 178 .Fn pthread_setcancelstate
 179 may fail with:
 180 .Bl -tag -width Er
 181 .It Bq Er EINVAL
 182 The specified state is not
 183 .Dv PTHREAD_CANCEL_ENABLE
 184 or
 185 .Dv PTHREAD_CANCEL_DISABLE .
 186 .El
 187 .Pp
 188 The function
 189 .Fn pthread_setcanceltype
 190 may fail with:
 191 .Bl -tag -width Er
 192 .It Bq Er EINVAL
 193 The specified state is not
 194 .Dv PTHREAD_CANCEL_DEFERRED
 195 or
 196 .Dv PTHREAD_CANCEL_ASYNCHRONOUS .
 197 .El
 198 .Sh SEE ALSO
 199 .Xr pthread_cancel 3
 200 .Sh STANDARDS
 201 The
 202 .Fn pthread_testcancel
 203 function conforms to
 204 .St -p1003.1-96 .
 205 .Sh AUTHORS
 206 This manual page was written by
 207 .An David Leonard Aq Mt d@openbsd.org
 208 for the
 209 .Ox
 210 implementation of
 211 .Xr pthread_cancel 3 .