This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
slightly modified version of suggested patch
[perl5.git] / thrdvar.h
CommitLineData
cb68f92d
GS
1/***********************************************/
2/* Global only to current thread */
3/***********************************************/
4
8b3be1d1
JP
5/* Don't forget to re-run embed.pl to propagate changes! */
6
cb68f92d
GS
7/* The 'T' prefix is only needed for vars that need appropriate #defines
8 * generated when built with or without USE_THREADS. It is also used
9 * to generate the appropriate export list for win32.
10 *
11 * When building without USE_THREADS, these variables will be truly global.
12 * When building without USE_THREADS but with MULTIPLICITY, these variables
13 * will be global per-interpreter.
14 *
15 * Avoid build-specific #ifdefs here, like DEBUGGING. That way,
16 * we can keep binary compatibility of the curinterp structure */
8b3be1d1 17
49f531da 18/* Important ones in the first cache line (if alignment is done right) */
d4cce5f1 19
c5be433b
GS
20#ifdef USE_THREADS
21PERLVAR(interp, PerlInterpreter*) /* thread owner */
22#endif
23
cb68f92d 24PERLVAR(Tstack_sp, SV **) /* top of the stack */
49f531da 25#ifdef OP_IN_REGISTER
cb68f92d 26PERLVAR(Topsave, OP *)
49f531da 27#else
cb68f92d 28PERLVAR(Top, OP *) /* currently executing op */
49f531da 29#endif
cb68f92d
GS
30PERLVAR(Tcurpad, SV **) /* active pad (lexicals+tmps) */
31
32PERLVAR(Tstack_base, SV **)
33PERLVAR(Tstack_max, SV **)
34
35PERLVAR(Tscopestack, I32 *) /* scopes we've ENTERed */
36PERLVAR(Tscopestack_ix, I32)
37PERLVAR(Tscopestack_max,I32)
49f531da 38
cb68f92d
GS
39PERLVAR(Tsavestack, ANY *) /* items that need to be restored
40 when LEAVEing scopes we've ENTERed */
41PERLVAR(Tsavestack_ix, I32)
42PERLVAR(Tsavestack_max, I32)
49f531da 43
cb68f92d
GS
44PERLVAR(Ttmps_stack, SV **) /* mortals we've made */
45PERLVARI(Ttmps_ix, I32, -1)
46PERLVARI(Ttmps_floor, I32, -1)
47PERLVAR(Ttmps_max, I32)
49f531da 48
cb68f92d
GS
49PERLVAR(Tmarkstack, I32 *) /* stack_sp locations we're remembering */
50PERLVAR(Tmarkstack_ptr, I32 *)
51PERLVAR(Tmarkstack_max, I32 *)
49f531da 52
cb68f92d
GS
53PERLVAR(Tretstack, OP **) /* OPs we have postponed executing */
54PERLVAR(Tretstack_ix, I32)
55PERLVAR(Tretstack_max, I32)
49f531da 56
cb68f92d
GS
57PERLVAR(TSv, SV *) /* used to hold temporary values */
58PERLVAR(TXpv, XPV *) /* used to hold temporary values */
b099ddc0
GS
59PERLVAR(Tna, STRLEN) /* for use in SvPV when length is
60 Not Applicable */
49f531da 61
5c0ca799 62/* stat stuff */
cb68f92d 63PERLVAR(Tstatbuf, Stat_t)
5c0ca799
GS
64PERLVAR(Tstatcache, Stat_t) /* _ */
65PERLVAR(Tstatgv, GV *)
66PERLVARI(Tstatname, SV *, Nullsv)
67
49f531da 68#ifdef HAS_TIMES
cb68f92d 69PERLVAR(Ttimesbuf, struct tms)
49f531da 70#endif
49f531da
NIS
71
72/* Fields used by magic variables such as $@, $/ and so on */
d4cce5f1 73PERLVAR(Ttainted, bool) /* using variables controlled by $< */
cb68f92d
GS
74PERLVAR(Tcurpm, PMOP *) /* what to do \ interps in REs from */
75PERLVAR(Tnrs, SV *)
76PERLVAR(Trs, SV *) /* input record separator $/ */
77PERLVAR(Tlast_in_gv, GV *) /* GV used in last <FH> */
78PERLVAR(Tofs, char *) /* output field separator $, */
79PERLVAR(Tofslen, STRLEN)
80PERLVAR(Tdefoutgv, GV *) /* default FH for output */
d4cce5f1 81PERLVARI(Tchopset, char *, " \n-") /* $: */
cb68f92d
GS
82PERLVAR(Tformtarget, SV *)
83PERLVAR(Tbodytarget, SV *)
84PERLVAR(Ttoptarget, SV *)
49f531da 85
d4cce5f1
NIS
86/* Stashes */
87PERLVAR(Tdefstash, HV *) /* main symbol table */
88PERLVAR(Tcurstash, HV *) /* symbol table for current package */
49f531da 89
cb68f92d 90PERLVAR(Trestartop, OP *) /* propagating an error from croak? */
3280af22 91PERLVARI(Tcurcop, COP * VOL, &PL_compiling)
d4cce5f1
NIS
92PERLVAR(Tin_eval, VOL int) /* trap "fatal" errors? */
93PERLVAR(Tdelaymagic, int) /* ($<,$>) = ... */
24d3c518 94PERLVARI(Tdirty, bool, FALSE) /* in the middle of tearing things down? */
61bb5906 95PERLVAR(Tlocalizing, int) /* are we processing a local() list? */
49f531da 96
cb68f92d
GS
97PERLVAR(Tcurstack, AV *) /* THE STACK */
98PERLVAR(Tcurstackinfo, PERL_SI *) /* current stack + context */
99PERLVAR(Tmainstack, AV *) /* the stack when nothing funny is happening */
312caa8e 100
cb68f92d
GS
101PERLVAR(Ttop_env, JMPENV *) /* ptr. to current sigjmp() environment */
102PERLVAR(Tstart_env, JMPENV) /* empty startup sigjmp() environment */
0b94c7bb 103PERLVARI(Tprotect, protect_proc_t, MEMBER_TO_FPTR(Perl_default_protect))
49f531da 104
4e4c362e 105/* statics "owned" by various functions */
cb68f92d
GS
106PERLVAR(Tav_fetch_sv, SV *) /* owned by av_fetch() */
107PERLVAR(Thv_fetch_sv, SV *) /* owned by hv_fetch() */
108PERLVAR(Thv_fetch_ent_mh, HE) /* owned by hv_fetch_ent() */
109
110PERLVAR(Tmodcount, I32) /* how much mod()ification in assignment? */
4e4c362e 111
5c0ca799 112PERLVAR(Tlastgotoprobe, OP*) /* from pp_ctl.c */
3967c732 113PERLVARI(Tdumpindent, I32, 4) /* # of blanks per dump indentation level */
5c0ca799
GS
114
115/* sort stuff */
116PERLVAR(Tsortcop, OP *) /* user defined sort routine */
117PERLVAR(Tsortstash, HV *) /* which is in some package or other */
118PERLVAR(Tfirstgv, GV *) /* $a */
119PERLVAR(Tsecondgv, GV *) /* $b */
120PERLVAR(Tsortcxix, I32) /* from pp_ctl.c */
121
122/* regex stuff */
123
124PERLVAR(Tscreamfirst, I32 *)
125PERLVAR(Tscreamnext, I32 *)
126PERLVARI(Tmaxscream, I32, -1)
127PERLVAR(Tlastscream, SV *)
128
129PERLVAR(Tregdummy, regnode) /* from regcomp.c */
130PERLVAR(Tregcomp_parse, char*) /* Input-scan pointer. */
131PERLVAR(Tregxend, char*) /* End of input for compile */
132PERLVAR(Tregcode, regnode*) /* Code-emit pointer; &regdummy = don't */
133PERLVAR(Tregnaughty, I32) /* How bad is this pattern? */
134PERLVAR(Tregsawback, I32) /* Did we see \1, ...? */
135PERLVAR(Tregprecomp, char *) /* uncompiled string. */
136PERLVAR(Tregnpar, I32) /* () count. */
137PERLVAR(Tregsize, I32) /* Code size. */
138PERLVAR(Tregflags, U16) /* are we folding, multilining? */
139PERLVAR(Tregseen, U32) /* from regcomp.c */
140PERLVAR(Tseen_zerolen, I32) /* from regcomp.c */
141PERLVAR(Tseen_evals, I32) /* from regcomp.c */
142PERLVAR(Tregcomp_rx, regexp *) /* from regcomp.c */
143PERLVAR(Textralen, I32) /* from regcomp.c */
144PERLVAR(Tcolorset, int) /* from regcomp.c */
51371543 145PERLVARA(Tcolors,6, char *) /* from regcomp.c */
5c0ca799
GS
146PERLVAR(Treginput, char *) /* String-input pointer. */
147PERLVAR(Tregbol, char *) /* Beginning of input, for ^ check. */
148PERLVAR(Tregeol, char *) /* End of input, for $ check. */
cf93c79d
IZ
149PERLVAR(Tregstartp, I32 *) /* Pointer to startp array. */
150PERLVAR(Tregendp, I32 *) /* Ditto for endp. */
5c0ca799
GS
151PERLVAR(Treglastparen, U32 *) /* Similarly for lastparen. */
152PERLVAR(Tregtill, char *) /* How far we are required to go. */
153PERLVAR(Tregprev, char) /* char before regbol, \n if none */
154PERLVAR(Treg_start_tmp, char **) /* from regexec.c */
155PERLVAR(Treg_start_tmpl,U32) /* from regexec.c */
156PERLVAR(Tregdata, struct reg_data *)
157 /* from regexec.c renamed was data */
158PERLVAR(Tbostr, char *) /* from regexec.c */
159PERLVAR(Treg_flags, U32) /* from regexec.c */
160PERLVAR(Treg_eval_set, I32) /* from regexec.c */
161PERLVAR(Tregnarrate, I32) /* from regexec.c */
162PERLVAR(Tregprogram, regnode *) /* from regexec.c */
163PERLVARI(Tregindent, int, 0) /* from regexec.c */
164PERLVAR(Tregcc, CURCUR *) /* from regexec.c */
0f5d15d6
IZ
165PERLVAR(Treg_call_cc, struct re_cc_state *) /* from regexec.c */
166PERLVAR(Treg_re, regexp *) /* from regexec.c */
22e551b9
IZ
167PERLVAR(Treg_ganch, char *) /* position of \G */
168PERLVAR(Treg_sv, SV *) /* what we match against */
9661b544
IZ
169PERLVAR(Treg_magic, MAGIC *) /* pos-magic of what we match */
170PERLVAR(Treg_oldpos, I32) /* old pos of what we match */
5c5e4c24
IZ
171PERLVARI(Treg_oldcurpm, PMOP*, NULL) /* curpm before match */
172PERLVARI(Treg_curpm, PMOP*, NULL) /* curpm during match */
cf93c79d
IZ
173PERLVAR(Treg_oldsaved, char*) /* old saved substr during match */
174PERLVAR(Treg_oldsavedlen, STRLEN) /* old length of saved substr during match */
5c0ca799 175
0b94c7bb 176PERLVARI(Tregcompp, regcomp_t, MEMBER_TO_FPTR(Perl_pregcomp))
f722798b 177 /* Pointer to REx compiler */
0b94c7bb 178PERLVARI(Tregexecp, regexec_t, MEMBER_TO_FPTR(Perl_regexec_flags))
f722798b 179 /* Pointer to REx executer */
0b94c7bb 180PERLVARI(Tregint_start, re_intuit_start_t, MEMBER_TO_FPTR(Perl_re_intuit_start))
f722798b 181 /* Pointer to optimized REx executer */
0b94c7bb 182PERLVARI(Tregint_string,re_intuit_string_t, MEMBER_TO_FPTR(Perl_re_intuit_string))
f722798b 183 /* Pointer to optimized REx string */
0b94c7bb 184PERLVARI(Tregfree, regfree_t, MEMBER_TO_FPTR(Perl_pregfree))
f722798b
IZ
185 /* Pointer to REx free()er */
186
57668c4d 187PERLVARI(Treginterp_cnt,int, 0) /* Whether `Regexp'
5c0ca799 188 was interpolated. */
364723c2 189PERLVARI(Treg_starttry, char *, 0) /* -Dr: where regtry was called. */
22c35a8c
GS
190PERLVARI(Twatchaddr, char **, 0)
191PERLVAR(Twatchok, char *)
d4cce5f1 192
8b3be1d1 193/* Note that the variables below are all explicitly referenced in the code
cb68f92d 194 * as thr->whatever and therefore don't need the 'T' prefix. */
8b3be1d1 195
d4cce5f1 196#ifdef USE_THREADS
49f531da 197
cb68f92d
GS
198PERLVAR(oursv, SV *)
199PERLVAR(cvcache, HV *)
200PERLVAR(self, perl_os_thread) /* Underlying thread object */
201PERLVAR(flags, U32)
202PERLVAR(threadsv, AV *) /* Per-thread SVs ($_, $@ etc.) */
203PERLVAR(threadsvp, SV **) /* AvARRAY(threadsv) */
204PERLVAR(specific, AV *) /* Thread-specific user data */
205PERLVAR(errsv, SV *) /* Backing SV for $@ */
206PERLVAR(errhv, HV *) /* HV for what was %@ in pp_ctl.c */
207PERLVAR(mutex, perl_mutex) /* For the fields others can change */
208PERLVAR(tid, U32)
49f531da 209PERLVAR(prev, struct perl_thread *)
cb68f92d
GS
210PERLVAR(next, struct perl_thread *)
211 /* Circular linked list of threads */
49f531da
NIS
212
213#ifdef HAVE_THREAD_INTERN
cb68f92d
GS
214PERLVAR(i, struct thread_intern)
215 /* Platform-dependent internals */
49f531da
NIS
216#endif
217
cb68f92d 218PERLVAR(trailing_nul, char) /* For the sake of thrsv and oursv */
49f531da 219
d4cce5f1 220#endif /* USE_THREADS */