This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
"who be" should be "who are" in perl*delta.pod
[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 /*
12 =head1 Per-Interpreter Variables
13 */
14
15 /* These variables are per-interpreter in threaded/multiplicity builds,
16  * global otherwise.
17
18  * Don't forget to re-run regen/embed.pl to propagate changes! */
19
20 /* New variables must be added to the very end for binary compatibility.
21  * XSUB.h provides wrapper functions via perlapi.h that make this
22  * irrelevant, but not all code may be expected to #include XSUB.h. */
23
24 /* Don't forget to add your variable also to perl_clone()! */
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(Istack_sp,      SV **)          /* top of the stack */
36 #ifdef OP_IN_REGISTER
37 PERLVAR(Iopsave,        OP *)
38 #else
39 PERLVAR(Iop,            OP *)           /* currently executing op */
40 #endif
41 PERLVAR(Icurpad,        SV **)          /* active pad (lexicals+tmps) */
42
43 PERLVAR(Istack_base,    SV **)
44 PERLVAR(Istack_max,     SV **)
45
46 PERLVAR(Iscopestack,    I32 *)          /* scopes we've ENTERed */
47 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
48    present always, as -DDEUBGGING must be binary compatible with non.  */
49 PERLVARI(Iscopestack_name, const char * *, NULL)
50 PERLVAR(Iscopestack_ix, I32)
51 PERLVAR(Iscopestack_max,I32)
52
53 PERLVAR(Isavestack,     ANY *)          /* items that need to be restored when
54                                            LEAVEing scopes we've ENTERed */
55 PERLVAR(Isavestack_ix,  I32)
56 PERLVAR(Isavestack_max, I32)
57
58 PERLVAR(Itmps_stack,    SV **)          /* mortals we've made */
59 PERLVARI(Itmps_ix,      I32,    -1)
60 PERLVARI(Itmps_floor,   I32,    -1)
61 PERLVAR(Itmps_max,      I32)
62 PERLVAR(Imodcount,      I32)            /* how much op_lvalue()ification in
63                                            assignment? */
64
65 PERLVAR(Imarkstack,     I32 *)          /* stack_sp locations we're
66                                            remembering */
67 PERLVAR(Imarkstack_ptr, I32 *)
68 PERLVAR(Imarkstack_max, I32 *)
69
70 PERLVAR(ISv,            SV *)           /* used to hold temporary values */
71 PERLVAR(IXpv,           XPV *)          /* used to hold temporary values */
72
73 /*
74 =for apidoc Amn|STRLEN|PL_na
75
76 A convenience variable which is typically used with C<SvPV> when one
77 doesn't care about the length of the string.  It is usually more efficient
78 to either declare a local variable and use that instead or to use the
79 C<SvPV_nolen> macro.
80
81 =cut
82 */
83
84 PERLVAR(Ina,            STRLEN)         /* for use in SvPV when length is
85                                            Not Applicable */
86
87 /* stat stuff */
88 PERLVAR(Istatbuf,       Stat_t)
89 PERLVAR(Istatcache,     Stat_t)         /* _ */
90 PERLVAR(Istatgv,        GV *)
91 PERLVARI(Istatname,     SV *,   NULL)
92
93 #ifdef HAS_TIMES
94 PERLVAR(Itimesbuf,      struct tms)
95 #endif
96
97 /* Fields used by magic variables such as $@, $/ and so on */
98 PERLVAR(Icurpm,         PMOP *)         /* what to do \ interps in REs from */
99
100 /*
101 =for apidoc mn|SV*|PL_rs
102
103 The input record separator - C<$/> in Perl space.
104
105 =for apidoc mn|GV*|PL_last_in_gv
106
107 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
108
109 =for apidoc mn|GV*|PL_ofsgv
110
111 The glob containing the output field separator - C<*,> in Perl space.
112
113 =cut
114 */
115
116 PERLVAR(Irs,            SV *)           /* input record separator $/ */
117 PERLVAR(Ilast_in_gv,    GV *)           /* GV used in last <FH> */
118 PERLVAR(Iofsgv,         GV *)           /* GV of output field separator *, */
119 PERLVAR(Idefoutgv,      GV *)           /* default FH for output */
120 PERLVARI(Ichopset,      const char *, " \n-")   /* $: */
121 PERLVAR(Iformtarget,    SV *)
122 PERLVAR(Ibodytarget,    SV *)
123 PERLVAR(Itoptarget,     SV *)
124
125 /* Stashes */
126 PERLVAR(Idefstash,      HV *)           /* main symbol table */
127 PERLVAR(Icurstash,      HV *)           /* symbol table for current package */
128
129 PERLVAR(Irestartop,     OP *)           /* propagating an error from croak? */
130 PERLVAR(Irestartjmpenv, JMPENV *)       /* target frame for longjmp in die */
131 PERLVAR(Icurcop,        COP *)
132 PERLVAR(Icurstack,      AV *)           /* THE STACK */
133 PERLVAR(Icurstackinfo,  PERL_SI *)      /* current stack + context */
134 PERLVAR(Imainstack,     AV *)           /* the stack when nothing funny is
135                                            happening */
136
137 PERLVAR(Itop_env,       JMPENV *)       /* ptr to current sigjmp environment */
138 PERLVAR(Istart_env,     JMPENV)         /* empty startup sigjmp environment */
139 PERLVARI(Ierrors,       SV *,   NULL)   /* outstanding queued errors */
140
141 /* statics "owned" by various functions */
142 PERLVAR(Ihv_fetch_ent_mh, HE*)          /* owned by hv_fetch_ent() */
143
144 PERLVAR(Ilastgotoprobe, OP*)            /* from pp_ctl.c */
145
146 /* sort stuff */
147 PERLVAR(Isortcop,       OP *)           /* user defined sort routine */
148 PERLVAR(Isortstash,     HV *)           /* which is in some package or other */
149 PERLVAR(Ifirstgv,       GV *)           /* $a */
150 PERLVAR(Isecondgv,      GV *)           /* $b */
151
152 /* float buffer */
153 PERLVAR(Iefloatbuf,     char *)
154 PERLVAR(Iefloatsize,    STRLEN)
155
156 /* regex stuff */
157
158 PERLVAR(Iscreamfirst,   I32 *)
159 PERLVAR(Iscreamnext,    I32 *)
160 PERLVAR(Ilastscream,    SV *)
161
162 PERLVAR(Ireg_state,     struct re_save_state)
163
164 PERLVAR(Iregdummy,      regnode)        /* from regcomp.c */
165
166 PERLVARI(Idumpindent,   U16,    4)      /* number of blanks per dump
167                                            indentation level */
168
169
170 PERLVAR(Iutf8locale,    bool)           /* utf8 locale detected */
171 PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
172
173 PERLVARA(Icolors,6,     char *)         /* from regcomp.c */
174
175 /*
176 =for apidoc Amn|peep_t|PL_peepp
177
178 Pointer to the per-subroutine peephole optimiser.  This is a function
179 that gets called at the end of compilation of a Perl subroutine (or
180 equivalently independent piece of Perl code) to perform fixups of
181 some ops and to perform small-scale optimisations.  The function is
182 called once for each subroutine that is compiled, and is passed, as sole
183 parameter, a pointer to the op that is the entry point to the subroutine.
184 It modifies the op tree in place.
185
186 The peephole optimiser should never be completely replaced.  Rather,
187 add code to it by wrapping the existing optimiser.  The basic way to do
188 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
189 If the new code wishes to operate on ops throughout the subroutine's
190 structure, rather than just at the top level, it is likely to be more
191 convenient to wrap the L</PL_rpeepp> hook.
192
193 =cut
194 */
195
196 PERLVARI(Ipeepp,        peep_t, Perl_peep)
197
198 /*
199 =for apidoc Amn|peep_t|PL_rpeepp
200
201 Pointer to the recursive peephole optimiser.  This is a function
202 that gets called at the end of compilation of a Perl subroutine (or
203 equivalently independent piece of Perl code) to perform fixups of some
204 ops and to perform small-scale optimisations.  The function is called
205 once for each chain of ops linked through their C<op_next> fields;
206 it is recursively called to handle each side chain.  It is passed, as
207 sole parameter, a pointer to the op that is at the head of the chain.
208 It modifies the op tree in place.
209
210 The peephole optimiser should never be completely replaced.  Rather,
211 add code to it by wrapping the existing optimiser.  The basic way to do
212 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
213 If the new code wishes to operate only on ops at a subroutine's top level,
214 rather than throughout the structure, it is likely to be more convenient
215 to wrap the L</PL_peepp> hook.
216
217 =cut
218 */
219
220 PERLVARI(Irpeepp,       peep_t, Perl_rpeep)
221
222 /*
223 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
224
225 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.
226 This allows extensions to free any extra attribute they have locally attached to an OP.
227 It is also assured to first fire for the parent OP and then for its kids.
228
229 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.
230
231 =cut
232 */
233
234 PERLVARI(Iopfreehook,   Perl_ophook_t, 0) /* op_free() hook */
235
236 PERLVARI(Imaxscream,    I32,    -1)
237 PERLVARI(Ireginterp_cnt,I32,     0)     /* Whether "Regexp" was interpolated. */
238 PERLVARI(Iwatchaddr,    char **, 0)
239 PERLVAR(Iwatchok,       char *)
240
241 /* the currently active slab in a chain of slabs of regmatch states,
242  * and the currently active state within that slab */
243
244 PERLVARI(Iregmatch_slab, regmatch_slab *,       NULL)
245 PERLVAR(Iregmatch_state, regmatch_state *)
246
247 /* Put anything new that is pointer aligned here. */
248
249 PERLVAR(Idelaymagic,    U16)            /* ($<,$>) = ... */
250 PERLVAR(Ilocalizing,    U8)             /* are we processing a local() list? */
251 PERLVAR(Icolorset,      bool)           /* from regcomp.c */
252 PERLVAR(Iin_eval,       U8)             /* trap "fatal" errors? */
253 PERLVAR(Itainted,       bool)           /* using variables controlled by $< */
254 PERLVAR(Itainting,      bool)           /* doing taint checks */
255
256 /* This value may be set when embedding for full cleanup  */
257 /* 0=none, 1=full, 2=full with checks */
258 /* mod_perl is special, and also assigns a meaning -1 */
259 PERLVARI(Iperl_destruct_level,  signed char,    0)
260
261 /* current phase the interpreter is in */
262 PERLVARI(Iphase,        enum perl_phase, PERL_PHASE_CONSTRUCT)
263
264 PERLVAR(Iperldb,        U32)
265
266 PERLVAR(Isignals,       U32)    /* Using which pre-5.8 signals */
267
268 /* pseudo environmental stuff */
269 PERLVAR(Iorigargc,      int)
270 PERLVAR(Iorigargv,      char **)
271 PERLVAR(Ienvgv,         GV *)
272 PERLVAR(Iincgv,         GV *)
273 PERLVAR(Ihintgv,        GV *)
274 PERLVAR(Iorigfilename,  char *)
275 PERLVAR(Idiehook,       SV *)
276 PERLVAR(Iwarnhook,      SV *)
277
278 /* switches */
279 PERLVAR(Ipatchlevel,    SV *)
280 PERLVAR(Iapiversion,    SV *)
281 PERLVAR(Ilocalpatches,  const char * const *)
282 PERLVARI(Isplitstr,     const char *, " ")
283
284 PERLVAR(Iminus_c,       bool)
285 PERLVAR(Iminus_n,       bool)
286 PERLVAR(Iminus_p,       bool)
287 PERLVAR(Iminus_l,       bool)
288 PERLVAR(Iminus_a,       bool)
289 PERLVAR(Iminus_F,       bool)
290 PERLVAR(Idoswitches,    bool)
291 PERLVAR(Iminus_E,       bool)
292
293 /*
294
295 =for apidoc mn|bool|PL_dowarn
296
297 The C variable which corresponds to Perl's $^W warning variable.
298
299 =cut
300 */
301
302 PERLVAR(Idowarn,        U8)
303 PERLVAR(Isawampersand,  bool)           /* must save all match strings */
304 PERLVAR(Iunsafe,        bool)
305 PERLVAR(Iexit_flags,    U8)             /* was exit() unexpected, etc. */
306 PERLVAR(Isrand_called,  bool)
307 PERLVARI(Iin_load_module, bool, FALSE)  /* to prevent recursions in PerlIO_find_layer */
308      /* Space for a U16  */
309 PERLVAR(Iinplace,       char *)
310 PERLVAR(Ie_script,      SV *)
311
312 /* magical thingies */
313 PERLVAR(Ibasetime,      Time_t)         /* $^T */
314 PERLVAR(Iformfeed,      SV *)           /* $^L */
315
316
317 PERLVARI(Imaxsysfd,     I32,    MAXSYSFD)
318                                         /* top fd to pass to subprocesses */
319 PERLVAR(Istatusvalue,   I32)            /* $? */
320 #ifdef VMS
321 PERLVAR(Istatusvalue_vms,U32)
322 #else
323 PERLVAR(Istatusvalue_posix,I32)
324 #endif
325
326 PERLVARI(Isig_pending, int,0)           /* Number if highest signal pending */
327 PERLVAR(Ipsig_pend, int *)              /* per-signal "count" of pending */
328
329 /* shortcuts to various I/O objects */
330 PERLVAR(Istdingv,       GV *)           /*  *STDIN      */
331 PERLVAR(Istderrgv,      GV *)           /*  *STDERR     */
332 PERLVAR(Idefgv,         GV *)
333 PERLVAR(Iargvgv,        GV *)           /*  *ARGV       */
334 PERLVAR(Iargvoutgv,     GV *)           /*  *ARGVOUT    */
335 PERLVAR(Iargvout_stack, AV *)
336
337 /* shortcuts to regexp stuff */
338 PERLVAR(Ireplgv,        GV *)           /*  *^R         */
339
340 /* shortcuts to misc objects */
341 PERLVAR(Ierrgv,         GV *)           /*  *@          */
342
343 /* shortcuts to debugging objects */
344 PERLVAR(IDBgv,          GV *)           /*  *DB::DB     */
345 PERLVAR(IDBline,        GV *)           /*  *DB::line   */
346
347 /*
348 =for apidoc mn|GV *|PL_DBsub
349 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
350 the SV which holds the name of the sub being debugged.  This is the C
351 variable which corresponds to Perl's $DB::sub variable.  See
352 C<PL_DBsingle>.
353
354 =for apidoc mn|SV *|PL_DBsingle
355 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
356 boolean which indicates whether subs are being single-stepped.
357 Single-stepping is automatically turned on after every step.  This is the C
358 variable which corresponds to Perl's $DB::single variable.  See
359 C<PL_DBsub>.
360
361 =for apidoc mn|SV *|PL_DBtrace
362 Trace variable used when Perl is run in debugging mode, with the B<-d>
363 switch.  This is the C variable which corresponds to Perl's $DB::trace
364 variable.  See C<PL_DBsingle>.
365
366 =cut
367 */
368
369 PERLVAR(IDBsub,         GV *)           /*  *DB::sub    */
370 PERLVAR(IDBsingle,      SV *)           /*  $DB::single */
371 PERLVAR(IDBtrace,       SV *)           /*  $DB::trace  */
372 PERLVAR(IDBsignal,      SV *)           /*  $DB::signal */
373 PERLVAR(Idbargs,        AV *)           /* args to call listed by caller function */
374
375 /* symbol tables */
376 PERLVAR(Idebstash,      HV *)           /* symbol table for perldb package */
377 PERLVAR(Iglobalstash,   HV *)           /* global keyword overrides imported here */
378 PERLVAR(Icurstname,     SV *)           /* name of current package */
379 PERLVAR(Ibeginav,       AV *)           /* names of BEGIN subroutines */
380 PERLVAR(Iendav,         AV *)           /* names of END subroutines */
381 PERLVAR(Iunitcheckav,   AV *)           /* names of UNITCHECK subroutines */
382 PERLVAR(Icheckav,       AV *)           /* names of CHECK subroutines */
383 PERLVAR(Iinitav,        AV *)           /* names of INIT subroutines */
384 PERLVAR(Istrtab,        HV *)           /* shared string table */
385 PERLVARI(Isub_generation,U32,1)         /* incr to invalidate method cache */
386
387 /* funky return mechanisms */
388 PERLVAR(Iforkprocess,   int)            /* so do_open |- can return proc# */
389
390 /* memory management */
391 PERLVAR(Isv_count,      I32)            /* how many SV* are currently allocated */
392 PERLVAR(Isv_objcount,   I32)            /* how many objects are currently allocated */
393 PERLVAR(Isv_root,       SV*)            /* storage for SVs belonging to interp */
394 PERLVAR(Isv_arenaroot,  SV*)            /* list of areas for garbage collection */
395
396 /* subprocess state */
397 PERLVAR(Ifdpid,         AV *)           /* keep fd-to-pid mappings for my_popen */
398
399 /* internal state */
400 PERLVARI(Iop_mask,      char *, NULL)   /* masked operations for safe evals */
401
402 /* current interpreter roots */
403 PERLVAR(Imain_cv,       CV *)
404 PERLVAR(Imain_root,     OP *)
405 PERLVAR(Imain_start,    OP *)
406 PERLVAR(Ieval_root,     OP *)
407 PERLVAR(Ieval_start,    OP *)
408
409 /* runtime control stuff */
410 PERLVARI(Icurcopdb,     COP *,  NULL)
411
412 PERLVAR(Ifilemode,      int)            /* so nextargv() can preserve mode */
413 PERLVAR(Ilastfd,        int)            /* what to preserve mode on */
414 PERLVAR(Ioldname,       char *)         /* what to preserve mode on */
415 PERLVAR(IArgv,          const char **)  /* stuff to free from do_aexec, vfork safe */
416 PERLVAR(ICmd,           char *)         /* stuff to free from do_aexec, vfork safe */
417 /* Elements in this array have ';' appended and are injected as a single line
418    into the tokeniser. You can't put any (literal) newlines into any program
419    you stuff in into this array, as the point where it's injected is expecting
420    a single physical line. */
421 PERLVAR(Ipreambleav,    AV *)
422 PERLVAR(Imess_sv,       SV *)
423 PERLVAR(Iors_sv,        SV *)           /* output record separator $\ */
424 /* statics moved here for shared library purposes */
425 PERLVARI(Igensym,       I32,    0)      /* next symbol for getsym() to define */
426 PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
427 PERLVAR(Itaint_warn,    bool)      /* taint warns instead of dying */
428 PERLVARI(Ilaststype,    U16,    OP_STAT)
429 PERLVARI(Ilaststatval,  int,    -1)
430
431 /* interpreter atexit processing */
432 PERLVARI(Iexitlistlen,  I32, 0)         /* length of same */
433 PERLVARI(Iexitlist,     PerlExitListEntry *, NULL)
434                                         /* list of exit functions */
435
436 /*
437 =for apidoc Amn|HV*|PL_modglobal
438
439 C<PL_modglobal> is a general purpose, interpreter global HV for use by
440 extensions that need to keep information on a per-interpreter basis.
441 In a pinch, it can also be used as a symbol table for extensions
442 to share data among each other.  It is a good idea to use keys
443 prefixed by the package name of the extension that owns the data.
444
445 =cut
446 */
447
448 PERLVAR(Imodglobal,     HV *)           /* per-interp module data */
449
450 /* these used to be in global before 5.004_68 */
451 PERLVARI(Iprofiledata,  U32 *,  NULL)   /* table of ops, counts */
452
453 PERLVAR(Icompiling,     COP)            /* compiling/done executing marker */
454
455 PERLVAR(Icompcv,        CV *)           /* currently compiling subroutine */
456 PERLVAR(Icomppad,       AV *)           /* storage for lexically scoped temporaries */
457 PERLVAR(Icomppad_name,  AV *)           /* variable names for "my" variables */
458 PERLVAR(Icomppad_name_fill,     I32)    /* last "introduced" variable offset */
459 PERLVAR(Icomppad_name_floor,    I32)    /* start of vars in innermost block */
460
461 #ifdef HAVE_INTERP_INTERN
462 PERLVAR(Isys_intern,    struct interp_intern)
463                                         /* platform internals */
464 #endif
465
466 /* more statics moved here */
467 PERLVAR(IDBcv,          CV *)           /* from perl.c */
468 PERLVARI(Igeneration,   int,    100)    /* from op.c */
469
470 PERLVARI(Iin_clean_objs,bool,    FALSE) /* from sv.c */
471 PERLVARI(Iin_clean_all, bool,    FALSE) /* ptrs to freed SVs now legal */
472 PERLVAR(Inomemok,       bool)           /* let malloc context handle nomem */
473 PERLVARI(Isavebegin,     bool,  FALSE)  /* save BEGINs for compiler     */
474
475 PERLVAR(Iuid,           Uid_t)          /* current real user id */
476 PERLVAR(Ieuid,          Uid_t)          /* current effective user id */
477 PERLVAR(Igid,           Gid_t)          /* current real group id */
478 PERLVAR(Iegid,          Gid_t)          /* current effective group id */
479 PERLVARI(Ian,           U32,    0)      /* malloc sequence number */
480
481 #ifdef DEBUGGING
482     /* exercise wrap-around */
483     #define PERL_COP_SEQMAX (U32_MAX-50)
484 #else
485     #define PERL_COP_SEQMAX 0
486 #endif
487 PERLVARI(Icop_seqmax,   U32,    PERL_COP_SEQMAX) /* statement sequence number */
488 #undef PERL_COP_SEQMAX
489
490 PERLVARI(Ievalseq,      U32,    0)      /* eval sequence number */
491 PERLVAR(Iorigalen,      U32)
492 PERLVAR(Iorigenviron,   char **)
493 #ifdef PERL_USES_PL_PIDSTATUS
494 PERLVAR(Ipidstatus,     HV *)           /* pid-to-status mappings for waitpid */
495 #endif
496 PERLVAR(Iosname,        char *)         /* operating system */
497
498 PERLVAR(Isighandlerp,   Sighandler_t)
499
500 PERLVARA(Ibody_roots,   PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
501
502 PERLVAR(Iunicode, U32)  /* Unicode features: $ENV{PERL_UNICODE} or -C */
503
504 PERLVARI(Imaxo, int,    MAXO)           /* maximum number of ops */
505
506 PERLVARI(Irunops,       runops_proc_t,  RUNOPS_DEFAULT)
507
508 /*
509 =for apidoc Amn|SV|PL_sv_undef
510 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
511
512 =for apidoc Amn|SV|PL_sv_no
513 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
514 C<&PL_sv_no>.
515
516 =for apidoc Amn|SV|PL_sv_yes
517 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
518 C<&PL_sv_yes>.
519
520 =cut
521 */
522
523 PERLVAR(Isv_undef,      SV)
524 PERLVAR(Isv_no,         SV)
525 PERLVAR(Isv_yes,        SV)
526
527 PERLVAR(Isubname,       SV *)           /* name of current subroutine */
528
529 PERLVAR(Isubline,       I32)            /* line this subroutine began on */
530 PERLVAR(Imin_intro_pending,     I32)    /* start of vars to introduce */
531
532 PERLVAR(Imax_intro_pending,     I32)    /* end of vars to introduce */
533 PERLVAR(Ipadix,         I32)            /* max used index in current "register" pad */
534
535 PERLVAR(Ipadix_floor,   I32)            /* how low may inner block reset padix */
536
537 PERLVAR(Ihints,         U32)            /* pragma-tic compile-time flags */
538
539 PERLVAR(Idebug,         VOL U32)        /* flags given to -D switch */
540
541 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
542 PERLVARI(Ibreakable_sub_gen, U32, 0)
543
544 PERLVARI(Iamagic_generation,    long,   0)
545
546 #ifdef USE_LOCALE_COLLATE
547 PERLVAR(Icollation_name,char *)         /* Name of current collation */
548 PERLVAR(Icollxfrm_base, Size_t)         /* Basic overhead in *xfrm() */
549 PERLVARI(Icollxfrm_mult,Size_t, 2)      /* Expansion factor in *xfrm() */
550 PERLVARI(Icollation_ix, U32,    0)      /* Collation generation index */
551 PERLVARI(Icollation_standard, bool,     TRUE)
552                                         /* Assume simple collation */
553 #endif /* USE_LOCALE_COLLATE */
554
555
556 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
557 #  define PERL___I -1
558 #else
559 #  define PERL___I 1
560 #endif
561 PERLVARI(Iutf8cache, I8, PERL___I)      /* Is the utf8 caching code enabled? */
562 #undef PERL___I
563
564
565 #ifdef USE_LOCALE_NUMERIC
566
567 PERLVARI(Inumeric_standard,     bool,   TRUE)
568                                         /* Assume simple numerics */
569 PERLVARI(Inumeric_local,        bool,   TRUE)
570                                         /* Assume local numerics */
571 PERLVAR(Inumeric_name,  char *)         /* Name of current numeric locale */
572 #endif /* !USE_LOCALE_NUMERIC */
573
574 /* utf8 character classes */
575 PERLVAR(Iutf8_alnum,    SV *)
576 PERLVAR(Iutf8_ascii,    SV *)
577 PERLVAR(Iutf8_alpha,    SV *)
578 PERLVAR(Iutf8_space,    SV *)
579 PERLVAR(Iutf8_perl_space,       SV *)
580 PERLVAR(Iutf8_perl_word,        SV *)
581 PERLVAR(Iutf8_posix_digit,      SV *)
582 PERLVAR(Iutf8_cntrl,    SV *)
583 PERLVAR(Iutf8_graph,    SV *)
584 PERLVAR(Iutf8_digit,    SV *)
585 PERLVAR(Iutf8_upper,    SV *)
586 PERLVAR(Iutf8_lower,    SV *)
587 PERLVAR(Iutf8_print,    SV *)
588 PERLVAR(Iutf8_punct,    SV *)
589 PERLVAR(Iutf8_xdigit,   SV *)
590 PERLVAR(Iutf8_mark,     SV *)
591 PERLVAR(Iutf8_X_begin,  SV *)
592 PERLVAR(Iutf8_X_extend, SV *)
593 PERLVAR(Iutf8_X_prepend,        SV *)
594 PERLVAR(Iutf8_X_non_hangul,     SV *)
595 PERLVAR(Iutf8_X_L,      SV *)
596 PERLVAR(Iutf8_X_LV,     SV *)
597 PERLVAR(Iutf8_X_LVT,    SV *)
598 PERLVAR(Iutf8_X_T,      SV *)
599 PERLVAR(Iutf8_X_V,      SV *)
600 PERLVAR(Iutf8_X_LV_LVT_V,       SV *)
601 PERLVAR(Iutf8_toupper,  SV *)
602 PERLVAR(Iutf8_totitle,  SV *)
603 PERLVAR(Iutf8_tolower,  SV *)
604 PERLVAR(Iutf8_tofold,   SV *)
605 PERLVAR(Ilast_swash_hv, HV *)
606 PERLVAR(Ilast_swash_tmps,       U8 *)
607 PERLVAR(Ilast_swash_slen,       STRLEN)
608 PERLVARA(Ilast_swash_key,10,    U8)
609 PERLVAR(Ilast_swash_klen,       U8)     /* Only needs to store 0-10  */
610
611 #ifdef FCRYPT
612 PERLVARI(Icryptseen,    bool,   FALSE)  /* has fast crypt() been initialized? */
613 #endif
614
615 PERLVAR(Ipad_reset_pending,     bool)   /* reset pad on next attempted alloc */
616
617 PERLVARI(Iglob_index,   int,    0)
618
619
620 PERLVAR(Iparser,        yy_parser *)    /* current parser state */
621
622 /* Array of signal handlers, indexed by signal number, through which the C
623    signal handler dispatches.  */
624 PERLVAR(Ipsig_ptr, SV**)
625 /* Array of names of signals, indexed by signal number, for (re)use as the first
626    argument to a signal handler.   Only one block of memory is allocated for
627    both psig_name and psig_ptr.  */
628 PERLVAR(Ipsig_name, SV**)               
629
630 #if defined(PERL_IMPLICIT_SYS)
631 PERLVAR(IMem,           struct IPerlMem*)
632 PERLVAR(IMemShared,     struct IPerlMem*)
633 PERLVAR(IMemParse,      struct IPerlMem*)
634 PERLVAR(IEnv,           struct IPerlEnv*)
635 PERLVAR(IStdIO,         struct IPerlStdIO*)
636 PERLVAR(ILIO,           struct IPerlLIO*)
637 PERLVAR(IDir,           struct IPerlDir*)
638 PERLVAR(ISock,          struct IPerlSock*)
639 PERLVAR(IProc,          struct IPerlProc*)
640 #endif
641
642 PERLVAR(Iptr_table,     PTR_TBL_t*)
643 PERLVARI(Ibeginav_save, AV*, NULL)      /* save BEGIN{}s when compiling */
644
645 PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
646
647
648 #ifdef USE_LOCALE_NUMERIC
649
650 PERLVAR(Inumeric_radix_sv,      SV *)   /* The radix separator if not '.' */
651
652 #endif
653
654 #if defined(USE_ITHREADS)
655 PERLVAR(Iregex_pad,     SV**)           /* Shortcut into the array of
656                                            regex_padav */
657 PERLVAR(Iregex_padav,   AV*)            /* All regex objects, indexed via the
658                                            values in op_pmoffset of pmop.
659                                            Entry 0 is an SV whose PV is a
660                                            "packed" list of IVs listing
661                                            the now-free slots in the array */
662 #endif
663
664 #ifdef USE_REENTRANT_API
665 PERLVAR(Ireentrant_buffer, REENTR*)     /* here we store the _r buffers */
666 #endif
667
668 PERLVAR(Icustom_op_names, HV*)  /* Names of user defined ops */
669 PERLVAR(Icustom_op_descs, HV*)  /* Descriptions of user defined ops */
670
671 #ifdef PERLIO_LAYERS
672 PERLVARI(Iperlio, PerlIOl *,NULL)
673 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
674 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
675 #endif
676
677 PERLVARI(Iencoding,     SV*, NULL)              /* character encoding */
678
679 PERLVAR(Idebug_pad,     struct perl_debug_pad)  /* always needed because of the re extension */
680
681 PERLVAR(Iutf8_idstart,  SV *)
682 PERLVAR(Iutf8_idcont,   SV *)
683 PERLVAR(Iutf8_xidstart, SV *)
684 PERLVAR(Iutf8_xidcont,  SV *)
685
686 PERLVAR(Isort_RealCmp,  SVCOMPARE_t)
687
688 PERLVARI(Icheckav_save, AV*, NULL)      /* save CHECK{}s when compiling */
689 PERLVARI(Iunitcheckav_save, AV*, NULL)  /* save UNITCHECK{}s when compiling */
690
691 PERLVARI(Iclocktick, long, 0)   /* this many times() ticks in a second */
692
693 PERLVAR(Istashcache,    HV *)           /* Cache to speed up S_method_common */
694
695 /* Hooks to shared SVs and locks. */
696 PERLVARI(Isharehook,    share_proc_t,   Perl_sv_nosharing)
697 PERLVARI(Ilockhook,     share_proc_t,   Perl_sv_nosharing)
698 #ifdef NO_MATHOMS
699 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
700 #else
701 /* This reference ensures that the mathoms are linked with perl */
702 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
703 #endif
704 PERLVARI(Iunlockhook,   share_proc_t,   PERL_UNLOCK_HOOK)
705
706 PERLVARI(Ithreadhook,   thrhook_proc_t, Perl_nothreadhook)
707
708 /* Can shared object be destroyed */
709 PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
710
711 #ifndef PERL_MICRO
712 PERLVARI(Isignalhook,   despatch_signals_proc_t, Perl_despatch_signals)
713 #endif
714
715 PERLVARI(Ihash_seed, UV, 0)             /* Hash initializer */
716
717 PERLVARI(Irehash_seed, UV, 0)           /* 582 hash initializer */
718
719 PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
720
721 /* Register of known Method Resolution Orders.
722    What this actually points to is an implementation detail (it may change to
723    a structure incorporating a reference count - use mro_get_from_name to
724    retrieve a C<struct mro_alg *>  */
725 PERLVAR(Iregistered_mros, HV *)
726
727 /* Compile-time block start/end hooks */
728 PERLVAR(Iblockhooks, AV *)
729
730 /* Everything that folds to a given character, for case insensitivity regex
731  * matching */
732 PERLVARI(Iutf8_foldclosures,    HV *, NULL)
733
734 /* List of characters that participate in folds (except marks, etc in
735  * multi-char folds) */
736 PERLVARI(Iutf8_foldable,        HV *, NULL)
737
738 PERLVAR(Icustom_ops, HV *)      /* custom op registrations */
739
740 PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
741
742 /* The last unconditional member of the interpreter structure when 5.10.0 was
743    released. The offset of the end of this is baked into a global variable in 
744    any shared perl library which will allow a sanity test in future perl
745    releases.  */
746 #define PERL_LAST_5_16_0_INTERP_MEMBER  Ireentrant_retint
747
748 #ifdef PERL_IMPLICIT_CONTEXT
749 PERLVARI(Imy_cxt_size, int, 0)          /* size of PL_my_cxt_list */
750 PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
751 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
752 PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
753 #  endif
754 #endif
755
756 #ifdef PERL_TRACK_MEMPOOL
757 /* For use with the memory debugging code in util.c  */
758 PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
759 #endif
760
761 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
762 /* File descriptor to talk to the child which dumps scalars.  */
763 PERLVARI(Idumper_fd, int, -1)
764 #endif
765
766 /* Stores the PPID */
767 #ifdef THREADS_HAVE_PIDS
768 PERLVARI(Ippid,         IV,             0)
769 #endif
770
771 #ifdef PERL_MAD
772 PERLVARI(Imadskills,    bool, FALSE)    /* preserve all syntactic info */
773                                         /* (MAD = Misc Attribute Decoration) */
774 PERLVARI(Ixmlfp, PerlIO *,NULL)
775 #endif
776
777 #ifdef PL_OP_SLAB_ALLOC
778 PERLVAR(IOpPtr,I32 **)
779 PERLVARI(IOpSpace,I32,0)
780 PERLVAR(IOpSlab,I32 *)
781 #endif
782
783 #ifdef PERL_DEBUG_READONLY_OPS
784 PERLVARI(Islabs, I32**, NULL)   /* Array of slabs that have been allocated */
785 PERLVARI(Islab_count, U32, 0)   /* Size of the array */
786 #endif
787
788 #ifdef DEBUG_LEAKING_SCALARS
789 PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
790 #endif
791
792 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
793  * above on where there are gaps which currently will be structure padding.  */
794
795 /* Within a stable branch, new variables must be added to the very end, before
796  * this comment, for binary compatibility (the offsets of the old members must
797  *  not change).
798  * (Don't forget to add your variable also to perl_clone()!)
799  * XSUB.h provides wrapper functions via perlapi.h that make this
800  * irrelevant, but not all code may be expected to #include XSUB.h.
801  */