1 /***********************************************/
2 /* Global only to current interpreter instance */
3 /***********************************************/
5 /* Don't forget to re-run embed.pl to propagate changes! */
7 /* New variables must be added to the very end for binary compatibility.
8 * XSUB.h provides wrapper functions via perlapi.h that make this
9 * irrelevant, but not all code may be expected to #include XSUB.h. */
11 /* Don't forget to add your variable also to perl_clone()! */
13 /* The 'I' prefix is only needed for vars that need appropriate #defines
14 * generated when built with or without MULTIPLICITY. It is also used
15 * to generate the appropriate export list for win32.
17 * When building without MULTIPLICITY, these variables will be truly global. */
20 /* For historical reasons this file follows thrdvar.h into the interpeter
21 struct, and that file currently ends with 7 bytes of variables, so putting
22 one last byte here is good for alignment. */
24 /* This value may be set when embedding for full cleanup */
25 /* 0=none, 1=full, 2=full with checks */
26 PERLVARI(Iperl_destruct_level, U8, 0)
30 /* pseudo environmental stuff */
31 PERLVAR(Iorigargc, int)
32 PERLVAR(Iorigargv, char **)
35 PERLVAR(Ihintgv, GV *)
36 PERLVAR(Iorigfilename, char *)
37 PERLVAR(Idiehook, SV *)
38 PERLVAR(Iwarnhook, SV *)
41 PERLVAR(Ipatchlevel, SV *)
42 PERLVAR(Ilocalpatches, const char * const *)
43 PERLVARI(Isplitstr, const char *, " ")
45 PERLVAR(Iminus_c, bool)
46 PERLVAR(Ipreprocess, bool)
47 PERLVAR(Iminus_n, bool)
48 PERLVAR(Iminus_p, bool)
49 PERLVAR(Iminus_l, bool)
50 PERLVAR(Iminus_a, bool)
51 PERLVAR(Iminus_F, bool)
52 PERLVAR(Idoswitches, bool)
54 PERLVAR(Iminus_E, bool)
57 =head1 Global Variables
59 =for apidoc mn|bool|PL_dowarn
61 The C variable which corresponds to Perl's $^W warning variable.
67 PERLVAR(Idoextract, bool)
68 PERLVAR(Isawampersand, bool) /* must save all match strings */
69 PERLVAR(Iunsafe, bool)
70 PERLVAR(Iexit_flags, U8) /* was exit() unexpected, etc. */
71 PERLVAR(Isrand_called, bool)
72 /* Part of internal state, but makes the 16th 1 byte variable in a row. */
73 PERLVAR(Itainting, bool) /* doing taint checks */
74 PERLVAR(Iinplace, char *)
75 PERLVAR(Ie_script, SV *)
77 /* magical thingies */
78 PERLVAR(Ibasetime, Time_t) /* $^T */
79 PERLVAR(Iformfeed, SV *) /* $^L */
82 PERLVARI(Imaxsysfd, I32, MAXSYSFD)
83 /* top fd to pass to subprocesses */
84 PERLVAR(Istatusvalue, I32) /* $? */
86 PERLVAR(Istatusvalue_vms,U32)
88 PERLVAR(Istatusvalue_posix,I32)
92 PERLVARI(Icshlen, I32, 0)
93 PERLVARI(Icshname, const char *, CSH)
96 /* shortcuts to various I/O objects */
97 PERLVAR(Istdingv, GV *)
98 PERLVAR(Istderrgv, GV *)
100 PERLVAR(Iargvgv, GV *)
101 PERLVAR(Iargvoutgv, GV *)
102 PERLVAR(Iargvout_stack, AV *)
104 /* shortcuts to regexp stuff */
105 /* this one needs to be moved to thrdvar.h and accessed via
106 * find_threadsv() when USE_5005THREADS */
107 PERLVAR(Ireplgv, GV *)
109 /* shortcuts to misc objects */
110 PERLVAR(Ierrgv, GV *)
112 /* shortcuts to debugging objects */
114 PERLVAR(IDBline, GV *)
117 =for apidoc mn|GV *|PL_DBsub
118 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
119 the SV which holds the name of the sub being debugged. This is the C
120 variable which corresponds to Perl's $DB::sub variable. See
123 =for apidoc mn|SV *|PL_DBsingle
124 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
125 boolean which indicates whether subs are being single-stepped.
126 Single-stepping is automatically turned on after every step. This is the C
127 variable which corresponds to Perl's $DB::single variable. See
130 =for apidoc mn|SV *|PL_DBtrace
131 Trace variable used when Perl is run in debugging mode, with the B<-d>
132 switch. This is the C variable which corresponds to Perl's $DB::trace
133 variable. See C<PL_DBsingle>.
138 PERLVAR(IDBsub, GV *)
139 PERLVAR(IDBsingle, SV *)
140 PERLVAR(IDBtrace, SV *)
141 PERLVAR(IDBsignal, SV *)
142 PERLVAR(Ilineary, AV *) /* lines of script for debugger */
143 PERLVAR(Idbargs, AV *) /* args to call listed by caller function */
146 PERLVAR(Idebstash, HV *) /* symbol table for perldb package */
147 PERLVAR(Iglobalstash, HV *) /* global keyword overrides imported here */
148 PERLVAR(Icurstname, SV *) /* name of current package */
149 PERLVAR(Ibeginav, AV *) /* names of BEGIN subroutines */
150 PERLVAR(Iendav, AV *) /* names of END subroutines */
151 PERLVAR(Iunitcheckav, AV *) /* names of UNITCHECK subroutines */
152 PERLVAR(Icheckav, AV *) /* names of CHECK subroutines */
153 PERLVAR(Iinitav, AV *) /* names of INIT subroutines */
154 PERLVAR(Istrtab, HV *) /* shared string table */
155 PERLVARI(Isub_generation,U32,1) /* incr to invalidate method cache */
157 /* funky return mechanisms */
158 PERLVAR(Iforkprocess, int) /* so do_open |- can return proc# */
160 /* memory management */
161 PERLVAR(Isv_count, I32) /* how many SV* are currently allocated */
162 PERLVAR(Isv_objcount, I32) /* how many objects are currently allocated */
163 PERLVAR(Isv_root, SV*) /* storage for SVs belonging to interp */
164 PERLVAR(Isv_arenaroot, SV*) /* list of areas for garbage collection */
166 /* subprocess state */
167 PERLVAR(Ifdpid, AV *) /* keep fd-to-pid mappings for my_popen */
170 PERLVARI(Iop_mask, char *, NULL) /* masked operations for safe evals */
172 /* current interpreter roots */
173 PERLVAR(Imain_cv, CV *)
174 PERLVAR(Imain_root, OP *)
175 PERLVAR(Imain_start, OP *)
176 PERLVAR(Ieval_root, OP *)
177 PERLVAR(Ieval_start, OP *)
179 /* runtime control stuff */
180 PERLVARI(Icurcopdb, COP *, NULL)
182 /* statics moved here for shared library purposes */
183 PERLVARI(Igensym, I32, 0) /* next symbol for getsym() to define */
184 PERLVAR(Ifilemode, int) /* so nextargv() can preserve mode */
185 PERLVAR(Ilastfd, int) /* what to preserve mode on */
186 PERLVAR(Ioldname, char *) /* what to preserve mode on */
187 PERLVAR(IArgv, char **) /* stuff to free from do_aexec, vfork safe */
188 PERLVAR(ICmd, char *) /* stuff to free from do_aexec, vfork safe */
189 PERLVAR(Ipreambleav, AV *)
190 PERLVAR(Imess_sv, SV *)
191 PERLVAR(Iors_sv, SV *) /* output record separator $\ */
192 PERLVAR(Iin_my, U16) /* we're compiling a "my" (or "our") declaration */
193 PERLVARI(Ilaststype, U16, OP_STAT)
194 PERLVARI(Ilaststatval, int, -1)
196 /* interpreter atexit processing */
197 PERLVARI(Iexitlistlen, I32, 0) /* length of same */
198 PERLVARI(Iexitlist, PerlExitListEntry *, NULL)
199 /* list of exit functions */
202 =for apidoc Amn|HV*|PL_modglobal
204 C<PL_modglobal> is a general purpose, interpreter global HV for use by
205 extensions that need to keep information on a per-interpreter basis.
206 In a pinch, it can also be used as a symbol table for extensions
207 to share data among each other. It is a good idea to use keys
208 prefixed by the package name of the extension that owns the data.
213 PERLVAR(Imodglobal, HV *) /* per-interp module data */
215 /* these used to be in global before 5.004_68 */
216 PERLVARI(Iprofiledata, U32 *, NULL) /* table of ops, counts */
217 PERLVARI(Irsfp, PerlIO * VOL, NULL) /* current source file pointer */
218 PERLVARI(Irsfp_filters, AV *, NULL) /* keeps active source filters */
220 PERLVAR(Icompiling, COP) /* compiling/done executing marker */
222 PERLVAR(Icompcv, CV *) /* currently compiling subroutine */
223 PERLVAR(Icomppad, AV *) /* storage for lexically scoped temporaries */
224 PERLVAR(Icomppad_name, AV *) /* variable names for "my" variables */
225 PERLVAR(Icomppad_name_fill, I32) /* last "introduced" variable offset */
226 PERLVAR(Icomppad_name_floor, I32) /* start of vars in innermost block */
228 #ifdef HAVE_INTERP_INTERN
229 PERLVAR(Isys_intern, struct interp_intern)
230 /* platform internals */
233 /* more statics moved here */
234 PERLVAR(IDBcv, CV *) /* from perl.c */
235 PERLVARI(Igeneration, int, 100) /* from op.c */
237 PERLVARI(Iin_clean_objs,bool, FALSE) /* from sv.c */
238 PERLVARI(Iin_clean_all, bool, FALSE) /* from sv.c */
239 PERLVAR(Inomemok, bool) /* let malloc context handle nomem */
240 PERLVARI(Isavebegin, bool, FALSE) /* save BEGINs for compiler */
242 PERLVAR(Iuid, Uid_t) /* current real user id */
243 PERLVAR(Ieuid, Uid_t) /* current effective user id */
244 PERLVAR(Igid, Gid_t) /* current real group id */
245 PERLVAR(Iegid, Gid_t) /* current effective group id */
246 PERLVARI(Ian, U32, 0) /* malloc sequence number */
247 PERLVARI(Icop_seqmax, U32, 0) /* statement sequence number */
248 PERLVARI(Ievalseq, U32, 0) /* eval sequence number */
249 PERLVAR(Iorigalen, U32)
250 PERLVAR(Iorigenviron, char **)
251 #ifdef PERL_USES_PL_PIDSTATUS
252 PERLVAR(Ipidstatus, HV *) /* pid-to-status mappings for waitpid */
254 PERLVAR(Iosname, char *) /* operating system */
256 PERLVAR(Isighandlerp, Sighandler_t)
258 PERLVARA(Ibody_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
260 PERLVAR(Inice_chunk, char *) /* a nice chunk of memory to reuse */
261 PERLVAR(Inice_chunk_size, U32) /* how nice the chunk of memory is */
263 PERLVARI(Imaxo, int, MAXO) /* maximum number of ops */
265 PERLVARI(Irunops, runops_proc_t, MEMBER_TO_FPTR(RUNOPS_DEFAULT))
267 PERLVARA(Itokenbuf,256, char)
270 =for apidoc Amn|SV|PL_sv_undef
271 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
273 =for apidoc Amn|SV|PL_sv_no
274 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
277 =for apidoc Amn|SV|PL_sv_yes
278 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
284 PERLVAR(Isv_undef, SV)
288 /* What we know when we're in LEX_KNOWNEXT state. */
290 PERLVARA(Inexttoke,5, NEXTTOKE) /* value of next token, if any */
291 PERLVAR(Icurforce, I32)
293 PERLVARA(Inextval,5, YYSTYPE) /* value of next token, if any */
294 PERLVARA(Inexttype,5, I32) /* type of next token */
295 PERLVAR(Inexttoke, I32)
298 PERLVAR(Ilex_state, U8) /* next token is determined */
299 PERLVAR(Ierror_count, U8) /* how many errors so far, max 10 */
300 PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
301 /* Space for one more U8 here without increasing the structure size */
303 PERLVAR(Imulti_end, I32) /* last line of multi-line string */
305 PERLVAR(Isubname, SV *) /* name of current subroutine */
307 PERLVAR(Isubline, I32) /* line this subroutine began on */
308 PERLVAR(Imin_intro_pending, I32) /* start of vars to introduce */
310 PERLVAR(Imax_intro_pending, I32) /* end of vars to introduce */
311 PERLVAR(Ipadix, I32) /* max used index in current "register" pad */
313 PERLVAR(Ipadix_floor, I32) /* how low may inner block reset padix */
314 PERLVAR(Ipad_reset_pending, I32) /* reset pad on next attempted alloc */
316 PERLVAR(Iin_my_stash, HV *) /* declared class of this "my" declaration */
318 PERLVAR(Ihints, U32) /* pragma-tic compile-time flags */
320 PERLVAR(Idebug, VOL U32) /* flags given to -D switch */
322 PERLVARI(Iamagic_generation, long, 0)
324 #ifdef USE_LOCALE_COLLATE
325 PERLVAR(Icollation_name,char *) /* Name of current collation */
326 PERLVAR(Icollxfrm_base, Size_t) /* Basic overhead in *xfrm() */
327 PERLVARI(Icollxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
328 PERLVARI(Icollation_ix, U32, 0) /* Collation generation index */
329 PERLVARI(Icollation_standard, bool, TRUE)
330 /* Assume simple collation */
331 #endif /* USE_LOCALE_COLLATE */
334 #ifdef PERL_UTF8_CACHE_ASSERT
335 PERLVARI(Iutf8cache, I8, -1) /* Is the utf8 caching code enabled? */
337 PERLVARI(Iutf8cache, I8, 1) /* Is the utf8 caching code enabled? */
340 #ifdef USE_LOCALE_NUMERIC
342 PERLVARI(Inumeric_standard, bool, TRUE)
343 /* Assume simple numerics */
344 PERLVARI(Inumeric_local, bool, TRUE)
345 /* Assume local numerics */
346 PERLVAR(Inumeric_name, char *) /* Name of current numeric locale */
347 #endif /* !USE_LOCALE_NUMERIC */
349 /* utf8 character classes */
350 PERLVAR(Iutf8_alnum, SV *)
351 PERLVAR(Iutf8_alnumc, SV *)
352 PERLVAR(Iutf8_ascii, SV *)
353 PERLVAR(Iutf8_alpha, SV *)
354 PERLVAR(Iutf8_space, SV *)
355 PERLVAR(Iutf8_cntrl, SV *)
356 PERLVAR(Iutf8_graph, SV *)
357 PERLVAR(Iutf8_digit, SV *)
358 PERLVAR(Iutf8_upper, SV *)
359 PERLVAR(Iutf8_lower, SV *)
360 PERLVAR(Iutf8_print, SV *)
361 PERLVAR(Iutf8_punct, SV *)
362 PERLVAR(Iutf8_xdigit, SV *)
363 PERLVAR(Iutf8_mark, SV *)
364 PERLVAR(Iutf8_toupper, SV *)
365 PERLVAR(Iutf8_totitle, SV *)
366 PERLVAR(Iutf8_tolower, SV *)
367 PERLVAR(Iutf8_tofold, SV *)
368 PERLVAR(Ilast_swash_hv, HV *)
369 PERLVAR(Ilast_swash_tmps, U8 *)
370 PERLVAR(Ilast_swash_slen, STRLEN)
371 PERLVARA(Ilast_swash_key,10, U8)
372 PERLVAR(Ilast_swash_klen, U8) /* Only needs to store 0-10 */
375 PERLVARI(Icryptseen, bool, FALSE) /* has fast crypt() been initialized? */
378 PERLVARI(Iglob_index, int, 0)
381 PERLVAR(Iparser, yy_parser *) /* current parser state */
383 PERLVAR(Ibitcount, char *)
385 PERLVAR(Ipsig_ptr, SV**)
386 PERLVAR(Ipsig_name, SV**)
388 #if defined(PERL_IMPLICIT_SYS)
389 PERLVAR(IMem, struct IPerlMem*)
390 PERLVAR(IMemShared, struct IPerlMem*)
391 PERLVAR(IMemParse, struct IPerlMem*)
392 PERLVAR(IEnv, struct IPerlEnv*)
393 PERLVAR(IStdIO, struct IPerlStdIO*)
394 PERLVAR(ILIO, struct IPerlLIO*)
395 PERLVAR(IDir, struct IPerlDir*)
396 PERLVAR(ISock, struct IPerlSock*)
397 PERLVAR(IProc, struct IPerlProc*)
400 PERLVAR(Iptr_table, PTR_TBL_t*)
401 PERLVARI(Ibeginav_save, AV*, NULL) /* save BEGIN{}s when compiling */
403 PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
405 PERLVAR(Ipsig_pend, int *) /* per-signal "count" of pending */
406 PERLVARI(Isig_pending, int,0) /* Number if highest signal pending */
409 PERLVAR(Itaint_warn, bool) /* taint warns instead of dying */
410 PERLVAR(Iutf8locale, bool) /* utf8 locale detected */
411 PERLVARI(Ihash_seed_set, bool, FALSE) /* Hash initialized? */
412 PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
414 #ifdef USE_LOCALE_NUMERIC
416 PERLVAR(Inumeric_radix_sv, SV *) /* The radix separator if not '.' */
420 #if defined(USE_ITHREADS)
421 PERLVAR(Iregex_pad, SV**) /* All regex objects */
422 PERLVAR(Iregex_padav, AV*) /* All regex objects */
426 #ifdef USE_REENTRANT_API
427 PERLVAR(Ireentrant_buffer, REENTR*) /* here we store the _r buffers */
432 PERLVARI(Imadskills, bool, FALSE) /* preserve all syntactic info */
433 /* (MAD = Misc Attribute Decoration) */
434 PERLVARI(Ixmlfp, PerlIO *,NULL)
437 PERLVAR(Icustom_op_names, HV*) /* Names of user defined ops */
438 PERLVAR(Icustom_op_descs, HV*) /* Descriptions of user defined ops */
441 PERLVARI(Iperlio, PerlIO *,NULL)
442 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
443 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
446 PERLVARI(Iencoding, SV*, NULL) /* character encoding */
448 PERLVAR(Idebug_pad, struct perl_debug_pad) /* always needed because of the re extension */
450 #ifdef PL_OP_SLAB_ALLOC
451 PERLVAR(IOpPtr,I32 **)
452 PERLVARI(IOpSpace,I32,0)
453 PERLVAR(IOpSlab,I32 *)
456 PERLVAR(Iutf8_idstart, SV *)
457 PERLVAR(Iutf8_idcont, SV *)
459 PERLVAR(Isort_RealCmp, SVCOMPARE_t)
461 PERLVARI(Icheckav_save, AV*, NULL) /* save CHECK{}s when compiling */
462 PERLVARI(Iunitcheckav_save, AV*, NULL) /* save UNITCHECK{}s when compiling */
464 PERLVARI(Iclocktick, long, 0) /* this many times() ticks in a second */
466 PERLVARI(Iin_load_module, int, 0) /* to prevent recursions in PerlIO_find_layer */
468 PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
470 PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
472 PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
474 PERLVAR(Istashcache, HV *) /* Cache to speed up S_method_common */
476 /* Hooks to shared SVs and locks. */
477 PERLVARI(Isharehook, share_proc_t, MEMBER_TO_FPTR(Perl_sv_nosharing))
478 PERLVARI(Ilockhook, share_proc_t, MEMBER_TO_FPTR(Perl_sv_nosharing))
480 # define PERL_UNLOCK_HOOK Perl_sv_nosharing
482 /* This reference ensures that the mathoms are linked with perl */
483 # define PERL_UNLOCK_HOOK Perl_sv_nounlocking
485 PERLVARI(Iunlockhook, share_proc_t, MEMBER_TO_FPTR(PERL_UNLOCK_HOOK))
487 PERLVARI(Ithreadhook, thrhook_proc_t, MEMBER_TO_FPTR(Perl_nothreadhook))
489 /* Force inclusion of both runops options */
490 PERLVARI(Irunops_std, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_standard))
491 PERLVARI(Irunops_dbg, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_debug))
493 /* Stores the PPID */
494 #ifdef THREADS_HAVE_PIDS
495 PERLVARI(Ippid, IV, 0)
498 PERLVARI(Ihash_seed, UV, 0) /* Hash initializer */
500 PERLVAR(IDBassertion, SV *)
502 PERLVARI(Irehash_seed, UV, 0) /* 582 hash initializer */
504 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
505 /* File descriptor to talk to the child which dumps scalars. */
506 PERLVARI(Idumper_fd, int, -1)
509 #ifdef PERL_IMPLICIT_CONTEXT
510 PERLVARI(Imy_cxt_size, int, 0) /* size of PL_my_cxt_list */
511 PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
512 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
513 PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
517 #ifdef PERL_TRACK_MEMPOOL
518 /* For use with the memory debugging code in util.c */
519 PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
522 #ifdef PERL_DEBUG_READONLY_OPS
523 PERLVARI(Islabs, I32**, NULL) /* Array of slabs that have been allocated */
524 PERLVARI(Islab_count, U32, 0) /* Size of the array */
527 PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
529 /* If you are adding a U8 or U16, see the 'Space' comments above on where
530 * there are gaps which currently will be structure padding. */
532 /* Within a stable branch, new variables must be added to the very end, before
533 * this comment, for binary compatibility (the offsets of the old members must
535 * (Don't forget to add your variable also to perl_clone()!)
536 * XSUB.h provides wrapper functions via perlapi.h that make this
537 * irrelevant, but not all code may be expected to #include XSUB.h.