This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix CORE::glob
[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
02506efe
JH
22/* Don't forget to add your variable also to perl_clone()! */
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
NC
164PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
165PERLVARI(I, rehash_seed_set, bool, FALSE) /* 582 hash initialized? */
907b3e23 166
115ff745 167PERLVARA(I, colors,6, char *) /* from regcomp.c */
907b3e23 168
9ea12537
Z
169/*
170=for apidoc Amn|peep_t|PL_peepp
171
172Pointer to the per-subroutine peephole optimiser. This is a function
173that gets called at the end of compilation of a Perl subroutine (or
174equivalently independent piece of Perl code) to perform fixups of
175some ops and to perform small-scale optimisations. The function is
176called once for each subroutine that is compiled, and is passed, as sole
177parameter, a pointer to the op that is the entry point to the subroutine.
178It modifies the op tree in place.
179
180The peephole optimiser should never be completely replaced. Rather,
181add code to it by wrapping the existing optimiser. The basic way to do
182this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
183If the new code wishes to operate on ops throughout the subroutine's
184structure, rather than just at the top level, it is likely to be more
185convenient to wrap the L</PL_rpeepp> hook.
186
187=cut
188*/
189
115ff745 190PERLVARI(I, peepp, peep_t, Perl_peep)
9ea12537
Z
191
192/*
193=for apidoc Amn|peep_t|PL_rpeepp
194
195Pointer to the recursive peephole optimiser. This is a function
196that gets called at the end of compilation of a Perl subroutine (or
197equivalently independent piece of Perl code) to perform fixups of some
198ops and to perform small-scale optimisations. The function is called
199once for each chain of ops linked through their C<op_next> fields;
200it is recursively called to handle each side chain. It is passed, as
201sole parameter, a pointer to the op that is at the head of the chain.
202It modifies the op tree in place.
203
204The peephole optimiser should never be completely replaced. Rather,
205add code to it by wrapping the existing optimiser. The basic way to do
206this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
207If the new code wishes to operate only on ops at a subroutine's top level,
208rather than throughout the structure, it is likely to be more convenient
209to wrap the L</PL_peepp> hook.
210
211=cut
212*/
213
115ff745 214PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
907b3e23 215
2f175318
VP
216/*
217=for apidoc Amn|Perl_ophook_t|PL_opfreehook
218
219When 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.
220This allows extensions to free any extra attribute they have locally attached to an OP.
221It is also assured to first fire for the parent OP and then for its kids.
222
223When 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.
224
225=cut
226*/
227
115ff745 228PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 229
4185c919 230/* Space for U32 */
115ff745
NC
231PERLVARI(I, reginterp_cnt,I32, 0) /* Whether "Regexp" was interpolated. */
232PERLVARI(I, watchaddr, char **, 0)
233PERLVAR(I, watchok, char *)
907b3e23
DM
234
235/* the currently active slab in a chain of slabs of regmatch states,
236 * and the currently active state within that slab */
237
115ff745
NC
238PERLVARI(I, regmatch_slab, regmatch_slab *, NULL)
239PERLVAR(I, regmatch_state, regmatch_state *)
907b3e23 240
907b3e23 241/* Put anything new that is pointer aligned here. */
d95e864f 242
115ff745
NC
243PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
244PERLVAR(I, localizing, U8) /* are we processing a local() list? */
245PERLVAR(I, colorset, bool) /* from regcomp.c */
246PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
247PERLVAR(I, tainted, bool) /* using variables controlled by $< */
248PERLVAR(I, tainting, bool) /* doing taint checks */
9ebf26ad 249
d95e864f
NC
250/* This value may be set when embedding for full cleanup */
251/* 0=none, 1=full, 2=full with checks */
801627e8 252/* mod_perl is special, and also assigns a meaning -1 */
115ff745 253PERLVARI(I, perl_destruct_level, signed char, 0)
d95e864f 254
30b0736d 255/* current phase the interpreter is in */
115ff745 256PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
30b0736d 257
115ff745 258PERLVAR(I, perldb, U32)
d95e864f 259
115ff745 260PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
30b0736d 261
49f531da 262/* pseudo environmental stuff */
115ff745
NC
263PERLVAR(I, origargc, int)
264PERLVAR(I, origargv, char **)
265PERLVAR(I, envgv, GV *)
266PERLVAR(I, incgv, GV *)
267PERLVAR(I, hintgv, GV *)
268PERLVAR(I, origfilename, char *)
269PERLVAR(I, diehook, SV *)
270PERLVAR(I, warnhook, SV *)
1d7c1841
GS
271
272/* switches */
115ff745
NC
273PERLVAR(I, patchlevel, SV *)
274PERLVAR(I, apiversion, SV *)
275PERLVAR(I, localpatches, const char * const *)
276PERLVARI(I, splitstr, const char *, " ")
277
278PERLVAR(I, minus_c, bool)
279PERLVAR(I, minus_n, bool)
280PERLVAR(I, minus_p, bool)
281PERLVAR(I, minus_l, bool)
282PERLVAR(I, minus_a, bool)
283PERLVAR(I, minus_F, bool)
284PERLVAR(I, doswitches, bool)
285PERLVAR(I, minus_E, bool)
954c1994
GS
286
287/*
ccfc67b7 288
2eb25c99 289=for apidoc mn|bool|PL_dowarn
954c1994
GS
290
291The C variable which corresponds to Perl's $^W warning variable.
292
293=cut
294*/
295
115ff745
NC
296PERLVAR(I, dowarn, U8)
297PERLVAR(I, sawampersand, bool) /* must save all match strings */
298PERLVAR(I, unsafe, bool)
299PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
300PERLVAR(I, srand_called, bool)
301PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
30b0736d 302 /* Space for a U16 */
115ff745
NC
303PERLVAR(I, inplace, char *)
304PERLVAR(I, e_script, SV *)
49f531da
NIS
305
306/* magical thingies */
115ff745
NC
307PERLVAR(I, basetime, Time_t) /* $^T */
308PERLVAR(I, formfeed, SV *) /* $^L */
d4cce5f1
NIS
309
310
115ff745 311PERLVARI(I, maxsysfd, I32, MAXSYSFD)
cb68f92d 312 /* top fd to pass to subprocesses */
115ff745 313PERLVAR(I, statusvalue, I32) /* $? */
49f531da 314#ifdef VMS
115ff745 315PERLVAR(I, statusvalue_vms, U32)
e5218da5 316#else
115ff745 317PERLVAR(I, statusvalue_posix, I32)
49f531da
NIS
318#endif
319
115ff745
NC
320PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
321PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
157b3822 322
49f531da 323/* shortcuts to various I/O objects */
115ff745
NC
324PERLVAR(I, stdingv, GV *) /* *STDIN */
325PERLVAR(I, stderrgv, GV *) /* *STDERR */
326PERLVAR(I, defgv, GV *)
327PERLVAR(I, argvgv, GV *) /* *ARGV */
328PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
329PERLVAR(I, argvout_stack, AV *)
49f531da
NIS
330
331/* shortcuts to regexp stuff */
115ff745 332PERLVAR(I, replgv, GV *) /* *^R */
49f531da
NIS
333
334/* shortcuts to misc objects */
115ff745 335PERLVAR(I, errgv, GV *) /* *@ */
49f531da
NIS
336
337/* shortcuts to debugging objects */
115ff745
NC
338PERLVAR(I, DBgv, GV *) /* *DB::DB */
339PERLVAR(I, DBline, GV *) /* *DB::line */
954c1994
GS
340
341/*
2eb25c99 342=for apidoc mn|GV *|PL_DBsub
954c1994
GS
343When Perl is run in debugging mode, with the B<-d> switch, this GV contains
344the SV which holds the name of the sub being debugged. This is the C
345variable which corresponds to Perl's $DB::sub variable. See
346C<PL_DBsingle>.
347
2eb25c99 348=for apidoc mn|SV *|PL_DBsingle
954c1994 349When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 350boolean which indicates whether subs are being single-stepped.
954c1994
GS
351Single-stepping is automatically turned on after every step. This is the C
352variable which corresponds to Perl's $DB::single variable. See
353C<PL_DBsub>.
354
2eb25c99 355=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
356Trace variable used when Perl is run in debugging mode, with the B<-d>
357switch. This is the C variable which corresponds to Perl's $DB::trace
358variable. See C<PL_DBsingle>.
359
360=cut
361*/
362
115ff745
NC
363PERLVAR(I, DBsub, GV *) /* *DB::sub */
364PERLVAR(I, DBsingle, SV *) /* $DB::single */
365PERLVAR(I, DBtrace, SV *) /* $DB::trace */
366PERLVAR(I, DBsignal, SV *) /* $DB::signal */
367PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
49f531da
NIS
368
369/* symbol tables */
115ff745
NC
370PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
371PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
372PERLVAR(I, curstname, SV *) /* name of current package */
373PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
374PERLVAR(I, endav, AV *) /* names of END subroutines */
375PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
376PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
377PERLVAR(I, initav, AV *) /* names of INIT subroutines */
378PERLVAR(I, strtab, HV *) /* shared string table */
379PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */
49f531da 380
9f7da6d5 381/* funky return mechanisms */
115ff745 382PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
9f7da6d5 383
49f531da 384/* memory management */
115ff745
NC
385PERLVAR(I, sv_count, I32) /* how many SV* are currently allocated */
386PERLVAR(I, sv_objcount, I32) /* how many objects are currently allocated */
387PERLVAR(I, sv_root, SV *) /* storage for SVs belonging to interp */
388PERLVAR(I, sv_arenaroot, SV *) /* list of areas for garbage collection */
49f531da 389
49f531da 390/* subprocess state */
115ff745 391PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
392
393/* internal state */
115ff745 394PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
49f531da 395
49f531da 396/* current interpreter roots */
115ff745
NC
397PERLVAR(I, main_cv, CV *)
398PERLVAR(I, main_root, OP *)
399PERLVAR(I, main_start, OP *)
400PERLVAR(I, eval_root, OP *)
401PERLVAR(I, eval_start, OP *)
49f531da
NIS
402
403/* runtime control stuff */
115ff745 404PERLVARI(I, curcopdb, COP *, NULL)
49f531da 405
115ff745
NC
406PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
407PERLVAR(I, lastfd, int) /* what to preserve mode on */
408PERLVAR(I, oldname, char *) /* what to preserve mode on */
409PERLVAR(I, Argv, const char **) /* stuff to free from do_aexec, vfork safe */
410PERLVAR(I, Cmd, char *) /* stuff to free from do_aexec, vfork safe */
00accf8d
NC
411/* Elements in this array have ';' appended and are injected as a single line
412 into the tokeniser. You can't put any (literal) newlines into any program
413 you stuff in into this array, as the point where it's injected is expecting
414 a single physical line. */
115ff745
NC
415PERLVAR(I, preambleav, AV *)
416PERLVAR(I, mess_sv, SV *)
417PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
71eebe1e 418/* statics moved here for shared library purposes */
115ff745
NC
419PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
420PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
421PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
422PERLVARI(I, laststype, U16, OP_STAT)
423PERLVARI(I, laststatval, int, -1)
d4cce5f1 424
4b556e6c 425/* interpreter atexit processing */
115ff745
NC
426PERLVARI(I, exitlistlen, I32, 0) /* length of same */
427PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
cb68f92d 428 /* list of exit functions */
954c1994
GS
429
430/*
431=for apidoc Amn|HV*|PL_modglobal
432
7889fe52 433C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 434extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
435In a pinch, it can also be used as a symbol table for extensions
436to share data among each other. It is a good idea to use keys
954c1994
GS
437prefixed by the package name of the extension that owns the data.
438
439=cut
440*/
441
115ff745 442PERLVAR(I, modglobal, HV *) /* per-interp module data */
cb68f92d
GS
443
444/* these used to be in global before 5.004_68 */
115ff745 445PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d 446
115ff745 447PERLVAR(I, compiling, COP) /* compiling/done executing marker */
cb68f92d 448
115ff745
NC
449PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
450PERLVAR(I, comppad, AV *) /* storage for lexically scoped temporaries */
451PERLVAR(I, comppad_name, AV *) /* variable names for "my" variables */
452PERLVAR(I, comppad_name_fill, I32) /* last "introduced" variable offset */
453PERLVAR(I, comppad_name_floor, I32) /* start of vars in innermost block */
4b556e6c
JD
454
455#ifdef HAVE_INTERP_INTERN
115ff745 456PERLVAR(I, sys_intern, struct interp_intern)
cb68f92d 457 /* platform internals */
4b556e6c
JD
458#endif
459
7fae4e64 460/* more statics moved here */
115ff745
NC
461PERLVAR(I, DBcv, CV *) /* from perl.c */
462PERLVARI(I, generation, int, 100) /* from op.c */
56953603 463
115ff745
NC
464PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
465PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
466PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
467PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 468
115ff745
NC
469PERLVAR(I, uid, Uid_t) /* current real user id */
470PERLVAR(I, euid, Uid_t) /* current effective user id */
471PERLVAR(I, gid, Gid_t) /* current real group id */
472PERLVAR(I, egid, Gid_t) /* current effective group id */
473PERLVARI(I, an, U32, 0) /* malloc sequence number */
be2b6a89
DM
474
475#ifdef DEBUGGING
476 /* exercise wrap-around */
477 #define PERL_COP_SEQMAX (U32_MAX-50)
478#else
479 #define PERL_COP_SEQMAX 0
480#endif
115ff745 481PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
be2b6a89
DM
482#undef PERL_COP_SEQMAX
483
115ff745
NC
484PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
485PERLVAR(I, origalen, U32)
486PERLVAR(I, origenviron, char **)
ca0c25f6 487#ifdef PERL_USES_PL_PIDSTATUS
115ff745 488PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 489#endif
115ff745 490PERLVAR(I, osname, char *) /* operating system */
5c728af0 491
115ff745 492PERLVAR(I, sighandlerp, Sighandler_t)
0672f40e 493
115ff745 494PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 495
115ff745 496PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
0672f40e 497
115ff745 498PERLVARI(I, maxo, int, MAXO) /* maximum number of ops */
9f7da6d5 499
115ff745 500PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
0672f40e 501
954c1994
GS
502/*
503=for apidoc Amn|SV|PL_sv_undef
504This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
505
506=for apidoc Amn|SV|PL_sv_no
507This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
508C<&PL_sv_no>.
509
510=for apidoc Amn|SV|PL_sv_yes
511This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
512C<&PL_sv_yes>.
513
514=cut
515*/
516
115ff745
NC
517PERLVAR(I, sv_undef, SV)
518PERLVAR(I, sv_no, SV)
519PERLVAR(I, sv_yes, SV)
0672f40e 520
115ff745 521PERLVAR(I, subname, SV *) /* name of current subroutine */
0672f40e 522
115ff745
NC
523PERLVAR(I, subline, I32) /* line this subroutine began on */
524PERLVAR(I, min_intro_pending, I32) /* start of vars to introduce */
d95e864f 525
115ff745
NC
526PERLVAR(I, max_intro_pending, I32) /* end of vars to introduce */
527PERLVAR(I, padix, I32) /* max used index in current "register" pad */
d95e864f 528
115ff745 529PERLVAR(I, padix_floor, I32) /* how low may inner block reset padix */
0672f40e 530
115ff745 531PERLVAR(I, hints, U32) /* pragma-tic compile-time flags */
0672f40e 532
115ff745 533PERLVAR(I, debug, VOL U32) /* flags given to -D switch */
0672f40e 534
f0cb02e3 535/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
115ff745 536PERLVARI(I, breakable_sub_gen, U32, 0)
f0cb02e3 537
115ff745 538PERLVARI(I, amagic_generation, long, 0)
0672f40e
GS
539
540#ifdef USE_LOCALE_COLLATE
115ff745
NC
541PERLVAR(I, collation_name, char *) /* Name of current collation */
542PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm() */
543PERLVARI(I, collxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
544PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */
545PERLVARI(I, collation_standard, bool, TRUE)
9f7da6d5 546 /* Assume simple collation */
0672f40e
GS
547#endif /* USE_LOCALE_COLLATE */
548
9f7da6d5 549
edd11d75 550#if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
95ca8690 551# define PERL___I -1
9f7da6d5 552#else
7cd91da4 553# define PERL___I 1
9f7da6d5 554#endif
115ff745 555PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
95ca8690
DM
556#undef PERL___I
557
9f7da6d5 558
0672f40e
GS
559#ifdef USE_LOCALE_NUMERIC
560
115ff745 561PERLVARI(I, numeric_standard, bool, TRUE)
0672f40e 562 /* Assume simple numerics */
115ff745 563PERLVARI(I, numeric_local, bool, TRUE)
0672f40e 564 /* Assume local numerics */
115ff745
NC
565PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
566PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */
f8115845 567
0672f40e
GS
568#endif /* !USE_LOCALE_NUMERIC */
569
570/* utf8 character classes */
115ff745 571PERLVAR(I, utf8_alnum, SV *)
115ff745
NC
572PERLVAR(I, utf8_alpha, SV *)
573PERLVAR(I, utf8_space, SV *)
115ff745
NC
574PERLVAR(I, utf8_graph, SV *)
575PERLVAR(I, utf8_digit, SV *)
576PERLVAR(I, utf8_upper, SV *)
577PERLVAR(I, utf8_lower, SV *)
578PERLVAR(I, utf8_print, SV *)
579PERLVAR(I, utf8_punct, SV *)
580PERLVAR(I, utf8_xdigit, SV *)
581PERLVAR(I, utf8_mark, SV *)
582PERLVAR(I, utf8_X_begin, SV *)
583PERLVAR(I, utf8_X_extend, SV *)
584PERLVAR(I, utf8_X_prepend, SV *)
585PERLVAR(I, utf8_X_non_hangul, SV *)
586PERLVAR(I, utf8_X_L, SV *)
587PERLVAR(I, utf8_X_LV, SV *)
588PERLVAR(I, utf8_X_LVT, SV *)
589PERLVAR(I, utf8_X_T, SV *)
590PERLVAR(I, utf8_X_V, SV *)
591PERLVAR(I, utf8_X_LV_LVT_V, SV *)
592PERLVAR(I, utf8_toupper, SV *)
593PERLVAR(I, utf8_totitle, SV *)
594PERLVAR(I, utf8_tolower, SV *)
595PERLVAR(I, utf8_tofold, SV *)
596PERLVAR(I, last_swash_hv, HV *)
597PERLVAR(I, last_swash_tmps, U8 *)
598PERLVAR(I, last_swash_slen, STRLEN)
599PERLVARA(I, last_swash_key,10, U8)
600PERLVAR(I, last_swash_klen, U8) /* Only needs to store 0-10 */
d95e864f
NC
601
602#ifdef FCRYPT
115ff745 603PERLVARI(I, cryptseen, bool, FALSE) /* has fast crypt() been initialized? */
d95e864f
NC
604#endif
605
115ff745 606PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
49947b44 607
115ff745 608PERLVARI(I, glob_index, int, 0)
d95e864f 609
0672f40e 610
115ff745 611PERLVAR(I, parser, yy_parser *) /* current parser state */
12fbd33b 612
c4a30c8c
NC
613/* Array of signal handlers, indexed by signal number, through which the C
614 signal handler dispatches. */
115ff745 615PERLVAR(I, psig_ptr, SV **)
c4a30c8c 616/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
617 argument to a signal handler. Only one block of memory is allocated for
618 both psig_name and psig_ptr. */
115ff745 619PERLVAR(I, psig_name, SV **)
1d7c1841 620
c5be433b 621#if defined(PERL_IMPLICIT_SYS)
115ff745
NC
622PERLVAR(I, Mem, struct IPerlMem *)
623PERLVAR(I, MemShared, struct IPerlMem *)
624PERLVAR(I, MemParse, struct IPerlMem *)
625PERLVAR(I, Env, struct IPerlEnv *)
626PERLVAR(I, StdIO, struct IPerlStdIO *)
627PERLVAR(I, LIO, struct IPerlLIO *)
628PERLVAR(I, Dir, struct IPerlDir *)
629PERLVAR(I, Sock, struct IPerlSock *)
630PERLVAR(I, Proc, struct IPerlProc *)
76e3520e 631#endif
1d7c1841 632
115ff745
NC
633PERLVAR(I, ptr_table, PTR_TBL_t *)
634PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
f180df80 635
115ff745 636PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
93e68bfb 637
d95e864f 638
1fcf4c12 639#if defined(USE_ITHREADS)
115ff745 640PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
e6853197 641 regex_padav */
115ff745 642PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
e6853197 643 values in op_pmoffset of pmop.
402d2eb1
NC
644 Entry 0 is an SV whose PV is a
645 "packed" list of IVs listing
e6853197 646 the now-free slots in the array */
1fcf4c12
AB
647#endif
648
ea68fd67 649#ifdef USE_REENTRANT_API
115ff745 650PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
f5a82810
JH
651#endif
652
115ff745
NC
653PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
654PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
19e8ce8e 655
a1ea730d 656#ifdef PERLIO_LAYERS
115ff745
NC
657PERLVARI(I, perlio, PerlIOl *, NULL)
658PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
659PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
a1ea730d
NIS
660#endif
661
115ff745 662PERLVARI(I, encoding, SV *, NULL) /* character encoding */
0a378802 663
115ff745 664PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
ce333219 665
115ff745
NC
666PERLVAR(I, utf8_idstart, SV *)
667PERLVAR(I, utf8_idcont, SV *)
668PERLVAR(I, utf8_xidstart, SV *)
b6912c02 669PERLVAR(I, utf8_perl_idstart, SV *)
115ff745 670PERLVAR(I, utf8_xidcont, SV *)
82686b01 671
115ff745 672PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
147f47de 673
115ff745
NC
674PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
675PERLVARI(I, unitcheckav_save, AV *, NULL)
676 /* save UNITCHECK{}s when compiling */
ece599bd 677
115ff745 678PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
5311654c 679
115ff745 680PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
9f7da6d5 681
15a5279a 682/* Hooks to shared SVs and locks. */
115ff745
NC
683PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
684PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
685#ifdef NO_MATHOMS
686# define PERL_UNLOCK_HOOK Perl_sv_nosharing
687#else
688/* This reference ensures that the mathoms are linked with perl */
689# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
690#endif
115ff745 691PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 692
115ff745 693PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 694
9e08d3a4 695/* Can shared object be destroyed */
115ff745 696PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
9e08d3a4 697
01d65469 698#ifndef PERL_MICRO
115ff745 699PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 700#endif
92f022bb 701
115ff745 702PERLVARI(I, hash_seed, UV, 0) /* Hash initializer */
504f80c1 703
115ff745 704PERLVARI(I, rehash_seed, UV, 0) /* 582 hash initializer */
4b5190b5 705
115ff745 706PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
f16dd614 707
9e08d3a4
NC
708/* Register of known Method Resolution Orders.
709 What this actually points to is an implementation detail (it may change to
710 a structure incorporating a reference count - use mro_get_from_name to
711 retrieve a C<struct mro_alg *> */
115ff745 712PERLVAR(I, registered_mros, HV *)
9e08d3a4
NC
713
714/* Compile-time block start/end hooks */
115ff745 715PERLVAR(I, blockhooks, AV *)
9e08d3a4
NC
716
717/* Everything that folds to a given character, for case insensitivity regex
718 * matching */
115ff745 719PERLVARI(I, utf8_foldclosures, HV *, NULL)
9e08d3a4
NC
720
721/* List of characters that participate in folds (except marks, etc in
722 * multi-char folds) */
115ff745 723PERLVARI(I, utf8_foldable, SV *, NULL)
9e08d3a4 724
115ff745 725PERLVAR(I, custom_ops, HV *) /* custom op registrations */
9e08d3a4 726
d67594ff
FC
727/* Hook for File::Glob */
728PERLVARI(I, globhook, globhook_t, NULL)
729
115ff745 730PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
30b0736d 731
ffee3ff6
NC
732/* The last unconditional member of the interpreter structure when 5.10.0 was
733 released. The offset of the end of this is baked into a global variable in
734 any shared perl library which will allow a sanity test in future perl
735 releases. */
30b0736d 736#define PERL_LAST_5_16_0_INTERP_MEMBER Ireentrant_retint
ffee3ff6 737
f16dd614 738#ifdef PERL_IMPLICIT_CONTEXT
115ff745
NC
739PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
740PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
ba6d381e 741# ifdef PERL_GLOBAL_STRUCT_PRIVATE
115ff745 742PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
ba6d381e 743# endif
f16dd614
DM
744#endif
745
7cb608b5
NC
746#ifdef PERL_TRACK_MEMPOOL
747/* For use with the memory debugging code in util.c */
115ff745 748PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
7cb608b5
NC
749#endif
750
ba6d381e
NC
751#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
752/* File descriptor to talk to the child which dumps scalars. */
115ff745 753PERLVARI(I, dumper_fd, int, -1)
ba6d381e
NC
754#endif
755
756/* Stores the PPID */
757#ifdef THREADS_HAVE_PIDS
115ff745 758PERLVARI(I, ppid, IV, 0)
ba6d381e
NC
759#endif
760
761#ifdef PERL_MAD
115ff745 762PERLVARI(I, madskills, bool, FALSE) /* preserve all syntactic info */
ba6d381e 763 /* (MAD = Misc Attribute Decoration) */
115ff745 764PERLVARI(I, xmlfp, PerlIO *, NULL)
ba6d381e
NC
765#endif
766
767#ifdef PL_OP_SLAB_ALLOC
115ff745
NC
768PERLVAR(I, OpPtr, I32 **)
769PERLVARI(I, OpSpace, I32, 0)
770PERLVAR(I, OpSlab, I32 *)
ba6d381e
NC
771#endif
772
f1fac472 773#ifdef PERL_DEBUG_READONLY_OPS
115ff745
NC
774PERLVARI(I, slabs, I32**, NULL) /* Array of slabs that have been allocated */
775PERLVARI(I, slab_count, U32, 0) /* Size of the array */
f1fac472
NC
776#endif
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
157b3822
NC
782/* If you are adding a U8 or U16, check to see if there are 'Space' comments
783 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
784
785/* Within a stable branch, new variables must be added to the very end, before
786 * this comment, for binary compatibility (the offsets of the old members must
787 * not change).
b83cd129 788 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 789 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
790 * irrelevant, but not all code may be expected to #include XSUB.h.
791 */