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