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