This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add explicit 1-arg and 3-arg sig handler functions
[perl5.git] / perlvars.h
1 /*    perlvars.h
2  *
3  *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4  *    by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12 =head1 Global Variables
13 These variables are global to an entire process.  They are shared between
14 all interpreters and all threads in a process.  Any variables not documented
15 here may be changed or removed without notice, so don't use them!
16 If you feel you really do need to use an unlisted variable, first send email to
17 L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>.  It may be that
18 someone there will point out a way to accomplish what you need without using an
19 internal variable.  But if not, you should get a go-ahead to document and then
20 use the variable.
21
22 =cut
23 */
24
25 /* Don't forget to re-run regen/embed.pl to propagate changes! */
26
27 /* This file describes the "global" variables used by perl
28  * This used to be in perl.h directly but we want to abstract out into
29  * distinct files which are per-thread, per-interpreter or really global,
30  * and how they're initialized.
31  *
32  * The 'G' prefix is only needed for vars that need appropriate #defines
33  * generated in embed*.h.  Such symbols are also used to generate
34  * the appropriate export list for win32. */
35
36 /* global state */
37 #if defined(USE_ITHREADS)
38 PERLVAR(G, op_mutex,    perl_mutex)     /* Mutex for op refcounting */
39 #endif
40 PERLVARI(G, curinterp,  PerlInterpreter *, NULL)
41                                         /* currently running interpreter
42                                          * (initial parent interpreter under
43                                          * useithreads) */
44 #if defined(USE_ITHREADS)
45 PERLVAR(G, thr_key,     perl_key)       /* key to retrieve per-thread struct */
46 #endif
47
48 /* XXX does anyone even use this? */
49 PERLVARI(G, do_undump,  bool,   FALSE)  /* -u or dump seen? */
50
51 #ifndef PERL_USE_SAFE_PUTENV
52 PERLVARI(G, use_safe_putenv, bool, TRUE)
53 #endif
54
55 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
56 PERLVARI(G, sig_handlers_initted, int, 0)
57 #endif
58 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
59 PERLVARA(G, sig_ignoring, SIG_SIZE, int)
60                                         /* which signals we are ignoring */
61 #endif
62 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
63 PERLVARA(G, sig_defaulting, SIG_SIZE, int)
64 #endif
65
66 /* XXX signals are process-wide anyway, so we
67  * ignore the implications of this for threading */
68 #ifndef HAS_SIGACTION
69 PERLVARI(G, sig_trapped, int,   0)
70 #endif
71
72 #ifndef PERL_MICRO
73 /* If Perl has to ignore SIGPFE, this is its saved state.
74  * See perl.h macros PERL_FPU_INIT and PERL_FPU_{PRE,POST}_EXEC. */
75 PERLVAR(G, sigfpe_saved, Sighandler_t)
76
77 /* these ptrs to functions are to avoid linkage problems; see
78  * perl-5.8.0-2193-g5c1546dc48
79  */
80 PERLVARI(G, csighandlerp,  Sighandler_t,  Perl_csighandler)
81 PERLVARI(G, csighandler1p, Sighandler1_t, Perl_csighandler1)
82 PERLVARI(G, csighandler3p, Sighandler3_t, Perl_csighandler3)
83 #endif
84
85 /* This is constant on most architectures, a global on OS/2 */
86 #ifdef OS2
87 PERLVARI(G, sh_path,    char *, SH_PATH) /* full path of shell */
88 #endif
89
90 #ifdef USE_PERLIO
91
92 #  if defined(USE_ITHREADS)
93 PERLVAR(G, perlio_mutex, perl_mutex)    /* Mutex for perlio fd refcounts */
94 #  endif
95
96 PERLVARI(G, perlio_fd_refcnt, int *, 0) /* Pointer to array of fd refcounts.  */
97 PERLVARI(G, perlio_fd_refcnt_size, int, 0) /* Size of the array */
98 PERLVARI(G, perlio_debug_fd, int, 0)    /* the fd to write perlio debug into, 0 means not set yet */
99 #endif
100
101 #ifdef HAS_MMAP
102 PERLVARI(G, mmap_page_size, IV, 0)
103 #endif
104
105 #if defined(USE_ITHREADS)
106 PERLVAR(G, hints_mutex, perl_mutex)    /* Mutex for refcounted he refcounting */
107 #  if ! defined(USE_THREAD_SAFE_LOCALE) || defined(TS_W32_BROKEN_LOCALECONV)
108 PERLVAR(G, locale_mutex, perl_mutex)   /* Mutex for setlocale() changing */
109 #  endif
110 #  ifndef USE_THREAD_SAFE_LOCALE
111 PERLVAR(G, lc_numeric_mutex, perl_mutex)   /* Mutex for switching LC_NUMERIC */
112 #  endif
113 #endif
114
115 #ifdef USE_POSIX_2008_LOCALE
116 PERLVAR(G, C_locale_obj, locale_t)
117 #endif
118
119 PERLVARI(G, watch_pvx,  char *, NULL)
120
121 /*
122 =for apidoc AmnU|Perl_check_t *|PL_check
123
124 Array, indexed by opcode, of functions that will be called for the "check"
125 phase of optree building during compilation of Perl code.  For most (but
126 not all) types of op, once the op has been initially built and populated
127 with child ops it will be filtered through the check function referenced
128 by the appropriate element of this array.  The new op is passed in as the
129 sole argument to the check function, and the check function returns the
130 completed op.  The check function may (as the name suggests) check the op
131 for validity and signal errors.  It may also initialise or modify parts of
132 the ops, or perform more radical surgery such as adding or removing child
133 ops, or even throw the op away and return a different op in its place.
134
135 This array of function pointers is a convenient place to hook into the
136 compilation process.  An XS module can put its own custom check function
137 in place of any of the standard ones, to influence the compilation of a
138 particular type of op.  However, a custom check function must never fully
139 replace a standard check function (or even a custom check function from
140 another module).  A module modifying checking must instead B<wrap> the
141 preexisting check function.  A custom check function must be selective
142 about when to apply its custom behaviour.  In the usual case where
143 it decides not to do anything special with an op, it must chain the
144 preexisting op function.  Check functions are thus linked in a chain,
145 with the core's base checker at the end.
146
147 For thread safety, modules should not write directly to this array.
148 Instead, use the function L</wrap_op_checker>.
149
150 =cut
151 */
152
153 #if defined(USE_ITHREADS)
154 PERLVAR(G, check_mutex, perl_mutex)     /* Mutex for PL_check */
155 #endif
156 #ifdef PERL_GLOBAL_STRUCT 
157 PERLVAR(G, ppaddr,      Perl_ppaddr_t *) /* or opcode.h */
158 PERLVAR(G, check,       Perl_check_t *) /* or opcode.h */
159 PERLVARA(G, fold_locale, 256, unsigned char) /* or perl.h */
160 #endif
161
162 #ifdef PERL_NEED_APPCTX
163 PERLVAR(G, appctx,      void*)          /* the application context */
164 #endif
165
166 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
167 PERLVAR(G, timesbase,   struct tms)
168 #endif
169
170 /* allocate a unique index to every module that calls MY_CXT_INIT */
171
172 #ifdef PERL_IMPLICIT_CONTEXT
173 # ifdef USE_ITHREADS
174 PERLVAR(G, my_ctx_mutex, perl_mutex)
175 # endif
176 PERLVARI(G, my_cxt_index, int,  0)
177 #endif
178
179 /* this is currently set without MUTEX protection, so keep it a type which
180  * can be set atomically (ie not a bit field) */
181 PERLVARI(G, veto_cleanup, int, FALSE)   /* exit without cleanup */
182
183 /*
184 =for apidoc AmnUx|Perl_keyword_plugin_t|PL_keyword_plugin
185
186 Function pointer, pointing at a function used to handle extended keywords.
187 The function should be declared as
188
189         int keyword_plugin_function(pTHX_
190                 char *keyword_ptr, STRLEN keyword_len,
191                 OP **op_ptr)
192
193 The function is called from the tokeniser, whenever a possible keyword
194 is seen.  C<keyword_ptr> points at the word in the parser's input
195 buffer, and C<keyword_len> gives its length; it is not null-terminated.
196 The function is expected to examine the word, and possibly other state
197 such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it
198 as an extended keyword.  If it does not, the function should return
199 C<KEYWORD_PLUGIN_DECLINE>, and the normal parser process will continue.
200
201 If the function wants to handle the keyword, it first must
202 parse anything following the keyword that is part of the syntax
203 introduced by the keyword.  See L</Lexer interface> for details.
204
205 When a keyword is being handled, the plugin function must build
206 a tree of C<OP> structures, representing the code that was parsed.
207 The root of the tree must be stored in C<*op_ptr>.  The function then
208 returns a constant indicating the syntactic role of the construct that
209 it has parsed: C<KEYWORD_PLUGIN_STMT> if it is a complete statement, or
210 C<KEYWORD_PLUGIN_EXPR> if it is an expression.  Note that a statement
211 construct cannot be used inside an expression (except via C<do BLOCK>
212 and similar), and an expression is not a complete statement (it requires
213 at least a terminating semicolon).
214
215 When a keyword is handled, the plugin function may also have
216 (compile-time) side effects.  It may modify C<%^H>, define functions, and
217 so on.  Typically, if side effects are the main purpose of a handler,
218 it does not wish to generate any ops to be included in the normal
219 compilation.  In this case it is still required to supply an op tree,
220 but it suffices to generate a single null op.
221
222 That's how the C<*PL_keyword_plugin> function needs to behave overall.
223 Conventionally, however, one does not completely replace the existing
224 handler function.  Instead, take a copy of C<PL_keyword_plugin> before
225 assigning your own function pointer to it.  Your handler function should
226 look for keywords that it is interested in and handle those.  Where it
227 is not interested, it should call the saved plugin function, passing on
228 the arguments it received.  Thus C<PL_keyword_plugin> actually points
229 at a chain of handler functions, all of which have an opportunity to
230 handle keywords, and only the last function in the chain (built into
231 the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
232
233 For thread safety, modules should not set this variable directly.
234 Instead, use the function L</wrap_keyword_plugin>.
235
236 =cut
237 */
238
239 #if defined(USE_ITHREADS)
240 PERLVAR(G, keyword_plugin_mutex, perl_mutex)   /* Mutex for PL_keyword_plugin */
241 #endif
242 PERLVARI(G, keyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
243
244 PERLVARI(G, op_sequence, HV *, NULL)    /* dump.c */
245 PERLVARI(G, op_seq,     UV,     0)      /* dump.c */
246
247 #ifdef USE_ITHREADS
248 PERLVAR(G, dollarzero_mutex, perl_mutex) /* Modifying $0 */
249 #endif
250
251 /* Restricted hashes placeholder value.
252    In theory, the contents are never used, only the address.
253    In practice, &PL_sv_placeholder is returned by some APIs, and the calling
254    code is checking SvOK().  */
255
256 PERLVAR(G, sv_placeholder, SV)
257
258 #if defined(MYMALLOC) && defined(USE_ITHREADS)
259 PERLVAR(G, malloc_mutex, perl_mutex)    /* Mutex for malloc */
260 #endif
261
262 PERLVARI(G, hash_seed_set, bool, FALSE) /* perl.c */
263 PERLVARA(G, hash_seed, PERL_HASH_SEED_BYTES, unsigned char) /* perl.c and hv.h */
264 #if defined(PERL_HASH_STATE_BYTES)
265 PERLVARA(G, hash_state, PERL_HASH_STATE_BYTES, unsigned char) /* perl.c and hv.h */
266 #endif
267 #if defined(PERL_USE_SINGLE_CHAR_HASH_CACHE)
268 PERLVARA(G, hash_chars, (1+256) * sizeof(U32), unsigned char) /* perl.c and hv.h */
269 #endif
270
271 /* The path separator can vary depending on whether we're running under DCL or
272  * a Unix shell.
273  */
274 #ifdef __VMS
275 PERLVAR(G, perllib_sep, char)
276 #endif
277
278 PERLVAR(G, AboveLatin1, SV *)
279 PERLVAR(G, Assigned_invlist, SV *)
280 PERLVAR(G, GCB_invlist, SV *)
281 PERLVAR(G, HasMultiCharFold,   SV *)
282 PERLVAR(G, InMultiCharFold,   SV *)
283 PERLVAR(G, Latin1,      SV *)
284 PERLVAR(G, LB_invlist, SV *)
285 PERLVAR(G, SB_invlist, SV *)
286 PERLVAR(G, SCX_invlist, SV *)
287 PERLVAR(G, UpperLatin1, SV *)   /* Code points 128 - 255 */
288
289 /* List of characters that participate in any fold defined by Unicode */
290 PERLVAR(G, in_some_fold, SV *)
291
292 PERLVAR(G, utf8_idcont, SV *)
293 PERLVAR(G, utf8_idstart, SV *)
294 PERLVAR(G, utf8_perl_idcont, SV *)
295 PERLVAR(G, utf8_perl_idstart, SV *)
296 PERLVAR(G, utf8_xidcont, SV *)
297 PERLVAR(G, utf8_xidstart, SV *)
298 PERLVAR(G, WB_invlist, SV *)
299 PERLVARA(G, XPosix_ptrs, POSIX_CC_COUNT, SV *)
300 PERLVARA(G,  Posix_ptrs, POSIX_CC_COUNT, SV *)
301 PERLVAR(G, utf8_toupper, SV *)
302 PERLVAR(G, utf8_totitle, SV *)
303 PERLVAR(G, utf8_tolower, SV *)
304 PERLVAR(G, utf8_tofold, SV *)
305 PERLVAR(G, utf8_tosimplefold,   SV *)
306 PERLVAR(G, utf8_charname_begin, SV *)
307 PERLVAR(G, utf8_charname_continue, SV *)
308 PERLVAR(G, utf8_mark,   SV *)
309 PERLVARI(G, InBitmap,   SV *, NULL)
310 PERLVAR(G, CCC_non0_non230,     SV *)
311 PERLVAR(G, Private_Use, SV *)
312
313 /* Definitions of user-defined \p{} properties, as the subs that define them
314  * are only called once */
315 PERLVARI(G, user_def_props,     HV *, NULL)
316
317 #if defined(USE_ITHREADS)
318 PERLVAR(G, user_def_props_aTHX, PerlInterpreter *)  /* aTHX that user_def_props
319                                                        was defined in */
320 PERLVAR(G, user_prop_mutex, perl_mutex)    /* Mutex for manipulating
321                                               PL_user_defined_properties */
322 #endif
323
324 /* Everything that folds to a given character, for case insensitivity regex
325  * matching */
326 PERLVAR(G, utf8_foldclosures, SV *)
327
328 /* these record the best way to to perform certain IO operations while
329  * atomically setting FD_CLOEXEC. On the first call, a probe is done
330  * and the result recorded for use by subsequent calls.
331  * In theory these variables aren't thread-safe, but the worst that can
332  * happen is that two treads will both do an initial probe
333  */
334 PERLVARI(G, strategy_dup,        int, 0)        /* doio.c */
335 PERLVARI(G, strategy_dup2,       int, 0)        /* doio.c */
336 PERLVARI(G, strategy_open,       int, 0)        /* doio.c */
337 PERLVARI(G, strategy_open3,      int, 0)        /* doio.c */
338 PERLVARI(G, strategy_mkstemp,    int, 0)        /* doio.c */
339 PERLVARI(G, strategy_socket,     int, 0)        /* doio.c */
340 PERLVARI(G, strategy_accept,     int, 0)        /* doio.c */
341 PERLVARI(G, strategy_pipe,       int, 0)        /* doio.c */
342 PERLVARI(G, strategy_socketpair, int, 0)        /* doio.c */
343
344 #ifdef PERL_IMPLICIT_CONTEXT
345 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
346 /* per-module array of pointers to MY_CXT_KEY constants.
347  * It simulates each module having a static my_cxt_index var on builds
348  * which don't allow static vars */
349 PERLVARI(G, my_cxt_keys, const char **, NULL)
350 PERLVARI(G, my_cxt_keys_size, int,      0)      /* size of PL_my_cxt_keys */
351 #  endif
352 #endif