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