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)
181 PERLVARI(Icopline, line_t, NOLINE)
183 /* statics moved here for shared library purposes */
184 PERLVARI(Igensym, I32, 0) /* next symbol for getsym() to define */
185 PERLVAR(Ifilemode, int) /* so nextargv() can preserve mode */
186 PERLVAR(Ilastfd, int) /* what to preserve mode on */
187 PERLVAR(Ioldname, char *) /* what to preserve mode on */
188 PERLVAR(IArgv, char **) /* stuff to free from do_aexec, vfork safe */
189 PERLVAR(ICmd, char *) /* stuff to free from do_aexec, vfork safe */
190 PERLVAR(Ipreambleav, AV *)
191 PERLVAR(Imess_sv, SV *)
192 PERLVAR(Iors_sv, SV *) /* output record separator $\ */
193 /* Space for one more U16 here without increasing the structure size */
194 PERLVAR(Ilast_lop_op, OPCODE) /* last list operator */
195 PERLVAR(Iin_my, U16) /* we're compiling a "my" (or "our") declaration */
196 PERLVARI(Ilaststype, U16, OP_STAT)
197 PERLVARI(Ilaststatval, int, -1)
199 /* interpreter atexit processing */
200 PERLVARI(Iexitlistlen, I32, 0) /* length of same */
201 PERLVARI(Iexitlist, PerlExitListEntry *, NULL)
202 /* list of exit functions */
205 =for apidoc Amn|HV*|PL_modglobal
207 C<PL_modglobal> is a general purpose, interpreter global HV for use by
208 extensions that need to keep information on a per-interpreter basis.
209 In a pinch, it can also be used as a symbol table for extensions
210 to share data among each other. It is a good idea to use keys
211 prefixed by the package name of the extension that owns the data.
216 PERLVAR(Imodglobal, HV *) /* per-interp module data */
218 /* these used to be in global before 5.004_68 */
219 PERLVARI(Iprofiledata, U32 *, NULL) /* table of ops, counts */
220 PERLVARI(Irsfp, PerlIO * VOL, NULL) /* current source file pointer */
221 PERLVARI(Irsfp_filters, AV *, NULL) /* keeps active source filters */
223 PERLVAR(Icompiling, COP) /* compiling/done executing marker */
225 PERLVAR(Icompcv, CV *) /* currently compiling subroutine */
226 PERLVAR(Icomppad, AV *) /* storage for lexically scoped temporaries */
227 PERLVAR(Icomppad_name, AV *) /* variable names for "my" variables */
228 PERLVAR(Icomppad_name_fill, I32) /* last "introduced" variable offset */
229 PERLVAR(Icomppad_name_floor, I32) /* start of vars in innermost block */
231 #ifdef HAVE_INTERP_INTERN
232 PERLVAR(Isys_intern, struct interp_intern)
233 /* platform internals */
236 /* more statics moved here */
237 PERLVAR(IDBcv, CV *) /* from perl.c */
238 PERLVARI(Igeneration, int, 100) /* from op.c */
240 PERLVARI(Iin_clean_objs,bool, FALSE) /* from sv.c */
241 PERLVARI(Iin_clean_all, bool, FALSE) /* from sv.c */
242 PERLVAR(Inomemok, bool) /* let malloc context handle nomem */
243 PERLVARI(Isavebegin, bool, FALSE) /* save BEGINs for compiler */
245 PERLVAR(Ilinestart, char *) /* beg. of most recently read line */
247 PERLVAR(Iuid, Uid_t) /* current real user id */
248 PERLVAR(Ieuid, Uid_t) /* current effective user id */
249 PERLVAR(Igid, Gid_t) /* current real group id */
250 PERLVAR(Iegid, Gid_t) /* current effective group id */
251 PERLVARI(Ian, U32, 0) /* malloc sequence number */
252 PERLVARI(Icop_seqmax, U32, 0) /* statement sequence number */
253 PERLVARI(Ievalseq, U32, 0) /* eval sequence number */
254 PERLVAR(Iorigalen, U32)
255 PERLVAR(Iorigenviron, char **)
256 #ifdef PERL_USES_PL_PIDSTATUS
257 PERLVAR(Ipidstatus, HV *) /* pid-to-status mappings for waitpid */
259 PERLVAR(Iosname, char *) /* operating system */
261 PERLVAR(Isighandlerp, Sighandler_t)
263 PERLVARA(Ibody_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
265 PERLVAR(Inice_chunk, char *) /* a nice chunk of memory to reuse */
266 PERLVAR(Inice_chunk_size, U32) /* how nice the chunk of memory is */
268 PERLVARI(Imaxo, int, MAXO) /* maximum number of ops */
270 PERLVARI(Irunops, runops_proc_t, MEMBER_TO_FPTR(RUNOPS_DEFAULT))
272 PERLVARA(Itokenbuf,256, char)
275 =for apidoc Amn|SV|PL_sv_undef
276 This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
278 =for apidoc Amn|SV|PL_sv_no
279 This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
282 =for apidoc Amn|SV|PL_sv_yes
283 This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
289 PERLVAR(Isv_undef, SV)
293 /* What we know when we're in LEX_KNOWNEXT state. */
295 PERLVARA(Inexttoke,5, NEXTTOKE) /* value of next token, if any */
296 PERLVAR(Icurforce, I32)
298 PERLVARA(Inextval,5, YYSTYPE) /* value of next token, if any */
299 PERLVARA(Inexttype,5, I32) /* type of next token */
300 PERLVAR(Inexttoke, I32)
303 PERLVAR(Ibufptr, char *)
304 PERLVAR(Ioldbufptr, char *)
305 PERLVAR(Ioldoldbufptr, char *)
306 PERLVAR(Ibufend, char *)
308 PERLVARI(Iexpect, U8, XSTATE) /* how to interpret ambiguous tokens */
309 PERLVAR(Ilex_state, U8) /* next token is determined */
310 PERLVAR(Ierror_count, U8) /* how many errors so far, max 10 */
311 PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
312 PERLVAR(Imulti_end, I32) /* last line of multi-line string */
314 PERLVAR(Isubname, SV *) /* name of current subroutine */
316 PERLVAR(Isubline, I32) /* line this subroutine began on */
317 PERLVAR(Imin_intro_pending, I32) /* start of vars to introduce */
319 PERLVAR(Imax_intro_pending, I32) /* end of vars to introduce */
320 PERLVAR(Ipadix, I32) /* max used index in current "register" pad */
322 PERLVAR(Ipadix_floor, I32) /* how low may inner block reset padix */
323 PERLVAR(Ipad_reset_pending, I32) /* reset pad on next attempted alloc */
325 PERLVAR(Ilast_uni, char *) /* position of last named-unary op */
326 PERLVAR(Ilast_lop, char *) /* position of last list operator */
327 PERLVAR(Iin_my_stash, HV *) /* declared class of this "my" declaration */
329 PERLVAR(Ihints, U32) /* pragma-tic compile-time flags */
331 PERLVAR(Idebug, VOL U32) /* flags given to -D switch */
333 PERLVARI(Iamagic_generation, long, 0)
335 #ifdef USE_LOCALE_COLLATE
336 PERLVAR(Icollation_name,char *) /* Name of current collation */
337 PERLVAR(Icollxfrm_base, Size_t) /* Basic overhead in *xfrm() */
338 PERLVARI(Icollxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
339 PERLVARI(Icollation_ix, U32, 0) /* Collation generation index */
340 PERLVARI(Icollation_standard, bool, TRUE)
341 /* Assume simple collation */
342 #endif /* USE_LOCALE_COLLATE */
345 #ifdef PERL_UTF8_CACHE_ASSERT
346 PERLVARI(Iutf8cache, I8, -1) /* Is the utf8 caching code enabled? */
348 PERLVARI(Iutf8cache, I8, 1) /* Is the utf8 caching code enabled? */
351 #ifdef USE_LOCALE_NUMERIC
353 PERLVARI(Inumeric_standard, bool, TRUE)
354 /* Assume simple numerics */
355 PERLVARI(Inumeric_local, bool, TRUE)
356 /* Assume local numerics */
357 PERLVAR(Inumeric_name, char *) /* Name of current numeric locale */
358 #endif /* !USE_LOCALE_NUMERIC */
360 /* utf8 character classes */
361 PERLVAR(Iutf8_alnum, SV *)
362 PERLVAR(Iutf8_alnumc, SV *)
363 PERLVAR(Iutf8_ascii, SV *)
364 PERLVAR(Iutf8_alpha, SV *)
365 PERLVAR(Iutf8_space, SV *)
366 PERLVAR(Iutf8_cntrl, SV *)
367 PERLVAR(Iutf8_graph, SV *)
368 PERLVAR(Iutf8_digit, SV *)
369 PERLVAR(Iutf8_upper, SV *)
370 PERLVAR(Iutf8_lower, SV *)
371 PERLVAR(Iutf8_print, SV *)
372 PERLVAR(Iutf8_punct, SV *)
373 PERLVAR(Iutf8_xdigit, SV *)
374 PERLVAR(Iutf8_mark, SV *)
375 PERLVAR(Iutf8_toupper, SV *)
376 PERLVAR(Iutf8_totitle, SV *)
377 PERLVAR(Iutf8_tolower, SV *)
378 PERLVAR(Iutf8_tofold, SV *)
379 PERLVAR(Ilast_swash_hv, HV *)
380 PERLVAR(Ilast_swash_tmps, U8 *)
381 PERLVAR(Ilast_swash_slen, STRLEN)
382 PERLVARA(Ilast_swash_key,10, U8)
383 PERLVAR(Ilast_swash_klen, U8) /* Only needs to store 0-10 */
386 PERLVARI(Icryptseen, bool, FALSE) /* has fast crypt() been initialized? */
389 PERLVARI(Iglob_index, int, 0)
392 PERLVAR(Iparser, yy_parser *) /* current parser state */
394 PERLVAR(Ibitcount, char *)
396 PERLVAR(Ipsig_ptr, SV**)
397 PERLVAR(Ipsig_name, SV**)
399 #if defined(PERL_IMPLICIT_SYS)
400 PERLVAR(IMem, struct IPerlMem*)
401 PERLVAR(IMemShared, struct IPerlMem*)
402 PERLVAR(IMemParse, struct IPerlMem*)
403 PERLVAR(IEnv, struct IPerlEnv*)
404 PERLVAR(IStdIO, struct IPerlStdIO*)
405 PERLVAR(ILIO, struct IPerlLIO*)
406 PERLVAR(IDir, struct IPerlDir*)
407 PERLVAR(ISock, struct IPerlSock*)
408 PERLVAR(IProc, struct IPerlProc*)
411 PERLVAR(Iptr_table, PTR_TBL_t*)
412 PERLVARI(Ibeginav_save, AV*, NULL) /* save BEGIN{}s when compiling */
414 PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
416 PERLVAR(Ipsig_pend, int *) /* per-signal "count" of pending */
417 PERLVARI(Isig_pending, int,0) /* Number if highest signal pending */
420 PERLVAR(Itaint_warn, bool) /* taint warns instead of dying */
421 PERLVAR(Iutf8locale, bool) /* utf8 locale detected */
422 PERLVARI(Ihash_seed_set, bool, FALSE) /* Hash initialized? */
423 PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
425 #ifdef USE_LOCALE_NUMERIC
427 PERLVAR(Inumeric_radix_sv, SV *) /* The radix separator if not '.' */
431 #if defined(USE_ITHREADS)
432 PERLVAR(Iregex_pad, SV**) /* All regex objects */
433 PERLVAR(Iregex_padav, AV*) /* All regex objects */
437 #ifdef USE_REENTRANT_API
438 PERLVAR(Ireentrant_buffer, REENTR*) /* here we store the _r buffers */
443 PERLVARI(Imadskills, bool, FALSE) /* preserve all syntactic info */
444 /* (MAD = Misc Attribute Decoration) */
445 PERLVARI(Ixmlfp, PerlIO *,NULL)
448 PERLVAR(Icustom_op_names, HV*) /* Names of user defined ops */
449 PERLVAR(Icustom_op_descs, HV*) /* Descriptions of user defined ops */
452 PERLVARI(Iperlio, PerlIO *,NULL)
453 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
454 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
457 PERLVARI(Iencoding, SV*, NULL) /* character encoding */
459 PERLVAR(Idebug_pad, struct perl_debug_pad) /* always needed because of the re extension */
461 #ifdef PL_OP_SLAB_ALLOC
462 PERLVAR(IOpPtr,I32 **)
463 PERLVARI(IOpSpace,I32,0)
464 PERLVAR(IOpSlab,I32 *)
467 PERLVAR(Iutf8_idstart, SV *)
468 PERLVAR(Iutf8_idcont, SV *)
470 PERLVAR(Isort_RealCmp, SVCOMPARE_t)
472 PERLVARI(Icheckav_save, AV*, NULL) /* save CHECK{}s when compiling */
473 PERLVARI(Iunitcheckav_save, AV*, NULL) /* save UNITCHECK{}s when compiling */
475 PERLVARI(Iclocktick, long, 0) /* this many times() ticks in a second */
477 PERLVARI(Iin_load_module, int, 0) /* to prevent recursions in PerlIO_find_layer */
479 PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
481 PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
483 PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
485 PERLVAR(Istashcache, HV *) /* Cache to speed up S_method_common */
487 /* Hooks to shared SVs and locks. */
488 PERLVARI(Isharehook, share_proc_t, MEMBER_TO_FPTR(Perl_sv_nosharing))
489 PERLVARI(Ilockhook, share_proc_t, MEMBER_TO_FPTR(Perl_sv_nosharing))
491 # define PERL_UNLOCK_HOOK Perl_sv_nosharing
493 /* This reference ensures that the mathoms are linked with perl */
494 # define PERL_UNLOCK_HOOK Perl_sv_nounlocking
496 PERLVARI(Iunlockhook, share_proc_t, MEMBER_TO_FPTR(PERL_UNLOCK_HOOK))
498 PERLVARI(Ithreadhook, thrhook_proc_t, MEMBER_TO_FPTR(Perl_nothreadhook))
500 /* Force inclusion of both runops options */
501 PERLVARI(Irunops_std, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_standard))
502 PERLVARI(Irunops_dbg, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_debug))
504 /* Stores the PPID */
505 #ifdef THREADS_HAVE_PIDS
506 PERLVARI(Ippid, IV, 0)
509 PERLVARI(Ihash_seed, UV, 0) /* Hash initializer */
511 PERLVAR(IDBassertion, SV *)
513 PERLVARI(Irehash_seed, UV, 0) /* 582 hash initializer */
515 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
516 /* File descriptor to talk to the child which dumps scalars. */
517 PERLVARI(Idumper_fd, int, -1)
520 #ifdef PERL_IMPLICIT_CONTEXT
521 PERLVARI(Imy_cxt_size, int, 0) /* size of PL_my_cxt_list */
522 PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
523 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
524 PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
528 #ifdef PERL_TRACK_MEMPOOL
529 /* For use with the memory debugging code in util.c */
530 PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
533 #ifdef PERL_DEBUG_READONLY_OPS
534 PERLVARI(Islabs, I32**, NULL) /* Array of slabs that have been allocated */
535 PERLVARI(Islab_count, U32, 0) /* Size of the array */
538 PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
540 /* If you are adding a U16, see the comment above on where there are 2 bytes
541 of gap which currently will be structure padding. */
543 /* Within a stable branch, new variables must be added to the very end, before
544 * this comment, for binary compatibility (the offsets of the old members must
546 * (Don't forget to add your variable also to perl_clone()!)
547 * XSUB.h provides wrapper functions via perlapi.h that make this
548 * irrelevant, but not all code may be expected to #include XSUB.h.