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