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