Commit | Line | Data |
---|---|---|
907b3e23 DM |
1 | /* intrpvar.h |
2 | * | |
3 | * Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, | |
1129b882 | 4 | * 2006, 2007, 2008 by Larry Wall and others |
907b3e23 DM |
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 | ||
e3d474b7 KW |
11 | #include "handy.h" |
12 | ||
907b3e23 DM |
13 | /* |
14 | =head1 Per-Interpreter Variables | |
15 | */ | |
49f531da | 16 | |
907b3e23 DM |
17 | /* These variables are per-interpreter in threaded/multiplicity builds, |
18 | * global otherwise. | |
19 | ||
d7cb65f2 | 20 | * Don't forget to re-run regen/embed.pl to propagate changes! */ |
cb68f92d | 21 | |
ab686ae8 | 22 | /* New variables must be added to the very end for binary compatibility. */ |
6537fe72 | 23 | |
ba05a734 | 24 | /* Don't forget to add your variable also to perl_clone()! (in sv.c) */ |
02506efe | 25 | |
cb68f92d GS |
26 | /* The 'I' prefix is only needed for vars that need appropriate #defines |
27 | * generated when built with or without MULTIPLICITY. It is also used | |
97df044c KW |
28 | * to generate the appropriate export list for win32. If the variable |
29 | * needs to be initialized, use PERLVARI. | |
cb68f92d | 30 | * |
907b3e23 DM |
31 | * When building without MULTIPLICITY, these variables will be truly global. |
32 | * | |
33 | * Important ones in the first cache line (if alignment is done right) */ | |
34 | ||
115ff745 | 35 | PERLVAR(I, stack_sp, SV **) /* top of the stack */ |
115ff745 | 36 | PERLVAR(I, op, OP *) /* currently executing op */ |
115ff745 | 37 | PERLVAR(I, curpad, SV **) /* active pad (lexicals+tmps) */ |
907b3e23 | 38 | |
115ff745 NC |
39 | PERLVAR(I, stack_base, SV **) |
40 | PERLVAR(I, stack_max, SV **) | |
907b3e23 | 41 | |
115ff745 | 42 | PERLVAR(I, savestack, ANY *) /* items that need to be restored when |
907b3e23 | 43 | LEAVEing scopes we've ENTERed */ |
115ff745 NC |
44 | PERLVAR(I, savestack_ix, I32) |
45 | PERLVAR(I, savestack_max, I32) | |
46 | ||
19bc2726 DM |
47 | PERLVAR(I, scopestack, I32 *) /* scopes we've ENTERed */ |
48 | PERLVAR(I, scopestack_ix, I32) | |
49 | PERLVAR(I, scopestack_max, I32) | |
50 | ||
115ff745 | 51 | PERLVAR(I, tmps_stack, SV **) /* mortals we've made */ |
e8eb279c FC |
52 | PERLVARI(I, tmps_ix, SSize_t, -1) |
53 | PERLVARI(I, tmps_floor, SSize_t, -1) | |
54 | PERLVAR(I, tmps_max, SSize_t) | |
19bc2726 DM |
55 | |
56 | PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */ | |
907b3e23 | 57 | |
115ff745 | 58 | PERLVAR(I, markstack, I32 *) /* stack_sp locations we're |
907b3e23 | 59 | remembering */ |
115ff745 NC |
60 | PERLVAR(I, markstack_ptr, I32 *) |
61 | PERLVAR(I, markstack_max, I32 *) | |
907b3e23 | 62 | |
6a5b4183 YO |
63 | #ifdef PERL_HASH_RANDOMIZE_KEYS |
64 | #ifdef USE_PERL_PERTURB_KEYS | |
65 | PERLVARI(I, hash_rand_bits_enabled, U8, 1) /* used to randomize hash stuff 0 == no-random, 1 == random, 2 == determinsitic */ | |
66 | #endif | |
0e0ab621 | 67 | PERLVARI(I, hash_rand_bits, UV, 0) /* used to randomize hash stuff */ |
6a5b4183 | 68 | #endif |
19bc2726 DM |
69 | PERLVAR(I, strtab, HV *) /* shared string table */ |
70 | ||
71 | /* Fields used by magic variables such as $@, $/ and so on */ | |
72 | PERLVAR(I, curpm, PMOP *) /* what to do \ interps in REs from */ | |
73 | ||
74 | PERLVAR(I, tainting, bool) /* doing taint checks */ | |
75 | PERLVAR(I, tainted, bool) /* using variables controlled by $< */ | |
76 | PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */ | |
77 | PERLVAR(I, localizing, U8) /* are we processing a local() list? */ | |
78 | PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */ | |
3f44dc81 | 79 | PERLVAR(I, defgv, GV *) /* the *_ glob */ |
19bc2726 DM |
80 | /* |
81 | ||
82 | =for apidoc mn|bool|PL_dowarn | |
83 | ||
84 | The C variable which corresponds to Perl's $^W warning variable. | |
85 | ||
86 | =cut | |
87 | */ | |
88 | ||
89 | PERLVAR(I, dowarn, U8) | |
90 | ||
91 | #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING) | |
92 | # define PERL___I -1 | |
93 | #else | |
94 | # define PERL___I 1 | |
95 | #endif | |
96 | PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */ | |
97 | #undef PERL___I | |
98 | ||
99 | ||
100 | /* Stashes */ | |
101 | PERLVAR(I, defstash, HV *) /* main symbol table */ | |
102 | PERLVAR(I, curstash, HV *) /* symbol table for current package */ | |
103 | ||
104 | PERLVAR(I, curcop, COP *) | |
105 | PERLVAR(I, curstack, AV *) /* THE STACK */ | |
106 | PERLVAR(I, curstackinfo, PERL_SI *) /* current stack + context */ | |
107 | PERLVAR(I, mainstack, AV *) /* the stack when nothing funny is | |
108 | happening */ | |
109 | ||
110 | /* memory management */ | |
111 | PERLVAR(I, sv_count, IV) /* how many SV* are currently allocated */ | |
19bc2726 DM |
112 | |
113 | PERLVAR(I, sv_root, SV *) /* storage for SVs belonging to interp */ | |
114 | PERLVAR(I, sv_arenaroot, SV *) /* list of areas for garbage collection */ | |
115 | ||
f65e70f5 DM |
116 | /* fake PMOP that PL_curpm points to while in (?{}) so $1 et al are visible */ |
117 | PERLVARI(I, reg_curpm, PMOP*, NULL) | |
118 | ||
19bc2726 | 119 | /* the currently active slab in a chain of slabs of regmatch states, |
87c1d905 DM |
120 | * and the currently active state within that slab. This stack of states |
121 | * is shared amongst re-entrant calls to the regex engine */ | |
19bc2726 DM |
122 | |
123 | PERLVARI(I, regmatch_slab, regmatch_slab *, NULL) | |
124 | PERLVAR(I, regmatch_state, regmatch_state *) | |
125 | ||
126 | PERLVAR(I, comppad, PAD *) /* storage for lexically scoped temporaries */ | |
127 | ||
128 | /* | |
129 | =for apidoc Amn|SV|PL_sv_undef | |
130 | This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>. | |
131 | ||
132 | =for apidoc Amn|SV|PL_sv_no | |
133 | This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as | |
134 | C<&PL_sv_no>. | |
135 | ||
136 | =for apidoc Amn|SV|PL_sv_yes | |
137 | This is the C<true> SV. See C<PL_sv_no>. Always refer to this as | |
138 | C<&PL_sv_yes>. | |
139 | ||
140 | =cut | |
141 | */ | |
142 | ||
143 | PERLVAR(I, sv_undef, SV) | |
144 | PERLVAR(I, sv_no, SV) | |
145 | PERLVAR(I, sv_yes, SV) | |
115ff745 | 146 | PERLVAR(I, Sv, SV *) /* used to hold temporary values */ |
19bc2726 DM |
147 | |
148 | PERLVAR(I, parser, yy_parser *) /* current parser state */ | |
149 | ||
150 | PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */ | |
151 | ||
907b3e23 DM |
152 | |
153 | /* | |
154 | =for apidoc Amn|STRLEN|PL_na | |
155 | ||
156 | A convenience variable which is typically used with C<SvPV> when one | |
157 | doesn't care about the length of the string. It is usually more efficient | |
158 | to either declare a local variable and use that instead or to use the | |
159 | C<SvPV_nolen> macro. | |
160 | ||
161 | =cut | |
162 | */ | |
163 | ||
115ff745 | 164 | PERLVAR(I, na, STRLEN) /* for use in SvPV when length is |
907b3e23 DM |
165 | Not Applicable */ |
166 | ||
167 | /* stat stuff */ | |
115ff745 NC |
168 | PERLVAR(I, statbuf, Stat_t) |
169 | PERLVAR(I, statcache, Stat_t) /* _ */ | |
170 | PERLVAR(I, statgv, GV *) | |
171 | PERLVARI(I, statname, SV *, NULL) | |
907b3e23 DM |
172 | |
173 | #ifdef HAS_TIMES | |
236e9788 | 174 | /* Will be removed soon after v5.21.1. See RT #121351 */ |
115ff745 | 175 | PERLVAR(I, timesbuf, struct tms) |
907b3e23 DM |
176 | #endif |
177 | ||
907b3e23 DM |
178 | /* |
179 | =for apidoc mn|SV*|PL_rs | |
180 | ||
181 | The input record separator - C<$/> in Perl space. | |
182 | ||
183 | =for apidoc mn|GV*|PL_last_in_gv | |
184 | ||
154e47c8 | 185 | The GV which was last used for a filehandle input operation. (C<< <FH> >>) |
907b3e23 | 186 | |
e23d9e2f | 187 | =for apidoc mn|GV*|PL_ofsgv |
907b3e23 | 188 | |
e23d9e2f | 189 | The glob containing the output field separator - C<*,> in Perl space. |
907b3e23 DM |
190 | |
191 | =cut | |
192 | */ | |
193 | ||
115ff745 NC |
194 | PERLVAR(I, rs, SV *) /* input record separator $/ */ |
195 | PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */ | |
196 | PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */ | |
197 | PERLVAR(I, defoutgv, GV *) /* default FH for output */ | |
198 | PERLVARI(I, chopset, const char *, " \n-") /* $: */ | |
199 | PERLVAR(I, formtarget, SV *) | |
200 | PERLVAR(I, bodytarget, SV *) | |
201 | PERLVAR(I, toptarget, SV *) | |
907b3e23 | 202 | |
115ff745 NC |
203 | |
204 | PERLVAR(I, restartop, OP *) /* propagating an error from croak? */ | |
205 | PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */ | |
907b3e23 | 206 | |
115ff745 NC |
207 | PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */ |
208 | PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */ | |
209 | PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */ | |
907b3e23 DM |
210 | |
211 | /* statics "owned" by various functions */ | |
115ff745 | 212 | PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */ |
907b3e23 | 213 | |
115ff745 | 214 | PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */ |
907b3e23 DM |
215 | |
216 | /* sort stuff */ | |
115ff745 NC |
217 | PERLVAR(I, sortcop, OP *) /* user defined sort routine */ |
218 | PERLVAR(I, sortstash, HV *) /* which is in some package or other */ | |
219 | PERLVAR(I, firstgv, GV *) /* $a */ | |
220 | PERLVAR(I, secondgv, GV *) /* $b */ | |
907b3e23 DM |
221 | |
222 | /* float buffer */ | |
115ff745 NC |
223 | PERLVAR(I, efloatbuf, char *) |
224 | PERLVAR(I, efloatsize, STRLEN) | |
907b3e23 | 225 | |
115ff745 | 226 | PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump |
907b3e23 DM |
227 | indentation level */ |
228 | ||
e914d9bb | 229 | PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */ |
157b3822 | 230 | |
115ff745 | 231 | PERLVAR(I, utf8locale, bool) /* utf8 locale detected */ |
31f05a37 | 232 | PERLVAR(I, in_utf8_CTYPE_locale, bool) |
907b3e23 | 233 | |
87c1d905 | 234 | PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */ |
907b3e23 | 235 | |
9ea12537 Z |
236 | /* |
237 | =for apidoc Amn|peep_t|PL_peepp | |
238 | ||
239 | Pointer to the per-subroutine peephole optimiser. This is a function | |
240 | that gets called at the end of compilation of a Perl subroutine (or | |
241 | equivalently independent piece of Perl code) to perform fixups of | |
242 | some ops and to perform small-scale optimisations. The function is | |
243 | called once for each subroutine that is compiled, and is passed, as sole | |
244 | parameter, a pointer to the op that is the entry point to the subroutine. | |
245 | It modifies the op tree in place. | |
246 | ||
247 | The peephole optimiser should never be completely replaced. Rather, | |
248 | add code to it by wrapping the existing optimiser. The basic way to do | |
249 | this can be seen in L<perlguts/Compile pass 3: peephole optimization>. | |
250 | If the new code wishes to operate on ops throughout the subroutine's | |
251 | structure, rather than just at the top level, it is likely to be more | |
252 | convenient to wrap the L</PL_rpeepp> hook. | |
253 | ||
254 | =cut | |
255 | */ | |
256 | ||
115ff745 | 257 | PERLVARI(I, peepp, peep_t, Perl_peep) |
9ea12537 Z |
258 | |
259 | /* | |
260 | =for apidoc Amn|peep_t|PL_rpeepp | |
261 | ||
262 | Pointer to the recursive peephole optimiser. This is a function | |
263 | that gets called at the end of compilation of a Perl subroutine (or | |
264 | equivalently independent piece of Perl code) to perform fixups of some | |
265 | ops and to perform small-scale optimisations. The function is called | |
266 | once for each chain of ops linked through their C<op_next> fields; | |
267 | it is recursively called to handle each side chain. It is passed, as | |
268 | sole parameter, a pointer to the op that is at the head of the chain. | |
269 | It modifies the op tree in place. | |
270 | ||
271 | The peephole optimiser should never be completely replaced. Rather, | |
272 | add code to it by wrapping the existing optimiser. The basic way to do | |
273 | this can be seen in L<perlguts/Compile pass 3: peephole optimization>. | |
274 | If the new code wishes to operate only on ops at a subroutine's top level, | |
275 | rather than throughout the structure, it is likely to be more convenient | |
276 | to wrap the L</PL_peepp> hook. | |
277 | ||
278 | =cut | |
279 | */ | |
280 | ||
115ff745 | 281 | PERLVARI(I, rpeepp, peep_t, Perl_rpeep) |
907b3e23 | 282 | |
2f175318 VP |
283 | /* |
284 | =for apidoc Amn|Perl_ophook_t|PL_opfreehook | |
285 | ||
286 | When non-C<NULL>, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument. | |
287 | This allows extensions to free any extra attribute they have locally attached to an OP. | |
288 | It is also assured to first fire for the parent OP and then for its kids. | |
289 | ||
290 | When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own. | |
291 | ||
292 | =cut | |
293 | */ | |
294 | ||
115ff745 | 295 | PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */ |
f37b8c3f | 296 | |
115ff745 NC |
297 | PERLVARI(I, watchaddr, char **, 0) |
298 | PERLVAR(I, watchok, char *) | |
907b3e23 | 299 | |
115ff745 | 300 | PERLVAR(I, perldb, U32) |
d95e864f | 301 | |
115ff745 | 302 | PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */ |
30b0736d | 303 | |
79968a97 NC |
304 | PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */ |
305 | ||
49f531da | 306 | /* pseudo environmental stuff */ |
115ff745 NC |
307 | PERLVAR(I, origargc, int) |
308 | PERLVAR(I, origargv, char **) | |
309 | PERLVAR(I, envgv, GV *) | |
310 | PERLVAR(I, incgv, GV *) | |
311 | PERLVAR(I, hintgv, GV *) | |
312 | PERLVAR(I, origfilename, char *) | |
313 | PERLVAR(I, diehook, SV *) | |
314 | PERLVAR(I, warnhook, SV *) | |
1d7c1841 GS |
315 | |
316 | /* switches */ | |
115ff745 NC |
317 | PERLVAR(I, patchlevel, SV *) |
318 | PERLVAR(I, apiversion, SV *) | |
319 | PERLVAR(I, localpatches, const char * const *) | |
320 | PERLVARI(I, splitstr, const char *, " ") | |
321 | ||
322 | PERLVAR(I, minus_c, bool) | |
323 | PERLVAR(I, minus_n, bool) | |
324 | PERLVAR(I, minus_p, bool) | |
325 | PERLVAR(I, minus_l, bool) | |
326 | PERLVAR(I, minus_a, bool) | |
327 | PERLVAR(I, minus_F, bool) | |
328 | PERLVAR(I, doswitches, bool) | |
329 | PERLVAR(I, minus_E, bool) | |
954c1994 | 330 | |
115ff745 NC |
331 | PERLVAR(I, inplace, char *) |
332 | PERLVAR(I, e_script, SV *) | |
49f531da | 333 | |
115ff745 | 334 | PERLVAR(I, basetime, Time_t) /* $^T */ |
d4cce5f1 | 335 | |
115ff745 | 336 | PERLVARI(I, maxsysfd, I32, MAXSYSFD) |
cb68f92d | 337 | /* top fd to pass to subprocesses */ |
115ff745 | 338 | PERLVAR(I, statusvalue, I32) /* $? */ |
49f531da | 339 | #ifdef VMS |
115ff745 | 340 | PERLVAR(I, statusvalue_vms, U32) |
e5218da5 | 341 | #else |
115ff745 | 342 | PERLVAR(I, statusvalue_posix, I32) |
49f531da NIS |
343 | #endif |
344 | ||
115ff745 NC |
345 | PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */ |
346 | PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */ | |
157b3822 | 347 | |
49f531da | 348 | /* shortcuts to various I/O objects */ |
115ff745 NC |
349 | PERLVAR(I, stdingv, GV *) /* *STDIN */ |
350 | PERLVAR(I, stderrgv, GV *) /* *STDERR */ | |
115ff745 NC |
351 | PERLVAR(I, argvgv, GV *) /* *ARGV */ |
352 | PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */ | |
353 | PERLVAR(I, argvout_stack, AV *) | |
49f531da NIS |
354 | |
355 | /* shortcuts to regexp stuff */ | |
115ff745 | 356 | PERLVAR(I, replgv, GV *) /* *^R */ |
49f531da NIS |
357 | |
358 | /* shortcuts to misc objects */ | |
115ff745 | 359 | PERLVAR(I, errgv, GV *) /* *@ */ |
49f531da NIS |
360 | |
361 | /* shortcuts to debugging objects */ | |
115ff745 NC |
362 | PERLVAR(I, DBgv, GV *) /* *DB::DB */ |
363 | PERLVAR(I, DBline, GV *) /* *DB::line */ | |
954c1994 GS |
364 | |
365 | /* | |
2eb25c99 | 366 | =for apidoc mn|GV *|PL_DBsub |
954c1994 GS |
367 | When Perl is run in debugging mode, with the B<-d> switch, this GV contains |
368 | the SV which holds the name of the sub being debugged. This is the C | |
369 | variable which corresponds to Perl's $DB::sub variable. See | |
370 | C<PL_DBsingle>. | |
371 | ||
2eb25c99 | 372 | =for apidoc mn|SV *|PL_DBsingle |
954c1994 | 373 | When Perl is run in debugging mode, with the B<-d> switch, this SV is a |
7889fe52 | 374 | boolean which indicates whether subs are being single-stepped. |
954c1994 GS |
375 | Single-stepping is automatically turned on after every step. This is the C |
376 | variable which corresponds to Perl's $DB::single variable. See | |
377 | C<PL_DBsub>. | |
378 | ||
2eb25c99 | 379 | =for apidoc mn|SV *|PL_DBtrace |
954c1994 GS |
380 | Trace variable used when Perl is run in debugging mode, with the B<-d> |
381 | switch. This is the C variable which corresponds to Perl's $DB::trace | |
382 | variable. See C<PL_DBsingle>. | |
383 | ||
384 | =cut | |
385 | */ | |
386 | ||
115ff745 NC |
387 | PERLVAR(I, DBsub, GV *) /* *DB::sub */ |
388 | PERLVAR(I, DBsingle, SV *) /* $DB::single */ | |
389 | PERLVAR(I, DBtrace, SV *) /* $DB::trace */ | |
390 | PERLVAR(I, DBsignal, SV *) /* $DB::signal */ | |
391 | PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */ | |
49f531da NIS |
392 | |
393 | /* symbol tables */ | |
115ff745 NC |
394 | PERLVAR(I, debstash, HV *) /* symbol table for perldb package */ |
395 | PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */ | |
396 | PERLVAR(I, curstname, SV *) /* name of current package */ | |
397 | PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */ | |
398 | PERLVAR(I, endav, AV *) /* names of END subroutines */ | |
399 | PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */ | |
400 | PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */ | |
401 | PERLVAR(I, initav, AV *) /* names of INIT subroutines */ | |
49f531da | 402 | |
49f531da | 403 | /* subprocess state */ |
115ff745 | 404 | PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */ |
49f531da NIS |
405 | |
406 | /* internal state */ | |
115ff745 | 407 | PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */ |
49f531da | 408 | |
49f531da | 409 | /* current interpreter roots */ |
115ff745 NC |
410 | PERLVAR(I, main_cv, CV *) |
411 | PERLVAR(I, main_root, OP *) | |
412 | PERLVAR(I, main_start, OP *) | |
413 | PERLVAR(I, eval_root, OP *) | |
414 | PERLVAR(I, eval_start, OP *) | |
49f531da NIS |
415 | |
416 | /* runtime control stuff */ | |
115ff745 | 417 | PERLVARI(I, curcopdb, COP *, NULL) |
49f531da | 418 | |
115ff745 NC |
419 | PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */ |
420 | PERLVAR(I, lastfd, int) /* what to preserve mode on */ | |
421 | PERLVAR(I, oldname, char *) /* what to preserve mode on */ | |
422 | PERLVAR(I, Argv, const char **) /* stuff to free from do_aexec, vfork safe */ | |
423 | PERLVAR(I, Cmd, char *) /* stuff to free from do_aexec, vfork safe */ | |
00accf8d NC |
424 | /* Elements in this array have ';' appended and are injected as a single line |
425 | into the tokeniser. You can't put any (literal) newlines into any program | |
426 | you stuff in into this array, as the point where it's injected is expecting | |
427 | a single physical line. */ | |
115ff745 NC |
428 | PERLVAR(I, preambleav, AV *) |
429 | PERLVAR(I, mess_sv, SV *) | |
430 | PERLVAR(I, ors_sv, SV *) /* output record separator $\ */ | |
19bc2726 | 431 | |
79968a97 NC |
432 | /* funky return mechanisms */ |
433 | PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */ | |
434 | ||
71eebe1e | 435 | /* statics moved here for shared library purposes */ |
115ff745 NC |
436 | PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */ |
437 | PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */ | |
438 | PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */ | |
439 | PERLVARI(I, laststype, U16, OP_STAT) | |
19bc2726 | 440 | |
115ff745 | 441 | PERLVARI(I, laststatval, int, -1) |
d4cce5f1 | 442 | |
19bc2726 DM |
443 | PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in |
444 | assignment? */ | |
445 | ||
4b556e6c | 446 | /* interpreter atexit processing */ |
115ff745 NC |
447 | PERLVARI(I, exitlistlen, I32, 0) /* length of same */ |
448 | PERLVARI(I, exitlist, PerlExitListEntry *, NULL) | |
cb68f92d | 449 | /* list of exit functions */ |
954c1994 GS |
450 | |
451 | /* | |
452 | =for apidoc Amn|HV*|PL_modglobal | |
453 | ||
7889fe52 | 454 | C<PL_modglobal> is a general purpose, interpreter global HV for use by |
954c1994 | 455 | extensions that need to keep information on a per-interpreter basis. |
7889fe52 NIS |
456 | In a pinch, it can also be used as a symbol table for extensions |
457 | to share data among each other. It is a good idea to use keys | |
954c1994 GS |
458 | prefixed by the package name of the extension that owns the data. |
459 | ||
460 | =cut | |
461 | */ | |
462 | ||
115ff745 | 463 | PERLVAR(I, modglobal, HV *) /* per-interp module data */ |
cb68f92d GS |
464 | |
465 | /* these used to be in global before 5.004_68 */ | |
115ff745 | 466 | PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */ |
cb68f92d | 467 | |
115ff745 | 468 | PERLVAR(I, compiling, COP) /* compiling/done executing marker */ |
cb68f92d | 469 | |
115ff745 | 470 | PERLVAR(I, compcv, CV *) /* currently compiling subroutine */ |
36c300bb | 471 | PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */ |
115ff745 NC |
472 | PERLVAR(I, comppad_name_fill, I32) /* last "introduced" variable offset */ |
473 | PERLVAR(I, comppad_name_floor, I32) /* start of vars in innermost block */ | |
4b556e6c JD |
474 | |
475 | #ifdef HAVE_INTERP_INTERN | |
115ff745 | 476 | PERLVAR(I, sys_intern, struct interp_intern) |
cb68f92d | 477 | /* platform internals */ |
4b556e6c JD |
478 | #endif |
479 | ||
7fae4e64 | 480 | /* more statics moved here */ |
115ff745 NC |
481 | PERLVAR(I, DBcv, CV *) /* from perl.c */ |
482 | PERLVARI(I, generation, int, 100) /* from op.c */ | |
56953603 | 483 | |
19bc2726 DM |
484 | PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */ |
485 | ||
115ff745 NC |
486 | PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */ |
487 | PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */ | |
488 | PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */ | |
489 | PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */ | |
7fae4e64 | 490 | |
19bc2726 | 491 | |
985213f2 AB |
492 | PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */ |
493 | PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */ | |
494 | PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */ | |
495 | PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */ | |
115ff745 | 496 | PERLVARI(I, an, U32, 0) /* malloc sequence number */ |
be2b6a89 | 497 | |
79968a97 NC |
498 | /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */ |
499 | PERLVARI(I, breakable_sub_gen, U32, 0) | |
500 | ||
be2b6a89 DM |
501 | #ifdef DEBUGGING |
502 | /* exercise wrap-around */ | |
503 | #define PERL_COP_SEQMAX (U32_MAX-50) | |
504 | #else | |
505 | #define PERL_COP_SEQMAX 0 | |
506 | #endif | |
115ff745 | 507 | PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */ |
be2b6a89 DM |
508 | #undef PERL_COP_SEQMAX |
509 | ||
115ff745 NC |
510 | PERLVARI(I, evalseq, U32, 0) /* eval sequence number */ |
511 | PERLVAR(I, origalen, U32) | |
512 | PERLVAR(I, origenviron, char **) | |
ca0c25f6 | 513 | #ifdef PERL_USES_PL_PIDSTATUS |
115ff745 | 514 | PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */ |
ca0c25f6 | 515 | #endif |
115ff745 | 516 | PERLVAR(I, osname, char *) /* operating system */ |
5c728af0 | 517 | |
115ff745 | 518 | PERLVAR(I, sighandlerp, Sighandler_t) |
0672f40e | 519 | |
115ff745 | 520 | PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */ |
93e68bfb | 521 | |
79968a97 NC |
522 | PERLVAR(I, debug, VOL U32) /* flags given to -D switch */ |
523 | ||
115ff745 | 524 | PERLVARI(I, maxo, int, MAXO) /* maximum number of ops */ |
9f7da6d5 | 525 | |
115ff745 | 526 | PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT) |
0672f40e | 527 | |
115ff745 | 528 | PERLVAR(I, subname, SV *) /* name of current subroutine */ |
0672f40e | 529 | |
115ff745 NC |
530 | PERLVAR(I, subline, I32) /* line this subroutine began on */ |
531 | PERLVAR(I, min_intro_pending, I32) /* start of vars to introduce */ | |
d95e864f | 532 | |
115ff745 NC |
533 | PERLVAR(I, max_intro_pending, I32) /* end of vars to introduce */ |
534 | PERLVAR(I, padix, I32) /* max used index in current "register" pad */ | |
d95e864f | 535 | |
115ff745 | 536 | PERLVAR(I, padix_floor, I32) /* how low may inner block reset padix */ |
0672f40e | 537 | |
0672f40e | 538 | #ifdef USE_LOCALE_COLLATE |
115ff745 NC |
539 | PERLVAR(I, collation_name, char *) /* Name of current collation */ |
540 | PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm() */ | |
541 | PERLVARI(I, collxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */ | |
542 | PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */ | |
543 | PERLVARI(I, collation_standard, bool, TRUE) | |
9f7da6d5 | 544 | /* Assume simple collation */ |
0672f40e GS |
545 | #endif /* USE_LOCALE_COLLATE */ |
546 | ||
19bc2726 DM |
547 | #ifdef PERL_SAWAMPERSAND |
548 | PERLVAR(I, sawampersand, U8) /* must save all match strings */ | |
9f7da6d5 | 549 | #endif |
95ca8690 | 550 | |
19bc2726 | 551 | PERLVAR(I, unsafe, bool) |
87c1d905 | 552 | PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */ |
19bc2726 | 553 | |
79968a97 NC |
554 | /* current phase the interpreter is in |
555 | for ordering this structure to remove holes, we're assuming that this is 4 | |
556 | bytes. */ | |
557 | PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT) | |
558 | ||
559 | PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */ | |
560 | ||
561 | /* This value may be set when embedding for full cleanup */ | |
562 | /* 0=none, 1=full, 2=full with checks */ | |
563 | /* mod_perl is special, and also assigns a meaning -1 */ | |
564 | PERLVARI(I, perl_destruct_level, signed char, 0) | |
9f7da6d5 | 565 | |
0672f40e GS |
566 | #ifdef USE_LOCALE_NUMERIC |
567 | ||
7738054c | 568 | PERLVARI(I, numeric_standard, int, TRUE) |
0672f40e | 569 | /* Assume simple numerics */ |
115ff745 | 570 | PERLVARI(I, numeric_local, bool, TRUE) |
0672f40e | 571 | /* Assume local numerics */ |
115ff745 NC |
572 | PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */ |
573 | PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */ | |
f8115845 | 574 | |
0672f40e GS |
575 | #endif /* !USE_LOCALE_NUMERIC */ |
576 | ||
a3e1f3a6 | 577 | /* Unicode inversion lists */ |
a3e1f3a6 | 578 | PERLVAR(I, Latin1, SV *) |
892d8259 | 579 | PERLVAR(I, UpperLatin1, SV *) /* Code points 128 - 255 */ |
a3e1f3a6 KW |
580 | PERLVAR(I, AboveLatin1, SV *) |
581 | ||
26faadbd | 582 | PERLVAR(I, NonL1NonFinalFold, SV *) |
9d53c457 | 583 | PERLVAR(I, HasMultiCharFold, SV *) |
26faadbd | 584 | |
a3e1f3a6 | 585 | /* utf8 character class swashes */ |
115ff745 | 586 | PERLVAR(I, utf8_mark, SV *) |
27d4fc33 | 587 | PERLVAR(I, utf8_X_regular_begin, SV *) |
115ff745 | 588 | PERLVAR(I, utf8_X_extend, SV *) |
115ff745 NC |
589 | PERLVAR(I, utf8_toupper, SV *) |
590 | PERLVAR(I, utf8_totitle, SV *) | |
591 | PERLVAR(I, utf8_tolower, SV *) | |
592 | PERLVAR(I, utf8_tofold, SV *) | |
bde9e88d KW |
593 | PERLVAR(I, utf8_charname_begin, SV *) |
594 | PERLVAR(I, utf8_charname_continue, SV *) | |
30f9bdb0 | 595 | |
63c61c3f | 596 | PERLVARA(I, utf8_swash_ptrs, POSIX_SWASH_COUNT, SV *) |
30f9bdb0 | 597 | PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *) |
cac6e0ca KW |
598 | PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *) |
599 | ||
115ff745 NC |
600 | PERLVAR(I, last_swash_hv, HV *) |
601 | PERLVAR(I, last_swash_tmps, U8 *) | |
602 | PERLVAR(I, last_swash_slen, STRLEN) | |
6c2f1a55 | 603 | PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8) |
45d91b83 | 604 | PERLVAR(I, last_swash_klen, U8) /* Only needs to store 0-12 */ |
d95e864f NC |
605 | |
606 | #ifdef FCRYPT | |
115ff745 | 607 | PERLVARI(I, cryptseen, bool, FALSE) /* has fast crypt() been initialized? */ |
79968a97 NC |
608 | #else |
609 | /* One byte hole in the interpreter structure. */ | |
d95e864f NC |
610 | #endif |
611 | ||
115ff745 | 612 | PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */ |
e6b4660c | 613 | PERLVAR(I, srand_called, bool) |
12fbd33b | 614 | |
c4a30c8c NC |
615 | /* Array of signal handlers, indexed by signal number, through which the C |
616 | signal handler dispatches. */ | |
115ff745 | 617 | PERLVAR(I, psig_ptr, SV **) |
c4a30c8c | 618 | /* Array of names of signals, indexed by signal number, for (re)use as the first |
d525a7b2 NC |
619 | argument to a signal handler. Only one block of memory is allocated for |
620 | both psig_name and psig_ptr. */ | |
115ff745 | 621 | PERLVAR(I, psig_name, SV **) |
1d7c1841 | 622 | |
c5be433b | 623 | #if defined(PERL_IMPLICIT_SYS) |
115ff745 NC |
624 | PERLVAR(I, Mem, struct IPerlMem *) |
625 | PERLVAR(I, MemShared, struct IPerlMem *) | |
626 | PERLVAR(I, MemParse, struct IPerlMem *) | |
627 | PERLVAR(I, Env, struct IPerlEnv *) | |
628 | PERLVAR(I, StdIO, struct IPerlStdIO *) | |
629 | PERLVAR(I, LIO, struct IPerlLIO *) | |
630 | PERLVAR(I, Dir, struct IPerlDir *) | |
631 | PERLVAR(I, Sock, struct IPerlSock *) | |
632 | PERLVAR(I, Proc, struct IPerlProc *) | |
76e3520e | 633 | #endif |
1d7c1841 | 634 | |
115ff745 NC |
635 | PERLVAR(I, ptr_table, PTR_TBL_t *) |
636 | PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */ | |
f180df80 | 637 | |
115ff745 | 638 | PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */ |
93e68bfb | 639 | |
d95e864f | 640 | |
1fcf4c12 | 641 | #if defined(USE_ITHREADS) |
115ff745 | 642 | PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of |
e6853197 | 643 | regex_padav */ |
115ff745 | 644 | PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the |
e6853197 | 645 | values in op_pmoffset of pmop. |
402d2eb1 NC |
646 | Entry 0 is an SV whose PV is a |
647 | "packed" list of IVs listing | |
e6853197 | 648 | the now-free slots in the array */ |
d4d03940 FC |
649 | PERLVAR(I, stashpad, HV **) /* for CopSTASH */ |
650 | PERLVARI(I, stashpadmax, PADOFFSET, 64) | |
651 | PERLVARI(I, stashpadix, PADOFFSET, 0) | |
1fcf4c12 AB |
652 | #endif |
653 | ||
ea68fd67 | 654 | #ifdef USE_REENTRANT_API |
115ff745 | 655 | PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */ |
f5a82810 JH |
656 | #endif |
657 | ||
115ff745 NC |
658 | PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */ |
659 | PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */ | |
19e8ce8e | 660 | |
a1ea730d | 661 | #ifdef PERLIO_LAYERS |
115ff745 NC |
662 | PERLVARI(I, perlio, PerlIOl *, NULL) |
663 | PERLVARI(I, known_layers, PerlIO_list_t *, NULL) | |
664 | PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL) | |
a1ea730d NIS |
665 | #endif |
666 | ||
115ff745 | 667 | PERLVARI(I, encoding, SV *, NULL) /* character encoding */ |
0a378802 | 668 | |
115ff745 NC |
669 | PERLVAR(I, utf8_idstart, SV *) |
670 | PERLVAR(I, utf8_idcont, SV *) | |
671 | PERLVAR(I, utf8_xidstart, SV *) | |
b6912c02 | 672 | PERLVAR(I, utf8_perl_idstart, SV *) |
eba68aa0 | 673 | PERLVAR(I, utf8_perl_idcont, SV *) |
115ff745 | 674 | PERLVAR(I, utf8_xidcont, SV *) |
82686b01 | 675 | |
115ff745 | 676 | PERLVAR(I, sort_RealCmp, SVCOMPARE_t) |
147f47de | 677 | |
115ff745 NC |
678 | PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */ |
679 | PERLVARI(I, unitcheckav_save, AV *, NULL) | |
680 | /* save UNITCHECK{}s when compiling */ | |
ece599bd | 681 | |
115ff745 | 682 | PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */ |
5311654c | 683 | |
15a5279a | 684 | /* Hooks to shared SVs and locks. */ |
115ff745 NC |
685 | PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing) |
686 | PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing) | |
d0647d4e NC |
687 | #ifdef NO_MATHOMS |
688 | # define PERL_UNLOCK_HOOK Perl_sv_nosharing | |
689 | #else | |
690 | /* This reference ensures that the mathoms are linked with perl */ | |
691 | # define PERL_UNLOCK_HOOK Perl_sv_nounlocking | |
692 | #endif | |
115ff745 | 693 | PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK) |
d0647d4e | 694 | |
115ff745 | 695 | PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook) |
15a5279a | 696 | |
9e08d3a4 | 697 | /* Can shared object be destroyed */ |
115ff745 | 698 | PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable) |
9e08d3a4 | 699 | |
01d65469 | 700 | #ifndef PERL_MICRO |
115ff745 | 701 | PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals) |
01d65469 | 702 | #endif |
92f022bb | 703 | |
115ff745 | 704 | PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */ |
f16dd614 | 705 | |
9e08d3a4 NC |
706 | /* Register of known Method Resolution Orders. |
707 | What this actually points to is an implementation detail (it may change to | |
708 | a structure incorporating a reference count - use mro_get_from_name to | |
709 | retrieve a C<struct mro_alg *> */ | |
115ff745 | 710 | PERLVAR(I, registered_mros, HV *) |
9e08d3a4 NC |
711 | |
712 | /* Compile-time block start/end hooks */ | |
115ff745 | 713 | PERLVAR(I, blockhooks, AV *) |
9e08d3a4 NC |
714 | |
715 | /* Everything that folds to a given character, for case insensitivity regex | |
716 | * matching */ | |
115ff745 | 717 | PERLVARI(I, utf8_foldclosures, HV *, NULL) |
9e08d3a4 NC |
718 | |
719 | /* List of characters that participate in folds (except marks, etc in | |
720 | * multi-char folds) */ | |
115ff745 | 721 | PERLVARI(I, utf8_foldable, SV *, NULL) |
9e08d3a4 | 722 | |
115ff745 | 723 | PERLVAR(I, custom_ops, HV *) /* custom op registrations */ |
9e08d3a4 | 724 | |
19bc2726 DM |
725 | PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */ |
726 | ||
727 | /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be | |
728 | present always, as -DDEBUGGING must be binary compatible with non. */ | |
729 | PERLVARI(I, scopestack_name, const char * *, NULL) | |
730 | ||
731 | PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */ | |
732 | ||
d67594ff FC |
733 | /* Hook for File::Glob */ |
734 | PERLVARI(I, globhook, globhook_t, NULL) | |
735 | ||
236e9788 | 736 | /* The last unconditional member of the interpreter structure when 5.21.1 was |
ffee3ff6 NC |
737 | released. The offset of the end of this is baked into a global variable in |
738 | any shared perl library which will allow a sanity test in future perl | |
739 | releases. */ | |
d399cf59 | 740 | #define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook |
ffee3ff6 | 741 | |
f16dd614 | 742 | #ifdef PERL_IMPLICIT_CONTEXT |
115ff745 | 743 | PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */ |
817b0f24 | 744 | PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */ |
ba6d381e | 745 | # ifdef PERL_GLOBAL_STRUCT_PRIVATE |
115ff745 | 746 | PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */ |
ba6d381e | 747 | # endif |
f16dd614 DM |
748 | #endif |
749 | ||
7cb608b5 NC |
750 | #ifdef PERL_TRACK_MEMPOOL |
751 | /* For use with the memory debugging code in util.c */ | |
115ff745 | 752 | PERLVAR(I, memory_debug_header, struct perl_memory_debug_header) |
7cb608b5 NC |
753 | #endif |
754 | ||
ba6d381e NC |
755 | #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP |
756 | /* File descriptor to talk to the child which dumps scalars. */ | |
115ff745 | 757 | PERLVARI(I, dumper_fd, int, -1) |
ba6d381e NC |
758 | #endif |
759 | ||
ba6d381e | 760 | |
d7a2c63c | 761 | #ifdef DEBUG_LEAKING_SCALARS |
115ff745 | 762 | PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */ |
d7a2c63c MHM |
763 | #endif |
764 | ||
a38ab475 RZ |
765 | PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */ |
766 | ||
75d476e2 S |
767 | #ifdef PERL_TRACE_OPS |
768 | PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type. | |
769 | If PERL_TRACE_OPS is enabled, we'll dump | |
770 | a summary count of all ops executed in the | |
771 | program at perl_destruct time. For | |
772 | profiling/debugging only. Works only if | |
773 | DEBUGGING is enabled, too. */ | |
774 | #endif | |
775 | ||
3be8f094 TC |
776 | PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE) |
777 | ||
157b3822 NC |
778 | /* If you are adding a U8 or U16, check to see if there are 'Space' comments |
779 | * above on where there are gaps which currently will be structure padding. */ | |
d95e864f NC |
780 | |
781 | /* Within a stable branch, new variables must be added to the very end, before | |
782 | * this comment, for binary compatibility (the offsets of the old members must | |
783 | * not change). | |
b83cd129 | 784 | * (Don't forget to add your variable also to perl_clone()!) |
e3acbfda | 785 | * XSUB.h provides wrapper functions via perlapi.h that make this |
b83cd129 JH |
786 | * irrelevant, but not all code may be expected to #include XSUB.h. |
787 | */ |