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