-/* Per-thread variables */
+/* thdrvar.h
+ *
+ * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
+ *
+ * You may distribute under the terms of either the GNU General Public
+ * License or the Artistic License, as specified in the README file.
+ *
+ */
+
+/*
+=head1 Global Variables
+*/
+
+/***********************************************/
+/* Global only to current thread */
+/***********************************************/
+
+/* Don't forget to re-run embed.pl to propagate changes! */
+
+/* The 'T' prefix is only needed for vars that need appropriate #defines
+ * generated when built with or without USE_5005THREADS. It is also used
+ * to generate the appropriate export list for win32.
+ *
+ * When building without USE_5005THREADS, these variables will be truly global.
+ * When building without USE_5005THREADS but with MULTIPLICITY, these variables
+ * will be global per-interpreter. */
+
/* Important ones in the first cache line (if alignment is done right) */
-PERLVAR(Tstack_sp, SV **)
+PERLVAR(Tstack_sp, SV **) /* top of the stack */
#ifdef OP_IN_REGISTER
-PERLVAR(Topsave, OP *)
+PERLVAR(Topsave, OP *)
#else
-PERLVAR(Top, OP *)
+PERLVAR(Top, OP *) /* currently executing op */
#endif
-PERLVAR(Tcurpad, SV **)
+PERLVAR(Tcurpad, SV **) /* active pad (lexicals+tmps) */
+
+PERLVAR(Tstack_base, SV **)
+PERLVAR(Tstack_max, SV **)
+
+PERLVAR(Tscopestack, I32 *) /* scopes we've ENTERed */
+PERLVAR(Tscopestack_ix, I32)
+PERLVAR(Tscopestack_max,I32)
+
+PERLVAR(Tsavestack, ANY *) /* items that need to be restored
+ when LEAVEing scopes we've ENTERed */
+PERLVAR(Tsavestack_ix, I32)
+PERLVAR(Tsavestack_max, I32)
+
+PERLVAR(Ttmps_stack, SV **) /* mortals we've made */
+PERLVARI(Ttmps_ix, I32, -1)
+PERLVARI(Ttmps_floor, I32, -1)
+PERLVAR(Ttmps_max, I32)
+
+PERLVAR(Tmarkstack, I32 *) /* stack_sp locations we're remembering */
+PERLVAR(Tmarkstack_ptr, I32 *)
+PERLVAR(Tmarkstack_max, I32 *)
+
+PERLVAR(TSv, SV *) /* used to hold temporary values */
+PERLVAR(TXpv, XPV *) /* used to hold temporary values */
-PERLVAR(Tstack_base, SV **)
-PERLVAR(Tstack_max, SV **)
+/*
+=for apidoc Amn|STRLEN|PL_na
-PERLVAR(Tscopestack, I32 *)
-PERLVAR(Tscopestack_ix, I32)
-PERLVAR(Tscopestack_max,I32)
+A convenience variable which is typically used with C<SvPV> when one
+doesn't care about the length of the string. It is usually more efficient
+to either declare a local variable and use that instead or to use the
+C<SvPV_nolen> macro.
-PERLVAR(Tsavestack, ANY *)
-PERLVAR(Tsavestack_ix, I32)
-PERLVAR(Tsavestack_max, I32)
+=cut
+*/
-PERLVAR(Tretstack, OP **)
-PERLVAR(Tretstack_ix, I32)
-PERLVAR(Tretstack_max, I32)
+PERLVAR(Tna, STRLEN) /* for use in SvPV when length is
+ Not Applicable */
-PERLVAR(Tmarkstack, I32 *)
-PERLVAR(Tmarkstack_ptr, I32 *)
-PERLVAR(Tmarkstack_max, I32 *)
+/* stat stuff */
+PERLVAR(Tstatbuf, Stat_t)
+PERLVAR(Tstatcache, Stat_t) /* _ */
+PERLVAR(Tstatgv, GV *)
+PERLVARI(Tstatname, SV *, NULL)
-PERLVAR(TSv, SV *)
-PERLVAR(TXpv, XPV *)
-PERLVAR(Tstatbuf, Stat_t)
#ifdef HAS_TIMES
-PERLVAR(Ttimesbuf, struct tms)
+PERLVAR(Ttimesbuf, struct tms)
#endif
-
-/* Now the fields that used to be "per interpreter" (even when global) */
/* Fields used by magic variables such as $@, $/ and so on */
PERLVAR(Ttainted, bool) /* using variables controlled by $< */
-PERLVAR(Tcurpm, PMOP *) /* what to do \ interps from */
-PERLVAR(Tnrs, SV *)
-PERLVAR(Trs, SV *) /* $/ */
-PERLVAR(Tlast_in_gv, GV *)
-PERLVAR(Tofs, char *) /* $, */
-PERLVAR(Tofslen, STRLEN)
-PERLVAR(Tdefoutgv, GV *)
-PERLVARI(Tchopset, char *, " \n-") /* $: */
-PERLVAR(Tformtarget, SV *)
-PERLVAR(Tbodytarget, SV *)
-PERLVAR(Ttoptarget, SV *)
+PERLVAR(Tcurpm, PMOP *) /* what to do \ interps in REs from */
+
+/*
+=for apidoc mn|SV*|PL_rs
+
+The input record separator - C<$/> in Perl space.
+
+=for apidoc mn|GV*|PL_last_in_gv
+
+The GV which was last used for a filehandle input operation. (C<< <FH> >>)
+
+=for apidoc mn|SV*|PL_ofs_sv
+
+The output field separator - C<$,> in Perl space.
+
+=cut
+*/
+
+PERLVAR(Trs, SV *) /* input record separator $/ */
+PERLVAR(Tlast_in_gv, GV *) /* GV used in last <FH> */
+PERLVAR(Tofs_sv, SV *) /* output field separator $, */
+PERLVAR(Tdefoutgv, GV *) /* default FH for output */
+PERLVARI(Tchopset, const char *, " \n-") /* $: */
+PERLVAR(Tformtarget, SV *)
+PERLVAR(Tbodytarget, SV *)
+PERLVAR(Ttoptarget, SV *)
/* Stashes */
PERLVAR(Tdefstash, HV *) /* main symbol table */
PERLVAR(Tcurstash, HV *) /* symbol table for current package */
-/* Stacks */
-PERLVAR(Ttmps_stack, SV **)
-PERLVARI(Ttmps_ix, I32, -1)
-PERLVARI(Ttmps_floor, I32, -1)
-PERLVAR(Ttmps_max, I32)
-
-PERLVAR(Trestartop, OP *) /* Are we propagating an error from croak? */
-PERLVARI(Tcurcop, COP * VOL, &compiling)
-PERLVAR(Tin_eval, VOL int) /* trap "fatal" errors? */
-PERLVAR(Tdelaymagic, int) /* ($<,$>) = ... */
-PERLVAR(Tdirty, bool) /* In the middle of tearing things down? */
+PERLVAR(Trestartop, OP *) /* propagating an error from croak? */
+PERLVARI(Tcurcop, COP * VOL, &PL_compiling)
+PERLVAR(Tin_eval, VOL U8) /* trap "fatal" errors? */
+PERLVAR(Tdelaymagic, U16) /* ($<,$>) = ... */
+PERLVARI(Tdirty, bool, FALSE) /* in the middle of tearing things down? */
PERLVAR(Tlocalizing, int) /* are we processing a local() list? */
-PERLVAR(Tcurstack, AV *) /* THE STACK */
-PERLVAR(Tcurstackinfo, PERL_SI *) /* current stack + context */
-PERLVAR(Tmainstack, AV *) /* the stack when nothing funny is happening */
-PERLVAR(Ttop_env, JMPENV *) /* ptr. to current sigjmp() environment */
-PERLVAR(Tstart_env, JMPENV) /* empty startup sigjmp() environment */
+PERLVAR(Tcurstack, AV *) /* THE STACK */
+PERLVAR(Tcurstackinfo, PERL_SI *) /* current stack + context */
+PERLVAR(Tmainstack, AV *) /* the stack when nothing funny is happening */
+
+PERLVAR(Ttop_env, JMPENV *) /* ptr. to current sigjmp() environment */
+PERLVAR(Tstart_env, JMPENV) /* empty startup sigjmp() environment */
+PERLVARI(Terrors, SV *, NULL) /* outstanding queued errors */
/* statics "owned" by various functions */
-PERLVAR(Tav_fetch_sv, SV *)
-PERLVAR(Thv_fetch_sv, SV *)
-PERLVAR(Thv_fetch_ent_mh, HE)
-
-/* XXX Sort stuff, firstgv secongv and so on? */
-/* XXX What about regexp stuff? */
-
-#ifdef USE_THREADS
-
-PERLVAR(oursv, SV *)
-PERLVAR(cvcache, HV *)
-PERLVAR(self, perl_os_thread) /* Underlying thread object */
-PERLVAR(flags, U32)
-PERLVAR(threadsv, AV *) /* Per-thread SVs ($_, $@ etc.) */
-PERLVAR(threadsvp, SV **) /* AvARRAY(threadsv) */
-PERLVAR(specific, AV *) /* Thread-specific user data */
-PERLVAR(errsv, SV *) /* Backing SV for $@ */
-PERLVAR(errhv, HV *) /* HV for what was %@ in pp_ctl.c */
-PERLVAR(mutex, perl_mutex) /* For the fields others can change */
-PERLVAR(tid, U32)
-PERLVAR(prev, struct perl_thread *)
-PERLVAR(next, struct perl_thread *) /* Circular linked list of threads */
-
-#ifdef HAVE_THREAD_INTERN
-PERLVAR(i, struct thread_intern) /* Platform-dependent internals */
-#endif
+PERLVAR(Tav_fetch_sv, SV *) /* unused as of change #19268 */
+PERLVAR(Thv_fetch_sv, SV *) /* unused as of change #19268 */
+PERLVAR(Thv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
+
+PERLVAR(Tmodcount, I32) /* how much mod()ification in assignment? */
+
+PERLVAR(Tlastgotoprobe, OP*) /* from pp_ctl.c */
+PERLVARI(Tdumpindent, I32, 4) /* # of blanks per dump indentation level */
+
+/* sort stuff */
+PERLVAR(Tsortcop, OP *) /* user defined sort routine */
+PERLVAR(Tsortstash, HV *) /* which is in some package or other */
+PERLVAR(Tfirstgv, GV *) /* $a */
+PERLVAR(Tsecondgv, GV *) /* $b */
+
+/* float buffer */
+PERLVAR(Tefloatbuf, char*)
+PERLVAR(Tefloatsize, STRLEN)
+
+/* regex stuff */
+
+PERLVAR(Tscreamfirst, I32 *)
+PERLVAR(Tscreamnext, I32 *)
+PERLVARI(Tmaxscream, I32, -1)
+PERLVAR(Tlastscream, SV *)
+
+PERLVAR(Treg_state, struct re_save_state)
+PERLVAR(Tregdummy, regnode) /* from regcomp.c */
+PERLVAR(Tcolorset, int) /* from regcomp.c */
+PERLVARA(Tcolors,6, char *) /* from regcomp.c */
+
+PERLVARI(Tpeepp, peep_t, MEMBER_TO_FPTR(Perl_peep))
+ /* Pointer to peephole optimizer */
+
+PERLVARI(Treginterp_cnt,int, 0) /* Whether "Regexp" was interpolated. */
+PERLVARI(Twatchaddr, char **, 0)
+PERLVAR(Twatchok, char *)
+
+/* Note that the variables below are all explicitly referenced in the code
+ * as thr->whatever and therefore don't need the 'T' prefix. */
-PERLVAR(trailing_nul, char) /* For the sake of thrsv and oursv */
+/* the currently active slab in a chain of slabs of regmatch states,
+ * and the currently active state within that slab */
-#endif /* USE_THREADS */
+PERLVARI(Tregmatch_slab, regmatch_slab *, NULL)
+PERLVAR(Tregmatch_state, regmatch_state *)