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