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