This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
By re-ordering declarations in interpvar.h and thrdvar.h, reduce the
[perl5.git] / thrdvar.h
CommitLineData
d6376244
JH
1/* thdrvar.h
2 *
699a97de
RGS
3 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006
4 * by Larry Wall and others
d6376244
JH
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
9 */
10
ccfc67b7
JH
11/*
12=head1 Global Variables
13*/
14
cb68f92d
GS
15/***********************************************/
16/* Global only to current thread */
17/***********************************************/
18
8b3be1d1
JP
19/* Don't forget to re-run embed.pl to propagate changes! */
20
cb68f92d 21/* The 'T' prefix is only needed for vars that need appropriate #defines
4d1ff10f 22 * generated when built with or without USE_5005THREADS. It is also used
cb68f92d
GS
23 * to generate the appropriate export list for win32.
24 *
4d1ff10f
AB
25 * When building without USE_5005THREADS, these variables will be truly global.
26 * When building without USE_5005THREADS but with MULTIPLICITY, these variables
14dd3ad8 27 * will be global per-interpreter. */
8b3be1d1 28
49f531da 29/* Important ones in the first cache line (if alignment is done right) */
d4cce5f1 30
cb68f92d 31PERLVAR(Tstack_sp, SV **) /* top of the stack */
49f531da 32#ifdef OP_IN_REGISTER
cb68f92d 33PERLVAR(Topsave, OP *)
49f531da 34#else
cb68f92d 35PERLVAR(Top, OP *) /* currently executing op */
49f531da 36#endif
cb68f92d
GS
37PERLVAR(Tcurpad, SV **) /* active pad (lexicals+tmps) */
38
39PERLVAR(Tstack_base, SV **)
40PERLVAR(Tstack_max, SV **)
41
42PERLVAR(Tscopestack, I32 *) /* scopes we've ENTERed */
43PERLVAR(Tscopestack_ix, I32)
44PERLVAR(Tscopestack_max,I32)
49f531da 45
cb68f92d
GS
46PERLVAR(Tsavestack, ANY *) /* items that need to be restored
47 when LEAVEing scopes we've ENTERed */
48PERLVAR(Tsavestack_ix, I32)
49PERLVAR(Tsavestack_max, I32)
49f531da 50
cb68f92d
GS
51PERLVAR(Ttmps_stack, SV **) /* mortals we've made */
52PERLVARI(Ttmps_ix, I32, -1)
53PERLVARI(Ttmps_floor, I32, -1)
54PERLVAR(Ttmps_max, I32)
9f7da6d5 55PERLVAR(Tmodcount, I32) /* how much mod()ification in assignment? */
49f531da 56
cb68f92d
GS
57PERLVAR(Tmarkstack, I32 *) /* stack_sp locations we're remembering */
58PERLVAR(Tmarkstack_ptr, I32 *)
59PERLVAR(Tmarkstack_max, I32 *)
49f531da 60
cb68f92d
GS
61PERLVAR(TSv, SV *) /* used to hold temporary values */
62PERLVAR(TXpv, XPV *) /* used to hold temporary values */
954c1994
GS
63
64/*
65=for apidoc Amn|STRLEN|PL_na
66
67A convenience variable which is typically used with C<SvPV> when one
68doesn't care about the length of the string. It is usually more efficient
69to either declare a local variable and use that instead or to use the
70C<SvPV_nolen> macro.
71
72=cut
73*/
74
b099ddc0
GS
75PERLVAR(Tna, STRLEN) /* for use in SvPV when length is
76 Not Applicable */
49f531da 77
5c0ca799 78/* stat stuff */
cb68f92d 79PERLVAR(Tstatbuf, Stat_t)
5c0ca799
GS
80PERLVAR(Tstatcache, Stat_t) /* _ */
81PERLVAR(Tstatgv, GV *)
a0714e2c 82PERLVARI(Tstatname, SV *, NULL)
5c0ca799 83
49f531da 84#ifdef HAS_TIMES
cb68f92d 85PERLVAR(Ttimesbuf, struct tms)
49f531da 86#endif
49f531da
NIS
87
88/* Fields used by magic variables such as $@, $/ and so on */
cb68f92d 89PERLVAR(Tcurpm, PMOP *) /* what to do \ interps in REs from */
c155e47c
SC
90
91/*
2eb25c99 92=for apidoc mn|SV*|PL_rs
c155e47c
SC
93
94The input record separator - C<$/> in Perl space.
95
2eb25c99 96=for apidoc mn|GV*|PL_last_in_gv
c155e47c
SC
97
98The GV which was last used for a filehandle input operation. (C<< <FH> >>)
99
2eb25c99 100=for apidoc mn|SV*|PL_ofs_sv
c155e47c
SC
101
102The output field separator - C<$,> in Perl space.
103
104=cut
105*/
106
cb68f92d
GS
107PERLVAR(Trs, SV *) /* input record separator $/ */
108PERLVAR(Tlast_in_gv, GV *) /* GV used in last <FH> */
7889fe52 109PERLVAR(Tofs_sv, SV *) /* output field separator $, */
cb68f92d 110PERLVAR(Tdefoutgv, GV *) /* default FH for output */
dd374669 111PERLVARI(Tchopset, const char *, " \n-") /* $: */
cb68f92d
GS
112PERLVAR(Tformtarget, SV *)
113PERLVAR(Tbodytarget, SV *)
114PERLVAR(Ttoptarget, SV *)
49f531da 115
d4cce5f1
NIS
116/* Stashes */
117PERLVAR(Tdefstash, HV *) /* main symbol table */
118PERLVAR(Tcurstash, HV *) /* symbol table for current package */
49f531da 119
cb68f92d 120PERLVAR(Trestartop, OP *) /* propagating an error from croak? */
3280af22 121PERLVARI(Tcurcop, COP * VOL, &PL_compiling)
61bb5906 122PERLVAR(Tlocalizing, int) /* are we processing a local() list? */
9f7da6d5 123PERLVAR(Tcolorset, int) /* from regcomp.c */
49f531da 124
cb68f92d
GS
125PERLVAR(Tcurstack, AV *) /* THE STACK */
126PERLVAR(Tcurstackinfo, PERL_SI *) /* current stack + context */
127PERLVAR(Tmainstack, AV *) /* the stack when nothing funny is happening */
312caa8e 128
cb68f92d
GS
129PERLVAR(Ttop_env, JMPENV *) /* ptr. to current sigjmp() environment */
130PERLVAR(Tstart_env, JMPENV) /* empty startup sigjmp() environment */
a0714e2c 131PERLVARI(Terrors, SV *, NULL) /* outstanding queued errors */
49f531da 132
4e4c362e 133/* statics "owned" by various functions */
195c09c3
JH
134PERLVAR(Tav_fetch_sv, SV *) /* unused as of change #19268 */
135PERLVAR(Thv_fetch_sv, SV *) /* unused as of change #19268 */
dd28f7bb 136PERLVAR(Thv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
cb68f92d 137
4e4c362e 138
5c0ca799 139PERLVAR(Tlastgotoprobe, OP*) /* from pp_ctl.c */
3967c732 140PERLVARI(Tdumpindent, I32, 4) /* # of blanks per dump indentation level */
5c0ca799
GS
141
142/* sort stuff */
143PERLVAR(Tsortcop, OP *) /* user defined sort routine */
144PERLVAR(Tsortstash, HV *) /* which is in some package or other */
145PERLVAR(Tfirstgv, GV *) /* $a */
146PERLVAR(Tsecondgv, GV *) /* $b */
5c0ca799 147
7d5ea4e7
GS
148/* float buffer */
149PERLVAR(Tefloatbuf, char*)
150PERLVAR(Tefloatsize, STRLEN)
151
5c0ca799
GS
152/* regex stuff */
153
154PERLVAR(Tscreamfirst, I32 *)
155PERLVAR(Tscreamnext, I32 *)
5c0ca799
GS
156PERLVAR(Tlastscream, SV *)
157
46ab3289 158PERLVAR(Treg_state, struct re_save_state)
5c0ca799 159PERLVAR(Tregdummy, regnode) /* from regcomp.c */
51371543 160PERLVARA(Tcolors,6, char *) /* from regcomp.c */
5c0ca799 161
a2efc822
SC
162PERLVARI(Tpeepp, peep_t, MEMBER_TO_FPTR(Perl_peep))
163 /* Pointer to peephole optimizer */
84da74a7 164
9f7da6d5 165PERLVARI(Tmaxscream, I32, -1)
a0288114 166PERLVARI(Treginterp_cnt,int, 0) /* Whether "Regexp" was interpolated. */
22c35a8c
GS
167PERLVARI(Twatchaddr, char **, 0)
168PERLVAR(Twatchok, char *)
d4cce5f1 169
8b3be1d1 170/* Note that the variables below are all explicitly referenced in the code
cb68f92d 171 * as thr->whatever and therefore don't need the 'T' prefix. */
8b3be1d1 172
5d9a96ca
DM
173/* the currently active slab in a chain of slabs of regmatch states,
174 * and the currently active state within that slab */
175
176PERLVARI(Tregmatch_slab, regmatch_slab *, NULL)
177PERLVAR(Tregmatch_state, regmatch_state *)
9f7da6d5
NC
178
179PERLVAR(Tdelaymagic, U16) /* ($<,$>) = ... */
180PERLVARI(Tdirty, bool, FALSE) /* in the middle of tearing things down? */
181PERLVAR(Tin_eval, VOL U8) /* trap "fatal" errors? */
182PERLVAR(Ttainted, bool) /* using variables controlled by $< */