Bump Devel::PPPort to keep in sync with CPAN
[perl.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 #ifdef MULTIPLICITY
171 PERLVAR(I, sv_yes,      SV)
172 PERLVAR(I, sv_undef,    SV)
173 PERLVAR(I, sv_no,       SV)
174 PERLVAR(I, sv_zero,     SV)
175 #else
176 /* store the immortals as an array to ensure they are contiguous in
177  * memory: makes SvIMMORTAL_INTERP(sv) possible */
178 PERLVARA(I, sv_immortals, 4, SV)
179 #endif
180
181 PERLVAR(I, padname_undef,       PADNAME)
182 PERLVAR(I, padname_const,       PADNAME)
183 PERLVAR(I, Sv,          SV *)           /* used to hold temporary values */
184
185 PERLVAR(I, parser,      yy_parser *)    /* current parser state */
186
187 PERLVAR(I, stashcache,  HV *)           /* Cache to speed up S_method_common */
188
189
190 /*
191 =for apidoc Amn|STRLEN|PL_na
192
193 A convenience variable which is typically used with C<SvPV> when one
194 doesn't care about the length of the string.  It is usually more efficient
195 to either declare a local variable and use that instead or to use the
196 C<SvPV_nolen> macro.
197
198 =cut
199 */
200
201 PERLVAR(I, na,          STRLEN)         /* for use in SvPV when length is
202                                            Not Applicable */
203
204 /* stat stuff */
205 PERLVAR(I, statcache,   Stat_t)         /* _ */
206 PERLVAR(I, statgv,      GV *)
207 PERLVARI(I, statname,   SV *,   NULL)
208
209 /*
210 =for apidoc mn|SV*|PL_rs
211
212 The input record separator - C<$/> in Perl space.
213
214 =for apidoc mn|GV*|PL_last_in_gv
215
216 The GV which was last used for a filehandle input operation.  (C<< <FH> >>)
217
218 =for apidoc mn|GV*|PL_ofsgv
219
220 The glob containing the output field separator - C<*,> in Perl space.
221
222 =cut
223 */
224
225 PERLVAR(I, rs,          SV *)           /* input record separator $/ */
226 PERLVAR(I, last_in_gv,  GV *)           /* GV used in last <FH> */
227 PERLVAR(I, ofsgv,       GV *)           /* GV of output field separator *, */
228 PERLVAR(I, defoutgv,    GV *)           /* default FH for output */
229 PERLVARI(I, chopset,    const char *, " \n-")   /* $: */
230 PERLVAR(I, formtarget,  SV *)
231 PERLVAR(I, bodytarget,  SV *)
232 PERLVAR(I, toptarget,   SV *)
233
234
235 PERLVAR(I, restartop,   OP *)           /* propagating an error from croak? */
236 PERLVAR(I, restartjmpenv, JMPENV *)     /* target frame for longjmp in die */
237
238 PERLVAR(I, top_env,     JMPENV *)       /* ptr to current sigjmp environment */
239 PERLVAR(I, start_env,   JMPENV)         /* empty startup sigjmp environment */
240 PERLVARI(I, errors,     SV *,   NULL)   /* outstanding queued errors */
241
242 /* statics "owned" by various functions */
243 PERLVAR(I, hv_fetch_ent_mh, HE*)        /* owned by hv_fetch_ent() */
244
245 PERLVAR(I, lastgotoprobe, OP*)          /* from pp_ctl.c */
246
247 /* sort stuff */
248 PERLVAR(I, sortcop,     OP *)           /* user defined sort routine */
249 PERLVAR(I, sortstash,   HV *)           /* which is in some package or other */
250 PERLVAR(I, firstgv,     GV *)           /* $a */
251 PERLVAR(I, secondgv,    GV *)           /* $b */
252
253 /* float buffer */
254 PERLVAR(I, efloatbuf,   char *)
255 PERLVAR(I, efloatsize,  STRLEN)
256
257 PERLVARI(I, dumpindent, U16,    4)      /* number of blanks per dump
258                                            indentation level */
259
260 PERLVAR(I, exit_flags,  U8)             /* was exit() unexpected, etc. */
261
262 PERLVAR(I, utf8locale,  bool)           /* utf8 locale detected */
263 PERLVAR(I, in_utf8_CTYPE_locale, bool)
264 PERLVAR(I, in_utf8_COLLATE_locale, bool)
265 PERLVAR(I, in_utf8_turkic_locale, bool)
266 #if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
267 PERLVARI(I, lc_numeric_mutex_depth, int, 0)   /* Emulate general semaphore */
268 #endif
269 PERLVARA(I, locale_utf8ness, 256, char)
270
271 #ifdef USE_LOCALE_CTYPE
272     PERLVAR(I, warn_locale, SV *)
273 #endif
274
275 PERLVARA(I, colors,6,   char *)         /* values from PERL_RE_COLORS env var */
276
277 /*
278 =for apidoc Amn|peep_t|PL_peepp
279
280 Pointer to the per-subroutine peephole optimiser.  This is a function
281 that gets called at the end of compilation of a Perl subroutine (or
282 equivalently independent piece of Perl code) to perform fixups of
283 some ops and to perform small-scale optimisations.  The function is
284 called once for each subroutine that is compiled, and is passed, as sole
285 parameter, a pointer to the op that is the entry point to the subroutine.
286 It modifies the op tree in place.
287
288 The peephole optimiser should never be completely replaced.  Rather,
289 add code to it by wrapping the existing optimiser.  The basic way to do
290 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
291 If the new code wishes to operate on ops throughout the subroutine's
292 structure, rather than just at the top level, it is likely to be more
293 convenient to wrap the L</PL_rpeepp> hook.
294
295 =cut
296 */
297
298 PERLVARI(I, peepp,      peep_t, Perl_peep)
299
300 /*
301 =for apidoc Amn|peep_t|PL_rpeepp
302
303 Pointer to the recursive peephole optimiser.  This is a function
304 that gets called at the end of compilation of a Perl subroutine (or
305 equivalently independent piece of Perl code) to perform fixups of some
306 ops and to perform small-scale optimisations.  The function is called
307 once for each chain of ops linked through their C<op_next> fields;
308 it is recursively called to handle each side chain.  It is passed, as
309 sole parameter, a pointer to the op that is at the head of the chain.
310 It modifies the op tree in place.
311
312 The peephole optimiser should never be completely replaced.  Rather,
313 add code to it by wrapping the existing optimiser.  The basic way to do
314 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
315 If the new code wishes to operate only on ops at a subroutine's top level,
316 rather than throughout the structure, it is likely to be more convenient
317 to wrap the L</PL_peepp> hook.
318
319 =cut
320 */
321
322 PERLVARI(I, rpeepp,     peep_t, Perl_rpeep)
323
324 /*
325 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
326
327 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.
328 This allows extensions to free any extra attribute they have locally attached to an OP.
329 It is also assured to first fire for the parent OP and then for its kids.
330
331 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.
332
333 =cut
334 */
335
336 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
337
338 PERLVARI(I, watchaddr,  char **, 0)
339 PERLVAR(I, watchok,     char *)
340
341 PERLVAR(I, perldb,      U32)
342
343 PERLVAR(I, signals,     U32)    /* Using which pre-5.8 signals */
344
345 PERLVAR(I, reentrant_retint, int)       /* Integer return value from reentrant functions */
346
347 /* pseudo environmental stuff */
348 PERLVAR(I, origargc,    int)
349 PERLVAR(I, origargv,    char **)
350 PERLVAR(I, envgv,       GV *)
351 PERLVAR(I, incgv,       GV *)
352 PERLVAR(I, hintgv,      GV *)
353 PERLVAR(I, origfilename, char *)
354 PERLVARI(I, xsubfilename, const char *, NULL)
355 PERLVAR(I, diehook,     SV *)
356 PERLVAR(I, warnhook,    SV *)
357
358 /* switches */
359 PERLVAR(I, patchlevel,  SV *)
360 PERLVAR(I, localpatches, const char * const *)
361 PERLVARI(I, splitstr,   const char *, " ")
362
363 PERLVAR(I, minus_c,     bool)
364 PERLVAR(I, minus_n,     bool)
365 PERLVAR(I, minus_p,     bool)
366 PERLVAR(I, minus_l,     bool)
367 PERLVAR(I, minus_a,     bool)
368 PERLVAR(I, minus_F,     bool)
369 PERLVAR(I, doswitches,  bool)
370 PERLVAR(I, minus_E,     bool)
371
372 PERLVAR(I, inplace,     char *)
373 PERLVAR(I, e_script,    SV *)
374
375 PERLVAR(I, basetime,    Time_t)         /* $^T */
376
377 PERLVARI(I, maxsysfd,   I32,    MAXSYSFD)
378                                         /* top fd to pass to subprocesses */
379 PERLVAR(I, statusvalue, I32)            /* $? */
380 #ifdef VMS
381 PERLVAR(I, statusvalue_vms, U32)
382 #else
383 PERLVAR(I, statusvalue_posix, I32)
384 #endif
385
386 PERLVARI(I, sig_pending, int, 0)        /* Number if highest signal pending */
387 PERLVAR(I, psig_pend, int *)            /* per-signal "count" of pending */
388
389 /* shortcuts to various I/O objects */
390 PERLVAR(I, stdingv,     GV *)           /*  *STDIN      */
391 PERLVAR(I, stderrgv,    GV *)           /*  *STDERR     */
392 PERLVAR(I, argvgv,      GV *)           /*  *ARGV       */
393 PERLVAR(I, argvoutgv,   GV *)           /*  *ARGVOUT    */
394 PERLVAR(I, argvout_stack, AV *)
395
396 /* shortcuts to regexp stuff */
397 PERLVAR(I, replgv,      GV *)           /*  *^R         */
398
399 /* shortcuts to misc objects */
400 PERLVAR(I, errgv,       GV *)           /*  *@          */
401
402 /* shortcuts to debugging objects */
403 PERLVAR(I, DBgv,        GV *)           /*  *DB::DB     */
404 PERLVAR(I, DBline,      GV *)           /*  *DB::line   */
405
406 /*
407 =for apidoc mn|GV *|PL_DBsub
408 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
409 the SV which holds the name of the sub being debugged.  This is the C
410 variable which corresponds to Perl's $DB::sub variable.  See
411 C<L</PL_DBsingle>>.
412
413 =for apidoc mn|SV *|PL_DBsingle
414 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
415 boolean which indicates whether subs are being single-stepped.
416 Single-stepping is automatically turned on after every step.  This is the C
417 variable which corresponds to Perl's $DB::single variable.  See
418 C<L</PL_DBsub>>.
419
420 =for apidoc mn|SV *|PL_DBtrace
421 Trace variable used when Perl is run in debugging mode, with the B<-d>
422 switch.  This is the C variable which corresponds to Perl's $DB::trace
423 variable.  See C<L</PL_DBsingle>>.
424
425 =cut
426 */
427
428 PERLVAR(I, DBsub,       GV *)           /*  *DB::sub    */
429 PERLVAR(I, DBsingle,    SV *)           /*  $DB::single */
430 PERLVAR(I, DBtrace,     SV *)           /*  $DB::trace  */
431 PERLVAR(I, DBsignal,    SV *)           /*  $DB::signal */
432 PERLVAR(I, dbargs,      AV *)           /* args to call listed by caller function */
433
434 PERLVARA(I, DBcontrol,    DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
435
436 /* symbol tables */
437 PERLVAR(I, debstash,    HV *)           /* symbol table for perldb package */
438 PERLVAR(I, globalstash, HV *)           /* global keyword overrides imported here */
439 PERLVAR(I, curstname,   SV *)           /* name of current package */
440 PERLVAR(I, beginav,     AV *)           /* names of BEGIN subroutines */
441 PERLVAR(I, endav,       AV *)           /* names of END subroutines */
442 PERLVAR(I, unitcheckav, AV *)           /* names of UNITCHECK subroutines */
443 PERLVAR(I, checkav,     AV *)           /* names of CHECK subroutines */
444 PERLVAR(I, initav,      AV *)           /* names of INIT subroutines */
445
446 /* subprocess state */
447 PERLVAR(I, fdpid,       AV *)           /* keep fd-to-pid mappings for my_popen */
448
449 /* internal state */
450 PERLVARI(I, op_mask,    char *, NULL)   /* masked operations for safe evals */
451
452 /* current interpreter roots */
453 PERLVAR(I, main_cv,     CV *)
454 PERLVAR(I, main_root,   OP *)
455 PERLVAR(I, main_start,  OP *)
456 PERLVAR(I, eval_root,   OP *)
457 PERLVAR(I, eval_start,  OP *)
458
459 /* runtime control stuff */
460 PERLVARI(I, curcopdb,   COP *,  NULL)
461
462 PERLVAR(I, filemode,    int)            /* so nextargv() can preserve mode */
463 PERLVAR(I, lastfd,      int)            /* what to preserve mode on */
464 PERLVAR(I, oldname,     char *)         /* what to preserve mode on */
465 /* Elements in this array have ';' appended and are injected as a single line
466    into the tokeniser. You can't put any (literal) newlines into any program
467    you stuff in into this array, as the point where it's injected is expecting
468    a single physical line. */
469 PERLVAR(I, preambleav,  AV *)
470 PERLVAR(I, mess_sv,     SV *)
471 PERLVAR(I, ors_sv,      SV *)           /* output record separator $\ */
472
473 /* funky return mechanisms */
474 PERLVAR(I, forkprocess, int)            /* so do_open |- can return proc# */
475
476 /* statics moved here for shared library purposes */
477 PERLVARI(I, gensym,     I32,    0)      /* next symbol for getsym() to define */
478 PERLVARI(I, cv_has_eval, bool, FALSE)   /* PL_compcv includes an entereval or similar */
479 PERLVAR(I, taint_warn,  bool)           /* taint warns instead of dying */
480 PERLVARI(I, laststype,  U16,    OP_STAT)
481
482 PERLVARI(I, laststatval, int,   -1)
483
484 PERLVAR(I, modcount,    I32)            /* how much op_lvalue()ification in
485                                            assignment? */
486
487 /* interpreter atexit processing */
488 PERLVARI(I, exitlistlen, I32, 0)        /* length of same */
489 PERLVARI(I, exitlist,   PerlExitListEntry *, NULL)
490                                         /* list of exit functions */
491
492 /*
493 =for apidoc Amn|HV*|PL_modglobal
494
495 C<PL_modglobal> is a general purpose, interpreter global HV for use by
496 extensions that need to keep information on a per-interpreter basis.
497 In a pinch, it can also be used as a symbol table for extensions
498 to share data among each other.  It is a good idea to use keys
499 prefixed by the package name of the extension that owns the data.
500
501 =cut
502 */
503
504 PERLVAR(I, modglobal,   HV *)           /* per-interp module data */
505
506 /* these used to be in global before 5.004_68 */
507 PERLVARI(I, profiledata, U32 *, NULL)   /* table of ops, counts */
508
509 PERLVAR(I, compiling,   COP)            /* compiling/done executing marker */
510
511 PERLVAR(I, compcv,      CV *)           /* currently compiling subroutine */
512 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
513 PERLVAR(I, comppad_name_fill,   PADOFFSET)/* last "introduced" variable offset */
514 PERLVAR(I, comppad_name_floor,  PADOFFSET)/* start of vars in innermost block */
515
516 #ifdef HAVE_INTERP_INTERN
517 PERLVAR(I, sys_intern,  struct interp_intern)
518                                         /* platform internals */
519 #endif
520
521 /* more statics moved here */
522 PERLVAR(I, DBcv,        CV *)           /* from perl.c */
523 PERLVARI(I, generation, int,    100)    /* scan sequence# for OP_AASSIGN
524                                            compile-time common elem detection */
525
526 PERLVAR(I, unicode, U32)        /* Unicode features: $ENV{PERL_UNICODE} or -C */
527
528 PERLVARI(I, in_clean_objs,bool,    FALSE)       /* from sv.c */
529 PERLVARI(I, in_clean_all, bool,    FALSE)       /* ptrs to freed SVs now legal */
530 PERLVAR(I, nomemok,     bool)           /* let malloc context handle nomem */
531 PERLVARI(I, savebegin,  bool,   FALSE)  /* save BEGINs for compiler     */
532
533
534 PERLVAR(I, delaymagic_uid,      Uid_t)  /* current real user id, only for delaymagic */
535 PERLVAR(I, delaymagic_euid,     Uid_t)  /* current effective user id, only for delaymagic */
536 PERLVAR(I, delaymagic_gid,      Gid_t)  /* current real group id, only for delaymagic */
537 PERLVAR(I, delaymagic_egid,     Gid_t)  /* current effective group id, only for delaymagic */
538 PERLVARI(I, an,         U32,    0)      /* malloc sequence number */
539
540 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
541 PERLVARI(I, breakable_sub_gen, U32, 0)
542
543 #ifdef DEBUGGING
544     /* exercise wrap-around */
545     #define PERL_COP_SEQMAX (U32_MAX-50)
546 #else
547     #define PERL_COP_SEQMAX 0
548 #endif
549 PERLVARI(I, cop_seqmax, U32,    PERL_COP_SEQMAX) /* statement sequence number */
550 #undef PERL_COP_SEQMAX
551
552 PERLVARI(I, evalseq,    U32,    0)      /* eval sequence number */
553 PERLVAR(I, origalen,    U32)
554 PERLVAR(I, origenviron, char **)
555 #ifdef PERL_USES_PL_PIDSTATUS
556 PERLVAR(I, pidstatus,   HV *)           /* pid-to-status mappings for waitpid */
557 #endif
558 PERLVAR(I, osname,      char *)         /* operating system */
559
560 PERLVAR(I, sighandlerp, Sighandler_t)
561
562 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
563
564 PERLVAR(I, debug,       volatile U32)   /* flags given to -D switch */
565
566 PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
567
568 PERLVARI(I, runops,     runops_proc_t, RUNOPS_DEFAULT)
569
570 PERLVAR(I, subname,     SV *)           /* name of current subroutine */
571
572 PERLVAR(I, subline,     I32)            /* line this subroutine began on */
573 PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
574
575 PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
576 PERLVAR(I, padix,       PADOFFSET)      /* lowest unused index - 1
577                                            in current "register" pad */
578 PERLVAR(I, constpadix,  PADOFFSET)      /* lowest unused for constants */
579
580 PERLVAR(I, padix_floor, PADOFFSET)      /* how low may inner block reset padix */
581
582 #if defined(USE_POSIX_2008_LOCALE)          \
583  && defined(USE_THREAD_SAFE_LOCALE)         \
584  && ! defined(HAS_QUERYLOCALE)
585
586 PERLVARA(I, curlocales, 12, char *)
587
588 #endif
589 #ifdef USE_LOCALE_COLLATE
590
591 PERLVAR(I, collation_name, char *)      /* Name of current collation */
592 PERLVAR(I, collxfrm_base, Size_t)       /* Basic overhead in *xfrm() */
593 PERLVARI(I, collxfrm_mult,Size_t, 2)    /* Expansion factor in *xfrm() */
594 PERLVARI(I, collation_ix, U32,  0)      /* Collation generation index */
595 PERLVARI(I, strxfrm_NUL_replacement, U8, 0)  /* Code point to replace NULs */
596 PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
597                             /* Assume until proven otherwise that it works */
598 PERLVARI(I, strxfrm_max_cp, U8, 0)      /* Highest collating cp in locale */
599 PERLVARI(I, collation_standard, bool, TRUE)
600                                         /* Assume simple collation */
601 #endif /* USE_LOCALE_COLLATE */
602
603 PERLVARI(I, langinfo_buf, char *, NULL)
604 PERLVARI(I, langinfo_bufsize, Size_t, 0)
605 PERLVARI(I, setlocale_buf, char *, NULL)
606 PERLVARI(I, setlocale_bufsize, Size_t, 0)
607
608 #ifdef PERL_SAWAMPERSAND
609 PERLVAR(I, sawampersand, U8)            /* must save all match strings */
610 #endif
611
612 PERLVAR(I, unsafe,      bool)
613 PERLVAR(I, colorset,    bool)           /* PERL_RE_COLORS env var is in use */
614
615 /* current phase the interpreter is in
616    for ordering this structure to remove holes, we're assuming that this is 4
617    bytes.  */
618 PERLVARI(I, phase,      enum perl_phase, PERL_PHASE_CONSTRUCT)
619
620 PERLVARI(I, in_load_module, bool, FALSE)        /* to prevent recursions in PerlIO_find_layer */
621
622 /* This value may be set when embedding for full cleanup  */
623 /* 0=none, 1=full, 2=full with checks */
624 /* mod_perl is special, and also assigns a meaning -1 */
625 PERLVARI(I, perl_destruct_level, signed char,   0)
626
627 #ifdef USE_LOCALE_NUMERIC
628
629 PERLVARI(I, numeric_standard, int, TRUE)
630                                         /* Assume C locale numerics */
631 PERLVARI(I, numeric_underlying, bool, TRUE)
632                                         /* Assume underlying locale numerics */
633 PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
634 PERLVAR(I, numeric_name, char *)        /* Name of current numeric locale */
635 PERLVAR(I, numeric_radix_sv, SV *)      /* The radix separator if not '.' */
636
637 #  ifdef HAS_POSIX_2008_LOCALE
638
639 PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
640
641 #  endif
642 #endif /* !USE_LOCALE_NUMERIC */
643
644 /* utf8 character class swashes */
645 PERLVAR(I, seen_deprecated_macro, HV *)
646
647 PERLVAR(I, last_swash_hv, HV *)
648 PERLVAR(I, last_swash_tmps, U8 *)
649 PERLVAR(I, last_swash_slen, STRLEN)
650 PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
651 PERLVAR(I, last_swash_klen, U8)         /* Only needs to store 0-12  */
652
653 #ifdef FCRYPT
654 PERLVARI(I, cryptseen,  bool,   FALSE)  /* has fast crypt() been initialized? */
655 #else
656 /* One byte hole in the interpreter structure.  */
657 #endif
658
659 PERLVAR(I, pad_reset_pending, bool)     /* reset pad on next attempted alloc */
660 PERLVAR(I, srand_called, bool)
661
662 /* Array of signal handlers, indexed by signal number, through which the C
663    signal handler dispatches.  */
664 PERLVAR(I, psig_ptr,    SV **)
665 /* Array of names of signals, indexed by signal number, for (re)use as the first
666    argument to a signal handler.   Only one block of memory is allocated for
667    both psig_name and psig_ptr.  */
668 PERLVAR(I, psig_name,   SV **)
669
670 #if defined(PERL_IMPLICIT_SYS)
671 PERLVAR(I, Mem,         struct IPerlMem *)
672 PERLVAR(I, MemShared,   struct IPerlMem *)
673 PERLVAR(I, MemParse,    struct IPerlMem *)
674 PERLVAR(I, Env,         struct IPerlEnv *)
675 PERLVAR(I, StdIO,       struct IPerlStdIO *)
676 PERLVAR(I, LIO,         struct IPerlLIO *)
677 PERLVAR(I, Dir,         struct IPerlDir *)
678 PERLVAR(I, Sock,        struct IPerlSock *)
679 PERLVAR(I, Proc,        struct IPerlProc *)
680 #endif
681
682 PERLVAR(I, ptr_table,   PTR_TBL_t *)
683 PERLVARI(I, beginav_save, AV *, NULL)   /* save BEGIN{}s when compiling */
684
685 PERLVAR(I, body_arenas, void *)         /* pointer to list of body-arenas */
686
687
688 #if defined(USE_ITHREADS)
689 PERLVAR(I, regex_pad,     SV **)        /* Shortcut into the array of
690                                            regex_padav */
691 PERLVAR(I, regex_padav,   AV *)         /* All regex objects, indexed via the
692                                            values in op_pmoffset of pmop.
693                                            Entry 0 is an SV whose PV is a
694                                            "packed" list of IVs listing
695                                            the now-free slots in the array */
696 PERLVAR(I, stashpad,    HV **)          /* for CopSTASH */
697 PERLVARI(I, stashpadmax, PADOFFSET, 64)
698 PERLVARI(I, stashpadix, PADOFFSET, 0)
699 #endif
700
701 #ifdef USE_REENTRANT_API
702 PERLVAR(I, reentrant_buffer, REENTR *)  /* here we store the _r buffers */
703 #endif
704
705 PERLVAR(I, custom_op_names, HV *)       /* Names of user defined ops */
706 PERLVAR(I, custom_op_descs, HV *)       /* Descriptions of user defined ops */
707
708 #ifdef PERLIO_LAYERS
709 PERLVARI(I, perlio,     PerlIOl *, NULL)
710 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
711 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
712 #endif
713
714 PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
715
716 PERLVARI(I, checkav_save, AV *, NULL)   /* save CHECK{}s when compiling */
717 PERLVARI(I, unitcheckav_save, AV *, NULL)
718                                         /* save UNITCHECK{}s when compiling */
719
720 PERLVARI(I, clocktick,  long,   0)      /* this many times() ticks in a second */
721
722 /* Hooks to shared SVs and locks. */
723 PERLVARI(I, sharehook,  share_proc_t, Perl_sv_nosharing)
724 PERLVARI(I, lockhook,   share_proc_t, Perl_sv_nosharing)
725 #ifdef NO_MATHOMS
726 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
727 #else
728 /* This reference ensures that the mathoms are linked with perl */
729 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
730 #endif
731 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
732
733 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
734
735 /* Can shared object be destroyed */
736 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
737
738 #ifndef PERL_MICRO
739 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
740 #endif
741
742 PERLVARI(I, isarev, HV *, NULL)         /* Reverse map of @ISA dependencies */
743
744 /* Register of known Method Resolution Orders.
745    What this actually points to is an implementation detail (it may change to
746    a structure incorporating a reference count - use mro_get_from_name to
747    retrieve a C<struct mro_alg *>  */
748 PERLVAR(I, registered_mros, HV *)
749
750 /* Compile-time block start/end hooks */
751 PERLVAR(I, blockhooks,  AV *)
752
753 PERLVAR(I, custom_ops,  HV *)           /* custom op registrations */
754
755 PERLVAR(I, Xpv,         XPV *)          /* (unused) held temporary value */
756
757 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
758    present always, as -DDEBUGGING must be binary compatible with non.  */
759 PERLVARI(I, scopestack_name, const char * *, NULL)
760
761 PERLVAR(I, debug_pad,   struct perl_debug_pad)  /* always needed because of the re extension */
762
763 /* Hook for File::Glob */
764 PERLVARI(I, globhook,   globhook_t, NULL)
765
766 /* The last unconditional member of the interpreter structure when 5.18.0 was
767    released. The offset of the end of this is baked into a global variable in 
768    any shared perl library which will allow a sanity test in future perl
769    releases.  */
770 #define PERL_LAST_5_18_0_INTERP_MEMBER  Iglobhook
771
772 #ifdef PERL_IMPLICIT_CONTEXT
773 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
774 PERLVARI(I, my_cxt_size, int,   0)      /* size of PL_my_cxt_list */
775 #endif
776
777 #if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
778 /* For use with the memory debugging code in util.c. This is used only in
779  * DEBUGGING builds (as long as the relevant structure is defined), but
780  * defining it in non-debug builds too means that we retain binary
781  * compatibility between otherwise-compatible plain and debug builds. */
782 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
783 #endif
784
785 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
786 /* File descriptor to talk to the child which dumps scalars.  */
787 PERLVARI(I, dumper_fd,  int,    -1)
788 #endif
789
790
791 #ifdef DEBUG_LEAKING_SCALARS
792 PERLVARI(I, sv_serial,  U32,    0)      /* SV serial number, used in sv.c */
793 #endif
794
795 PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*)    /* constant SVs with precomputed hash value */
796
797 #ifdef PERL_TRACE_OPS
798 PERLVARA(I, op_exec_cnt, OP_max+2, UV)  /* Counts of executed OPs of the given type.
799                                            If PERL_TRACE_OPS is enabled, we'll dump
800                                            a summary count of all ops executed in the
801                                            program at perl_destruct time. For
802                                            profiling/debugging only. Works only if
803                                            DEBUGGING is enabled, too. */
804 #endif
805
806 PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
807
808 PERLVARI(I, dump_re_max_len, STRLEN, 60)
809
810 /* For internal uses of randomness, this ensures the sequence of
811  * random numbers returned by rand() isn't modified by perl's internal
812  * use of randomness.
813  * This is important if the user has called srand() with a seed.
814  */
815
816 PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
817
818 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
819  * above on where there are gaps which currently will be structure padding.  */
820
821 /* Within a stable branch, new variables must be added to the very end, before
822  * this comment, for binary compatibility (the offsets of the old members must
823  *  not change).
824  * (Don't forget to add your variable also to perl_clone()!)
825  * XSUB.h provides wrapper functions via perlapi.h that make this
826  * irrelevant, but not all code may be expected to #include XSUB.h.
827  */