fix typo in Artistic
[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 #if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
266 PERLVARI(I, lc_numeric_mutex_depth, int, 0)   /* Emulate general semaphore */
267 #endif
268 PERLVARA(I, locale_utf8ness, 256, char)
269
270 #ifdef USE_LOCALE_CTYPE
271     PERLVAR(I, warn_locale, SV *)
272 #endif
273
274 PERLVARA(I, colors,6,   char *)         /* values from PERL_RE_COLORS env var */
275
276 /*
277 =for apidoc Amn|peep_t|PL_peepp
278
279 Pointer to the per-subroutine peephole optimiser.  This is a function
280 that gets called at the end of compilation of a Perl subroutine (or
281 equivalently independent piece of Perl code) to perform fixups of
282 some ops and to perform small-scale optimisations.  The function is
283 called once for each subroutine that is compiled, and is passed, as sole
284 parameter, a pointer to the op that is the entry point to the subroutine.
285 It modifies the op tree in place.
286
287 The peephole optimiser should never be completely replaced.  Rather,
288 add code to it by wrapping the existing optimiser.  The basic way to do
289 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
290 If the new code wishes to operate on ops throughout the subroutine's
291 structure, rather than just at the top level, it is likely to be more
292 convenient to wrap the L</PL_rpeepp> hook.
293
294 =cut
295 */
296
297 PERLVARI(I, peepp,      peep_t, Perl_peep)
298
299 /*
300 =for apidoc Amn|peep_t|PL_rpeepp
301
302 Pointer to the recursive peephole optimiser.  This is a function
303 that gets called at the end of compilation of a Perl subroutine (or
304 equivalently independent piece of Perl code) to perform fixups of some
305 ops and to perform small-scale optimisations.  The function is called
306 once for each chain of ops linked through their C<op_next> fields;
307 it is recursively called to handle each side chain.  It is passed, as
308 sole parameter, a pointer to the op that is at the head of the chain.
309 It modifies the op tree in place.
310
311 The peephole optimiser should never be completely replaced.  Rather,
312 add code to it by wrapping the existing optimiser.  The basic way to do
313 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
314 If the new code wishes to operate only on ops at a subroutine's top level,
315 rather than throughout the structure, it is likely to be more convenient
316 to wrap the L</PL_peepp> hook.
317
318 =cut
319 */
320
321 PERLVARI(I, rpeepp,     peep_t, Perl_rpeep)
322
323 /*
324 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
325
326 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.
327 This allows extensions to free any extra attribute they have locally attached to an OP.
328 It is also assured to first fire for the parent OP and then for its kids.
329
330 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.
331
332 =cut
333 */
334
335 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
336
337 PERLVARI(I, watchaddr,  char **, 0)
338 PERLVAR(I, watchok,     char *)
339
340 PERLVAR(I, perldb,      U32)
341
342 PERLVAR(I, signals,     U32)    /* Using which pre-5.8 signals */
343
344 PERLVAR(I, reentrant_retint, int)       /* Integer return value from reentrant functions */
345
346 /* pseudo environmental stuff */
347 PERLVAR(I, origargc,    int)
348 PERLVAR(I, origargv,    char **)
349 PERLVAR(I, envgv,       GV *)
350 PERLVAR(I, incgv,       GV *)
351 PERLVAR(I, hintgv,      GV *)
352 PERLVAR(I, origfilename, char *)
353 PERLVARI(I, xsubfilename, const char *, NULL)
354 PERLVAR(I, diehook,     SV *)
355 PERLVAR(I, warnhook,    SV *)
356
357 /* switches */
358 PERLVAR(I, patchlevel,  SV *)
359 PERLVAR(I, localpatches, const char * const *)
360 PERLVARI(I, splitstr,   const char *, " ")
361
362 PERLVAR(I, minus_c,     bool)
363 PERLVAR(I, minus_n,     bool)
364 PERLVAR(I, minus_p,     bool)
365 PERLVAR(I, minus_l,     bool)
366 PERLVAR(I, minus_a,     bool)
367 PERLVAR(I, minus_F,     bool)
368 PERLVAR(I, doswitches,  bool)
369 PERLVAR(I, minus_E,     bool)
370
371 PERLVAR(I, inplace,     char *)
372 PERLVAR(I, e_script,    SV *)
373
374 PERLVAR(I, basetime,    Time_t)         /* $^T */
375
376 PERLVARI(I, maxsysfd,   I32,    MAXSYSFD)
377                                         /* top fd to pass to subprocesses */
378 PERLVAR(I, statusvalue, I32)            /* $? */
379 #ifdef VMS
380 PERLVAR(I, statusvalue_vms, U32)
381 #else
382 PERLVAR(I, statusvalue_posix, I32)
383 #endif
384
385 PERLVARI(I, sig_pending, int, 0)        /* Number if highest signal pending */
386 PERLVAR(I, psig_pend, int *)            /* per-signal "count" of pending */
387
388 /* shortcuts to various I/O objects */
389 PERLVAR(I, stdingv,     GV *)           /*  *STDIN      */
390 PERLVAR(I, stderrgv,    GV *)           /*  *STDERR     */
391 PERLVAR(I, argvgv,      GV *)           /*  *ARGV       */
392 PERLVAR(I, argvoutgv,   GV *)           /*  *ARGVOUT    */
393 PERLVAR(I, argvout_stack, AV *)
394
395 /* shortcuts to regexp stuff */
396 PERLVAR(I, replgv,      GV *)           /*  *^R         */
397
398 /* shortcuts to misc objects */
399 PERLVAR(I, errgv,       GV *)           /*  *@          */
400
401 /* shortcuts to debugging objects */
402 PERLVAR(I, DBgv,        GV *)           /*  *DB::DB     */
403 PERLVAR(I, DBline,      GV *)           /*  *DB::line   */
404
405 /*
406 =for apidoc mn|GV *|PL_DBsub
407 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
408 the SV which holds the name of the sub being debugged.  This is the C
409 variable which corresponds to Perl's $DB::sub variable.  See
410 C<L</PL_DBsingle>>.
411
412 =for apidoc mn|SV *|PL_DBsingle
413 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
414 boolean which indicates whether subs are being single-stepped.
415 Single-stepping is automatically turned on after every step.  This is the C
416 variable which corresponds to Perl's $DB::single variable.  See
417 C<L</PL_DBsub>>.
418
419 =for apidoc mn|SV *|PL_DBtrace
420 Trace variable used when Perl is run in debugging mode, with the B<-d>
421 switch.  This is the C variable which corresponds to Perl's $DB::trace
422 variable.  See C<L</PL_DBsingle>>.
423
424 =cut
425 */
426
427 PERLVAR(I, DBsub,       GV *)           /*  *DB::sub    */
428 PERLVAR(I, DBsingle,    SV *)           /*  $DB::single */
429 PERLVAR(I, DBtrace,     SV *)           /*  $DB::trace  */
430 PERLVAR(I, DBsignal,    SV *)           /*  $DB::signal */
431 PERLVAR(I, dbargs,      AV *)           /* args to call listed by caller function */
432
433 PERLVARA(I, DBcontrol,    DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
434
435 /* symbol tables */
436 PERLVAR(I, debstash,    HV *)           /* symbol table for perldb package */
437 PERLVAR(I, globalstash, HV *)           /* global keyword overrides imported here */
438 PERLVAR(I, curstname,   SV *)           /* name of current package */
439 PERLVAR(I, beginav,     AV *)           /* names of BEGIN subroutines */
440 PERLVAR(I, endav,       AV *)           /* names of END subroutines */
441 PERLVAR(I, unitcheckav, AV *)           /* names of UNITCHECK subroutines */
442 PERLVAR(I, checkav,     AV *)           /* names of CHECK subroutines */
443 PERLVAR(I, initav,      AV *)           /* names of INIT subroutines */
444
445 /* subprocess state */
446 PERLVAR(I, fdpid,       AV *)           /* keep fd-to-pid mappings for my_popen */
447
448 /* internal state */
449 PERLVARI(I, op_mask,    char *, NULL)   /* masked operations for safe evals */
450
451 /* current interpreter roots */
452 PERLVAR(I, main_cv,     CV *)
453 PERLVAR(I, main_root,   OP *)
454 PERLVAR(I, main_start,  OP *)
455 PERLVAR(I, eval_root,   OP *)
456 PERLVAR(I, eval_start,  OP *)
457
458 /* runtime control stuff */
459 PERLVARI(I, curcopdb,   COP *,  NULL)
460
461 PERLVAR(I, filemode,    int)            /* so nextargv() can preserve mode */
462 PERLVAR(I, lastfd,      int)            /* what to preserve mode on */
463 PERLVAR(I, oldname,     char *)         /* what to preserve mode on */
464 /* Elements in this array have ';' appended and are injected as a single line
465    into the tokeniser. You can't put any (literal) newlines into any program
466    you stuff in into this array, as the point where it's injected is expecting
467    a single physical line. */
468 PERLVAR(I, preambleav,  AV *)
469 PERLVAR(I, mess_sv,     SV *)
470 PERLVAR(I, ors_sv,      SV *)           /* output record separator $\ */
471
472 /* funky return mechanisms */
473 PERLVAR(I, forkprocess, int)            /* so do_open |- can return proc# */
474
475 /* statics moved here for shared library purposes */
476 PERLVARI(I, gensym,     I32,    0)      /* next symbol for getsym() to define */
477 PERLVARI(I, cv_has_eval, bool, FALSE)   /* PL_compcv includes an entereval or similar */
478 PERLVAR(I, taint_warn,  bool)           /* taint warns instead of dying */
479 PERLVARI(I, laststype,  U16,    OP_STAT)
480
481 PERLVARI(I, laststatval, int,   -1)
482
483 PERLVAR(I, modcount,    I32)            /* how much op_lvalue()ification in
484                                            assignment? */
485
486 /* interpreter atexit processing */
487 PERLVARI(I, exitlistlen, I32, 0)        /* length of same */
488 PERLVARI(I, exitlist,   PerlExitListEntry *, NULL)
489                                         /* list of exit functions */
490
491 /*
492 =for apidoc Amn|HV*|PL_modglobal
493
494 C<PL_modglobal> is a general purpose, interpreter global HV for use by
495 extensions that need to keep information on a per-interpreter basis.
496 In a pinch, it can also be used as a symbol table for extensions
497 to share data among each other.  It is a good idea to use keys
498 prefixed by the package name of the extension that owns the data.
499
500 =cut
501 */
502
503 PERLVAR(I, modglobal,   HV *)           /* per-interp module data */
504
505 /* these used to be in global before 5.004_68 */
506 PERLVARI(I, profiledata, U32 *, NULL)   /* table of ops, counts */
507
508 PERLVAR(I, compiling,   COP)            /* compiling/done executing marker */
509
510 PERLVAR(I, compcv,      CV *)           /* currently compiling subroutine */
511 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
512 PERLVAR(I, comppad_name_fill,   PADOFFSET)/* last "introduced" variable offset */
513 PERLVAR(I, comppad_name_floor,  PADOFFSET)/* start of vars in innermost block */
514
515 #ifdef HAVE_INTERP_INTERN
516 PERLVAR(I, sys_intern,  struct interp_intern)
517                                         /* platform internals */
518 #endif
519
520 /* more statics moved here */
521 PERLVAR(I, DBcv,        CV *)           /* from perl.c */
522 PERLVARI(I, generation, int,    100)    /* scan sequence# for OP_AASSIGN
523                                            compile-time common elem detection */
524
525 PERLVAR(I, unicode, U32)        /* Unicode features: $ENV{PERL_UNICODE} or -C */
526
527 PERLVARI(I, in_clean_objs,bool,    FALSE)       /* from sv.c */
528 PERLVARI(I, in_clean_all, bool,    FALSE)       /* ptrs to freed SVs now legal */
529 PERLVAR(I, nomemok,     bool)           /* let malloc context handle nomem */
530 PERLVARI(I, savebegin,  bool,   FALSE)  /* save BEGINs for compiler     */
531
532
533 PERLVAR(I, delaymagic_uid,      Uid_t)  /* current real user id, only for delaymagic */
534 PERLVAR(I, delaymagic_euid,     Uid_t)  /* current effective user id, only for delaymagic */
535 PERLVAR(I, delaymagic_gid,      Gid_t)  /* current real group id, only for delaymagic */
536 PERLVAR(I, delaymagic_egid,     Gid_t)  /* current effective group id, only for delaymagic */
537 PERLVARI(I, an,         U32,    0)      /* malloc sequence number */
538
539 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
540 PERLVARI(I, breakable_sub_gen, U32, 0)
541
542 #ifdef DEBUGGING
543     /* exercise wrap-around */
544     #define PERL_COP_SEQMAX (U32_MAX-50)
545 #else
546     #define PERL_COP_SEQMAX 0
547 #endif
548 PERLVARI(I, cop_seqmax, U32,    PERL_COP_SEQMAX) /* statement sequence number */
549 #undef PERL_COP_SEQMAX
550
551 PERLVARI(I, evalseq,    U32,    0)      /* eval sequence number */
552 PERLVAR(I, origalen,    U32)
553 PERLVAR(I, origenviron, char **)
554 #ifdef PERL_USES_PL_PIDSTATUS
555 PERLVAR(I, pidstatus,   HV *)           /* pid-to-status mappings for waitpid */
556 #endif
557 PERLVAR(I, osname,      char *)         /* operating system */
558
559 PERLVAR(I, sighandlerp, Sighandler_t)
560
561 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
562
563 PERLVAR(I, debug,       volatile U32)   /* flags given to -D switch */
564
565 PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
566
567 PERLVARI(I, runops,     runops_proc_t, RUNOPS_DEFAULT)
568
569 PERLVAR(I, subname,     SV *)           /* name of current subroutine */
570
571 PERLVAR(I, subline,     I32)            /* line this subroutine began on */
572 PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
573
574 PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
575 PERLVAR(I, padix,       PADOFFSET)      /* lowest unused index - 1
576                                            in current "register" pad */
577 PERLVAR(I, constpadix,  PADOFFSET)      /* lowest unused for constants */
578
579 PERLVAR(I, padix_floor, PADOFFSET)      /* how low may inner block reset padix */
580
581 #if defined(USE_POSIX_2008_LOCALE)          \
582  && defined(USE_THREAD_SAFE_LOCALE)         \
583  && ! defined(HAS_QUERYLOCALE)
584
585 PERLVARA(I, curlocales, 12, char *)
586
587 #endif
588 #ifdef USE_LOCALE_COLLATE
589
590 PERLVAR(I, collation_name, char *)      /* Name of current collation */
591 PERLVAR(I, collxfrm_base, Size_t)       /* Basic overhead in *xfrm() */
592 PERLVARI(I, collxfrm_mult,Size_t, 2)    /* Expansion factor in *xfrm() */
593 PERLVARI(I, collation_ix, U32,  0)      /* Collation generation index */
594 PERLVARI(I, strxfrm_NUL_replacement, U8, 0)  /* Code point to replace NULs */
595 PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
596                             /* Assume until proven otherwise that it works */
597 PERLVARI(I, strxfrm_max_cp, U8, 0)      /* Highest collating cp in locale */
598 PERLVARI(I, collation_standard, bool, TRUE)
599                                         /* Assume simple collation */
600 #endif /* USE_LOCALE_COLLATE */
601
602 PERLVARI(I, langinfo_buf, char *, NULL)
603 PERLVARI(I, langinfo_bufsize, Size_t, 0)
604 PERLVARI(I, setlocale_buf, char *, NULL)
605 PERLVARI(I, setlocale_bufsize, Size_t, 0)
606
607 #ifdef PERL_SAWAMPERSAND
608 PERLVAR(I, sawampersand, U8)            /* must save all match strings */
609 #endif
610
611 PERLVAR(I, unsafe,      bool)
612 PERLVAR(I, colorset,    bool)           /* PERL_RE_COLORS env var is in use */
613
614 /* current phase the interpreter is in
615    for ordering this structure to remove holes, we're assuming that this is 4
616    bytes.  */
617 PERLVARI(I, phase,      enum perl_phase, PERL_PHASE_CONSTRUCT)
618
619 PERLVARI(I, in_load_module, bool, FALSE)        /* to prevent recursions in PerlIO_find_layer */
620
621 /* This value may be set when embedding for full cleanup  */
622 /* 0=none, 1=full, 2=full with checks */
623 /* mod_perl is special, and also assigns a meaning -1 */
624 PERLVARI(I, perl_destruct_level, signed char,   0)
625
626 #ifdef USE_LOCALE_NUMERIC
627
628 PERLVARI(I, numeric_standard, int, TRUE)
629                                         /* Assume C locale numerics */
630 PERLVARI(I, numeric_underlying, bool, TRUE)
631                                         /* Assume underlying locale numerics */
632 PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
633 PERLVAR(I, numeric_name, char *)        /* Name of current numeric locale */
634 PERLVAR(I, numeric_radix_sv, SV *)      /* The radix separator if not '.' */
635
636 #  ifdef HAS_POSIX_2008_LOCALE
637
638 PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
639
640 #  endif
641 #endif /* !USE_LOCALE_NUMERIC */
642
643 /* Unicode inversion lists */
644 PERLVAR(I, InBitmap,    SV *)
645
646 /* utf8 character class swashes */
647 PERLVAR(I, utf8_mark,   SV *)
648 PERLVAR(I, seen_deprecated_macro, HV *)
649
650 PERLVAR(I, last_swash_hv, HV *)
651 PERLVAR(I, last_swash_tmps, U8 *)
652 PERLVAR(I, last_swash_slen, STRLEN)
653 PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
654 PERLVAR(I, last_swash_klen, U8)         /* Only needs to store 0-12  */
655
656 #ifdef FCRYPT
657 PERLVARI(I, cryptseen,  bool,   FALSE)  /* has fast crypt() been initialized? */
658 #else
659 /* One byte hole in the interpreter structure.  */
660 #endif
661
662 PERLVAR(I, pad_reset_pending, bool)     /* reset pad on next attempted alloc */
663 PERLVAR(I, srand_called, bool)
664
665 /* Array of signal handlers, indexed by signal number, through which the C
666    signal handler dispatches.  */
667 PERLVAR(I, psig_ptr,    SV **)
668 /* Array of names of signals, indexed by signal number, for (re)use as the first
669    argument to a signal handler.   Only one block of memory is allocated for
670    both psig_name and psig_ptr.  */
671 PERLVAR(I, psig_name,   SV **)
672
673 #if defined(PERL_IMPLICIT_SYS)
674 PERLVAR(I, Mem,         struct IPerlMem *)
675 PERLVAR(I, MemShared,   struct IPerlMem *)
676 PERLVAR(I, MemParse,    struct IPerlMem *)
677 PERLVAR(I, Env,         struct IPerlEnv *)
678 PERLVAR(I, StdIO,       struct IPerlStdIO *)
679 PERLVAR(I, LIO,         struct IPerlLIO *)
680 PERLVAR(I, Dir,         struct IPerlDir *)
681 PERLVAR(I, Sock,        struct IPerlSock *)
682 PERLVAR(I, Proc,        struct IPerlProc *)
683 #endif
684
685 PERLVAR(I, ptr_table,   PTR_TBL_t *)
686 PERLVARI(I, beginav_save, AV *, NULL)   /* save BEGIN{}s when compiling */
687
688 PERLVAR(I, body_arenas, void *)         /* pointer to list of body-arenas */
689
690
691 #if defined(USE_ITHREADS)
692 PERLVAR(I, regex_pad,     SV **)        /* Shortcut into the array of
693                                            regex_padav */
694 PERLVAR(I, regex_padav,   AV *)         /* All regex objects, indexed via the
695                                            values in op_pmoffset of pmop.
696                                            Entry 0 is an SV whose PV is a
697                                            "packed" list of IVs listing
698                                            the now-free slots in the array */
699 PERLVAR(I, stashpad,    HV **)          /* for CopSTASH */
700 PERLVARI(I, stashpadmax, PADOFFSET, 64)
701 PERLVARI(I, stashpadix, PADOFFSET, 0)
702 #endif
703
704 #ifdef USE_REENTRANT_API
705 PERLVAR(I, reentrant_buffer, REENTR *)  /* here we store the _r buffers */
706 #endif
707
708 PERLVAR(I, custom_op_names, HV *)       /* Names of user defined ops */
709 PERLVAR(I, custom_op_descs, HV *)       /* Descriptions of user defined ops */
710
711 #ifdef PERLIO_LAYERS
712 PERLVARI(I, perlio,     PerlIOl *, NULL)
713 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
714 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
715 #endif
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 PERLVAR(I, custom_ops,  HV *)           /* custom op registrations */
757
758 PERLVAR(I, Xpv,         XPV *)          /* (unused) held temporary value */
759
760 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
761    present always, as -DDEBUGGING must be binary compatible with non.  */
762 PERLVARI(I, scopestack_name, const char * *, NULL)
763
764 PERLVAR(I, debug_pad,   struct perl_debug_pad)  /* always needed because of the re extension */
765
766 /* Hook for File::Glob */
767 PERLVARI(I, globhook,   globhook_t, NULL)
768
769 /* The last unconditional member of the interpreter structure when 5.18.0 was
770    released. The offset of the end of this is baked into a global variable in 
771    any shared perl library which will allow a sanity test in future perl
772    releases.  */
773 #define PERL_LAST_5_18_0_INTERP_MEMBER  Iglobhook
774
775 #ifdef PERL_IMPLICIT_CONTEXT
776 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
777 PERLVARI(I, my_cxt_size, int,   0)      /* size of PL_my_cxt_list */
778 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
779 PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
780 #  endif
781 #endif
782
783 #if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
784 /* For use with the memory debugging code in util.c. This is used only in
785  * DEBUGGING builds (as long as the relevant structure is defined), but
786  * defining it in non-debug builds too means that we retain binary
787  * compatibility between otherwise-compatible plain and debug builds. */
788 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
789 #endif
790
791 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
792 /* File descriptor to talk to the child which dumps scalars.  */
793 PERLVARI(I, dumper_fd,  int,    -1)
794 #endif
795
796
797 #ifdef DEBUG_LEAKING_SCALARS
798 PERLVARI(I, sv_serial,  U32,    0)      /* SV serial number, used in sv.c */
799 #endif
800
801 PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*)    /* constant SVs with precomputed hash value */
802
803 #ifdef PERL_TRACE_OPS
804 PERLVARA(I, op_exec_cnt, OP_max+2, UV)  /* Counts of executed OPs of the given type.
805                                            If PERL_TRACE_OPS is enabled, we'll dump
806                                            a summary count of all ops executed in the
807                                            program at perl_destruct time. For
808                                            profiling/debugging only. Works only if
809                                            DEBUGGING is enabled, too. */
810 #endif
811
812 PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
813
814 PERLVARI(I, dump_re_max_len, STRLEN, 60)
815
816 /* For internal uses of randomness, this ensures the sequence of
817  * random numbers returned by rand() isn't modified by perl's internal
818  * use of randomness.
819  * This is important if the user has called srand() with a seed.
820  */
821
822 PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
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  */