This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PATCH: GH #17367 read 1 beyond end of buffer
[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
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
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
DM
55
56PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */
907b3e23 57
115ff745 58PERLVAR(I, markstack, I32 *) /* stack_sp locations we're
907b3e23 59 remembering */
115ff745
NC
60PERLVAR(I, markstack_ptr, I32 *)
61PERLVAR(I, markstack_max, I32 *)
907b3e23 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
TC
96/*
97=for apidoc Amn|GV *|PL_defgv
98
99The GV representing C<*_>. Useful for access to C<$_>.
100
101=cut
102*/
103
19bc2726
DM
104PERLVAR(I, localizing, U8) /* are we processing a local() list? */
105PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
3f44dc81 106PERLVAR(I, defgv, GV *) /* the *_ glob */
19bc2726
DM
107/*
108
b5282d7c 109=for apidoc mn|U8|PL_dowarn
19bc2726 110
b5282d7c
AC
111The C variable that roughly corresponds to Perl's C<$^W> warning variable.
112However, C<$^W> is treated as a boolean, whereas C<PL_dowarn> is a
113collection of flag bits.
19bc2726
DM
114
115=cut
116*/
117
118PERLVAR(I, dowarn, U8)
119
120#if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
121# define PERL___I -1
122#else
123# define PERL___I 1
124#endif
125PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
126#undef PERL___I
127
c07b34e4
TC
128/*
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
311=cut
312*/
313
e914d9bb 314PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
157b3822 315
115ff745 316PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
31f05a37 317PERLVAR(I, in_utf8_CTYPE_locale, bool)
165a1c52 318PERLVAR(I, in_utf8_COLLATE_locale, bool)
b8df1494 319PERLVAR(I, in_utf8_turkic_locale, bool)
bffa51e2 320#if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
49d7d366 321PERLVARI(I, lc_numeric_mutex_depth, int, 0) /* Emulate general semaphore */
bffa51e2 322#endif
47280b20
KW
323PERLVARA(I, locale_utf8ness, 256, char)
324
5b7de470
KW
325#ifdef USE_LOCALE_CTYPE
326 PERLVAR(I, warn_locale, SV *)
327#endif
907b3e23 328
87c1d905 329PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
907b3e23 330
9ea12537
Z
331/*
332=for apidoc Amn|peep_t|PL_peepp
333
334Pointer to the per-subroutine peephole optimiser. This is a function
335that gets called at the end of compilation of a Perl subroutine (or
336equivalently independent piece of Perl code) to perform fixups of
337some ops and to perform small-scale optimisations. The function is
338called once for each subroutine that is compiled, and is passed, as sole
339parameter, a pointer to the op that is the entry point to the subroutine.
340It modifies the op tree in place.
341
342The peephole optimiser should never be completely replaced. Rather,
343add code to it by wrapping the existing optimiser. The basic way to do
344this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
345If the new code wishes to operate on ops throughout the subroutine's
346structure, rather than just at the top level, it is likely to be more
347convenient to wrap the L</PL_rpeepp> hook.
348
349=cut
350*/
351
115ff745 352PERLVARI(I, peepp, peep_t, Perl_peep)
9ea12537
Z
353
354/*
355=for apidoc Amn|peep_t|PL_rpeepp
356
357Pointer to the recursive peephole optimiser. This is a function
358that gets called at the end of compilation of a Perl subroutine (or
359equivalently independent piece of Perl code) to perform fixups of some
360ops and to perform small-scale optimisations. The function is called
361once for each chain of ops linked through their C<op_next> fields;
362it is recursively called to handle each side chain. It is passed, as
363sole parameter, a pointer to the op that is at the head of the chain.
364It modifies the op tree in place.
365
366The peephole optimiser should never be completely replaced. Rather,
367add code to it by wrapping the existing optimiser. The basic way to do
368this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
369If the new code wishes to operate only on ops at a subroutine's top level,
370rather than throughout the structure, it is likely to be more convenient
371to wrap the L</PL_peepp> hook.
372
373=cut
374*/
375
115ff745 376PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
907b3e23 377
2f175318
VP
378/*
379=for apidoc Amn|Perl_ophook_t|PL_opfreehook
380
381When 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.
382This allows extensions to free any extra attribute they have locally attached to an OP.
383It is also assured to first fire for the parent OP and then for its kids.
384
385When 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.
386
387=cut
388*/
389
115ff745 390PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 391
115ff745
NC
392PERLVARI(I, watchaddr, char **, 0)
393PERLVAR(I, watchok, char *)
907b3e23 394
115ff745 395PERLVAR(I, perldb, U32)
d95e864f 396
115ff745 397PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
30b0736d 398
79968a97
NC
399PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
400
49f531da 401/* pseudo environmental stuff */
115ff745
NC
402PERLVAR(I, origargc, int)
403PERLVAR(I, origargv, char **)
404PERLVAR(I, envgv, GV *)
405PERLVAR(I, incgv, GV *)
406PERLVAR(I, hintgv, GV *)
407PERLVAR(I, origfilename, char *)
9a189793 408PERLVARI(I, xsubfilename, const char *, NULL)
115ff745
NC
409PERLVAR(I, diehook, SV *)
410PERLVAR(I, warnhook, SV *)
1d7c1841
GS
411
412/* switches */
115ff745 413PERLVAR(I, patchlevel, SV *)
115ff745
NC
414PERLVAR(I, localpatches, const char * const *)
415PERLVARI(I, splitstr, const char *, " ")
416
417PERLVAR(I, minus_c, bool)
418PERLVAR(I, minus_n, bool)
419PERLVAR(I, minus_p, bool)
420PERLVAR(I, minus_l, bool)
421PERLVAR(I, minus_a, bool)
422PERLVAR(I, minus_F, bool)
423PERLVAR(I, doswitches, bool)
424PERLVAR(I, minus_E, bool)
954c1994 425
115ff745
NC
426PERLVAR(I, inplace, char *)
427PERLVAR(I, e_script, SV *)
49f531da 428
115ff745 429PERLVAR(I, basetime, Time_t) /* $^T */
d4cce5f1 430
115ff745 431PERLVARI(I, maxsysfd, I32, MAXSYSFD)
cb68f92d 432 /* top fd to pass to subprocesses */
115ff745 433PERLVAR(I, statusvalue, I32) /* $? */
49f531da 434#ifdef VMS
115ff745 435PERLVAR(I, statusvalue_vms, U32)
e5218da5 436#else
115ff745 437PERLVAR(I, statusvalue_posix, I32)
49f531da
NIS
438#endif
439
115ff745
NC
440PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
441PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
157b3822 442
49f531da 443/* shortcuts to various I/O objects */
115ff745
NC
444PERLVAR(I, stdingv, GV *) /* *STDIN */
445PERLVAR(I, stderrgv, GV *) /* *STDERR */
115ff745
NC
446PERLVAR(I, argvgv, GV *) /* *ARGV */
447PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
448PERLVAR(I, argvout_stack, AV *)
49f531da
NIS
449
450/* shortcuts to regexp stuff */
115ff745 451PERLVAR(I, replgv, GV *) /* *^R */
49f531da
NIS
452
453/* shortcuts to misc objects */
115ff745 454PERLVAR(I, errgv, GV *) /* *@ */
49f531da
NIS
455
456/* shortcuts to debugging objects */
115ff745
NC
457PERLVAR(I, DBgv, GV *) /* *DB::DB */
458PERLVAR(I, DBline, GV *) /* *DB::line */
954c1994
GS
459
460/*
2eb25c99 461=for apidoc mn|GV *|PL_DBsub
954c1994
GS
462When Perl is run in debugging mode, with the B<-d> switch, this GV contains
463the SV which holds the name of the sub being debugged. This is the C
464variable which corresponds to Perl's $DB::sub variable. See
fbe13c60 465C<L</PL_DBsingle>>.
954c1994 466
2eb25c99 467=for apidoc mn|SV *|PL_DBsingle
954c1994 468When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 469boolean which indicates whether subs are being single-stepped.
954c1994
GS
470Single-stepping is automatically turned on after every step. This is the C
471variable which corresponds to Perl's $DB::single variable. See
fbe13c60 472C<L</PL_DBsub>>.
954c1994 473
2eb25c99 474=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
475Trace variable used when Perl is run in debugging mode, with the B<-d>
476switch. This is the C variable which corresponds to Perl's $DB::trace
fbe13c60 477variable. See C<L</PL_DBsingle>>.
954c1994
GS
478
479=cut
480*/
481
115ff745
NC
482PERLVAR(I, DBsub, GV *) /* *DB::sub */
483PERLVAR(I, DBsingle, SV *) /* $DB::single */
484PERLVAR(I, DBtrace, SV *) /* $DB::trace */
485PERLVAR(I, DBsignal, SV *) /* $DB::signal */
486PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
49f531da 487
a6d69523
TC
488PERLVARA(I, DBcontrol, DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
489
49f531da 490/* symbol tables */
115ff745
NC
491PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
492PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
493PERLVAR(I, curstname, SV *) /* name of current package */
494PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
495PERLVAR(I, endav, AV *) /* names of END subroutines */
496PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
497PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
498PERLVAR(I, initav, AV *) /* names of INIT subroutines */
49f531da 499
49f531da 500/* subprocess state */
115ff745 501PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
502
503/* internal state */
115ff745 504PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
49f531da 505
49f531da 506/* current interpreter roots */
115ff745
NC
507PERLVAR(I, main_cv, CV *)
508PERLVAR(I, main_root, OP *)
509PERLVAR(I, main_start, OP *)
510PERLVAR(I, eval_root, OP *)
511PERLVAR(I, eval_start, OP *)
49f531da
NIS
512
513/* runtime control stuff */
115ff745 514PERLVARI(I, curcopdb, COP *, NULL)
49f531da 515
115ff745
NC
516PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
517PERLVAR(I, lastfd, int) /* what to preserve mode on */
518PERLVAR(I, oldname, char *) /* what to preserve mode on */
00accf8d
NC
519/* Elements in this array have ';' appended and are injected as a single line
520 into the tokeniser. You can't put any (literal) newlines into any program
521 you stuff in into this array, as the point where it's injected is expecting
522 a single physical line. */
115ff745
NC
523PERLVAR(I, preambleav, AV *)
524PERLVAR(I, mess_sv, SV *)
525PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
19bc2726 526
79968a97
NC
527/* funky return mechanisms */
528PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
529
71eebe1e 530/* statics moved here for shared library purposes */
115ff745
NC
531PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
532PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
533PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
534PERLVARI(I, laststype, U16, OP_STAT)
19bc2726 535
115ff745 536PERLVARI(I, laststatval, int, -1)
d4cce5f1 537
19bc2726
DM
538PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in
539 assignment? */
540
4b556e6c 541/* interpreter atexit processing */
115ff745
NC
542PERLVARI(I, exitlistlen, I32, 0) /* length of same */
543PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
cb68f92d 544 /* list of exit functions */
954c1994
GS
545
546/*
547=for apidoc Amn|HV*|PL_modglobal
548
7889fe52 549C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 550extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
551In a pinch, it can also be used as a symbol table for extensions
552to share data among each other. It is a good idea to use keys
954c1994
GS
553prefixed by the package name of the extension that owns the data.
554
555=cut
556*/
557
115ff745 558PERLVAR(I, modglobal, HV *) /* per-interp module data */
cb68f92d
GS
559
560/* these used to be in global before 5.004_68 */
115ff745 561PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d 562
115ff745 563PERLVAR(I, compiling, COP) /* compiling/done executing marker */
cb68f92d 564
115ff745 565PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
36c300bb 566PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
d12be05d
DM
567PERLVAR(I, comppad_name_fill, PADOFFSET)/* last "introduced" variable offset */
568PERLVAR(I, comppad_name_floor, PADOFFSET)/* start of vars in innermost block */
4b556e6c
JD
569
570#ifdef HAVE_INTERP_INTERN
115ff745 571PERLVAR(I, sys_intern, struct interp_intern)
cb68f92d 572 /* platform internals */
4b556e6c
JD
573#endif
574
7fae4e64 575/* more statics moved here */
115ff745 576PERLVAR(I, DBcv, CV *) /* from perl.c */
75010704
DM
577PERLVARI(I, generation, int, 100) /* scan sequence# for OP_AASSIGN
578 compile-time common elem detection */
56953603 579
19bc2726
DM
580PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
581
115ff745
NC
582PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
583PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
584PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
585PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 586
19bc2726 587
985213f2
AB
588PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */
589PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */
590PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */
591PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */
115ff745 592PERLVARI(I, an, U32, 0) /* malloc sequence number */
be2b6a89 593
79968a97
NC
594/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
595PERLVARI(I, breakable_sub_gen, U32, 0)
596
be2b6a89
DM
597#ifdef DEBUGGING
598 /* exercise wrap-around */
599 #define PERL_COP_SEQMAX (U32_MAX-50)
600#else
601 #define PERL_COP_SEQMAX 0
602#endif
115ff745 603PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
be2b6a89
DM
604#undef PERL_COP_SEQMAX
605
115ff745
NC
606PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
607PERLVAR(I, origalen, U32)
608PERLVAR(I, origenviron, char **)
ca0c25f6 609#ifdef PERL_USES_PL_PIDSTATUS
115ff745 610PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 611#endif
115ff745 612PERLVAR(I, osname, char *) /* operating system */
5c728af0 613
dc37125b
DM
614PERLVAR(I, sighandlerp, Sighandler_t)
615/* these two are provided only to solve library linkage issues; they
616 * should not be hooked by user code */
617PERLVAR(I, sighandler1p, Sighandler1_t)
618PERLVAR(I, sighandler3p, Sighandler3_t)
0672f40e 619
115ff745 620PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 621
8162b70e 622PERLVAR(I, debug, volatile U32) /* flags given to -D switch */
79968a97 623
e897f2d7 624PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
9f7da6d5 625
a902610b
TC
626/*
627=for apidoc Amn|runops_proc_t|PL_runops
628
629See L<perlguts/Pluggable runops>.
630
631=cut
632*/
633
115ff745 634PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
0672f40e 635
115ff745 636PERLVAR(I, subname, SV *) /* name of current subroutine */
0672f40e 637
115ff745 638PERLVAR(I, subline, I32) /* line this subroutine began on */
d12be05d 639PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
d95e864f 640
d12be05d
DM
641PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
642PERLVAR(I, padix, PADOFFSET) /* lowest unused index - 1
8ce2f624 643 in current "register" pad */
d12be05d 644PERLVAR(I, constpadix, PADOFFSET) /* lowest unused for constants */
d95e864f 645
d12be05d 646PERLVAR(I, padix_floor, PADOFFSET) /* how low may inner block reset padix */
0672f40e 647
e9bc6d6b
KW
648#if defined(USE_POSIX_2008_LOCALE) \
649 && defined(USE_THREAD_SAFE_LOCALE) \
650 && ! defined(HAS_QUERYLOCALE)
651
652PERLVARA(I, curlocales, 12, char *)
653
654#endif
0672f40e 655#ifdef USE_LOCALE_COLLATE
e9bc6d6b 656
115ff745
NC
657PERLVAR(I, collation_name, char *) /* Name of current collation */
658PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm() */
659PERLVARI(I, collxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
660PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */
f28f4d2a 661PERLVARI(I, strxfrm_NUL_replacement, U8, 0) /* Code point to replace NULs */
c664130f
KW
662PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
663 /* Assume until proven otherwise that it works */
a4a439fb 664PERLVARI(I, strxfrm_max_cp, U8, 0) /* Highest collating cp in locale */
115ff745 665PERLVARI(I, collation_standard, bool, TRUE)
9f7da6d5 666 /* Assume simple collation */
0672f40e
GS
667#endif /* USE_LOCALE_COLLATE */
668
f7416781
KW
669PERLVARI(I, langinfo_buf, char *, NULL)
670PERLVARI(I, langinfo_bufsize, Size_t, 0)
9aac5db8
KW
671PERLVARI(I, setlocale_buf, char *, NULL)
672PERLVARI(I, setlocale_bufsize, Size_t, 0)
f7416781 673
19bc2726
DM
674#ifdef PERL_SAWAMPERSAND
675PERLVAR(I, sawampersand, U8) /* must save all match strings */
9f7da6d5 676#endif
95ca8690 677
19bc2726 678PERLVAR(I, unsafe, bool)
87c1d905 679PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
19bc2726 680
79968a97
NC
681/* current phase the interpreter is in
682 for ordering this structure to remove holes, we're assuming that this is 4
683 bytes. */
684PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
685
686PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
687
daf9aebe
TC
688/*
689=for apidoc Amn|signed char|PL_perl_destruct_level
690
691This value may be set when embedding for full cleanup.
692
693Possible values:
694
695=over
696
697=item * 0 - none
698
699=item * 1 - full
700
701=item * 2 or greater - full with checks.
702
703=back
704
705If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the
706value of C<PL_perl_destruct_level> its value is used instead.
707
708=cut
709*/
79968a97
NC
710/* mod_perl is special, and also assigns a meaning -1 */
711PERLVARI(I, perl_destruct_level, signed char, 0)
9f7da6d5 712
0672f40e
GS
713#ifdef USE_LOCALE_NUMERIC
714
7738054c 715PERLVARI(I, numeric_standard, int, TRUE)
892e6465
KW
716 /* Assume C locale numerics */
717PERLVARI(I, numeric_underlying, bool, TRUE)
718 /* Assume underlying locale numerics */
4c68b815 719PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
115ff745
NC
720PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
721PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */
f8115845 722
7e5377f7 723# ifdef HAS_POSIX_2008_LOCALE
e1aa2579
KW
724
725PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
726
727# endif
0672f40e
GS
728#endif /* !USE_LOCALE_NUMERIC */
729
d95e864f 730#ifdef FCRYPT
115ff745 731PERLVARI(I, cryptseen, bool, FALSE) /* has fast crypt() been initialized? */
79968a97
NC
732#else
733/* One byte hole in the interpreter structure. */
d95e864f
NC
734#endif
735
115ff745 736PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
e6b4660c 737PERLVAR(I, srand_called, bool)
12fbd33b 738
c4a30c8c
NC
739/* Array of signal handlers, indexed by signal number, through which the C
740 signal handler dispatches. */
115ff745 741PERLVAR(I, psig_ptr, SV **)
c4a30c8c 742/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
743 argument to a signal handler. Only one block of memory is allocated for
744 both psig_name and psig_ptr. */
115ff745 745PERLVAR(I, psig_name, SV **)
1d7c1841 746
c5be433b 747#if defined(PERL_IMPLICIT_SYS)
115ff745
NC
748PERLVAR(I, Mem, struct IPerlMem *)
749PERLVAR(I, MemShared, struct IPerlMem *)
750PERLVAR(I, MemParse, struct IPerlMem *)
751PERLVAR(I, Env, struct IPerlEnv *)
752PERLVAR(I, StdIO, struct IPerlStdIO *)
753PERLVAR(I, LIO, struct IPerlLIO *)
754PERLVAR(I, Dir, struct IPerlDir *)
755PERLVAR(I, Sock, struct IPerlSock *)
756PERLVAR(I, Proc, struct IPerlProc *)
76e3520e 757#endif
1d7c1841 758
115ff745
NC
759PERLVAR(I, ptr_table, PTR_TBL_t *)
760PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
f180df80 761
115ff745 762PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
93e68bfb 763
d95e864f 764
1fcf4c12 765#if defined(USE_ITHREADS)
115ff745 766PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
e6853197 767 regex_padav */
115ff745 768PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
e6853197 769 values in op_pmoffset of pmop.
402d2eb1
NC
770 Entry 0 is an SV whose PV is a
771 "packed" list of IVs listing
e6853197 772 the now-free slots in the array */
d4d03940
FC
773PERLVAR(I, stashpad, HV **) /* for CopSTASH */
774PERLVARI(I, stashpadmax, PADOFFSET, 64)
775PERLVARI(I, stashpadix, PADOFFSET, 0)
1fcf4c12
AB
776#endif
777
ea68fd67 778#ifdef USE_REENTRANT_API
115ff745 779PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
f5a82810
JH
780#endif
781
115ff745
NC
782PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
783PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
19e8ce8e 784
a1ea730d 785#ifdef PERLIO_LAYERS
115ff745
NC
786PERLVARI(I, perlio, PerlIOl *, NULL)
787PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
788PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
a1ea730d
NIS
789#endif
790
115ff745 791PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
147f47de 792
115ff745
NC
793PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
794PERLVARI(I, unitcheckav_save, AV *, NULL)
795 /* save UNITCHECK{}s when compiling */
ece599bd 796
115ff745 797PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
5311654c 798
15a5279a 799/* Hooks to shared SVs and locks. */
115ff745
NC
800PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
801PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
238965b4
KW
802
803GCC_DIAG_IGNORE(-Wdeprecated-declarations)
d0647d4e
NC
804#ifdef NO_MATHOMS
805# define PERL_UNLOCK_HOOK Perl_sv_nosharing
806#else
807/* This reference ensures that the mathoms are linked with perl */
808# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
809#endif
115ff745 810PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 811
238965b4
KW
812GCC_DIAG_RESTORE
813
115ff745 814PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 815
9e08d3a4 816/* Can shared object be destroyed */
115ff745 817PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
9e08d3a4 818
01d65469 819#ifndef PERL_MICRO
115ff745 820PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 821#endif
92f022bb 822
115ff745 823PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
f16dd614 824
9e08d3a4
NC
825/* Register of known Method Resolution Orders.
826 What this actually points to is an implementation detail (it may change to
827 a structure incorporating a reference count - use mro_get_from_name to
828 retrieve a C<struct mro_alg *> */
115ff745 829PERLVAR(I, registered_mros, HV *)
9e08d3a4
NC
830
831/* Compile-time block start/end hooks */
115ff745 832PERLVAR(I, blockhooks, AV *)
9e08d3a4 833
115ff745 834PERLVAR(I, custom_ops, HV *) /* custom op registrations */
9e08d3a4 835
19bc2726
DM
836PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
837
838/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
839 present always, as -DDEBUGGING must be binary compatible with non. */
840PERLVARI(I, scopestack_name, const char * *, NULL)
841
842PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
843
d67594ff
FC
844/* Hook for File::Glob */
845PERLVARI(I, globhook, globhook_t, NULL)
846
436227c7 847/* The last unconditional member of the interpreter structure when 5.18.0 was
ffee3ff6
NC
848 released. The offset of the end of this is baked into a global variable in
849 any shared perl library which will allow a sanity test in future perl
850 releases. */
d399cf59 851#define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
ffee3ff6 852
f16dd614 853#ifdef PERL_IMPLICIT_CONTEXT
115ff745 854PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
817b0f24 855PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614
DM
856#endif
857
0419d978 858#if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
5ca5a628 859/* For use with the memory debugging code in util.c. This is used only in
0419d978
AC
860 * DEBUGGING builds (as long as the relevant structure is defined), but
861 * defining it in non-debug builds too means that we retain binary
862 * compatibility between otherwise-compatible plain and debug builds. */
115ff745 863PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
0419d978 864#endif
7cb608b5 865
ba6d381e
NC
866#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
867/* File descriptor to talk to the child which dumps scalars. */
115ff745 868PERLVARI(I, dumper_fd, int, -1)
ba6d381e
NC
869#endif
870
ba6d381e 871
d7a2c63c 872#ifdef DEBUG_LEAKING_SCALARS
115ff745 873PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
d7a2c63c
MHM
874#endif
875
a38ab475
RZ
876PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
877
75d476e2
SM
878#ifdef PERL_TRACE_OPS
879PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
880 If PERL_TRACE_OPS is enabled, we'll dump
881 a summary count of all ops executed in the
882 program at perl_destruct time. For
883 profiling/debugging only. Works only if
884 DEBUGGING is enabled, too. */
885#endif
886
3be8f094
TC
887PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
888
eecd4d11 889PERLVARI(I, dump_re_max_len, STRLEN, 60)
2bfbbbaf 890
f26b33bd
TC
891/* For internal uses of randomness, this ensures the sequence of
892 * random numbers returned by rand() isn't modified by perl's internal
893 * use of randomness.
894 * This is important if the user has called srand() with a seed.
895 */
896
897PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
898
8c90d3a9
KW
899PERLVARA(I, TR_SPECIAL_HANDLING_UTF8, UTF8_MAXBYTES, char)
900
a8def808
KW
901PERLVAR(I, AboveLatin1, SV *)
902PERLVAR(I, Assigned_invlist, SV *)
903PERLVAR(I, GCB_invlist, SV *)
904PERLVAR(I, HasMultiCharFold, SV *)
905PERLVAR(I, InMultiCharFold, SV *)
906PERLVAR(I, Latin1, SV *)
907PERLVAR(I, LB_invlist, SV *)
908PERLVAR(I, SB_invlist, SV *)
909PERLVAR(I, SCX_invlist, SV *)
910PERLVAR(I, UpperLatin1, SV *) /* Code points 128 - 255 */
911
912/* List of characters that participate in any fold defined by Unicode */
913PERLVAR(I, in_some_fold, SV *)
914
915PERLVAR(I, utf8_idcont, SV *)
916PERLVAR(I, utf8_idstart, SV *)
917PERLVAR(I, utf8_perl_idcont, SV *)
918PERLVAR(I, utf8_perl_idstart, SV *)
919PERLVAR(I, utf8_xidcont, SV *)
920PERLVAR(I, utf8_xidstart, SV *)
921PERLVAR(I, WB_invlist, SV *)
922PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
923PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
924PERLVAR(I, utf8_toupper, SV *)
925PERLVAR(I, utf8_totitle, SV *)
926PERLVAR(I, utf8_tolower, SV *)
927PERLVAR(I, utf8_tofold, SV *)
928PERLVAR(I, utf8_tosimplefold, SV *)
929PERLVAR(I, utf8_charname_begin, SV *)
930PERLVAR(I, utf8_charname_continue, SV *)
931PERLVAR(I, utf8_mark, SV *)
932PERLVARI(I, InBitmap, SV *, NULL)
933PERLVAR(I, CCC_non0_non230, SV *)
934PERLVAR(I, Private_Use, SV *)
935
157b3822
NC
936/* If you are adding a U8 or U16, check to see if there are 'Space' comments
937 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
938
939/* Within a stable branch, new variables must be added to the very end, before
940 * this comment, for binary compatibility (the offsets of the old members must
941 * not change).
b83cd129 942 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 943 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
944 * irrelevant, but not all code may be expected to #include XSUB.h.
945 */