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