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