This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
It would be nice to have tests in B for the functions getting changed.
[perl5.git] / perlvars.h
CommitLineData
eb1102fc
NIS
1/* perlvars.h
2 *
54ca4ee7
NC
3 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
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
IZ
56
57/* This is constant on most architectures, a global on OS/2 */
e1ec3a88 58PERLVARI(Gsh_path, const char *, SH_PATH)/* full path of shell */
af419de7 59
2f42fcb0 60#ifndef PERL_MICRO
b35112e7
CS
61/* If Perl has to ignore SIGPFE, this is its saved state.
62 * See perl.h macros PERL_FPU_INIT and PERL_FPU_{PRE,POST}_EXEC. */
63PERLVAR(Gsigfpe_saved, Sighandler_t)
2f42fcb0 64#endif
b35112e7 65
643157af
JH
66/* Restricted hashes placeholder value.
67 * The contents are never used, only the address. */
68PERLVAR(Gsv_placeholder, SV)
69
2f42fcb0 70#ifndef PERL_MICRO
1c127fab 71PERLVARI(Gcsighandlerp, Sighandler_t, Perl_csighandler) /* Pointer to C-level sighandler */
2f42fcb0 72#endif
5c1546dc 73
50acdf95
MS
74#ifndef PERL_USE_SAFE_PUTENV
75PERLVARI(Guse_safe_putenv, int, 1)
76#endif
27da23d5
JH
77
78#ifdef USE_PERLIO
79PERLVARA(Gperlio_fd_refcnt, 2048, int) /* PERLIO_MAX_REFCOUNTABLE_FD */
80PERLVARI(Gperlio_debug_fd, int, 0) /* the fd to write perlio debug into, 0 means not set yet */
81#endif
82
83#ifdef HAS_MMAP
84PERLVARI(Gmmap_page_size, IV, 0)
85#endif
86
87#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
88PERLVARI(Gsig_handlers_initted, int, 0)
89#endif
90#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
91PERLVARA(Gsig_ignoring, SIG_SIZE, int) /* which signals we are ignoring */
92#endif
93#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
aadb217d 94PERLVARA(Gsig_defaulting, SIG_SIZE, int)
27da23d5
JH
95#endif
96
97#ifndef PERL_IMPLICIT_CONTEXT
98PERLVAR(Gsig_sv, SV*)
99#endif
100
101/* XXX signals are process-wide anyway, so we
102 * ignore the implications of this for threading */
103#ifndef HAS_SIGACTION
104PERLVARI(Gsig_trapped, int, 0)
105#endif
106
107#ifdef DEBUGGING
108PERLVAR(Gwatch_pvx, char*)
109#endif
110
111#ifdef PERL_GLOBAL_STRUCT
112PERLVAR(Gppaddr, Perl_ppaddr_t*) /* or opcode.h */
113PERLVAR(Gcheck, Perl_check_t *) /* or opcode.h */
114PERLVARA(Gfold_locale, 256, unsigned char) /* or perl.h */
115#endif
116
117#ifdef PERL_NEED_APPCTX
118PERLVAR(Gappctx, void*) /* the application context */
119#endif
120
121PERLVAR(Gop_sequence, HV*) /* dump.c */
122PERLVARI(Gop_seq, UV, 0) /* dump.c */
123
124#if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
125PERLVAR(Gtimesbase, struct tms)
126#endif
127
f16dd614 128/* allocate a unique index to every module that calls MY_CXT_INIT */
27da23d5 129
f16dd614 130#ifdef PERL_IMPLICIT_CONTEXT
97aff369 131# ifdef USE_ITHREADS
f16dd614 132PERLVAR(Gmy_ctx_mutex, perl_mutex)
97aff369 133# endif
f16dd614
DM
134PERLVARI(Gmy_cxt_index, int, 0)
135#endif