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