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