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