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