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