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