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