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