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