This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
274e7af040dd4c475f2169fdd101270e56e36732
[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 #ifdef OP_IN_REGISTER
37 PERLVAR(I, opsave,      OP *)
38 #else
39 PERLVAR(I, op,          OP *)           /* currently executing op */
40 #endif
41 PERLVAR(I, curpad,      SV **)          /* active pad (lexicals+tmps) */
42
43 PERLVAR(I, stack_base,  SV **)
44 PERLVAR(I, stack_max,   SV **)
45
46 PERLVAR(I, savestack,   ANY *)          /* items that need to be restored when
47                                            LEAVEing scopes we've ENTERed */
48 PERLVAR(I, savestack_ix, I32)
49 PERLVAR(I, savestack_max, I32)
50
51 PERLVAR(I, scopestack,  I32 *)          /* scopes we've ENTERed */
52 PERLVAR(I, scopestack_ix, I32)
53 PERLVAR(I, scopestack_max, I32)
54
55 PERLVAR(I, tmps_stack,  SV **)          /* mortals we've made */
56 PERLVARI(I, tmps_ix,    I32,    -1)
57 PERLVARI(I, tmps_floor, I32,    -1)
58 PERLVAR(I, tmps_max,    I32)
59
60 PERLVARI(I, sub_generation, U32, 1)     /* incr to invalidate method cache */
61
62 PERLVAR(I, markstack,   I32 *)          /* stack_sp locations we're
63                                            remembering */
64 PERLVAR(I, markstack_ptr, I32 *)
65 PERLVAR(I, markstack_max, I32 *)
66
67 PERLVARI(I, hash_rand_bits, UV, 0)      /* used to randomize hash stuff */
68 PERLVAR(I, strtab,      HV *)           /* shared string table */
69
70 /* Fields used by magic variables such as $@, $/ and so on */
71 PERLVAR(I, curpm,       PMOP *)         /* what to do \ interps in REs from */
72
73 PERLVAR(I, tainting,    bool)           /* doing taint checks */
74 PERLVAR(I, tainted,     bool)           /* using variables controlled by $< */
75 PERLVAR(I, delaymagic,  U16)            /* ($<,$>) = ... */
76 PERLVAR(I, localizing,  U8)             /* are we processing a local() list? */
77 PERLVAR(I, in_eval,     U8)             /* trap "fatal" errors? */
78 /*
79
80 =for apidoc mn|bool|PL_dowarn
81
82 The C variable which corresponds to Perl's $^W warning variable.
83
84 =cut
85 */
86
87 PERLVAR(I, dowarn,      U8)
88
89 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
90 #  define PERL___I -1
91 #else
92 #  define PERL___I 1
93 #endif
94 PERLVARI(I, utf8cache, I8, PERL___I)    /* Is the utf8 caching code enabled? */
95 #undef PERL___I
96
97
98 /* Stashes */
99 PERLVAR(I, defstash,    HV *)           /* main symbol table */
100 PERLVAR(I, curstash,    HV *)           /* symbol table for current package */
101
102 PERLVAR(I, curcop,      COP *)
103 PERLVAR(I, curstack,    AV *)           /* THE STACK */
104 PERLVAR(I, curstackinfo, PERL_SI *)     /* current stack + context */
105 PERLVAR(I, mainstack,   AV *)           /* the stack when nothing funny is
106                                            happening */
107
108 /* memory management */
109 PERLVAR(I, sv_count,    IV)             /* how many SV* are currently allocated */
110 PERLVAR(I, sv_objcount, IV)             /* DEPRECATED AND UNMAINTAINED.
111                                          * Will be removed in Perl 5.20.
112                                          * Used to be: how many objects are currently allocated. */
113
114 PERLVAR(I, sv_root,     SV *)           /* storage for SVs belonging to interp */
115 PERLVAR(I, sv_arenaroot, SV *)          /* list of areas for garbage collection */
116
117 PERLVAR(I, reg_state,   struct re_save_state)
118
119 /* the currently active slab in a chain of slabs of regmatch states,
120  * and the currently active state within that slab */
121
122 PERLVARI(I, regmatch_slab, regmatch_slab *,     NULL)
123 PERLVAR(I, regmatch_state, regmatch_state *)
124
125 PERLVAR(I, comppad,     PAD *)          /* storage for lexically scoped temporaries */
126
127 /*
128 =for apidoc Amn|SV|PL_sv_undef
129 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
130
131 =for apidoc Amn|SV|PL_sv_no
132 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
133 C<&PL_sv_no>.
134
135 =for apidoc Amn|SV|PL_sv_yes
136 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
137 C<&PL_sv_yes>.
138
139 =cut
140 */
141
142 PERLVAR(I, sv_undef,    SV)
143 PERLVAR(I, sv_no,       SV)
144 PERLVAR(I, sv_yes,      SV)
145 PERLVAR(I, Sv,          SV *)           /* used to hold temporary values */
146
147 PERLVAR(I, parser,      yy_parser *)    /* current parser state */
148
149 PERLVAR(I, stashcache,  HV *)           /* Cache to speed up S_method_common */
150
151
152 /*
153 =for apidoc Amn|STRLEN|PL_na
154
155 A convenience variable which is typically used with C<SvPV> when one
156 doesn't care about the length of the string.  It is usually more efficient
157 to either declare a local variable and use that instead or to use the
158 C<SvPV_nolen> macro.
159
160 =cut
161 */
162
163 PERLVAR(I, na,          STRLEN)         /* for use in SvPV when length is
164                                            Not Applicable */
165
166 /* stat stuff */
167 PERLVAR(I, statbuf,     Stat_t)
168 PERLVAR(I, statcache,   Stat_t)         /* _ */
169 PERLVAR(I, statgv,      GV *)
170 PERLVARI(I, statname,   SV *,   NULL)
171
172 #ifdef HAS_TIMES
173 PERLVAR(I, timesbuf,    struct tms)
174 #endif
175
176 /*
177 =for apidoc mn|SV*|PL_rs
178
179 The input record separator - C<$/> in Perl space.
180
181 =for apidoc mn|GV*|PL_last_in_gv
182
183 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
184
185 =for apidoc mn|GV*|PL_ofsgv
186
187 The glob containing the output field separator - C<*,> in Perl space.
188
189 =cut
190 */
191
192 PERLVAR(I, rs,          SV *)           /* input record separator $/ */
193 PERLVAR(I, last_in_gv,  GV *)           /* GV used in last <FH> */
194 PERLVAR(I, ofsgv,       GV *)           /* GV of output field separator *, */
195 PERLVAR(I, defoutgv,    GV *)           /* default FH for output */
196 PERLVARI(I, chopset,    const char *, " \n-")   /* $: */
197 PERLVAR(I, formtarget,  SV *)
198 PERLVAR(I, bodytarget,  SV *)
199 PERLVAR(I, toptarget,   SV *)
200
201
202 PERLVAR(I, restartop,   OP *)           /* propagating an error from croak? */
203 PERLVAR(I, restartjmpenv, JMPENV *)     /* target frame for longjmp in die */
204
205 PERLVAR(I, top_env,     JMPENV *)       /* ptr to current sigjmp environment */
206 PERLVAR(I, start_env,   JMPENV)         /* empty startup sigjmp environment */
207 PERLVARI(I, errors,     SV *,   NULL)   /* outstanding queued errors */
208
209 /* statics "owned" by various functions */
210 PERLVAR(I, hv_fetch_ent_mh, HE*)        /* owned by hv_fetch_ent() */
211
212 PERLVAR(I, lastgotoprobe, OP*)          /* from pp_ctl.c */
213
214 /* sort stuff */
215 PERLVAR(I, sortcop,     OP *)           /* user defined sort routine */
216 PERLVAR(I, sortstash,   HV *)           /* which is in some package or other */
217 PERLVAR(I, firstgv,     GV *)           /* $a */
218 PERLVAR(I, secondgv,    GV *)           /* $b */
219
220 /* float buffer */
221 PERLVAR(I, efloatbuf,   char *)
222 PERLVAR(I, efloatsize,  STRLEN)
223
224 PERLVAR(I, regdummy,    regnode)        /* from regcomp.c */
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
233 PERLVARA(I, colors,6,   char *)         /* from regcomp.c */
234
235 /*
236 =for apidoc Amn|peep_t|PL_peepp
237
238 Pointer to the per-subroutine peephole optimiser.  This is a function
239 that gets called at the end of compilation of a Perl subroutine (or
240 equivalently independent piece of Perl code) to perform fixups of
241 some ops and to perform small-scale optimisations.  The function is
242 called once for each subroutine that is compiled, and is passed, as sole
243 parameter, a pointer to the op that is the entry point to the subroutine.
244 It modifies the op tree in place.
245
246 The peephole optimiser should never be completely replaced.  Rather,
247 add code to it by wrapping the existing optimiser.  The basic way to do
248 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
249 If the new code wishes to operate on ops throughout the subroutine's
250 structure, rather than just at the top level, it is likely to be more
251 convenient to wrap the L</PL_rpeepp> hook.
252
253 =cut
254 */
255
256 PERLVARI(I, peepp,      peep_t, Perl_peep)
257
258 /*
259 =for apidoc Amn|peep_t|PL_rpeepp
260
261 Pointer to the recursive peephole optimiser.  This is a function
262 that gets called at the end of compilation of a Perl subroutine (or
263 equivalently independent piece of Perl code) to perform fixups of some
264 ops and to perform small-scale optimisations.  The function is called
265 once for each chain of ops linked through their C<op_next> fields;
266 it is recursively called to handle each side chain.  It is passed, as
267 sole parameter, a pointer to the op that is at the head of the chain.
268 It modifies the op tree in place.
269
270 The peephole optimiser should never be completely replaced.  Rather,
271 add code to it by wrapping the existing optimiser.  The basic way to do
272 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
273 If the new code wishes to operate only on ops at a subroutine's top level,
274 rather than throughout the structure, it is likely to be more convenient
275 to wrap the L</PL_peepp> hook.
276
277 =cut
278 */
279
280 PERLVARI(I, rpeepp,     peep_t, Perl_rpeep)
281
282 /*
283 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
284
285 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.
286 This allows extensions to free any extra attribute they have locally attached to an OP.
287 It is also assured to first fire for the parent OP and then for its kids.
288
289 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.
290
291 =cut
292 */
293
294 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
295
296 PERLVARI(I, watchaddr,  char **, 0)
297 PERLVAR(I, watchok,     char *)
298
299 PERLVAR(I, perldb,      U32)
300
301 PERLVAR(I, signals,     U32)    /* Using which pre-5.8 signals */
302
303 /* pseudo environmental stuff */
304 PERLVAR(I, origargc,    int)
305 PERLVAR(I, origargv,    char **)
306 PERLVAR(I, envgv,       GV *)
307 PERLVAR(I, incgv,       GV *)
308 PERLVAR(I, hintgv,      GV *)
309 PERLVAR(I, origfilename, char *)
310 PERLVAR(I, diehook,     SV *)
311 PERLVAR(I, warnhook,    SV *)
312
313 /* switches */
314 PERLVAR(I, patchlevel,  SV *)
315 PERLVAR(I, apiversion,  SV *)
316 PERLVAR(I, localpatches, const char * const *)
317 PERLVARI(I, splitstr,   const char *, " ")
318
319 PERLVAR(I, minus_c,     bool)
320 PERLVAR(I, minus_n,     bool)
321 PERLVAR(I, minus_p,     bool)
322 PERLVAR(I, minus_l,     bool)
323 PERLVAR(I, minus_a,     bool)
324 PERLVAR(I, minus_F,     bool)
325 PERLVAR(I, doswitches,  bool)
326 PERLVAR(I, minus_E,     bool)
327
328 PERLVAR(I, reentrant_retint, int)       /* Integer return value from reentrant functions */
329
330 PERLVAR(I, inplace,     char *)
331 PERLVAR(I, e_script,    SV *)
332
333 PERLVAR(I, basetime,    Time_t)         /* $^T */
334
335 PERLVARI(I, maxsysfd,   I32,    MAXSYSFD)
336                                         /* top fd to pass to subprocesses */
337 PERLVAR(I, statusvalue, I32)            /* $? */
338 #ifdef VMS
339 PERLVAR(I, statusvalue_vms, U32)
340 #else
341 PERLVAR(I, statusvalue_posix, I32)
342 #endif
343
344 PERLVARI(I, sig_pending, int, 0)        /* Number if highest signal pending */
345 PERLVAR(I, psig_pend, int *)            /* per-signal "count" of pending */
346
347 /* shortcuts to various I/O objects */
348 PERLVAR(I, stdingv,     GV *)           /*  *STDIN      */
349 PERLVAR(I, stderrgv,    GV *)           /*  *STDERR     */
350 PERLVAR(I, defgv,       GV *)
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 /* funky return mechanisms */
404 PERLVAR(I, forkprocess, int)            /* so do_open |- can return proc# */
405
406 /* subprocess state */
407 PERLVAR(I, fdpid,       AV *)           /* keep fd-to-pid mappings for my_popen */
408
409 /* internal state */
410 PERLVARI(I, op_mask,    char *, NULL)   /* masked operations for safe evals */
411
412 /* current interpreter roots */
413 PERLVAR(I, main_cv,     CV *)
414 PERLVAR(I, main_root,   OP *)
415 PERLVAR(I, main_start,  OP *)
416 PERLVAR(I, eval_root,   OP *)
417 PERLVAR(I, eval_start,  OP *)
418
419 /* runtime control stuff */
420 PERLVARI(I, curcopdb,   COP *,  NULL)
421
422 PERLVAR(I, filemode,    int)            /* so nextargv() can preserve mode */
423 PERLVAR(I, lastfd,      int)            /* what to preserve mode on */
424 PERLVAR(I, oldname,     char *)         /* what to preserve mode on */
425 PERLVAR(I, Argv,        const char **)  /* stuff to free from do_aexec, vfork safe */
426 PERLVAR(I, Cmd,         char *)         /* stuff to free from do_aexec, vfork safe */
427 /* Elements in this array have ';' appended and are injected as a single line
428    into the tokeniser. You can't put any (literal) newlines into any program
429    you stuff in into this array, as the point where it's injected is expecting
430    a single physical line. */
431 PERLVAR(I, preambleav,  AV *)
432 PERLVAR(I, mess_sv,     SV *)
433 PERLVAR(I, ors_sv,      SV *)           /* output record separator $\ */
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 #ifdef DEBUGGING
499     /* exercise wrap-around */
500     #define PERL_COP_SEQMAX (U32_MAX-50)
501 #else
502     #define PERL_COP_SEQMAX 0
503 #endif
504 PERLVARI(I, cop_seqmax, U32,    PERL_COP_SEQMAX) /* statement sequence number */
505 #undef PERL_COP_SEQMAX
506
507 PERLVARI(I, evalseq,    U32,    0)      /* eval sequence number */
508 PERLVAR(I, origalen,    U32)
509 PERLVAR(I, origenviron, char **)
510 #ifdef PERL_USES_PL_PIDSTATUS
511 PERLVAR(I, pidstatus,   HV *)           /* pid-to-status mappings for waitpid */
512 #endif
513 PERLVAR(I, osname,      char *)         /* operating system */
514
515 PERLVAR(I, sighandlerp, Sighandler_t)
516
517 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
518
519 PERLVARI(I, maxo,       int,    MAXO)   /* maximum number of ops */
520
521 PERLVARI(I, runops,     runops_proc_t, RUNOPS_DEFAULT)
522
523 PERLVAR(I, subname,     SV *)           /* name of current subroutine */
524
525 PERLVAR(I, subline,     I32)            /* line this subroutine began on */
526 PERLVAR(I, min_intro_pending, I32)      /* start of vars to introduce */
527
528 PERLVAR(I, max_intro_pending, I32)      /* end of vars to introduce */
529 PERLVAR(I, padix,       I32)            /* max used index in current "register" pad */
530
531 PERLVAR(I, padix_floor, I32)            /* how low may inner block reset padix */
532
533 PERLVAR(I, hints,       U32)            /* pragma-tic compile-time flags */
534
535 PERLVAR(I, debug,       VOL U32)        /* flags given to -D switch */
536
537 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
538 PERLVARI(I, breakable_sub_gen, U32, 0)
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)           /* from regcomp.c */
555
556 /* SPARE 2/3 bytes depending on PERL_SAWAMPERSAND */
557
558 #ifdef USE_LOCALE_NUMERIC
559
560 PERLVARI(I, numeric_standard, bool, TRUE)
561                                         /* Assume simple numerics */
562 PERLVARI(I, numeric_local, bool, TRUE)
563                                         /* Assume local numerics */
564 PERLVAR(I, numeric_name, char *)        /* Name of current numeric locale */
565 PERLVAR(I, numeric_radix_sv, SV *)      /* The radix separator if not '.' */
566
567 #endif /* !USE_LOCALE_NUMERIC */
568
569 /* Unicode inversion lists */
570 PERLVAR(I, ASCII,       SV *)
571 PERLVAR(I, Latin1,      SV *)
572 PERLVAR(I, AboveLatin1, SV *)
573
574 PERLVAR(I, NonL1NonFinalFold,   SV *)
575 PERLVAR(I, HasMultiCharFold,   SV *)
576
577 /* utf8 character class swashes */
578 PERLVAR(I, utf8_mark,   SV *)
579 PERLVAR(I, utf8_X_regular_begin, SV *)
580 PERLVAR(I, utf8_X_extend, SV *)
581 PERLVAR(I, utf8_toupper, SV *)
582 PERLVAR(I, utf8_totitle, SV *)
583 PERLVAR(I, utf8_tolower, SV *)
584 PERLVAR(I, utf8_tofold, SV *)
585 PERLVAR(I, utf8_charname_begin, SV *)
586 PERLVAR(I, utf8_charname_continue, SV *)
587
588 PERLVARA(I, utf8_swash_ptrs, POSIX_SWASH_COUNT, SV *)
589 PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
590 PERLVARA(I, L1Posix_ptrs, POSIX_CC_COUNT, SV *)
591 PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
592
593 PERLVAR(I, last_swash_hv, HV *)
594 PERLVAR(I, last_swash_tmps, U8 *)
595 PERLVAR(I, last_swash_slen, STRLEN)
596 PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
597 PERLVAR(I, last_swash_klen, U8)         /* Only needs to store 0-12  */
598
599 #ifdef FCRYPT
600 PERLVARI(I, cryptseen,  bool,   FALSE)  /* has fast crypt() been initialized? */
601 #endif
602
603 PERLVAR(I, pad_reset_pending, bool)     /* reset pad on next attempted alloc */
604 PERLVAR(I, srand_called, bool)
605 PERLVARI(I, in_load_module, bool, FALSE)        /* to prevent recursions in PerlIO_find_layer */
606
607 /* This value may be set when embedding for full cleanup  */
608 /* 0=none, 1=full, 2=full with checks */
609 /* mod_perl is special, and also assigns a meaning -1 */
610 PERLVARI(I, perl_destruct_level, signed char,   0)
611
612 /* current phase the interpreter is in */
613 PERLVARI(I, phase,      enum perl_phase, PERL_PHASE_CONSTRUCT)
614
615 /* Array of signal handlers, indexed by signal number, through which the C
616    signal handler dispatches.  */
617 PERLVAR(I, psig_ptr,    SV **)
618 /* Array of names of signals, indexed by signal number, for (re)use as the first
619    argument to a signal handler.   Only one block of memory is allocated for
620    both psig_name and psig_ptr.  */
621 PERLVAR(I, psig_name,   SV **)
622
623 #if defined(PERL_IMPLICIT_SYS)
624 PERLVAR(I, Mem,         struct IPerlMem *)
625 PERLVAR(I, MemShared,   struct IPerlMem *)
626 PERLVAR(I, MemParse,    struct IPerlMem *)
627 PERLVAR(I, Env,         struct IPerlEnv *)
628 PERLVAR(I, StdIO,       struct IPerlStdIO *)
629 PERLVAR(I, LIO,         struct IPerlLIO *)
630 PERLVAR(I, Dir,         struct IPerlDir *)
631 PERLVAR(I, Sock,        struct IPerlSock *)
632 PERLVAR(I, Proc,        struct IPerlProc *)
633 #endif
634
635 PERLVAR(I, ptr_table,   PTR_TBL_t *)
636 PERLVARI(I, beginav_save, AV *, NULL)   /* save BEGIN{}s when compiling */
637
638 PERLVAR(I, body_arenas, void *)         /* pointer to list of body-arenas */
639
640
641 #if defined(USE_ITHREADS)
642 PERLVAR(I, regex_pad,     SV **)        /* Shortcut into the array of
643                                            regex_padav */
644 PERLVAR(I, regex_padav,   AV *)         /* All regex objects, indexed via the
645                                            values in op_pmoffset of pmop.
646                                            Entry 0 is an SV whose PV is a
647                                            "packed" list of IVs listing
648                                            the now-free slots in the array */
649 PERLVAR(I, stashpad,    HV **)          /* for CopSTASH */
650 PERLVARI(I, stashpadmax, PADOFFSET, 64)
651 PERLVARI(I, stashpadix, PADOFFSET, 0)
652 #endif
653
654 #ifdef USE_REENTRANT_API
655 PERLVAR(I, reentrant_buffer, REENTR *)  /* here we store the _r buffers */
656 #endif
657
658 PERLVAR(I, custom_op_names, HV *)       /* Names of user defined ops */
659 PERLVAR(I, custom_op_descs, HV *)       /* Descriptions of user defined ops */
660
661 #ifdef PERLIO_LAYERS
662 PERLVARI(I, perlio,     PerlIOl *, NULL)
663 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
664 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
665 #endif
666
667 PERLVARI(I, encoding,   SV *,   NULL)   /* character encoding */
668
669 PERLVAR(I, utf8_idstart, SV *)
670 PERLVAR(I, utf8_idcont, SV *)
671 PERLVAR(I, utf8_xidstart, SV *)
672 PERLVAR(I, utf8_perl_idstart, SV *)
673 PERLVAR(I, utf8_perl_idcont, SV *)
674 PERLVAR(I, utf8_xidcont, SV *)
675
676 PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
677
678 PERLVARI(I, checkav_save, AV *, NULL)   /* save CHECK{}s when compiling */
679 PERLVARI(I, unitcheckav_save, AV *, NULL)
680                                         /* save UNITCHECK{}s when compiling */
681
682 PERLVARI(I, clocktick,  long,   0)      /* this many times() ticks in a second */
683
684 /* Hooks to shared SVs and locks. */
685 PERLVARI(I, sharehook,  share_proc_t, Perl_sv_nosharing)
686 PERLVARI(I, lockhook,   share_proc_t, Perl_sv_nosharing)
687 #ifdef NO_MATHOMS
688 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
689 #else
690 /* This reference ensures that the mathoms are linked with perl */
691 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
692 #endif
693 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
694
695 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
696
697 /* Can shared object be destroyed */
698 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
699
700 #ifndef PERL_MICRO
701 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
702 #endif
703
704 PERLVARI(I, isarev, HV *, NULL)         /* Reverse map of @ISA dependencies */
705
706 /* Register of known Method Resolution Orders.
707    What this actually points to is an implementation detail (it may change to
708    a structure incorporating a reference count - use mro_get_from_name to
709    retrieve a C<struct mro_alg *>  */
710 PERLVAR(I, registered_mros, HV *)
711
712 /* Compile-time block start/end hooks */
713 PERLVAR(I, blockhooks,  AV *)
714
715 /* Everything that folds to a given character, for case insensitivity regex
716  * matching */
717 PERLVARI(I, utf8_foldclosures, HV *, NULL)
718
719 /* List of characters that participate in folds (except marks, etc in
720  * multi-char folds) */
721 PERLVARI(I, utf8_foldable, SV *, NULL)
722
723 PERLVAR(I, custom_ops,  HV *)           /* custom op registrations */
724
725 PERLVAR(I, Xpv,         XPV *)          /* (unused) held temporary value */
726
727 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
728    present always, as -DDEBUGGING must be binary compatible with non.  */
729 PERLVARI(I, scopestack_name, const char * *, NULL)
730
731 PERLVAR(I, debug_pad,   struct perl_debug_pad)  /* always needed because of the re extension */
732
733 /* Hook for File::Glob */
734 PERLVARI(I, globhook,   globhook_t, NULL)
735
736 /* The last unconditional member of the interpreter structure when 5.18.0 was
737    released. The offset of the end of this is baked into a global variable in 
738    any shared perl library which will allow a sanity test in future perl
739    releases.  */
740 #define PERL_LAST_5_18_0_INTERP_MEMBER  Iglobhook
741
742 #ifdef PERL_IMPLICIT_CONTEXT
743 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
744 PERLVARI(I, my_cxt_size, int,   0)      /* size of PL_my_cxt_list */
745 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
746 PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
747 #  endif
748 #endif
749
750 #ifdef PERL_TRACK_MEMPOOL
751 /* For use with the memory debugging code in util.c  */
752 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
753 #endif
754
755 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
756 /* File descriptor to talk to the child which dumps scalars.  */
757 PERLVARI(I, dumper_fd,  int,    -1)
758 #endif
759
760 #ifdef PERL_MAD
761 PERLVARI(I, madskills,  bool,   FALSE)  /* preserve all syntactic info */
762                                         /* (MAD = Misc Attribute Decoration) */
763 PERLVARI(I, xmlfp,      PerlIO *, NULL)
764 #endif
765
766 #ifdef DEBUG_LEAKING_SCALARS
767 PERLVARI(I, sv_serial,  U32,    0)      /* SV serial number, used in sv.c */
768 #endif
769
770 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
771  * above on where there are gaps which currently will be structure padding.  */
772
773 /* Within a stable branch, new variables must be added to the very end, before
774  * this comment, for binary compatibility (the offsets of the old members must
775  *  not change).
776  * (Don't forget to add your variable also to perl_clone()!)
777  * XSUB.h provides wrapper functions via perlapi.h that make this
778  * irrelevant, but not all code may be expected to #include XSUB.h.
779  */