thread.h

   1 #ifndef USE_THREADS
   2 #define MUTEX_LOCK(m)
   3 #define MUTEX_UNLOCK(m)
   4 #define MUTEX_INIT(m)
   5 #define MUTEX_DESTROY(m)
   6 #define COND_INIT(c)
   7 #define COND_SIGNAL(c)
   8 #define COND_BROADCAST(c)
   9 #define COND_WAIT(c, m)
  10 #define COND_DESTROY(c)
  11
  12 #define THR
  13 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
  14 #define dTHR extern int errno
  15 #else
  16
  17 #ifdef FAKE_THREADS
  18 typedef struct thread *perl_thread;
  19 /* With fake threads, thr is global(ish) so we don't need dTHR */
  20 #define dTHR extern int errno
  21
  22 /*
  23  * Note that SCHEDULE() is only callable from pp code (which
  24  * must be expecting to be restarted). We'll have to do
  25  * something a bit different for XS code.
  26  */
  27 #define SCHEDULE() return schedule(), op
  28
  29 #define MUTEX_LOCK(m)
  30 #define MUTEX_UNLOCK(m)
  31 #define MUTEX_INIT(m)
  32 #define MUTEX_DESTROY(m)
  33 #define COND_INIT(c) perl_cond_init(c)
  34 #define COND_SIGNAL(c) perl_cond_signal(c)
  35 #define COND_BROADCAST(c) perl_cond_broadcast(c)
  36 #define COND_WAIT(c, m) STMT_START {    \
  37         perl_cond_wait(c);              \
  38         SCHEDULE();                     \
  39     } STMT_END
  40 #define COND_DESTROY(c)
  41 #else
  42 /* POSIXish threads */
  43 typedef pthread_t perl_thread;
  44 #ifdef OLD_PTHREADS_API
  45 #define pthread_mutexattr_init(a) pthread_mutexattr_create(a)
  46 #define pthread_mutexattr_settype(a,t) pthread_mutexattr_setkind_np(a,t)
  47 #define pthread_key_create(k,d) pthread_keycreate(k,(pthread_destructor_t)(d))
  48 #else
  49 #define pthread_mutexattr_default NULL
  50 #define pthread_condattr_default NULL
  51 #endif /* OLD_PTHREADS_API */
  52
  53 #define MUTEX_INIT(m) \
  54     if (pthread_mutex_init((m), pthread_mutexattr_default)) \
  55         croak("panic: MUTEX_INIT"); \
  56     else 1
  57 #define MUTEX_LOCK(m) \
  58     if (pthread_mutex_lock((m))) croak("panic: MUTEX_LOCK"); else 1
  59 #define MUTEX_UNLOCK(m) \
  60     if (pthread_mutex_unlock((m))) croak("panic: MUTEX_UNLOCK"); else 1
  61 #define MUTEX_DESTROY(m) \
  62     if (pthread_mutex_destroy((m))) croak("panic: MUTEX_DESTROY"); else 1
  63 #define COND_INIT(c) \
  64     if (pthread_cond_init((c), pthread_condattr_default)) \
  65         croak("panic: COND_INIT"); \
  66     else 1
  67 #define COND_SIGNAL(c) \
  68     if (pthread_cond_signal((c))) croak("panic: COND_SIGNAL"); else 1
  69 #define COND_BROADCAST(c) \
  70     if (pthread_cond_broadcast((c))) croak("panic: COND_BROADCAST"); else 1
  71 #define COND_WAIT(c, m) \
  72     if (pthread_cond_wait((c), (m))) croak("panic: COND_WAIT"); else 1
  73 #define COND_DESTROY(c) \
  74     if (pthread_cond_destroy((c))) croak("panic: COND_DESTROY"); else 1
  75
  76 /* DETACH(t) must only be called while holding t->mutex */
  77 #define DETACH(t)                       \
  78     if (pthread_detach((t)->Tself)) {   \
  79         MUTEX_UNLOCK(&(t)->mutex);      \
  80         croak("panic: DETACH");         \
  81     } else 1
  82
  83 /* XXX Add "old" (?) POSIX draft interface too */
  84 #ifdef OLD_PTHREADS_API
  85 struct thread *getTHR _((void));
  86 #define THR getTHR()
  87 #else
  88 #define THR ((struct thread *) pthread_getspecific(thr_key))
  89 #endif /* OLD_PTHREADS_API */
  90 #define dTHR struct thread *thr = THR
  91 #endif /* FAKE_THREADS */
  92
  93 #ifndef INIT_THREADS
  94 #  ifdef NEED_PTHREAD_INIT
  95 #    define INIT_THREADS pthread_init()
  96 #  else
  97 #    define INIT_THREADS NOOP
  98 #  endif
  99 #endif
 100
 101 struct thread {
 102     /* The fields that used to be global */
 103     /* Important ones in the first cache line (if alignment is done right) */
 104     SV **       Tstack_sp;
 105 #ifdef OP_IN_REGISTER
 106     OP *        Topsave;
 107 #else
 108     OP *        Top;
 109 #endif
 110     SV **       Tcurpad;
 111     SV **       Tstack_base;
 112
 113     SV **       Tstack_max;
 114
 115     I32 *       Tscopestack;
 116     I32         Tscopestack_ix;
 117     I32         Tscopestack_max;
 118
 119     ANY *       Tsavestack;
 120     I32         Tsavestack_ix;
 121     I32         Tsavestack_max;
 122
 123     OP **       Tretstack;
 124     I32         Tretstack_ix;
 125     I32         Tretstack_max;
 126
 127     I32 *       Tmarkstack;
 128     I32 *       Tmarkstack_ptr;
 129     I32 *       Tmarkstack_max;
 130
 131     SV *        TSv;
 132     XPV *       TXpv;
 133     struct stat Tstatbuf;
 134     struct tms  Ttimesbuf;
 135
 136     /* XXX What about regexp stuff? */
 137
 138     /* Now the fields that used to be "per interpreter" (even when global) */
 139
 140     /* XXX What about magic variables such as $/, $? and so on? */
 141     HV *        Tdefstash;
 142     HV *        Tcurstash;
 143
 144     SV **       Ttmps_stack;
 145     I32         Ttmps_ix;
 146     I32         Ttmps_floor;
 147     I32         Ttmps_max;
 148
 149     int         Tin_eval;
 150     OP *        Trestartop;
 151     int         Tdelaymagic;
 152     bool        Tdirty;
 153     U8          Tlocalizing;
 154     COP *       Tcurcop;
 155
 156     CONTEXT *   Tcxstack;
 157     I32         Tcxstack_ix;
 158     I32         Tcxstack_max;
 159
 160     AV *        Tcurstack;
 161     AV *        Tmainstack;
 162     JMPENV *    Ttop_env;
 163     I32         Trunlevel;
 164
 165     /* XXX Sort stuff, firstgv, secongv and so on? */
 166
 167     perl_thread Tself;
 168     SV *        Toursv;
 169     HV *        Tcvcache;
 170     U32         flags;
 171     perl_mutex  mutex;                  /* For the fields others can change */
 172     U32         tid;
 173     struct thread *next, *prev;         /* Circular linked list of threads */
 174
 175 #ifdef ADD_THREAD_INTERN
 176     struct thread_intern i;             /* Platform-dependent internals */
 177 #endif
 178 };
 179
 180 typedef struct thread *Thread;
 181
 182 /* Values and macros for thr->flags */
 183 #define THRf_STATE_MASK 7
 184 #define THRf_R_JOINABLE 0
 185 #define THRf_R_JOINED   1
 186 #define THRf_R_DETACHED 2
 187 #define THRf_ZOMBIE     3
 188 #define THRf_DEAD       4
 189
 190 #define THRf_DIE_FATAL  8
 191
 192 /* ThrSTATE(t) and ThrSETSTATE(t) must only be called while holding t->mutex */
 193 #define ThrSTATE(t) ((t)->flags)
 194 #define ThrSETSTATE(t, s) STMT_START {          \
 195         (t)->flags &= ~THRf_STATE_MASK;         \
 196         (t)->flags |= (s);                      \
 197         DEBUG_L(PerlIO_printf(PerlIO_stderr(),  \
 198                               "thread %p set to state %d\n", (t), (s))); \
 199     } STMT_END
 200
 201 typedef struct condpair {
 202     perl_mutex  mutex;          /* Protects all other fields */
 203     perl_cond   owner_cond;     /* For when owner changes at all */
 204     perl_cond   cond;           /* For cond_signal and cond_broadcast */
 205     Thread      owner;          /* Currently owning thread */
 206 } condpair_t;
 207
 208 #define MgMUTEXP(mg) (&((condpair_t *)(mg->mg_ptr))->mutex)
 209 #define MgOWNERCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->owner_cond)
 210 #define MgCONDP(mg) (&((condpair_t *)(mg->mg_ptr))->cond)
 211 #define MgOWNER(mg) ((condpair_t *)(mg->mg_ptr))->owner
 212
 213 #undef  stack_base
 214 #undef  stack_sp
 215 #undef  stack_max
 216 #undef  curstack
 217 #undef  mainstack
 218 #undef  markstack
 219 #undef  markstack_ptr
 220 #undef  markstack_max
 221 #undef  scopestack
 222 #undef  scopestack_ix
 223 #undef  scopestack_max
 224 #undef  savestack
 225 #undef  savestack_ix
 226 #undef  savestack_max
 227 #undef  retstack
 228 #undef  retstack_ix
 229 #undef  retstack_max
 230 #undef  curcop
 231 #undef  cxstack
 232 #undef  cxstack_ix
 233 #undef  cxstack_max
 234 #undef  defstash
 235 #undef  curstash
 236 #undef  tmps_stack
 237 #undef  tmps_floor
 238 #undef  tmps_ix
 239 #undef  tmps_max
 240 #undef  curpad
 241 #undef  Sv
 242 #undef  Xpv
 243 #undef  statbuf
 244 #undef  timesbuf
 245 #undef  top_env
 246 #undef  runlevel
 247 #undef  in_eval
 248 #undef  restartop
 249 #undef  delaymagic
 250 #undef  dirty
 251 #undef  localizing
 252
 253 #define self            (thr->Tself)
 254 #define oursv           (thr->Toursv)
 255 #define stack_base      (thr->Tstack_base)
 256 #define stack_sp        (thr->Tstack_sp)
 257 #define stack_max       (thr->Tstack_max)
 258 #ifdef OP_IN_REGISTER
 259 #define opsave          (thr->Topsave)
 260 #else
 261 #undef  op
 262 #define op              (thr->Top)
 263 #endif
 264 #define curcop          (thr->Tcurcop)
 265 #define stack           (thr->Tstack)
 266 #define curstack        (thr->Tcurstack)
 267 #define mainstack       (thr->Tmainstack)
 268 #define markstack       (thr->Tmarkstack)
 269 #define markstack_ptr   (thr->Tmarkstack_ptr)
 270 #define markstack_max   (thr->Tmarkstack_max)
 271 #define scopestack      (thr->Tscopestack)
 272 #define scopestack_ix   (thr->Tscopestack_ix)
 273 #define scopestack_max  (thr->Tscopestack_max)
 274
 275 #define savestack       (thr->Tsavestack)
 276 #define savestack_ix    (thr->Tsavestack_ix)
 277 #define savestack_max   (thr->Tsavestack_max)
 278
 279 #define retstack        (thr->Tretstack)
 280 #define retstack_ix     (thr->Tretstack_ix)
 281 #define retstack_max    (thr->Tretstack_max)
 282
 283 #define cxstack         (thr->Tcxstack)
 284 #define cxstack_ix      (thr->Tcxstack_ix)
 285 #define cxstack_max     (thr->Tcxstack_max)
 286
 287 #define curpad          (thr->Tcurpad)
 288 #define Sv              (thr->TSv)
 289 #define Xpv             (thr->TXpv)
 290 #define statbuf         (thr->Tstatbuf)
 291 #define timesbuf        (thr->Ttimesbuf)
 292 #define defstash        (thr->Tdefstash)
 293 #define curstash        (thr->Tcurstash)
 294
 295 #define tmps_stack      (thr->Ttmps_stack)
 296 #define tmps_ix         (thr->Ttmps_ix)
 297 #define tmps_floor      (thr->Ttmps_floor)
 298 #define tmps_max        (thr->Ttmps_max)
 299
 300 #define in_eval         (thr->Tin_eval)
 301 #define restartop       (thr->Trestartop)
 302 #define delaymagic      (thr->Tdelaymagic)
 303 #define dirty           (thr->Tdirty)
 304 #define localizing      (thr->Tlocalizing)
 305
 306 #define top_env         (thr->Ttop_env)
 307 #define runlevel        (thr->Trunlevel)
 308
 309 #define cvcache         (thr->Tcvcache)
 310 #endif /* USE_THREADS */