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