This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Updated CPANPLUS::Dist::Build to cpan version 0.41_01
[perl5.git] / perlvars.h
CommitLineData
eb1102fc
NIS
1/* perlvars.h
2 *
663f364b 3 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
54ca4ee7 4 * by Larry Wall and others
eb1102fc
NIS
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
49f531da
NIS
11/****************/
12/* Truly global */
13/****************/
14
cb68f92d
GS
15/* Don't forget to re-run embed.pl to propagate changes! */
16
17/* This file describes the "global" variables used by perl
18 * This used to be in perl.h directly but we want to abstract out into
19 * distinct files which are per-thread, per-interpreter or really global,
20 * and how they're initialized.
21 *
22 * The 'G' prefix is only needed for vars that need appropriate #defines
22c35a8c 23 * generated in embed*.h. Such symbols are also used to generate
14dd3ad8 24 * the appropriate export list for win32. */
cb68f92d 25
49f531da 26/* global state */
cb68f92d 27PERLVAR(Gcurinterp, PerlInterpreter *)
43165c05 28 /* currently running interpreter
ba869deb
GS
29 * (initial parent interpreter under
30 * useithreads) */
3db8f154 31#if defined(USE_ITHREADS)
ba869deb
GS
32PERLVAR(Gthr_key, perl_key) /* key to retrieve per-thread struct */
33#endif
a0ed51b3 34
27da23d5
JH
35/* constants (these are not literals to facilitate pointer comparisons)
36 * (PERLVARISC really does create variables, despite its looks) */
37PERLVARISC(GYes, "1")
38PERLVARISC(GNo, "")
39PERLVARISC(Ghexdigit, "0123456789abcdef0123456789ABCDEF")
40PERLVARISC(Gpatleave, "\\.^$@dDwWsSbB+*?|()-nrtfeaxc0123456789[{]}")
43165c05
GS
41
42/* XXX does anyone even use this? */
43PERLVARI(Gdo_undump, bool, FALSE) /* -u or dump seen? */
b363f7ed 44
3db8f154 45#if defined(MYMALLOC) && defined(USE_ITHREADS)
b363f7ed
GS
46PERLVAR(Gmalloc_mutex, perl_mutex) /* Mutex for malloc */
47#endif
534825c4
GS
48
49#if defined(USE_ITHREADS)
50PERLVAR(Gop_mutex, perl_mutex) /* Mutex for op refcounting */
51#endif
60e4ec2e 52
d90a703e
JH
53#ifdef USE_ITHREADS
54PERLVAR(Gdollarzero_mutex, perl_mutex) /* Modifying $0 */
55#endif
5c728af0 56
95ca8690 57
5c728af0 58/* This is constant on most architectures, a global on OS/2 */
428eed4a 59#ifdef OS2
95ca8690 60# define PERL___C
428eed4a 61#else
95ca8690 62# define PERL___C const
428eed4a 63#endif
95ca8690
DM
64PERLVARI(Gsh_path, PERL___C char *, SH_PATH) /* full path of shell */
65#undef PERL___C
af419de7 66
2f42fcb0 67#ifndef PERL_MICRO
b35112e7
CS
68/* If Perl has to ignore SIGPFE, this is its saved state.
69 * See perl.h macros PERL_FPU_INIT and PERL_FPU_{PRE,POST}_EXEC. */
70PERLVAR(Gsigfpe_saved, Sighandler_t)
2f42fcb0 71#endif
b35112e7 72
643157af
JH
73/* Restricted hashes placeholder value.
74 * The contents are never used, only the address. */
75PERLVAR(Gsv_placeholder, SV)
76
2f42fcb0 77#ifndef PERL_MICRO
1c127fab 78PERLVARI(Gcsighandlerp, Sighandler_t, Perl_csighandler) /* Pointer to C-level sighandler */
2f42fcb0 79#endif
5c1546dc 80
50acdf95
MS
81#ifndef PERL_USE_SAFE_PUTENV
82PERLVARI(Guse_safe_putenv, int, 1)
83#endif
27da23d5
JH
84
85#ifdef USE_PERLIO
22c96fc1
NC
86PERLVARI(Gperlio_fd_refcnt, int*, 0) /* Pointer to array of fd refcounts. */
87PERLVARI(Gperlio_fd_refcnt_size, int, 0) /* Size of the array */
27da23d5
JH
88PERLVARI(Gperlio_debug_fd, int, 0) /* the fd to write perlio debug into, 0 means not set yet */
89#endif
90
91#ifdef HAS_MMAP
92PERLVARI(Gmmap_page_size, IV, 0)
93#endif
94
95#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
96PERLVARI(Gsig_handlers_initted, int, 0)
97#endif
98#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
99PERLVARA(Gsig_ignoring, SIG_SIZE, int) /* which signals we are ignoring */
100#endif
101#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
aadb217d 102PERLVARA(Gsig_defaulting, SIG_SIZE, int)
27da23d5
JH
103#endif
104
105#ifndef PERL_IMPLICIT_CONTEXT
106PERLVAR(Gsig_sv, SV*)
107#endif
108
109/* XXX signals are process-wide anyway, so we
110 * ignore the implications of this for threading */
111#ifndef HAS_SIGACTION
112PERLVARI(Gsig_trapped, int, 0)
113#endif
114
115#ifdef DEBUGGING
116PERLVAR(Gwatch_pvx, char*)
117#endif
118
119#ifdef PERL_GLOBAL_STRUCT
120PERLVAR(Gppaddr, Perl_ppaddr_t*) /* or opcode.h */
121PERLVAR(Gcheck, Perl_check_t *) /* or opcode.h */
122PERLVARA(Gfold_locale, 256, unsigned char) /* or perl.h */
123#endif
124
125#ifdef PERL_NEED_APPCTX
126PERLVAR(Gappctx, void*) /* the application context */
127#endif
128
129PERLVAR(Gop_sequence, HV*) /* dump.c */
130PERLVARI(Gop_seq, UV, 0) /* dump.c */
131
132#if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
133PERLVAR(Gtimesbase, struct tms)
134#endif
135
f16dd614 136/* allocate a unique index to every module that calls MY_CXT_INIT */
27da23d5 137
f16dd614 138#ifdef PERL_IMPLICIT_CONTEXT
97aff369 139# ifdef USE_ITHREADS
f16dd614 140PERLVAR(Gmy_ctx_mutex, perl_mutex)
97aff369 141# endif
f16dd614
DM
142PERLVARI(Gmy_cxt_index, int, 0)
143#endif
71ad1b0c
NC
144
145#if defined(USE_ITHREADS)
146PERLVAR(Ghints_mutex, perl_mutex) /* Mutex for refcounted he refcounting */
147#endif
6cb8cb21 148
8b84d7dd 149#if defined(USE_ITHREADS)
6cb8cb21
RGS
150PERLVAR(Gperlio_mutex, perl_mutex) /* Mutex for perlio fd refcounts */
151#endif
c301d606
DM
152
153/* this is currently set without MUTEX protection, so keep it a type which
154 * can be set atomically (ie not a bit field) */
155PERLVARI(Gveto_cleanup, int, FALSE) /* exit without cleanup */
156
4b8f2e61
DM
157/* dummy variables that hold pointers to both runops functions, thus forcing
158 * them *both* to get linked in (useful for Peek.xs, debugging etc) */
159
160PERLVARI(Grunops_std, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_standard))
161PERLVARI(Grunops_dbg, runops_proc_t, MEMBER_TO_FPTR(Perl_runops_debug))
162
ffee3ff6
NC
163
164/* These are baked at compile time into any shared perl library.
165 In future 5.10.x releases this will allow us in main() to sanity test the
166 library we're linking against. */
167
168PERLVARI(Grevision, U8, PERL_REVISION)
169PERLVARI(Gversion, U8, PERL_VERSION)
170PERLVARI(Gsubversion, U8, PERL_SUBVERSION)
171
172#if defined(MULTIPLICITY)
173# define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member) \
174 STRUCT_OFFSET(struct interpreter, member) + \
175 sizeof(((struct interpreter*)0)->member)
176
177/* These might be useful. */
01523419 178PERLVARI(Ginterp_size, U16, sizeof(struct interpreter))
ffee3ff6
NC
179#if defined(PERL_GLOBAL_STRUCT)
180PERLVARI(Gglobal_struct_size, U16, sizeof(struct perl_vars))
181#endif
182
183/* This will be useful for subsequent releases, because this has to be the
184 same in your libperl as in main(), else you have a mismatch and must abort.
185*/
01523419 186PERLVARI(Ginterp_size_5_10_0, U16,
ffee3ff6
NC
187 PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_10_0_INTERP_MEMBER))
188#endif