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