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