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