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