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