This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
e578b1ab1975db53880dd38794b44571218a398e
[perl5.git] / intrpvar.h
1 /***********************************************/
2 /* Global only to current interpreter instance */
3 /***********************************************/
4
5 /* Don't forget to re-run embed.pl to propagate changes! */
6
7 /* The 'I' prefix is only needed for vars that need appropriate #defines
8  * generated when built with or without MULTIPLICITY.  It is also used
9  * to generate the appropriate export list for win32.
10  *
11  * When building without MULTIPLICITY, these variables will be truly global.
12  *
13  * Avoid build-specific #ifdefs here, like DEBUGGING.  That way,
14  * we can keep binary compatibility of the curinterp structure */
15
16 /* pseudo environmental stuff */
17 PERLVAR(Iorigargc,      int)
18 PERLVAR(Iorigargv,      char **)
19 PERLVAR(Ienvgv,         GV *)
20 PERLVAR(Iincgv,         GV *)
21 PERLVAR(Ihintgv,        GV *)
22 PERLVAR(Iorigfilename,  char *)
23 PERLVAR(Idiehook,       SV *)
24 PERLVAR(Iwarnhook,      SV *)
25
26 /* switches */
27 PERLVAR(Iminus_c,       bool)
28 PERLVAR(Ipatchlevel,    SV *)
29 PERLVAR(Ilocalpatches,  char **)
30 PERLVARI(Isplitstr,     char *, " ")
31 PERLVAR(Ipreprocess,    bool)
32 PERLVAR(Iminus_n,       bool)
33 PERLVAR(Iminus_p,       bool)
34 PERLVAR(Iminus_l,       bool)
35 PERLVAR(Iminus_a,       bool)
36 PERLVAR(Iminus_F,       bool)
37 PERLVAR(Idoswitches,    bool)
38
39 /*
40 =for apidoc Amn|bool|PL_dowarn
41
42 The C variable which corresponds to Perl's $^W warning variable.
43
44 =cut
45 */
46
47 PERLVAR(Idowarn,        U8)
48 PERLVAR(Iwidesyscalls,  bool)           /* wide system calls */
49 PERLVAR(Idoextract,     bool)
50 PERLVAR(Isawampersand,  bool)           /* must save all match strings */
51 PERLVAR(Iunsafe,        bool)
52 PERLVAR(Iinplace,       char *)
53 PERLVAR(Ie_script,      SV *)
54 PERLVAR(Iperldb,        U32)
55
56 /* This value may be set when embedding for full cleanup  */
57 /* 0=none, 1=full, 2=full with checks */
58 PERLVARI(Iperl_destruct_level,  int,    0)
59
60 /* magical thingies */
61 PERLVAR(Ibasetime,      Time_t)         /* $^T */
62 PERLVAR(Iformfeed,      SV *)           /* $^L */
63
64
65 PERLVARI(Imaxsysfd,     I32,    MAXSYSFD)
66                                         /* top fd to pass to subprocesses */
67 PERLVAR(Imultiline,     int)            /* $*--do strings hold >1 line? */
68 PERLVAR(Istatusvalue,   I32)            /* $? */
69 PERLVAR(Iexit_flags,    U8)             /* was exit() unexpected, etc. */
70 #ifdef VMS
71 PERLVAR(Istatusvalue_vms,U32)
72 #endif
73
74 /* shortcuts to various I/O objects */
75 PERLVAR(Istdingv,       GV *)
76 PERLVAR(Istderrgv,      GV *)
77 PERLVAR(Idefgv,         GV *)
78 PERLVAR(Iargvgv,        GV *)
79 PERLVAR(Iargvoutgv,     GV *)
80 PERLVAR(Iargvout_stack, AV *)
81
82 /* shortcuts to regexp stuff */
83 /* this one needs to be moved to thrdvar.h and accessed via
84  * find_threadsv() when USE_THREADS */
85 PERLVAR(Ireplgv,        GV *)
86
87 /* shortcuts to misc objects */
88 PERLVAR(Ierrgv,         GV *)
89
90 /* shortcuts to debugging objects */
91 PERLVAR(IDBgv,          GV *)
92 PERLVAR(IDBline,        GV *)
93
94 /*
95 =for apidoc Amn|GV *|PL_DBsub
96 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
97 the SV which holds the name of the sub being debugged.  This is the C
98 variable which corresponds to Perl's $DB::sub variable.  See
99 C<PL_DBsingle>.
100
101 =for apidoc Amn|SV *|PL_DBsingle
102 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
103 boolean which indicates whether subs are being single-stepped. 
104 Single-stepping is automatically turned on after every step.  This is the C
105 variable which corresponds to Perl's $DB::single variable.  See
106 C<PL_DBsub>.
107
108 =for apidoc Amn|SV *|PL_DBtrace
109 Trace variable used when Perl is run in debugging mode, with the B<-d>
110 switch.  This is the C variable which corresponds to Perl's $DB::trace
111 variable.  See C<PL_DBsingle>.
112
113 =cut
114 */
115
116 PERLVAR(IDBsub,         GV *)
117 PERLVAR(IDBsingle,      SV *)
118 PERLVAR(IDBtrace,       SV *)
119 PERLVAR(IDBsignal,      SV *)
120 PERLVAR(Ilineary,       AV *)           /* lines of script for debugger */
121 PERLVAR(Idbargs,        AV *)           /* args to call listed by caller function */
122
123 /* symbol tables */
124 PERLVAR(Idebstash,      HV *)           /* symbol table for perldb package */
125 PERLVAR(Iglobalstash,   HV *)           /* global keyword overrides imported here */
126 PERLVAR(Icurstname,     SV *)           /* name of current package */
127 PERLVAR(Ibeginav,       AV *)           /* names of BEGIN subroutines */
128 PERLVAR(Iendav,         AV *)           /* names of END subroutines */
129 PERLVAR(Icheckav,       AV *)           /* names of CHECK subroutines */
130 PERLVAR(Iinitav,        AV *)           /* names of INIT subroutines */
131 PERLVAR(Istrtab,        HV *)           /* shared string table */
132 PERLVARI(Isub_generation,U32,1)         /* incr to invalidate method cache */
133
134 /* memory management */
135 PERLVAR(Isv_count,      I32)            /* how many SV* are currently allocated */
136 PERLVAR(Isv_objcount,   I32)            /* how many objects are currently allocated */
137 PERLVAR(Isv_root,       SV*)            /* storage for SVs belonging to interp */
138 PERLVAR(Isv_arenaroot,  SV*)            /* list of areas for garbage collection */
139
140 /* funky return mechanisms */
141 PERLVAR(Iforkprocess,   int)            /* so do_open |- can return proc# */
142
143 /* subprocess state */
144 PERLVAR(Ifdpid,         AV *)           /* keep fd-to-pid mappings for my_popen */
145
146 /* internal state */
147 PERLVAR(Itainting,      bool)           /* doing taint checks */
148 PERLVARI(Iop_mask,      char *, NULL)   /* masked operations for safe evals */
149
150 /* current interpreter roots */
151 PERLVAR(Imain_cv,       CV *)
152 PERLVAR(Imain_root,     OP *)
153 PERLVAR(Imain_start,    OP *)
154 PERLVAR(Ieval_root,     OP *)
155 PERLVAR(Ieval_start,    OP *)
156
157 /* runtime control stuff */
158 PERLVARI(Icurcopdb,     COP *,  NULL)
159 PERLVARI(Icopline,      line_t, NOLINE)
160
161 /* statics moved here for shared library purposes */
162 PERLVAR(Ifilemode,      int)            /* so nextargv() can preserve mode */
163 PERLVAR(Ilastfd,        int)            /* what to preserve mode on */
164 PERLVAR(Ioldname,       char *)         /* what to preserve mode on */
165 PERLVAR(IArgv,          char **)        /* stuff to free from do_aexec, vfork safe */
166 PERLVAR(ICmd,           char *)         /* stuff to free from do_aexec, vfork safe */
167 PERLVAR(Igensym,        I32)            /* next symbol for getsym() to define */
168 PERLVAR(Ipreambled,     bool)
169 PERLVAR(Ipreambleav,    AV *)
170 PERLVARI(Ilaststatval,  int,    -1)
171 PERLVARI(Ilaststype,    I32,    OP_STAT)
172 PERLVAR(Imess_sv,       SV *)
173
174 /* XXX shouldn't these be per-thread? --GSAR */
175 PERLVAR(Iors,           char *)         /* output record separator $\ */
176 PERLVAR(Iorslen,        STRLEN)
177 PERLVAR(Iofmt,          char *)         /* output format for numbers $# */
178
179 /* interpreter atexit processing */
180 PERLVARI(Iexitlist,     PerlExitListEntry *, NULL)
181                                         /* list of exit functions */
182 PERLVARI(Iexitlistlen,  I32, 0)         /* length of same */
183
184 /*
185 =for apidoc Amn|HV*|PL_modglobal
186
187 C<PL_modglobal> is a general purpose, interpreter global HV for use by 
188 extensions that need to keep information on a per-interpreter basis.
189 In a pinch, it can also be used as a symbol table for extensions 
190 to share data among each other.  It is a good idea to use keys 
191 prefixed by the package name of the extension that owns the data.
192
193 =cut
194 */
195
196 PERLVAR(Imodglobal,     HV *)           /* per-interp module data */
197
198 /* these used to be in global before 5.004_68 */
199 PERLVARI(Iprofiledata,  U32 *,  NULL)   /* table of ops, counts */
200 PERLVARI(Irsfp, PerlIO * VOL,   Nullfp) /* current source file pointer */
201 PERLVARI(Irsfp_filters, AV *,   Nullav) /* keeps active source filters */
202
203 PERLVAR(Icompiling,     COP)            /* compiling/done executing marker */
204
205 PERLVAR(Icompcv,        CV *)           /* currently compiling subroutine */
206 PERLVAR(Icomppad,       AV *)           /* storage for lexically scoped temporaries */
207 PERLVAR(Icomppad_name,  AV *)           /* variable names for "my" variables */
208 PERLVAR(Icomppad_name_fill,     I32)    /* last "introduced" variable offset */
209 PERLVAR(Icomppad_name_floor,    I32)    /* start of vars in innermost block */
210
211 #ifdef HAVE_INTERP_INTERN
212 PERLVAR(Isys_intern,    struct interp_intern)
213                                         /* platform internals */
214 #endif
215
216 /* more statics moved here */
217 PERLVARI(Igeneration,   int,    100)    /* from op.c */
218 PERLVAR(IDBcv,          CV *)           /* from perl.c */
219
220 PERLVARI(Iin_clean_objs,bool,    FALSE) /* from sv.c */
221 PERLVARI(Iin_clean_all, bool,    FALSE) /* from sv.c */
222
223 PERLVAR(Ilinestart,     char *)         /* beg. of most recently read line */
224 PERLVAR(Ipending_ident, char)           /* pending identifier lookup */
225 PERLVAR(Isublex_info,   SUBLEXINFO)     /* from toke.c */
226
227 #ifdef USE_THREADS
228 PERLVAR(Ithrsv,         SV *)           /* struct perl_thread for main thread */
229 PERLVARI(Ithreadnum,    U32,    0)      /* incremented each thread creation */
230 PERLVAR(Istrtab_mutex,  perl_mutex)     /* Mutex for string table access */
231 #endif /* USE_THREADS */
232
233 PERLVAR(Iuid,           Uid_t)          /* current real user id */
234 PERLVAR(Ieuid,          Uid_t)          /* current effective user id */
235 PERLVAR(Igid,           Gid_t)          /* current real group id */
236 PERLVAR(Iegid,          Gid_t)          /* current effective group id */
237 PERLVAR(Inomemok,       bool)           /* let malloc context handle nomem */
238 PERLVAR(Ian,            U32)            /* malloc sequence number */
239 PERLVAR(Icop_seqmax,    U32)            /* statement sequence number */
240 PERLVAR(Iop_seqmax,     U16)            /* op sequence number */
241 PERLVAR(Ievalseq,       U32)            /* eval sequence number */
242 PERLVAR(Iorigenviron,   char **)
243 PERLVAR(Iorigalen,      U32)
244 PERLVAR(Ipidstatus,     HV *)           /* pid-to-status mappings for waitpid */
245 PERLVARI(Imaxo, int,    MAXO)           /* maximum number of ops */
246 PERLVAR(Iosname,        char *)         /* operating system */
247 PERLVARI(Ish_path,      char *, SH_PATH)/* full path of shell */
248 PERLVAR(Isighandlerp,   Sighandler_t)
249
250 PERLVAR(Ixiv_arenaroot, XPV*)           /* list of allocated xiv areas */
251 PERLVAR(Ixiv_root,      IV *)           /* free xiv list--shared by interpreters */
252 PERLVAR(Ixnv_root,      NV *)           /* free xnv list--shared by interpreters */
253 PERLVAR(Ixrv_root,      XRV *)          /* free xrv list--shared by interpreters */
254 PERLVAR(Ixpv_root,      XPV *)          /* free xpv list--shared by interpreters */
255 PERLVAR(Ixpviv_root,    XPVIV *)        /* free xpviv list--shared by interpreters */
256 PERLVAR(Ixpvnv_root,    XPVNV *)        /* free xpvnv list--shared by interpreters */
257 PERLVAR(Ixpvcv_root,    XPVCV *)        /* free xpvcv list--shared by interpreters */
258 PERLVAR(Ixpvav_root,    XPVAV *)        /* free xpvav list--shared by interpreters */
259 PERLVAR(Ixpvhv_root,    XPVHV *)        /* free xpvhv list--shared by interpreters */
260 PERLVAR(Ixpvmg_root,    XPVMG *)        /* free xpvmg list--shared by interpreters */
261 PERLVAR(Ixpvlv_root,    XPVLV *)        /* free xpvlv list--shared by interpreters */
262 PERLVAR(Ixpvbm_root,    XPVBM *)        /* free xpvbm list--shared by interpreters */
263 PERLVAR(Ihe_root,       HE *)           /* free he list--shared by interpreters */
264 PERLVAR(Inice_chunk,    char *)         /* a nice chunk of memory to reuse */
265 PERLVAR(Inice_chunk_size,       U32)    /* how nice the chunk of memory is */
266
267 PERLVARI(Irunops,       runops_proc_t,  MEMBER_TO_FPTR(RUNOPS_DEFAULT))
268
269 PERLVARA(Itokenbuf,256, char)
270
271 /*
272 =for apidoc Amn|SV|PL_sv_undef
273 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
274
275 =for apidoc Amn|SV|PL_sv_no
276 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
277 C<&PL_sv_no>.
278
279 =for apidoc Amn|SV|PL_sv_yes
280 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
281 C<&PL_sv_yes>.
282
283 =cut
284 */
285
286 PERLVAR(Isv_undef,      SV)
287 PERLVAR(Isv_no,         SV)
288 PERLVAR(Isv_yes,        SV)
289
290 #ifdef CSH
291 PERLVARI(Icshname,      char *, CSH)
292 PERLVAR(Icshlen,        I32)
293 #endif
294
295 PERLVAR(Ilex_state,     U32)            /* next token is determined */
296 PERLVAR(Ilex_defer,     U32)            /* state after determined token */
297 PERLVAR(Ilex_expect,    int)            /* expect after determined token */
298 PERLVAR(Ilex_brackets,  I32)            /* bracket count */
299 PERLVAR(Ilex_formbrack, I32)            /* bracket count at outer format level */
300 PERLVAR(Ilex_casemods,  I32)            /* casemod count */
301 PERLVAR(Ilex_dojoin,    I32)            /* doing an array interpolation */
302 PERLVAR(Ilex_starts,    I32)            /* how many interps done on level */
303 PERLVAR(Ilex_stuff,     SV *)           /* runtime pattern from m// or s/// */
304 PERLVAR(Ilex_repl,      SV *)           /* runtime replacement from s/// */
305 PERLVAR(Ilex_op,        OP *)           /* extra info to pass back on op */
306 PERLVAR(Ilex_inpat,     OP *)           /* in pattern $) and $| are special */
307 PERLVAR(Ilex_inwhat,    I32)            /* what kind of quoting are we in */
308 PERLVAR(Ilex_brackstack,char *)         /* what kind of brackets to pop */
309 PERLVAR(Ilex_casestack, char *)         /* what kind of case mods in effect */
310
311 /* What we know when we're in LEX_KNOWNEXT state. */
312 PERLVARA(Inextval,5,    YYSTYPE)        /* value of next token, if any */
313 PERLVARA(Inexttype,5,   I32)            /* type of next token */
314 PERLVAR(Inexttoke,      I32)
315
316 PERLVAR(Ilinestr,       SV *)
317 PERLVAR(Ibufptr,        char *)
318 PERLVAR(Ioldbufptr,     char *)
319 PERLVAR(Ioldoldbufptr,  char *)
320 PERLVAR(Ibufend,        char *)
321 PERLVARI(Iexpect,int,   XSTATE)         /* how to interpret ambiguous tokens */
322
323 PERLVAR(Imulti_start,   I32)            /* 1st line of multi-line string */
324 PERLVAR(Imulti_end,     I32)            /* last line of multi-line string */
325 PERLVAR(Imulti_open,    I32)            /* delimiter of said string */
326 PERLVAR(Imulti_close,   I32)            /* delimiter of said string */
327
328 PERLVAR(Ierror_count,   I32)            /* how many errors so far, max 10 */
329 PERLVAR(Isubline,       I32)            /* line this subroutine began on */
330 PERLVAR(Isubname,       SV *)           /* name of current subroutine */
331
332 PERLVAR(Imin_intro_pending,     I32)    /* start of vars to introduce */
333 PERLVAR(Imax_intro_pending,     I32)    /* end of vars to introduce */
334 PERLVAR(Ipadix,         I32)            /* max used index in current "register" pad */
335 PERLVAR(Ipadix_floor,   I32)            /* how low may inner block reset padix */
336 PERLVAR(Ipad_reset_pending,     I32)    /* reset pad on next attempted alloc */
337
338 PERLVAR(Ilast_uni,      char *)         /* position of last named-unary op */
339 PERLVAR(Ilast_lop,      char *)         /* position of last list operator */
340 PERLVAR(Ilast_lop_op,   OPCODE)         /* last list operator */
341 PERLVAR(Iin_my,         I32)            /* we're compiling a "my" (or "our") declaration */
342 PERLVAR(Iin_my_stash,   HV *)           /* declared class of this "my" declaration */
343 #ifdef FCRYPT
344 PERLVAR(Icryptseen,     bool)           /* has fast crypt() been initialized? */
345 #endif
346
347 PERLVAR(Ihints,         U32)            /* pragma-tic compile-time flags */
348
349 PERLVAR(Idebug,         VOL U32)        /* flags given to -D switch */
350
351 PERLVAR(Iamagic_generation,     long)
352
353 #ifdef USE_LOCALE_COLLATE
354 PERLVAR(Icollation_ix,  U32)            /* Collation generation index */
355 PERLVAR(Icollation_name,char *)         /* Name of current collation */
356 PERLVARI(Icollation_standard, bool,     TRUE)
357                                         /* Assume simple collation */
358 PERLVAR(Icollxfrm_base, Size_t)         /* Basic overhead in *xfrm() */
359 PERLVARI(Icollxfrm_mult,Size_t, 2)      /* Expansion factor in *xfrm() */
360 #endif /* USE_LOCALE_COLLATE */
361
362 #ifdef USE_LOCALE_NUMERIC
363
364 PERLVAR(Inumeric_name,  char *)         /* Name of current numeric locale */
365 PERLVARI(Inumeric_standard,     bool,   TRUE)
366                                         /* Assume simple numerics */
367 PERLVARI(Inumeric_local,        bool,   TRUE)
368                                         /* Assume local numerics */
369 PERLVAR(Inumeric_radix,         char)
370                                         /* The radix character if not '.' */
371
372 #endif /* !USE_LOCALE_NUMERIC */
373
374 /* utf8 character classes */
375 PERLVAR(Iutf8_alnum,    SV *)
376 PERLVAR(Iutf8_alnumc,   SV *)
377 PERLVAR(Iutf8_ascii,    SV *)
378 PERLVAR(Iutf8_alpha,    SV *)
379 PERLVAR(Iutf8_space,    SV *)
380 PERLVAR(Iutf8_cntrl,    SV *)
381 PERLVAR(Iutf8_graph,    SV *)
382 PERLVAR(Iutf8_digit,    SV *)
383 PERLVAR(Iutf8_upper,    SV *)
384 PERLVAR(Iutf8_lower,    SV *)
385 PERLVAR(Iutf8_print,    SV *)
386 PERLVAR(Iutf8_punct,    SV *)
387 PERLVAR(Iutf8_xdigit,   SV *)
388 PERLVAR(Iutf8_mark,     SV *)
389 PERLVAR(Iutf8_toupper,  SV *)
390 PERLVAR(Iutf8_totitle,  SV *)
391 PERLVAR(Iutf8_tolower,  SV *)
392 PERLVAR(Ilast_swash_hv, HV *)
393 PERLVAR(Ilast_swash_klen,       U32)
394 PERLVARA(Ilast_swash_key,10,    U8)
395 PERLVAR(Ilast_swash_tmps,       U8 *)
396 PERLVAR(Ilast_swash_slen,       STRLEN)
397
398 /* perly.c globals */
399 PERLVAR(Iyydebug,       int)
400 PERLVAR(Iyynerrs,       int)
401 PERLVAR(Iyyerrflag,     int)
402 PERLVAR(Iyychar,        int)
403 PERLVAR(Iyyval,         YYSTYPE)
404 PERLVAR(Iyylval,        YYSTYPE)
405
406 PERLVAR(Iglob_index,    int)
407 PERLVAR(Isrand_called,  bool)
408 PERLVARA(Iuudmap,256,   char)
409 PERLVAR(Ibitcount,      char *)
410
411 #ifdef USE_THREADS
412 PERLVAR(Ithr_key,       perl_key)       /* For per-thread struct perl_thread* */
413 PERLVAR(Isv_mutex,      perl_mutex)     /* Mutex for allocating SVs in sv.c */
414 PERLVAR(Ieval_mutex,    perl_mutex)     /* Mutex for doeval */
415 PERLVAR(Ieval_cond,     perl_cond)      /* Condition variable for doeval */
416 PERLVAR(Ieval_owner,    struct perl_thread *)
417                                         /* Owner thread for doeval */
418 PERLVAR(Inthreads,      int)            /* Number of threads currently */
419 PERLVAR(Ithreads_mutex, perl_mutex)     /* Mutex for nthreads and thread list */
420 PERLVAR(Inthreads_cond, perl_cond)      /* Condition variable for nthreads */
421 PERLVAR(Isvref_mutex,   perl_mutex)     /* Mutex for SvREFCNT_{inc,dec} */
422 PERLVARI(Ithreadsv_names,char *,        THREADSV_NAMES)
423 #ifdef FAKE_THREADS
424 PERLVAR(Icurthr,        struct perl_thread *)
425                                         /* Currently executing (fake) thread */
426 #endif
427
428 PERLVAR(Icred_mutex,    perl_mutex)     /* altered credentials in effect */
429
430 #endif /* USE_THREADS */
431
432 PERLVAR(Ipsig_ptr, SV**)
433 PERLVAR(Ipsig_name, SV**)
434
435 #if defined(PERL_IMPLICIT_SYS)
436 PERLVAR(IMem,           struct IPerlMem*)
437 PERLVAR(IMemShared,     struct IPerlMem*)
438 PERLVAR(IMemParse,      struct IPerlMem*)
439 PERLVAR(IEnv,           struct IPerlEnv*)
440 PERLVAR(IStdIO,         struct IPerlStdIO*)
441 PERLVAR(ILIO,           struct IPerlLIO*)
442 PERLVAR(IDir,           struct IPerlDir*)
443 PERLVAR(ISock,          struct IPerlSock*)
444 PERLVAR(IProc,          struct IPerlProc*)
445 #endif
446
447 #if defined(USE_ITHREADS)
448 PERLVAR(Iptr_table,     PTR_TBL_t*)
449 #endif