This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add the Configure option to enable strict by default in perl programs.
[perl5.git] / intrpvar.h
CommitLineData
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 13/*
70b05c7c 14=for apidoc_section Per-Interpreter Variables
907b3e23 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
b8393ac7 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 35PERLVAR(I, stack_sp, SV **) /* top of the stack */
115ff745 36PERLVAR(I, op, OP *) /* currently executing op */
115ff745 37PERLVAR(I, curpad, SV **) /* active pad (lexicals+tmps) */
907b3e23 38
115ff745
NC
39PERLVAR(I, stack_base, SV **)
40PERLVAR(I, stack_max, SV **)
907b3e23 41
115ff745 42PERLVAR(I, savestack, ANY *) /* items that need to be restored when
907b3e23 43 LEAVEing scopes we've ENTERed */
115ff745
NC
44PERLVAR(I, savestack_ix, I32)
45PERLVAR(I, savestack_max, I32)
46
19bc2726
DM
47PERLVAR(I, scopestack, I32 *) /* scopes we've ENTERed */
48PERLVAR(I, scopestack_ix, I32)
49PERLVAR(I, scopestack_max, I32)
50
115ff745 51PERLVAR(I, tmps_stack, SV **) /* mortals we've made */
e8eb279c
FC
52PERLVARI(I, tmps_ix, SSize_t, -1)
53PERLVARI(I, tmps_floor, SSize_t, -1)
ba367634 54PERLVAR(I, tmps_max, SSize_t) /* first unalloced slot in tmps stack */
19bc2726 55
115ff745 56PERLVAR(I, markstack, I32 *) /* stack_sp locations we're
907b3e23 57 remembering */
115ff745
NC
58PERLVAR(I, markstack_ptr, I32 *)
59PERLVAR(I, markstack_max, I32 *)
907b3e23 60
63251dfc
RL
61PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */
62
6a5b4183
YO
63#ifdef PERL_HASH_RANDOMIZE_KEYS
64#ifdef USE_PERL_PERTURB_KEYS
65PERLVARI(I, hash_rand_bits_enabled, U8, 1) /* used to randomize hash stuff 0 == no-random, 1 == random, 2 == determinsitic */
66#endif
0e0ab621 67PERLVARI(I, hash_rand_bits, UV, 0) /* used to randomize hash stuff */
6a5b4183 68#endif
19bc2726 69PERLVAR(I, strtab, HV *) /* shared string table */
fedf30e1
DM
70/* prog counter for the currently executing OP_MULTIDEREF Used to signal
71 * to S_find_uninit_var() where we are */
72PERLVAR(I, multideref_pc, UNOP_AUX_item *)
19bc2726
DM
73
74/* Fields used by magic variables such as $@, $/ and so on */
75PERLVAR(I, curpm, PMOP *) /* what to do \ interps in REs from */
5585e758 76PERLVAR(I, curpm_under, PMOP *) /* what to do \ interps in REs from */
19bc2726 77
bc2f1ca1 78PERLVAR(I, tainting, bool) /* ? doing taint checks */
d48c660d 79PERLVARI(I, tainted, bool, FALSE) /* using variables controlled by $< */
a68090fe
DM
80
81/* PL_delaymagic is currently used for two purposes: to assure simultaneous
82 * updates in ($<,$>) = ..., and to assure atomic update in push/unshift
83 * @ISA, It works like this: a few places such as pp_push set the DM_DELAY
84 * flag; then various places such as av_store() skip mg_set(ary) if this
85 * flag is set, and various magic vtable methods set flags like
86 * DM_ARRAY_ISA if they've seen something of that ilk. Finally when
87 * control returns to pp_push or whatever, it sees if any of those flags
88 * have been set, and if so finally calls mg_set().
89 *
90 * NB: PL_delaymagic is automatically saved and restored by JUMPENV_PUSH
91 * / POP. This removes the need to do ENTER/SAVEI16(PL_delaymagic)/LEAVE
92 * in hot code like pp_push.
93 */
19bc2726 94PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
a68090fe 95
1172c104 96/*
b5282d7c 97=for apidoc mn|U8|PL_dowarn
19bc2726 98
b5282d7c
AC
99The C variable that roughly corresponds to Perl's C<$^W> warning variable.
100However, C<$^W> is treated as a boolean, whereas C<PL_dowarn> is a
101collection of flag bits.
19bc2726
DM
102
103=cut
104*/
105
106PERLVAR(I, dowarn, U8)
107
108#if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
109# define PERL___I -1
110#else
111# define PERL___I 1
112#endif
113PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
114#undef PERL___I
115
c07b34e4 116/*
63251dfc
RL
117=for apidoc Amn|GV *|PL_defgv
118
119The GV representing C<*_>. Useful for access to C<$_>.
120
121=cut
122*/
123
124PERLVAR(I, localizing, U8) /* are we processing a local() list? */
125PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
126PERLVAR(I, defgv, GV *) /* the *_ glob */
127
128/*
c07b34e4
TC
129=for apidoc Amn|HV*|PL_curstash
130
131The stash for the package code will be compiled into.
132
133=cut
134*/
19bc2726
DM
135
136/* Stashes */
137PERLVAR(I, defstash, HV *) /* main symbol table */
138PERLVAR(I, curstash, HV *) /* symbol table for current package */
139
20fbb8c2
TC
140/*
141=for apidoc Amn|COP*|PL_curcop
142
143The currently active COP (control op) roughly representing the current
144statement in the source.
145
146=cut
147*/
148
19bc2726
DM
149PERLVAR(I, curcop, COP *)
150PERLVAR(I, curstack, AV *) /* THE STACK */
151PERLVAR(I, curstackinfo, PERL_SI *) /* current stack + context */
152PERLVAR(I, mainstack, AV *) /* the stack when nothing funny is
153 happening */
154
155/* memory management */
156PERLVAR(I, sv_count, IV) /* how many SV* are currently allocated */
19bc2726
DM
157
158PERLVAR(I, sv_root, SV *) /* storage for SVs belonging to interp */
159PERLVAR(I, sv_arenaroot, SV *) /* list of areas for garbage collection */
160
f65e70f5
DM
161/* fake PMOP that PL_curpm points to while in (?{}) so $1 et al are visible */
162PERLVARI(I, reg_curpm, PMOP*, NULL)
163
19bc2726 164/* the currently active slab in a chain of slabs of regmatch states,
87c1d905
DM
165 * and the currently active state within that slab. This stack of states
166 * is shared amongst re-entrant calls to the regex engine */
19bc2726
DM
167
168PERLVARI(I, regmatch_slab, regmatch_slab *, NULL)
169PERLVAR(I, regmatch_state, regmatch_state *)
170
171PERLVAR(I, comppad, PAD *) /* storage for lexically scoped temporaries */
172
173/*
174=for apidoc Amn|SV|PL_sv_undef
175This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
176
177=for apidoc Amn|SV|PL_sv_no
fbe13c60 178This is the C<false> SV. See C<L</PL_sv_yes>>. Always refer to this as
19bc2726
DM
179C<&PL_sv_no>.
180
181=for apidoc Amn|SV|PL_sv_yes
fbe13c60 182This is the C<true> SV. See C<L</PL_sv_no>>. Always refer to this as
19bc2726
DM
183C<&PL_sv_yes>.
184
5a6c2837
DM
185=for apidoc Amn|SV|PL_sv_zero
186This readonly SV has a zero numeric value and a C<"0"> string value. It's
187similar to C<L</PL_sv_no>> except for its string value. Can be used as a
188cheap alternative to C<mXPUSHi(0)> for example. Always refer to this as
189C<&PL_sv_zero>. Introduced in 5.28.
190
19bc2726
DM
191=cut
192*/
193
7c123f9d
DM
194#ifdef MULTIPLICITY
195PERLVAR(I, sv_yes, SV)
19bc2726
DM
196PERLVAR(I, sv_undef, SV)
197PERLVAR(I, sv_no, SV)
5a6c2837 198PERLVAR(I, sv_zero, SV)
7c123f9d
DM
199#else
200/* store the immortals as an array to ensure they are contiguous in
201 * memory: makes SvIMMORTAL_INTERP(sv) possible */
202PERLVARA(I, sv_immortals, 4, SV)
203#endif
5a6c2837 204
12d375ea
FC
205PERLVAR(I, padname_undef, PADNAME)
206PERLVAR(I, padname_const, PADNAME)
115ff745 207PERLVAR(I, Sv, SV *) /* used to hold temporary values */
19bc2726
DM
208PERLVAR(I, parser, yy_parser *) /* current parser state */
209
210PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
211
907b3e23
DM
212
213/*
214=for apidoc Amn|STRLEN|PL_na
215
216A convenience variable which is typically used with C<SvPV> when one
217doesn't care about the length of the string. It is usually more efficient
218to either declare a local variable and use that instead or to use the
219C<SvPV_nolen> macro.
220
221=cut
222*/
223
115ff745 224PERLVAR(I, na, STRLEN) /* for use in SvPV when length is
907b3e23
DM
225 Not Applicable */
226
227/* stat stuff */
115ff745
NC
228PERLVAR(I, statcache, Stat_t) /* _ */
229PERLVAR(I, statgv, GV *)
230PERLVARI(I, statname, SV *, NULL)
907b3e23 231
907b3e23
DM
232/*
233=for apidoc mn|SV*|PL_rs
234
235The input record separator - C<$/> in Perl space.
236
237=for apidoc mn|GV*|PL_last_in_gv
238
154e47c8 239The GV which was last used for a filehandle input operation. (C<< <FH> >>)
907b3e23 240
e23d9e2f 241=for apidoc mn|GV*|PL_ofsgv
907b3e23 242
e23d9e2f 243The glob containing the output field separator - C<*,> in Perl space.
907b3e23
DM
244
245=cut
246*/
247
115ff745
NC
248PERLVAR(I, rs, SV *) /* input record separator $/ */
249PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */
250PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */
251PERLVAR(I, defoutgv, GV *) /* default FH for output */
252PERLVARI(I, chopset, const char *, " \n-") /* $: */
253PERLVAR(I, formtarget, SV *)
254PERLVAR(I, bodytarget, SV *)
255PERLVAR(I, toptarget, SV *)
907b3e23 256
115ff745
NC
257
258PERLVAR(I, restartop, OP *) /* propagating an error from croak? */
259PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */
907b3e23 260
115ff745
NC
261PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */
262PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */
263PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */
907b3e23
DM
264
265/* statics "owned" by various functions */
115ff745 266PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
907b3e23 267
115ff745 268PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */
907b3e23
DM
269
270/* sort stuff */
115ff745
NC
271PERLVAR(I, sortcop, OP *) /* user defined sort routine */
272PERLVAR(I, sortstash, HV *) /* which is in some package or other */
273PERLVAR(I, firstgv, GV *) /* $a */
274PERLVAR(I, secondgv, GV *) /* $b */
907b3e23
DM
275
276/* float buffer */
115ff745
NC
277PERLVAR(I, efloatbuf, char *)
278PERLVAR(I, efloatsize, STRLEN)
907b3e23 279
115ff745 280PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
907b3e23
DM
281 indentation level */
282
7b93aae2
TC
283/*
284=for apidoc Amn|U8|PL_exit_flags
285
286Contains flags controlling perl's behaviour on exit():
287
288=over
289
290=item * C<PERL_EXIT_DESTRUCT_END>
291
292If set, END blocks are executed when the interpreter is destroyed.
293This is normally set by perl itself after the interpreter is
294constructed.
295
296=item * C<PERL_EXIT_ABORT>
297
298Call C<abort()> on exit. This is used internally by perl itself to
299abort if exit is called while processing exit.
300
301=item * C<PERL_EXIT_WARN>
302
303Warn on exit.
304
305=item * C<PERL_EXIT_EXPECTED>
306
307Set by the L<perlfunc/exit> operator.
308
309=back
310
5af38e47
KW
311=for apidoc Amnh||PERL_EXIT_EXPECTED
312=for apidoc Amnh||PERL_EXIT_ABORT
313=for apidoc Amnh||PERL_EXIT_DESTRUCT_END
314=for apidoc Amnh||PERL_EXIT_WARN
315
7b93aae2
TC
316=cut
317*/
318
e914d9bb 319PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
157b3822 320
115ff745 321PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
31f05a37 322PERLVAR(I, in_utf8_CTYPE_locale, bool)
165a1c52 323PERLVAR(I, in_utf8_COLLATE_locale, bool)
b8df1494 324PERLVAR(I, in_utf8_turkic_locale, bool)
bffa51e2 325#if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
49d7d366 326PERLVARI(I, lc_numeric_mutex_depth, int, 0) /* Emulate general semaphore */
bffa51e2 327#endif
47280b20
KW
328PERLVARA(I, locale_utf8ness, 256, char)
329
5b7de470
KW
330#ifdef USE_LOCALE_CTYPE
331 PERLVAR(I, warn_locale, SV *)
332#endif
907b3e23 333
87c1d905 334PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
907b3e23 335
9ea12537
Z
336/*
337=for apidoc Amn|peep_t|PL_peepp
338
339Pointer to the per-subroutine peephole optimiser. This is a function
340that gets called at the end of compilation of a Perl subroutine (or
341equivalently independent piece of Perl code) to perform fixups of
342some ops and to perform small-scale optimisations. The function is
343called once for each subroutine that is compiled, and is passed, as sole
344parameter, a pointer to the op that is the entry point to the subroutine.
345It modifies the op tree in place.
346
347The peephole optimiser should never be completely replaced. Rather,
348add code to it by wrapping the existing optimiser. The basic way to do
349this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
350If the new code wishes to operate on ops throughout the subroutine's
351structure, rather than just at the top level, it is likely to be more
352convenient to wrap the L</PL_rpeepp> hook.
353
354=cut
355*/
356
115ff745 357PERLVARI(I, peepp, peep_t, Perl_peep)
9ea12537
Z
358
359/*
360=for apidoc Amn|peep_t|PL_rpeepp
361
362Pointer to the recursive peephole optimiser. This is a function
363that gets called at the end of compilation of a Perl subroutine (or
364equivalently independent piece of Perl code) to perform fixups of some
365ops and to perform small-scale optimisations. The function is called
366once for each chain of ops linked through their C<op_next> fields;
367it is recursively called to handle each side chain. It is passed, as
368sole parameter, a pointer to the op that is at the head of the chain.
369It modifies the op tree in place.
370
371The peephole optimiser should never be completely replaced. Rather,
372add code to it by wrapping the existing optimiser. The basic way to do
373this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
374If the new code wishes to operate only on ops at a subroutine's top level,
375rather than throughout the structure, it is likely to be more convenient
376to wrap the L</PL_peepp> hook.
377
378=cut
379*/
380
115ff745 381PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
907b3e23 382
2f175318
VP
383/*
384=for apidoc Amn|Perl_ophook_t|PL_opfreehook
385
386When 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.
387This allows extensions to free any extra attribute they have locally attached to an OP.
388It is also assured to first fire for the parent OP and then for its kids.
389
390When 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.
391
392=cut
393*/
394
115ff745 395PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 396
115ff745
NC
397PERLVARI(I, watchaddr, char **, 0)
398PERLVAR(I, watchok, char *)
907b3e23 399
115ff745 400PERLVAR(I, perldb, U32)
d95e864f 401
115ff745 402PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
30b0736d 403
79968a97
NC
404PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
405
49f531da 406/* pseudo environmental stuff */
115ff745
NC
407PERLVAR(I, origargc, int)
408PERLVAR(I, origargv, char **)
409PERLVAR(I, envgv, GV *)
410PERLVAR(I, incgv, GV *)
411PERLVAR(I, hintgv, GV *)
412PERLVAR(I, origfilename, char *)
9a189793 413PERLVARI(I, xsubfilename, const char *, NULL)
115ff745
NC
414PERLVAR(I, diehook, SV *)
415PERLVAR(I, warnhook, SV *)
1d7c1841
GS
416
417/* switches */
115ff745 418PERLVAR(I, patchlevel, SV *)
115ff745
NC
419PERLVAR(I, localpatches, const char * const *)
420PERLVARI(I, splitstr, const char *, " ")
421
422PERLVAR(I, minus_c, bool)
423PERLVAR(I, minus_n, bool)
424PERLVAR(I, minus_p, bool)
425PERLVAR(I, minus_l, bool)
426PERLVAR(I, minus_a, bool)
427PERLVAR(I, minus_F, bool)
428PERLVAR(I, doswitches, bool)
429PERLVAR(I, minus_E, bool)
954c1994 430
115ff745
NC
431PERLVAR(I, inplace, char *)
432PERLVAR(I, e_script, SV *)
49f531da 433
115ff745 434PERLVAR(I, basetime, Time_t) /* $^T */
d4cce5f1 435
115ff745 436PERLVARI(I, maxsysfd, I32, MAXSYSFD)
cb68f92d 437 /* top fd to pass to subprocesses */
115ff745 438PERLVAR(I, statusvalue, I32) /* $? */
49f531da 439#ifdef VMS
115ff745 440PERLVAR(I, statusvalue_vms, U32)
e5218da5 441#else
115ff745 442PERLVAR(I, statusvalue_posix, I32)
49f531da
NIS
443#endif
444
115ff745
NC
445PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
446PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
157b3822 447
49f531da 448/* shortcuts to various I/O objects */
115ff745
NC
449PERLVAR(I, stdingv, GV *) /* *STDIN */
450PERLVAR(I, stderrgv, GV *) /* *STDERR */
115ff745
NC
451PERLVAR(I, argvgv, GV *) /* *ARGV */
452PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
453PERLVAR(I, argvout_stack, AV *)
49f531da
NIS
454
455/* shortcuts to regexp stuff */
115ff745 456PERLVAR(I, replgv, GV *) /* *^R */
49f531da
NIS
457
458/* shortcuts to misc objects */
115ff745 459PERLVAR(I, errgv, GV *) /* *@ */
49f531da
NIS
460
461/* shortcuts to debugging objects */
115ff745
NC
462PERLVAR(I, DBgv, GV *) /* *DB::DB */
463PERLVAR(I, DBline, GV *) /* *DB::line */
954c1994
GS
464
465/*
2eb25c99 466=for apidoc mn|GV *|PL_DBsub
954c1994
GS
467When Perl is run in debugging mode, with the B<-d> switch, this GV contains
468the SV which holds the name of the sub being debugged. This is the C
469variable which corresponds to Perl's $DB::sub variable. See
fbe13c60 470C<L</PL_DBsingle>>.
954c1994 471
2eb25c99 472=for apidoc mn|SV *|PL_DBsingle
954c1994 473When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 474boolean which indicates whether subs are being single-stepped.
954c1994
GS
475Single-stepping is automatically turned on after every step. This is the C
476variable which corresponds to Perl's $DB::single variable. See
fbe13c60 477C<L</PL_DBsub>>.
954c1994 478
2eb25c99 479=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
480Trace variable used when Perl is run in debugging mode, with the B<-d>
481switch. This is the C variable which corresponds to Perl's $DB::trace
fbe13c60 482variable. See C<L</PL_DBsingle>>.
954c1994
GS
483
484=cut
485*/
486
115ff745
NC
487PERLVAR(I, DBsub, GV *) /* *DB::sub */
488PERLVAR(I, DBsingle, SV *) /* $DB::single */
489PERLVAR(I, DBtrace, SV *) /* $DB::trace */
490PERLVAR(I, DBsignal, SV *) /* $DB::signal */
491PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
49f531da 492
a6d69523
TC
493PERLVARA(I, DBcontrol, DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
494
49f531da 495/* symbol tables */
115ff745
NC
496PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
497PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
498PERLVAR(I, curstname, SV *) /* name of current package */
499PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
500PERLVAR(I, endav, AV *) /* names of END subroutines */
501PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
502PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
503PERLVAR(I, initav, AV *) /* names of INIT subroutines */
49f531da 504
49f531da 505/* subprocess state */
115ff745 506PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
507
508/* internal state */
115ff745 509PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
49f531da 510
49f531da 511/* current interpreter roots */
115ff745
NC
512PERLVAR(I, main_cv, CV *)
513PERLVAR(I, main_root, OP *)
514PERLVAR(I, main_start, OP *)
515PERLVAR(I, eval_root, OP *)
516PERLVAR(I, eval_start, OP *)
49f531da
NIS
517
518/* runtime control stuff */
115ff745 519PERLVARI(I, curcopdb, COP *, NULL)
49f531da 520
115ff745
NC
521PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
522PERLVAR(I, lastfd, int) /* what to preserve mode on */
523PERLVAR(I, oldname, char *) /* what to preserve mode on */
00accf8d
NC
524/* Elements in this array have ';' appended and are injected as a single line
525 into the tokeniser. You can't put any (literal) newlines into any program
526 you stuff in into this array, as the point where it's injected is expecting
527 a single physical line. */
115ff745
NC
528PERLVAR(I, preambleav, AV *)
529PERLVAR(I, mess_sv, SV *)
530PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
19bc2726 531
79968a97
NC
532/* funky return mechanisms */
533PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
534
71eebe1e 535/* statics moved here for shared library purposes */
115ff745
NC
536PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
537PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
538PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
539PERLVARI(I, laststype, U16, OP_STAT)
19bc2726 540
115ff745 541PERLVARI(I, laststatval, int, -1)
d4cce5f1 542
19bc2726
DM
543PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in
544 assignment? */
545
4b556e6c 546/* interpreter atexit processing */
115ff745
NC
547PERLVARI(I, exitlistlen, I32, 0) /* length of same */
548PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
cb68f92d 549 /* list of exit functions */
954c1994
GS
550
551/*
552=for apidoc Amn|HV*|PL_modglobal
553
7889fe52 554C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 555extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
556In a pinch, it can also be used as a symbol table for extensions
557to share data among each other. It is a good idea to use keys
954c1994
GS
558prefixed by the package name of the extension that owns the data.
559
560=cut
561*/
562
115ff745 563PERLVAR(I, modglobal, HV *) /* per-interp module data */
cb68f92d
GS
564
565/* these used to be in global before 5.004_68 */
115ff745 566PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d 567
115ff745 568PERLVAR(I, compiling, COP) /* compiling/done executing marker */
cb68f92d 569
115ff745 570PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
36c300bb 571PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
d12be05d
DM
572PERLVAR(I, comppad_name_fill, PADOFFSET)/* last "introduced" variable offset */
573PERLVAR(I, comppad_name_floor, PADOFFSET)/* start of vars in innermost block */
4b556e6c
JD
574
575#ifdef HAVE_INTERP_INTERN
115ff745 576PERLVAR(I, sys_intern, struct interp_intern)
cb68f92d 577 /* platform internals */
4b556e6c
JD
578#endif
579
7fae4e64 580/* more statics moved here */
115ff745 581PERLVAR(I, DBcv, CV *) /* from perl.c */
75010704
DM
582PERLVARI(I, generation, int, 100) /* scan sequence# for OP_AASSIGN
583 compile-time common elem detection */
56953603 584
19bc2726
DM
585PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
586
115ff745
NC
587PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
588PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
589PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
590PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 591
19bc2726 592
985213f2
AB
593PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */
594PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */
595PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */
596PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */
115ff745 597PERLVARI(I, an, U32, 0) /* malloc sequence number */
be2b6a89 598
79968a97
NC
599/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
600PERLVARI(I, breakable_sub_gen, U32, 0)
601
be2b6a89
DM
602#ifdef DEBUGGING
603 /* exercise wrap-around */
604 #define PERL_COP_SEQMAX (U32_MAX-50)
605#else
606 #define PERL_COP_SEQMAX 0
607#endif
115ff745 608PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
be2b6a89
DM
609#undef PERL_COP_SEQMAX
610
115ff745
NC
611PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
612PERLVAR(I, origalen, U32)
613PERLVAR(I, origenviron, char **)
ca0c25f6 614#ifdef PERL_USES_PL_PIDSTATUS
115ff745 615PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 616#endif
115ff745 617PERLVAR(I, osname, char *) /* operating system */
5c728af0 618
dc37125b
DM
619PERLVAR(I, sighandlerp, Sighandler_t)
620/* these two are provided only to solve library linkage issues; they
621 * should not be hooked by user code */
622PERLVAR(I, sighandler1p, Sighandler1_t)
623PERLVAR(I, sighandler3p, Sighandler3_t)
0672f40e 624
115ff745 625PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 626
8162b70e 627PERLVAR(I, debug, volatile U32) /* flags given to -D switch */
79968a97 628
e897f2d7 629PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
9f7da6d5 630
a902610b
TC
631/*
632=for apidoc Amn|runops_proc_t|PL_runops
633
634See L<perlguts/Pluggable runops>.
635
636=cut
637*/
638
115ff745 639PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
0672f40e 640
115ff745 641PERLVAR(I, subname, SV *) /* name of current subroutine */
0672f40e 642
115ff745 643PERLVAR(I, subline, I32) /* line this subroutine began on */
d12be05d 644PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
d95e864f 645
d12be05d
DM
646PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
647PERLVAR(I, padix, PADOFFSET) /* lowest unused index - 1
8ce2f624 648 in current "register" pad */
d12be05d 649PERLVAR(I, constpadix, PADOFFSET) /* lowest unused for constants */
d95e864f 650
d12be05d 651PERLVAR(I, padix_floor, PADOFFSET) /* how low may inner block reset padix */
0672f40e 652
e9bc6d6b
KW
653#if defined(USE_POSIX_2008_LOCALE) \
654 && defined(USE_THREAD_SAFE_LOCALE) \
655 && ! defined(HAS_QUERYLOCALE)
656
657PERLVARA(I, curlocales, 12, char *)
658
659#endif
0672f40e 660#ifdef USE_LOCALE_COLLATE
e9bc6d6b 661
115ff745
NC
662PERLVAR(I, collation_name, char *) /* Name of current collation */
663PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm() */
664PERLVARI(I, collxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
665PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */
f28f4d2a 666PERLVARI(I, strxfrm_NUL_replacement, U8, 0) /* Code point to replace NULs */
c664130f
KW
667PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
668 /* Assume until proven otherwise that it works */
a4a439fb 669PERLVARI(I, strxfrm_max_cp, U8, 0) /* Highest collating cp in locale */
115ff745 670PERLVARI(I, collation_standard, bool, TRUE)
9f7da6d5 671 /* Assume simple collation */
0672f40e
GS
672#endif /* USE_LOCALE_COLLATE */
673
f7416781
KW
674PERLVARI(I, langinfo_buf, char *, NULL)
675PERLVARI(I, langinfo_bufsize, Size_t, 0)
9aac5db8
KW
676PERLVARI(I, setlocale_buf, char *, NULL)
677PERLVARI(I, setlocale_bufsize, Size_t, 0)
f7416781 678
19bc2726
DM
679#ifdef PERL_SAWAMPERSAND
680PERLVAR(I, sawampersand, U8) /* must save all match strings */
9f7da6d5 681#endif
95ca8690 682
79968a97
NC
683/* current phase the interpreter is in
684 for ordering this structure to remove holes, we're assuming that this is 4
685 bytes. */
686PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
687
688PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
689
63251dfc
RL
690PERLVAR(I, unsafe, bool)
691PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
692
daf9aebe
TC
693/*
694=for apidoc Amn|signed char|PL_perl_destruct_level
695
696This value may be set when embedding for full cleanup.
697
698Possible values:
699
700=over
701
702=item * 0 - none
703
704=item * 1 - full
705
706=item * 2 or greater - full with checks.
707
708=back
709
710If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the
711value of C<PL_perl_destruct_level> its value is used instead.
712
713=cut
714*/
79968a97
NC
715/* mod_perl is special, and also assigns a meaning -1 */
716PERLVARI(I, perl_destruct_level, signed char, 0)
9f7da6d5 717
63251dfc
RL
718PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
719
720PERLVAR(I, srand_called, bool)
721
0672f40e
GS
722#ifdef USE_LOCALE_NUMERIC
723
892e6465
KW
724PERLVARI(I, numeric_underlying, bool, TRUE)
725 /* Assume underlying locale numerics */
4c68b815 726PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
63251dfc
RL
727
728PERLVARI(I, numeric_standard, int, TRUE)
729 /* Assume C locale numerics */
115ff745
NC
730PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
731PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */
f8115845 732
7e5377f7 733# ifdef HAS_POSIX_2008_LOCALE
e1aa2579
KW
734
735PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
736
737# endif
0672f40e
GS
738#endif /* !USE_LOCALE_NUMERIC */
739
c4a30c8c
NC
740/* Array of signal handlers, indexed by signal number, through which the C
741 signal handler dispatches. */
115ff745 742PERLVAR(I, psig_ptr, SV **)
c4a30c8c 743/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
744 argument to a signal handler. Only one block of memory is allocated for
745 both psig_name and psig_ptr. */
115ff745 746PERLVAR(I, psig_name, SV **)
1d7c1841 747
c5be433b 748#if defined(PERL_IMPLICIT_SYS)
115ff745
NC
749PERLVAR(I, Mem, struct IPerlMem *)
750PERLVAR(I, MemShared, struct IPerlMem *)
751PERLVAR(I, MemParse, struct IPerlMem *)
752PERLVAR(I, Env, struct IPerlEnv *)
753PERLVAR(I, StdIO, struct IPerlStdIO *)
754PERLVAR(I, LIO, struct IPerlLIO *)
755PERLVAR(I, Dir, struct IPerlDir *)
756PERLVAR(I, Sock, struct IPerlSock *)
757PERLVAR(I, Proc, struct IPerlProc *)
76e3520e 758#endif
1d7c1841 759
115ff745
NC
760PERLVAR(I, ptr_table, PTR_TBL_t *)
761PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
f180df80 762
115ff745 763PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
93e68bfb 764
d95e864f 765
1fcf4c12 766#if defined(USE_ITHREADS)
115ff745 767PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
e6853197 768 regex_padav */
115ff745 769PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
e6853197 770 values in op_pmoffset of pmop.
402d2eb1
NC
771 Entry 0 is an SV whose PV is a
772 "packed" list of IVs listing
e6853197 773 the now-free slots in the array */
d4d03940
FC
774PERLVAR(I, stashpad, HV **) /* for CopSTASH */
775PERLVARI(I, stashpadmax, PADOFFSET, 64)
776PERLVARI(I, stashpadix, PADOFFSET, 0)
1fcf4c12
AB
777#endif
778
ea68fd67 779#ifdef USE_REENTRANT_API
115ff745 780PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
f5a82810
JH
781#endif
782
115ff745
NC
783PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
784PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
19e8ce8e 785
a1ea730d 786#ifdef PERLIO_LAYERS
115ff745
NC
787PERLVARI(I, perlio, PerlIOl *, NULL)
788PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
789PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
a1ea730d
NIS
790#endif
791
115ff745
NC
792PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
793PERLVARI(I, unitcheckav_save, AV *, NULL)
794 /* save UNITCHECK{}s when compiling */
ece599bd 795
115ff745 796PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
5311654c 797
15a5279a 798/* Hooks to shared SVs and locks. */
115ff745
NC
799PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
800PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
238965b4
KW
801
802GCC_DIAG_IGNORE(-Wdeprecated-declarations)
d0647d4e
NC
803#ifdef NO_MATHOMS
804# define PERL_UNLOCK_HOOK Perl_sv_nosharing
805#else
806/* This reference ensures that the mathoms are linked with perl */
807# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
808#endif
115ff745 809PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 810
238965b4
KW
811GCC_DIAG_RESTORE
812
115ff745 813PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 814
9e08d3a4 815/* Can shared object be destroyed */
115ff745 816PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
9e08d3a4 817
01d65469 818#ifndef PERL_MICRO
115ff745 819PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 820#endif
92f022bb 821
115ff745 822PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
f16dd614 823
9e08d3a4
NC
824/* Register of known Method Resolution Orders.
825 What this actually points to is an implementation detail (it may change to
826 a structure incorporating a reference count - use mro_get_from_name to
827 retrieve a C<struct mro_alg *> */
115ff745 828PERLVAR(I, registered_mros, HV *)
9e08d3a4
NC
829
830/* Compile-time block start/end hooks */
115ff745 831PERLVAR(I, blockhooks, AV *)
9e08d3a4 832
115ff745 833PERLVAR(I, custom_ops, HV *) /* custom op registrations */
9e08d3a4 834
19bc2726
DM
835PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
836
837/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
838 present always, as -DDEBUGGING must be binary compatible with non. */
839PERLVARI(I, scopestack_name, const char * *, NULL)
840
841PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
842
d67594ff
FC
843/* Hook for File::Glob */
844PERLVARI(I, globhook, globhook_t, NULL)
845
436227c7 846/* The last unconditional member of the interpreter structure when 5.18.0 was
ffee3ff6
NC
847 released. The offset of the end of this is baked into a global variable in
848 any shared perl library which will allow a sanity test in future perl
849 releases. */
d399cf59 850#define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
ffee3ff6 851
f16dd614 852#ifdef PERL_IMPLICIT_CONTEXT
115ff745 853PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
817b0f24 854PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614
DM
855#endif
856
0419d978 857#if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
5ca5a628 858/* For use with the memory debugging code in util.c. This is used only in
0419d978
AC
859 * DEBUGGING builds (as long as the relevant structure is defined), but
860 * defining it in non-debug builds too means that we retain binary
861 * compatibility between otherwise-compatible plain and debug builds. */
115ff745 862PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
0419d978 863#endif
7cb608b5 864
ba6d381e
NC
865#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
866/* File descriptor to talk to the child which dumps scalars. */
115ff745 867PERLVARI(I, dumper_fd, int, -1)
ba6d381e
NC
868#endif
869
ba6d381e 870
d7a2c63c 871#ifdef DEBUG_LEAKING_SCALARS
115ff745 872PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
d7a2c63c
MHM
873#endif
874
a38ab475
RZ
875PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
876
75d476e2
SM
877#ifdef PERL_TRACE_OPS
878PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
879 If PERL_TRACE_OPS is enabled, we'll dump
880 a summary count of all ops executed in the
881 program at perl_destruct time. For
882 profiling/debugging only. Works only if
883 DEBUGGING is enabled, too. */
884#endif
885
3be8f094
TC
886PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
887
eecd4d11 888PERLVARI(I, dump_re_max_len, STRLEN, 60)
2bfbbbaf 889
f26b33bd
TC
890/* For internal uses of randomness, this ensures the sequence of
891 * random numbers returned by rand() isn't modified by perl's internal
892 * use of randomness.
893 * This is important if the user has called srand() with a seed.
894 */
895
896PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
897
8c90d3a9
KW
898PERLVARA(I, TR_SPECIAL_HANDLING_UTF8, UTF8_MAXBYTES, char)
899
a8def808
KW
900PERLVAR(I, AboveLatin1, SV *)
901PERLVAR(I, Assigned_invlist, SV *)
902PERLVAR(I, GCB_invlist, SV *)
903PERLVAR(I, HasMultiCharFold, SV *)
904PERLVAR(I, InMultiCharFold, SV *)
905PERLVAR(I, Latin1, SV *)
906PERLVAR(I, LB_invlist, SV *)
907PERLVAR(I, SB_invlist, SV *)
908PERLVAR(I, SCX_invlist, SV *)
909PERLVAR(I, UpperLatin1, SV *) /* Code points 128 - 255 */
910
911/* List of characters that participate in any fold defined by Unicode */
912PERLVAR(I, in_some_fold, SV *)
913
668d1998
KW
914/* Everything that folds to a given character, for case insensitivity regex
915 * matching */
916PERLVAR(I, utf8_foldclosures, SV *)
917
a8def808
KW
918PERLVAR(I, utf8_idcont, SV *)
919PERLVAR(I, utf8_idstart, SV *)
920PERLVAR(I, utf8_perl_idcont, SV *)
921PERLVAR(I, utf8_perl_idstart, SV *)
922PERLVAR(I, utf8_xidcont, SV *)
923PERLVAR(I, utf8_xidstart, SV *)
924PERLVAR(I, WB_invlist, SV *)
925PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
926PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
927PERLVAR(I, utf8_toupper, SV *)
928PERLVAR(I, utf8_totitle, SV *)
929PERLVAR(I, utf8_tolower, SV *)
930PERLVAR(I, utf8_tofold, SV *)
931PERLVAR(I, utf8_tosimplefold, SV *)
932PERLVAR(I, utf8_charname_begin, SV *)
933PERLVAR(I, utf8_charname_continue, SV *)
934PERLVAR(I, utf8_mark, SV *)
935PERLVARI(I, InBitmap, SV *, NULL)
936PERLVAR(I, CCC_non0_non230, SV *)
937PERLVAR(I, Private_Use, SV *)
938
d2c9cb53
KW
939#ifdef HAS_MBRLEN
940PERLVAR(I, mbrlen_ps, mbstate_t)
941#endif
5a6637f0
KW
942#ifdef HAS_MBRTOWC
943PERLVAR(I, mbrtowc_ps, mbstate_t)
944#endif
945#ifdef HAS_WCRTOMB
946PERLVAR(I, wcrtomb_ps, mbstate_t)
947#endif
d2c9cb53 948
157b3822
NC
949/* If you are adding a U8 or U16, check to see if there are 'Space' comments
950 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
951
952/* Within a stable branch, new variables must be added to the very end, before
953 * this comment, for binary compatibility (the offsets of the old members must
954 * not change).
b83cd129 955 * (Don't forget to add your variable also to perl_clone()!)
b83cd129 956 */