thread.h

   1 #if defined(USE_THREADS) || defined(USE_ITHREADS)
   2
   3 #ifdef WIN32
   4 #  include <win32thread.h>
   5 #else
   6 #  ifdef OLD_PTHREADS_API /* Here be dragons. */
   7 #    define DETACH(t) \
   8     STMT_START {                                                \
   9         if (pthread_detach(&(t)->self)) {                       \
  10             MUTEX_UNLOCK(&(t)->mutex);                          \
  11             Perl_croak_nocontext("panic: DETACH");              \
  12         }                                                       \
  13     } STMT_END
  14
  15 #    define PERL_GET_CONTEXT    Perl_get_context()
  16 #    define PERL_SET_CONTEXT(t) Perl_set_context((void*)t)
  17
  18 #    define PTHREAD_GETSPECIFIC_INT
  19 #    ifdef DJGPP
  20 #      define pthread_addr_t any_t
  21 #      define NEED_PTHREAD_INIT
  22 #      define PTHREAD_CREATE_JOINABLE (1)
  23 #    endif
  24 #    ifdef __OPEN_VM
  25 #      define pthread_addr_t void *
  26 #    endif
  27 #    ifdef VMS
  28 #      define pthread_attr_init(a) pthread_attr_create(a)
  29 #      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_setdetach_np(a,s)
  30 #      define PTHREAD_CREATE(t,a,s,d) pthread_create(t,a,s,d)
  31 #      define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
  32 #      define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
  33 #      define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
  34 #    endif
  35 #    if defined(DJGPP) || defined(__OPEN_VM)
  36 #      define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,&(s))
  37 #      define YIELD pthread_yield(NULL)
  38 #    endif
  39 #  endif
  40 #    define pthread_mutexattr_default NULL
  41 #    define pthread_condattr_default  NULL
  42 #endif
  43
  44 #ifndef PTHREAD_CREATE
  45 /* You are not supposed to pass NULL as the 2nd arg of PTHREAD_CREATE(). */
  46 #  define PTHREAD_CREATE(t,a,s,d) pthread_create(t,&(a),s,d)
  47 #endif
  48
  49 #ifndef PTHREAD_ATTR_SETDETACHSTATE
  50 #  define PTHREAD_ATTR_SETDETACHSTATE(a,s) pthread_attr_setdetachstate(a,s)
  51 #endif
  52
  53 #ifndef PTHREAD_CREATE_JOINABLE
  54 #  ifdef OLD_PTHREAD_CREATE_JOINABLE
  55 #    define PTHREAD_CREATE_JOINABLE OLD_PTHREAD_CREATE_JOINABLE
  56 #  else
  57 #    define PTHREAD_CREATE_JOINABLE 0 /* Panic?  No, guess. */
  58 #  endif
  59 #endif
  60
  61 #ifdef I_MACH_CTHREADS
  62
  63 /* cthreads interface */
  64
  65 /* #include <mach/cthreads.h> is in perl.h #ifdef I_MACH_CTHREADS */
  66
  67 #define MUTEX_INIT(m) \
  68     STMT_START {                                                \
  69         *m = mutex_alloc();                                     \
  70         if (*m) {                                               \
  71             mutex_init(*m);                                     \
  72         } else {                                                \
  73             Perl_croak_nocontext("panic: MUTEX_INIT");          \
  74         }                                                       \
  75     } STMT_END
  76
  77 #define MUTEX_LOCK(m)                   mutex_lock(*m)
  78 #define MUTEX_UNLOCK(m)                 mutex_unlock(*m)
  79 #define MUTEX_DESTROY(m) \
  80     STMT_START {                                                \
  81         mutex_free(*m);                                         \
  82         *m = 0;                                                 \
  83     } STMT_END
  84
  85 #define COND_INIT(c) \
  86     STMT_START {                                                \
  87         *c = condition_alloc();                                 \
  88         if (*c) {                                               \
  89             condition_init(*c);                                 \
  90         }                                                       \
  91         else {                                                  \
  92             Perl_croak_nocontext("panic: COND_INIT");           \
  93         }                                                       \
  94     } STMT_END
  95
  96 #define COND_SIGNAL(c)          condition_signal(*c)
  97 #define COND_BROADCAST(c)       condition_broadcast(*c)
  98 #define COND_WAIT(c, m)         condition_wait(*c, *m)
  99 #define COND_DESTROY(c) \
 100     STMT_START {                                                \
 101         condition_free(*c);                                     \
 102         *c = 0;                                                 \
 103     } STMT_END
 104
 105 #define THREAD_CREATE(thr, f)   (thr->self = cthread_fork(f, thr), 0)
 106 #define THREAD_POST_CREATE(thr)
 107
 108 #define THREAD_RET_TYPE         any_t
 109 #define THREAD_RET_CAST(x)      ((any_t) x)
 110
 111 #define DETACH(t)               cthread_detach(t->self)
 112 #define JOIN(t, avp)            (*(avp) = (AV *)cthread_join(t->self))
 113
 114 #define PERL_SET_CONTEXT(t)     cthread_set_data(cthread_self(), t)
 115 #define PERL_GET_CONTEXT        cthread_data(cthread_self())
 116
 117 #define INIT_THREADS            cthread_init()
 118 #define YIELD                   cthread_yield()
 119 #define ALLOC_THREAD_KEY        NOOP
 120 #define FREE_THREAD_KEY         NOOP
 121 #define SET_THREAD_SELF(thr)    (thr->self = cthread_self())
 122
 123 #endif /* I_MACH_CTHREADS */
 124
 125 #ifndef YIELD
 126 #  ifdef SCHED_YIELD
 127 #    define YIELD SCHED_YIELD
 128 #  else
 129 #    ifdef HAS_SCHED_YIELD
 130 #      define YIELD sched_yield()
 131 #    else
 132 #      ifdef HAS_PTHREAD_YIELD
 133     /* pthread_yield(NULL) platforms are expected
 134      * to have #defined YIELD for themselves. */
 135 #        define YIELD pthread_yield()
 136 #      endif
 137 #    endif
 138 #  endif
 139 #endif
 140
 141 #ifdef __hpux
 142 #  define MUTEX_INIT_NEEDS_MUTEX_ZEROED
 143 #endif
 144
 145 #ifndef MUTEX_INIT
 146
 147 #  ifdef MUTEX_INIT_NEEDS_MUTEX_ZEROED
 148     /* Temporary workaround, true bug is deeper. --jhi 1999-02-25 */
 149 #    define MUTEX_INIT(m) \
 150     STMT_START {                                                \
 151         Zero((m), 1, perl_mutex);                               \
 152         if (pthread_mutex_init((m), pthread_mutexattr_default)) \
 153             Perl_croak_nocontext("panic: MUTEX_INIT");          \
 154     } STMT_END
 155 #  else
 156 #    define MUTEX_INIT(m) \
 157     STMT_START {                                                \
 158         if (pthread_mutex_init((m), pthread_mutexattr_default)) \
 159             Perl_croak_nocontext("panic: MUTEX_INIT");          \
 160     } STMT_END
 161 #  endif
 162
 163 #  define MUTEX_LOCK(m) \
 164     STMT_START {                                                \
 165         if (pthread_mutex_lock((m)))                            \
 166             Perl_croak_nocontext("panic: MUTEX_LOCK");          \
 167     } STMT_END
 168
 169 #  define MUTEX_UNLOCK(m) \
 170     STMT_START {                                                \
 171         if (pthread_mutex_unlock((m)))                          \
 172             Perl_croak_nocontext("panic: MUTEX_UNLOCK");        \
 173     } STMT_END
 174
 175 #  define MUTEX_DESTROY(m) \
 176     STMT_START {                                                \
 177         if (pthread_mutex_destroy((m)))                         \
 178             Perl_croak_nocontext("panic: MUTEX_DESTROY");       \
 179     } STMT_END
 180 #endif /* MUTEX_INIT */
 181
 182 #ifndef COND_INIT
 183 #  define COND_INIT(c) \
 184     STMT_START {                                                \
 185         if (pthread_cond_init((c), pthread_condattr_default))   \
 186             Perl_croak_nocontext("panic: COND_INIT");           \
 187     } STMT_END
 188
 189 #  define COND_SIGNAL(c) \
 190     STMT_START {                                                \
 191         if (pthread_cond_signal((c)))                           \
 192             Perl_croak_nocontext("panic: COND_SIGNAL");         \
 193     } STMT_END
 194
 195 #  define COND_BROADCAST(c) \
 196     STMT_START {                                                \
 197         if (pthread_cond_broadcast((c)))                        \
 198             Perl_croak_nocontext("panic: COND_BROADCAST");      \
 199     } STMT_END
 200
 201 #  define COND_WAIT(c, m) \
 202     STMT_START {                                                \
 203         if (pthread_cond_wait((c), (m)))                        \
 204             Perl_croak_nocontext("panic: COND_WAIT");           \
 205     } STMT_END
 206
 207 #  define COND_DESTROY(c) \
 208     STMT_START {                                                \
 209         if (pthread_cond_destroy((c)))                          \
 210             Perl_croak_nocontext("panic: COND_DESTROY");        \
 211     } STMT_END
 212 #endif /* COND_INIT */
 213
 214 /* DETACH(t) must only be called while holding t->mutex */
 215 #ifndef DETACH
 216 #  define DETACH(t) \
 217     STMT_START {                                                \
 218         if (pthread_detach((t)->self)) {                        \
 219             MUTEX_UNLOCK(&(t)->mutex);                          \
 220             Perl_croak_nocontext("panic: DETACH");              \
 221         }                                                       \
 222     } STMT_END
 223 #endif /* DETACH */
 224
 225 #ifndef JOIN
 226 #  define JOIN(t, avp) \
 227     STMT_START {                                                \
 228         if (pthread_join((t)->self, (void**)(avp)))             \
 229             Perl_croak_nocontext("panic: pthread_join");        \
 230     } STMT_END
 231 #endif /* JOIN */
 232
 233 #ifndef PERL_GET_CONTEXT
 234 #  define PERL_GET_CONTEXT      pthread_getspecific(PL_thr_key)
 235 #endif
 236
 237 #ifndef PERL_SET_CONTEXT
 238 #  define PERL_SET_CONTEXT(t) \
 239     STMT_START {                                                \
 240         if (pthread_setspecific(PL_thr_key, (void *)(t)))       \
 241             Perl_croak_nocontext("panic: pthread_setspecific"); \
 242     } STMT_END
 243 #endif /* PERL_SET_CONTEXT */
 244
 245 #ifndef INIT_THREADS
 246 #  ifdef NEED_PTHREAD_INIT
 247 #    define INIT_THREADS pthread_init()
 248 #  endif
 249 #endif
 250
 251 #ifndef ALLOC_THREAD_KEY
 252 #  define ALLOC_THREAD_KEY \
 253     STMT_START {                                                \
 254         if (pthread_key_create(&PL_thr_key, 0)) {               \
 255             PerlIO_printf(PerlIO_stderr(), "panic: pthread_key_create");        \
 256             exit(1);                                            \
 257         }                                                       \
 258     } STMT_END
 259 #endif
 260
 261 #ifndef FREE_THREAD_KEY
 262 #  define FREE_THREAD_KEY \
 263     STMT_START {                                                \
 264         pthread_key_delete(PL_thr_key);                         \
 265     } STMT_END
 266 #endif
 267
 268 #ifndef THREAD_RET_TYPE
 269 #  define THREAD_RET_TYPE       void *
 270 #  define THREAD_RET_CAST(p)    ((void *)(p))
 271 #endif /* THREAD_RET */
 272
 273 #if defined(USE_THREADS)
 274
 275 /* Accessor for per-thread SVs */
 276 #  define THREADSV(i) (thr->threadsvp[i])
 277
 278 /*
 279  * LOCK_SV_MUTEX and UNLOCK_SV_MUTEX are performance-critical. Here, we
 280  * try only locking them if there may be more than one thread in existence.
 281  * Systems with very fast mutexes (and/or slow conditionals) may wish to
 282  * remove the "if (threadnum) ..." test.
 283  * XXX do NOT use C<if (PL_threadnum) ...> -- it sets up race conditions!
 284  */
 285 #  define LOCK_SV_MUTEX         MUTEX_LOCK(&PL_sv_mutex)
 286 #  define UNLOCK_SV_MUTEX       MUTEX_UNLOCK(&PL_sv_mutex)
 287 #  define LOCK_STRTAB_MUTEX     MUTEX_LOCK(&PL_strtab_mutex)
 288 #  define UNLOCK_STRTAB_MUTEX   MUTEX_UNLOCK(&PL_strtab_mutex)
 289 #  define LOCK_CRED_MUTEX       MUTEX_LOCK(&PL_cred_mutex)
 290 #  define UNLOCK_CRED_MUTEX     MUTEX_UNLOCK(&PL_cred_mutex)
 291 #  define LOCK_FDPID_MUTEX      MUTEX_LOCK(&PL_fdpid_mutex)
 292 #  define UNLOCK_FDPID_MUTEX    MUTEX_UNLOCK(&PL_fdpid_mutex)
 293 #  define LOCK_SV_LOCK_MUTEX    MUTEX_LOCK(&PL_sv_lock_mutex)
 294 #  define UNLOCK_SV_LOCK_MUTEX  MUTEX_UNLOCK(&PL_sv_lock_mutex)
 295
 296 /* Values and macros for thr->flags */
 297 #define THRf_STATE_MASK 7
 298 #define THRf_R_JOINABLE 0
 299 #define THRf_R_JOINED   1
 300 #define THRf_R_DETACHED 2
 301 #define THRf_ZOMBIE     3
 302 #define THRf_DEAD       4
 303
 304 #define THRf_DID_DIE    8
 305
 306 /* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
 307 #define ThrSTATE(t) ((t)->flags & THRf_STATE_MASK)
 308 #define ThrSETSTATE(t, s) STMT_START {          \
 309         (t)->flags &= ~THRf_STATE_MASK;         \
 310         (t)->flags |= (s);                      \
 311         DEBUG_S(PerlIO_printf(Perl_debug_log,   \
 312                               "thread %p set to state %d\n", (t), (s))); \
 313     } STMT_END
 314
 315 typedef struct condpair {
 316     perl_mutex  mutex;          /* Protects all other fields */
 317     perl_cond   owner_cond;     /* For when owner changes at all */
 318     perl_cond   cond;           /* For cond_signal and cond_broadcast */
 319     Thread      owner;          /* Currently owning thread */
 320 } condpair_t;
 321
 322 #define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
 323 #define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
 324 #define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
 325 #define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
 326
 327 #endif /* USE_THREADS */
 328 #endif /* USE_THREADS || USE_ITHREADS */
 329
 330 #ifndef MUTEX_LOCK
 331 #  define MUTEX_LOCK(m)
 332 #endif
 333
 334 #ifndef MUTEX_UNLOCK
 335 #  define MUTEX_UNLOCK(m)
 336 #endif
 337
 338 #ifndef MUTEX_INIT
 339 #  define MUTEX_INIT(m)
 340 #endif
 341
 342 #ifndef MUTEX_DESTROY
 343 #  define MUTEX_DESTROY(m)
 344 #endif
 345
 346 #ifndef COND_INIT
 347 #  define COND_INIT(c)
 348 #endif
 349
 350 #ifndef COND_SIGNAL
 351 #  define COND_SIGNAL(c)
 352 #endif
 353
 354 #ifndef COND_BROADCAST
 355 #  define COND_BROADCAST(c)
 356 #endif
 357
 358 #ifndef COND_WAIT
 359 #  define COND_WAIT(c, m)
 360 #endif
 361
 362 #ifndef COND_DESTROY
 363 #  define COND_DESTROY(c)
 364 #endif
 365
 366 #ifndef LOCK_SV_MUTEX
 367 #  define LOCK_SV_MUTEX
 368 #endif
 369
 370 #ifndef UNLOCK_SV_MUTEX
 371 #  define UNLOCK_SV_MUTEX
 372 #endif
 373
 374 #ifndef LOCK_STRTAB_MUTEX
 375 #  define LOCK_STRTAB_MUTEX
 376 #endif
 377
 378 #ifndef UNLOCK_STRTAB_MUTEX
 379 #  define UNLOCK_STRTAB_MUTEX
 380 #endif
 381
 382 #ifndef LOCK_CRED_MUTEX
 383 #  define LOCK_CRED_MUTEX
 384 #endif
 385
 386 #ifndef UNLOCK_CRED_MUTEX
 387 #  define UNLOCK_CRED_MUTEX
 388 #endif
 389
 390 #ifndef LOCK_FDPID_MUTEX
 391 #  define LOCK_FDPID_MUTEX
 392 #endif
 393
 394 #ifndef UNLOCK_FDPID_MUTEX
 395 #  define UNLOCK_FDPID_MUTEX
 396 #endif
 397
 398 #ifndef LOCK_SV_LOCK_MUTEX
 399 #  define LOCK_SV_LOCK_MUTEX
 400 #endif
 401
 402 #ifndef UNLOCK_SV_LOCK_MUTEX
 403 #  define UNLOCK_SV_LOCK_MUTEX
 404 #endif
 405
 406 /* THR, SET_THR, and dTHR are there for compatibility with old versions */
 407 #ifndef THR
 408 #  define THR           PERL_GET_THX
 409 #endif
 410
 411 #ifndef SET_THR
 412 #  define SET_THR(t)    PERL_SET_THX(t)
 413 #endif
 414
 415 #ifndef dTHR
 416 #  define dTHR dNOOP
 417 #endif
 418
 419 #ifndef INIT_THREADS
 420 #  define INIT_THREADS NOOP
 421 #endif