This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
(perl #132777) document (sort of) and APIify PL_runops
[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 208
aa9ca194
TC
209/*
210=for apidoc Amn|yy_parser*|PL_parser
211
212The parser state when compiling code.
213
214=cut
215*/
216
19bc2726
DM
217PERLVAR(I, parser, yy_parser *) /* current parser state */
218
219PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
220
907b3e23
DM
221
222/*
223=for apidoc Amn|STRLEN|PL_na
224
225A convenience variable which is typically used with C<SvPV> when one
226doesn't care about the length of the string. It is usually more efficient
227to either declare a local variable and use that instead or to use the
228C<SvPV_nolen> macro.
229
230=cut
231*/
232
115ff745 233PERLVAR(I, na, STRLEN) /* for use in SvPV when length is
907b3e23
DM
234 Not Applicable */
235
236/* stat stuff */
115ff745
NC
237PERLVAR(I, statcache, Stat_t) /* _ */
238PERLVAR(I, statgv, GV *)
239PERLVARI(I, statname, SV *, NULL)
907b3e23 240
907b3e23
DM
241/*
242=for apidoc mn|SV*|PL_rs
243
244The input record separator - C<$/> in Perl space.
245
246=for apidoc mn|GV*|PL_last_in_gv
247
154e47c8 248The GV which was last used for a filehandle input operation. (C<< <FH> >>)
907b3e23 249
e23d9e2f 250=for apidoc mn|GV*|PL_ofsgv
907b3e23 251
e23d9e2f 252The glob containing the output field separator - C<*,> in Perl space.
907b3e23
DM
253
254=cut
255*/
256
115ff745
NC
257PERLVAR(I, rs, SV *) /* input record separator $/ */
258PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */
259PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */
260PERLVAR(I, defoutgv, GV *) /* default FH for output */
261PERLVARI(I, chopset, const char *, " \n-") /* $: */
262PERLVAR(I, formtarget, SV *)
263PERLVAR(I, bodytarget, SV *)
264PERLVAR(I, toptarget, SV *)
907b3e23 265
115ff745
NC
266
267PERLVAR(I, restartop, OP *) /* propagating an error from croak? */
268PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */
907b3e23 269
115ff745
NC
270PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */
271PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */
272PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */
907b3e23
DM
273
274/* statics "owned" by various functions */
115ff745 275PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
907b3e23 276
115ff745 277PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */
907b3e23
DM
278
279/* sort stuff */
115ff745
NC
280PERLVAR(I, sortcop, OP *) /* user defined sort routine */
281PERLVAR(I, sortstash, HV *) /* which is in some package or other */
282PERLVAR(I, firstgv, GV *) /* $a */
283PERLVAR(I, secondgv, GV *) /* $b */
907b3e23
DM
284
285/* float buffer */
115ff745
NC
286PERLVAR(I, efloatbuf, char *)
287PERLVAR(I, efloatsize, STRLEN)
907b3e23 288
115ff745 289PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
907b3e23
DM
290 indentation level */
291
7b93aae2
TC
292/*
293=for apidoc Amn|U8|PL_exit_flags
294
295Contains flags controlling perl's behaviour on exit():
296
297=over
298
299=item * C<PERL_EXIT_DESTRUCT_END>
300
301If set, END blocks are executed when the interpreter is destroyed.
302This is normally set by perl itself after the interpreter is
303constructed.
304
305=item * C<PERL_EXIT_ABORT>
306
307Call C<abort()> on exit. This is used internally by perl itself to
308abort if exit is called while processing exit.
309
310=item * C<PERL_EXIT_WARN>
311
312Warn on exit.
313
314=item * C<PERL_EXIT_EXPECTED>
315
316Set by the L<perlfunc/exit> operator.
317
318=back
319
320=cut
321*/
322
e914d9bb 323PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
157b3822 324
115ff745 325PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
31f05a37 326PERLVAR(I, in_utf8_CTYPE_locale, bool)
165a1c52 327PERLVAR(I, in_utf8_COLLATE_locale, bool)
b8df1494 328PERLVAR(I, in_utf8_turkic_locale, bool)
bffa51e2 329#if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
49d7d366 330PERLVARI(I, lc_numeric_mutex_depth, int, 0) /* Emulate general semaphore */
bffa51e2 331#endif
47280b20
KW
332PERLVARA(I, locale_utf8ness, 256, char)
333
5b7de470
KW
334#ifdef USE_LOCALE_CTYPE
335 PERLVAR(I, warn_locale, SV *)
336#endif
907b3e23 337
87c1d905 338PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
907b3e23 339
9ea12537
Z
340/*
341=for apidoc Amn|peep_t|PL_peepp
342
343Pointer to the per-subroutine peephole optimiser. This is a function
344that gets called at the end of compilation of a Perl subroutine (or
345equivalently independent piece of Perl code) to perform fixups of
346some ops and to perform small-scale optimisations. The function is
347called once for each subroutine that is compiled, and is passed, as sole
348parameter, a pointer to the op that is the entry point to the subroutine.
349It modifies the op tree in place.
350
351The peephole optimiser should never be completely replaced. Rather,
352add code to it by wrapping the existing optimiser. The basic way to do
353this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
354If the new code wishes to operate on ops throughout the subroutine's
355structure, rather than just at the top level, it is likely to be more
356convenient to wrap the L</PL_rpeepp> hook.
357
358=cut
359*/
360
115ff745 361PERLVARI(I, peepp, peep_t, Perl_peep)
9ea12537
Z
362
363/*
364=for apidoc Amn|peep_t|PL_rpeepp
365
366Pointer to the recursive peephole optimiser. This is a function
367that gets called at the end of compilation of a Perl subroutine (or
368equivalently independent piece of Perl code) to perform fixups of some
369ops and to perform small-scale optimisations. The function is called
370once for each chain of ops linked through their C<op_next> fields;
371it is recursively called to handle each side chain. It is passed, as
372sole parameter, a pointer to the op that is at the head of the chain.
373It modifies the op tree in place.
374
375The peephole optimiser should never be completely replaced. Rather,
376add code to it by wrapping the existing optimiser. The basic way to do
377this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
378If the new code wishes to operate only on ops at a subroutine's top level,
379rather than throughout the structure, it is likely to be more convenient
380to wrap the L</PL_peepp> hook.
381
382=cut
383*/
384
115ff745 385PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
907b3e23 386
2f175318
VP
387/*
388=for apidoc Amn|Perl_ophook_t|PL_opfreehook
389
390When 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.
391This allows extensions to free any extra attribute they have locally attached to an OP.
392It is also assured to first fire for the parent OP and then for its kids.
393
394When 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.
395
396=cut
397*/
398
115ff745 399PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 400
115ff745
NC
401PERLVARI(I, watchaddr, char **, 0)
402PERLVAR(I, watchok, char *)
907b3e23 403
115ff745 404PERLVAR(I, perldb, U32)
d95e864f 405
115ff745 406PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
30b0736d 407
79968a97
NC
408PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
409
49f531da 410/* pseudo environmental stuff */
115ff745
NC
411PERLVAR(I, origargc, int)
412PERLVAR(I, origargv, char **)
413PERLVAR(I, envgv, GV *)
414PERLVAR(I, incgv, GV *)
415PERLVAR(I, hintgv, GV *)
416PERLVAR(I, origfilename, char *)
9a189793 417PERLVARI(I, xsubfilename, const char *, NULL)
115ff745
NC
418PERLVAR(I, diehook, SV *)
419PERLVAR(I, warnhook, SV *)
1d7c1841
GS
420
421/* switches */
115ff745 422PERLVAR(I, patchlevel, SV *)
115ff745
NC
423PERLVAR(I, localpatches, const char * const *)
424PERLVARI(I, splitstr, const char *, " ")
425
426PERLVAR(I, minus_c, bool)
427PERLVAR(I, minus_n, bool)
428PERLVAR(I, minus_p, bool)
429PERLVAR(I, minus_l, bool)
430PERLVAR(I, minus_a, bool)
431PERLVAR(I, minus_F, bool)
432PERLVAR(I, doswitches, bool)
433PERLVAR(I, minus_E, bool)
954c1994 434
115ff745
NC
435PERLVAR(I, inplace, char *)
436PERLVAR(I, e_script, SV *)
49f531da 437
115ff745 438PERLVAR(I, basetime, Time_t) /* $^T */
d4cce5f1 439
115ff745 440PERLVARI(I, maxsysfd, I32, MAXSYSFD)
cb68f92d 441 /* top fd to pass to subprocesses */
115ff745 442PERLVAR(I, statusvalue, I32) /* $? */
49f531da 443#ifdef VMS
115ff745 444PERLVAR(I, statusvalue_vms, U32)
e5218da5 445#else
115ff745 446PERLVAR(I, statusvalue_posix, I32)
49f531da
NIS
447#endif
448
115ff745
NC
449PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
450PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
157b3822 451
49f531da 452/* shortcuts to various I/O objects */
115ff745
NC
453PERLVAR(I, stdingv, GV *) /* *STDIN */
454PERLVAR(I, stderrgv, GV *) /* *STDERR */
115ff745
NC
455PERLVAR(I, argvgv, GV *) /* *ARGV */
456PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
457PERLVAR(I, argvout_stack, AV *)
49f531da
NIS
458
459/* shortcuts to regexp stuff */
115ff745 460PERLVAR(I, replgv, GV *) /* *^R */
49f531da
NIS
461
462/* shortcuts to misc objects */
115ff745 463PERLVAR(I, errgv, GV *) /* *@ */
49f531da
NIS
464
465/* shortcuts to debugging objects */
115ff745
NC
466PERLVAR(I, DBgv, GV *) /* *DB::DB */
467PERLVAR(I, DBline, GV *) /* *DB::line */
954c1994
GS
468
469/*
2eb25c99 470=for apidoc mn|GV *|PL_DBsub
954c1994
GS
471When Perl is run in debugging mode, with the B<-d> switch, this GV contains
472the SV which holds the name of the sub being debugged. This is the C
473variable which corresponds to Perl's $DB::sub variable. See
fbe13c60 474C<L</PL_DBsingle>>.
954c1994 475
2eb25c99 476=for apidoc mn|SV *|PL_DBsingle
954c1994 477When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 478boolean which indicates whether subs are being single-stepped.
954c1994
GS
479Single-stepping is automatically turned on after every step. This is the C
480variable which corresponds to Perl's $DB::single variable. See
fbe13c60 481C<L</PL_DBsub>>.
954c1994 482
2eb25c99 483=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
484Trace variable used when Perl is run in debugging mode, with the B<-d>
485switch. This is the C variable which corresponds to Perl's $DB::trace
fbe13c60 486variable. See C<L</PL_DBsingle>>.
954c1994
GS
487
488=cut
489*/
490
115ff745
NC
491PERLVAR(I, DBsub, GV *) /* *DB::sub */
492PERLVAR(I, DBsingle, SV *) /* $DB::single */
493PERLVAR(I, DBtrace, SV *) /* $DB::trace */
494PERLVAR(I, DBsignal, SV *) /* $DB::signal */
495PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
49f531da 496
a6d69523
TC
497PERLVARA(I, DBcontrol, DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
498
49f531da 499/* symbol tables */
115ff745
NC
500PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
501PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
502PERLVAR(I, curstname, SV *) /* name of current package */
503PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
504PERLVAR(I, endav, AV *) /* names of END subroutines */
505PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
506PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
507PERLVAR(I, initav, AV *) /* names of INIT subroutines */
49f531da 508
49f531da 509/* subprocess state */
115ff745 510PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
511
512/* internal state */
115ff745 513PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
49f531da 514
49f531da 515/* current interpreter roots */
115ff745
NC
516PERLVAR(I, main_cv, CV *)
517PERLVAR(I, main_root, OP *)
518PERLVAR(I, main_start, OP *)
519PERLVAR(I, eval_root, OP *)
520PERLVAR(I, eval_start, OP *)
49f531da
NIS
521
522/* runtime control stuff */
115ff745 523PERLVARI(I, curcopdb, COP *, NULL)
49f531da 524
115ff745
NC
525PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
526PERLVAR(I, lastfd, int) /* what to preserve mode on */
527PERLVAR(I, oldname, char *) /* what to preserve mode on */
00accf8d
NC
528/* Elements in this array have ';' appended and are injected as a single line
529 into the tokeniser. You can't put any (literal) newlines into any program
530 you stuff in into this array, as the point where it's injected is expecting
531 a single physical line. */
115ff745
NC
532PERLVAR(I, preambleav, AV *)
533PERLVAR(I, mess_sv, SV *)
534PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
19bc2726 535
79968a97
NC
536/* funky return mechanisms */
537PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
538
71eebe1e 539/* statics moved here for shared library purposes */
115ff745
NC
540PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
541PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
542PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
543PERLVARI(I, laststype, U16, OP_STAT)
19bc2726 544
115ff745 545PERLVARI(I, laststatval, int, -1)
d4cce5f1 546
19bc2726
DM
547PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in
548 assignment? */
549
4b556e6c 550/* interpreter atexit processing */
115ff745
NC
551PERLVARI(I, exitlistlen, I32, 0) /* length of same */
552PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
cb68f92d 553 /* list of exit functions */
954c1994
GS
554
555/*
556=for apidoc Amn|HV*|PL_modglobal
557
7889fe52 558C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 559extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
560In a pinch, it can also be used as a symbol table for extensions
561to share data among each other. It is a good idea to use keys
954c1994
GS
562prefixed by the package name of the extension that owns the data.
563
564=cut
565*/
566
115ff745 567PERLVAR(I, modglobal, HV *) /* per-interp module data */
cb68f92d
GS
568
569/* these used to be in global before 5.004_68 */
115ff745 570PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d 571
115ff745 572PERLVAR(I, compiling, COP) /* compiling/done executing marker */
cb68f92d 573
115ff745 574PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
36c300bb 575PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
d12be05d
DM
576PERLVAR(I, comppad_name_fill, PADOFFSET)/* last "introduced" variable offset */
577PERLVAR(I, comppad_name_floor, PADOFFSET)/* start of vars in innermost block */
4b556e6c
JD
578
579#ifdef HAVE_INTERP_INTERN
115ff745 580PERLVAR(I, sys_intern, struct interp_intern)
cb68f92d 581 /* platform internals */
4b556e6c
JD
582#endif
583
7fae4e64 584/* more statics moved here */
115ff745 585PERLVAR(I, DBcv, CV *) /* from perl.c */
75010704
DM
586PERLVARI(I, generation, int, 100) /* scan sequence# for OP_AASSIGN
587 compile-time common elem detection */
56953603 588
19bc2726
DM
589PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
590
115ff745
NC
591PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
592PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
593PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
594PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 595
19bc2726 596
985213f2
AB
597PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */
598PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */
599PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */
600PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */
115ff745 601PERLVARI(I, an, U32, 0) /* malloc sequence number */
be2b6a89 602
79968a97
NC
603/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
604PERLVARI(I, breakable_sub_gen, U32, 0)
605
be2b6a89
DM
606#ifdef DEBUGGING
607 /* exercise wrap-around */
608 #define PERL_COP_SEQMAX (U32_MAX-50)
609#else
610 #define PERL_COP_SEQMAX 0
611#endif
115ff745 612PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
be2b6a89
DM
613#undef PERL_COP_SEQMAX
614
115ff745
NC
615PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
616PERLVAR(I, origalen, U32)
617PERLVAR(I, origenviron, char **)
ca0c25f6 618#ifdef PERL_USES_PL_PIDSTATUS
115ff745 619PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 620#endif
115ff745 621PERLVAR(I, osname, char *) /* operating system */
5c728af0 622
115ff745 623PERLVAR(I, sighandlerp, Sighandler_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
19bc2726 683PERLVAR(I, unsafe, bool)
87c1d905 684PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
19bc2726 685
79968a97
NC
686/* current phase the interpreter is in
687 for ordering this structure to remove holes, we're assuming that this is 4
688 bytes. */
689PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
690
691PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
692
693/* This value may be set when embedding for full cleanup */
694/* 0=none, 1=full, 2=full with checks */
695/* mod_perl is special, and also assigns a meaning -1 */
696PERLVARI(I, perl_destruct_level, signed char, 0)
9f7da6d5 697
0672f40e
GS
698#ifdef USE_LOCALE_NUMERIC
699
7738054c 700PERLVARI(I, numeric_standard, int, TRUE)
892e6465
KW
701 /* Assume C locale numerics */
702PERLVARI(I, numeric_underlying, bool, TRUE)
703 /* Assume underlying locale numerics */
4c68b815 704PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
115ff745
NC
705PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
706PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */
f8115845 707
7e5377f7 708# ifdef HAS_POSIX_2008_LOCALE
e1aa2579
KW
709
710PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
711
712# endif
0672f40e
GS
713#endif /* !USE_LOCALE_NUMERIC */
714
a3e1f3a6 715/* utf8 character class swashes */
34aeb2e9 716PERLVAR(I, seen_deprecated_macro, HV *)
cac6e0ca 717
115ff745
NC
718PERLVAR(I, last_swash_hv, HV *)
719PERLVAR(I, last_swash_tmps, U8 *)
720PERLVAR(I, last_swash_slen, STRLEN)
6c2f1a55 721PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
45d91b83 722PERLVAR(I, last_swash_klen, U8) /* Only needs to store 0-12 */
d95e864f
NC
723
724#ifdef FCRYPT
115ff745 725PERLVARI(I, cryptseen, bool, FALSE) /* has fast crypt() been initialized? */
79968a97
NC
726#else
727/* One byte hole in the interpreter structure. */
d95e864f
NC
728#endif
729
115ff745 730PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
e6b4660c 731PERLVAR(I, srand_called, bool)
12fbd33b 732
c4a30c8c
NC
733/* Array of signal handlers, indexed by signal number, through which the C
734 signal handler dispatches. */
115ff745 735PERLVAR(I, psig_ptr, SV **)
c4a30c8c 736/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
737 argument to a signal handler. Only one block of memory is allocated for
738 both psig_name and psig_ptr. */
115ff745 739PERLVAR(I, psig_name, SV **)
1d7c1841 740
c5be433b 741#if defined(PERL_IMPLICIT_SYS)
115ff745
NC
742PERLVAR(I, Mem, struct IPerlMem *)
743PERLVAR(I, MemShared, struct IPerlMem *)
744PERLVAR(I, MemParse, struct IPerlMem *)
745PERLVAR(I, Env, struct IPerlEnv *)
746PERLVAR(I, StdIO, struct IPerlStdIO *)
747PERLVAR(I, LIO, struct IPerlLIO *)
748PERLVAR(I, Dir, struct IPerlDir *)
749PERLVAR(I, Sock, struct IPerlSock *)
750PERLVAR(I, Proc, struct IPerlProc *)
76e3520e 751#endif
1d7c1841 752
115ff745
NC
753PERLVAR(I, ptr_table, PTR_TBL_t *)
754PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
f180df80 755
115ff745 756PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
93e68bfb 757
d95e864f 758
1fcf4c12 759#if defined(USE_ITHREADS)
115ff745 760PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
e6853197 761 regex_padav */
115ff745 762PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
e6853197 763 values in op_pmoffset of pmop.
402d2eb1
NC
764 Entry 0 is an SV whose PV is a
765 "packed" list of IVs listing
e6853197 766 the now-free slots in the array */
d4d03940
FC
767PERLVAR(I, stashpad, HV **) /* for CopSTASH */
768PERLVARI(I, stashpadmax, PADOFFSET, 64)
769PERLVARI(I, stashpadix, PADOFFSET, 0)
1fcf4c12
AB
770#endif
771
ea68fd67 772#ifdef USE_REENTRANT_API
115ff745 773PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
f5a82810
JH
774#endif
775
115ff745
NC
776PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
777PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
19e8ce8e 778
a1ea730d 779#ifdef PERLIO_LAYERS
115ff745
NC
780PERLVARI(I, perlio, PerlIOl *, NULL)
781PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
782PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
a1ea730d
NIS
783#endif
784
115ff745 785PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
147f47de 786
115ff745
NC
787PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
788PERLVARI(I, unitcheckav_save, AV *, NULL)
789 /* save UNITCHECK{}s when compiling */
ece599bd 790
115ff745 791PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
5311654c 792
15a5279a 793/* Hooks to shared SVs and locks. */
115ff745
NC
794PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
795PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
796#ifdef NO_MATHOMS
797# define PERL_UNLOCK_HOOK Perl_sv_nosharing
798#else
799/* This reference ensures that the mathoms are linked with perl */
800# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
801#endif
115ff745 802PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 803
115ff745 804PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 805
9e08d3a4 806/* Can shared object be destroyed */
115ff745 807PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
9e08d3a4 808
01d65469 809#ifndef PERL_MICRO
115ff745 810PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 811#endif
92f022bb 812
115ff745 813PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
f16dd614 814
9e08d3a4
NC
815/* Register of known Method Resolution Orders.
816 What this actually points to is an implementation detail (it may change to
817 a structure incorporating a reference count - use mro_get_from_name to
818 retrieve a C<struct mro_alg *> */
115ff745 819PERLVAR(I, registered_mros, HV *)
9e08d3a4
NC
820
821/* Compile-time block start/end hooks */
115ff745 822PERLVAR(I, blockhooks, AV *)
9e08d3a4 823
115ff745 824PERLVAR(I, custom_ops, HV *) /* custom op registrations */
9e08d3a4 825
19bc2726
DM
826PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
827
828/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
829 present always, as -DDEBUGGING must be binary compatible with non. */
830PERLVARI(I, scopestack_name, const char * *, NULL)
831
832PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
833
d67594ff
FC
834/* Hook for File::Glob */
835PERLVARI(I, globhook, globhook_t, NULL)
836
436227c7 837/* The last unconditional member of the interpreter structure when 5.18.0 was
ffee3ff6
NC
838 released. The offset of the end of this is baked into a global variable in
839 any shared perl library which will allow a sanity test in future perl
840 releases. */
d399cf59 841#define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
ffee3ff6 842
f16dd614 843#ifdef PERL_IMPLICIT_CONTEXT
115ff745 844PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
817b0f24 845PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614
DM
846#endif
847
0419d978 848#if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
5ca5a628 849/* For use with the memory debugging code in util.c. This is used only in
0419d978
AC
850 * DEBUGGING builds (as long as the relevant structure is defined), but
851 * defining it in non-debug builds too means that we retain binary
852 * compatibility between otherwise-compatible plain and debug builds. */
115ff745 853PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
0419d978 854#endif
7cb608b5 855
ba6d381e
NC
856#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
857/* File descriptor to talk to the child which dumps scalars. */
115ff745 858PERLVARI(I, dumper_fd, int, -1)
ba6d381e
NC
859#endif
860
ba6d381e 861
d7a2c63c 862#ifdef DEBUG_LEAKING_SCALARS
115ff745 863PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
d7a2c63c
MHM
864#endif
865
a38ab475
RZ
866PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
867
75d476e2
SM
868#ifdef PERL_TRACE_OPS
869PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
870 If PERL_TRACE_OPS is enabled, we'll dump
871 a summary count of all ops executed in the
872 program at perl_destruct time. For
873 profiling/debugging only. Works only if
874 DEBUGGING is enabled, too. */
875#endif
876
3be8f094
TC
877PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
878
eecd4d11 879PERLVARI(I, dump_re_max_len, STRLEN, 60)
2bfbbbaf 880
f26b33bd
TC
881/* For internal uses of randomness, this ensures the sequence of
882 * random numbers returned by rand() isn't modified by perl's internal
883 * use of randomness.
884 * This is important if the user has called srand() with a seed.
885 */
886
887PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
888
157b3822
NC
889/* If you are adding a U8 or U16, check to see if there are 'Space' comments
890 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
891
892/* Within a stable branch, new variables must be added to the very end, before
893 * this comment, for binary compatibility (the offsets of the old members must
894 * not change).
b83cd129 895 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 896 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
897 * irrelevant, but not all code may be expected to #include XSUB.h.
898 */