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