3 * Copyright (C) 1991, 1992, 1993, 1999, 2001, 2002, 2003, 2004, 2005,
4 * 2007, by Larry Wall and others
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.
16 # define PERL_FILE_IS_ABSOLUTE(f) \
19 || ((*(f) == '[' || *(f) == '<') \
20 && (isWORDCHAR((f)[1]) || memCHRs("$-_]>",(f)[1])))))
22 #elif defined(WIN32) || defined(__CYGWIN__)
23 # define PERL_FILE_IS_ABSOLUTE(f) \
24 (*(f) == '/' || *(f) == '\\' /* UNC/rooted path */ \
25 || ((f)[0] && (f)[1] == ':')) /* drive name */
27 # define PERL_FILE_IS_ABSOLUTE(f) \
29 || ((f)[0] && (f)[1] == ':')) /* drive name */
30 #else /* NOT DOSISH */
31 # define PERL_FILE_IS_ABSOLUTE(f) (*(f) == '/')
35 =for apidoc_section $string
39 This is a synonym for S<C<(! foldEQ())>>
41 =for apidoc ibcmp_locale
43 This is a synonym for S<C<(! foldEQ_locale())>>
45 =for apidoc ibcmp_utf8
47 This is a synonym for S<C<(! foldEQ_utf8())>>
51 #define ibcmp(s1, s2, len) cBOOL(! foldEQ(s1, s2, len))
52 #define ibcmp_locale(s1, s2, len) cBOOL(! foldEQ_locale(s1, s2, len))
53 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
54 cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
56 /* outside the core, perl.h undefs HAS_QUAD if IV isn't 64-bit
57 We can't swap this to HAS_QUAD, because the logic here affects the type of
58 perl_drand48_t below, and that is visible outside of the core. */
60 /* use a faster implementation when quads are available */
61 # define PERL_DRAND48_QUAD
64 #ifdef PERL_DRAND48_QUAD
66 /* U64 is only defined under PERL_CORE, but this needs to be visible
67 * elsewhere so the definition of PerlInterpreter is complete.
69 typedef U64TYPE perl_drand48_t;
73 struct PERL_DRAND48_T {
77 typedef struct PERL_DRAND48_T perl_drand48_t;
81 #define PL_RANDOM_STATE_TYPE perl_drand48_t
83 #define Perl_drand48_init(seed) (Perl_drand48_init_r(&PL_random_state, (seed)))
84 #define Perl_drand48() (Perl_drand48_r(&PL_random_state))
87 /* uses a different source of randomness to avoid interfering with the results
89 #define Perl_internal_drand48() (Perl_drand48_r(&PL_internal_random_state))
92 #ifdef USE_C_BACKTRACE
95 /* The number of frames returned. */
97 /* The total size of the Perl_c_backtrace, including this header,
98 * the frames, and the name strings. */
100 } Perl_c_backtrace_header;
103 void* addr; /* the program counter at this frame */
105 /* We could use Dl_info (as used by dladdr()) for many of these but
106 * that would be naughty towards non-dlfcn systems (hi there, Win32). */
108 void* symbol_addr; /* symbol address (hint: try symbol_addr - addr) */
109 void* object_base_addr; /* base address of the shared object */
111 /* The offsets are from the beginning of the whole backtrace,
112 * which makes the backtrace relocatable. */
113 STRLEN object_name_offset; /* pathname of the shared object */
114 STRLEN object_name_size; /* length of the pathname */
115 STRLEN symbol_name_offset; /* symbol name */
116 STRLEN symbol_name_size; /* length of the symbol name */
117 STRLEN source_name_offset; /* source code file name */
118 STRLEN source_name_size; /* length of the source code file name */
119 STRLEN source_line_number; /* source code line number */
121 /* OS X notes: atos(1) (more recently, "xcrun atos"), but the C
122 * API atos() uses is unknown (private "Symbolicator" framework,
123 * might require Objective-C even if the API would be known).
124 * Currently we open read pipe to "xcrun atos" and parse the
125 * output - quite disgusting. And that won't work if the
126 * Developer Tools isn't installed. */
128 /* FreeBSD notes: execinfo.h exists, but probably would need also
129 * the library -lexecinfo. BFD exists if the pkg devel/binutils
130 * has been installed, but there seems to be a known problem that
131 * the "bfd.h" getting installed refers to "ansidecl.h", which
132 * doesn't get installed. */
134 /* Win32 notes: as moral equivalents of backtrace() + dladdr(),
135 * one could possibly first use GetCurrentProcess() +
136 * SymInitialize(), and then CaptureStackBackTrace() +
139 /* Note that using the compiler optimizer easily leads into much
140 * of this information, like the symbol names (think inlining),
141 * and source code locations getting lost or confused. In many
142 * cases keeping the debug information (-g) is necessary.
144 * Note that for example with gcc you can do both -O and -g.
146 * Note, however, that on some platforms (e.g. OSX + clang (cc))
147 * backtrace() + dladdr() works fine without -g. */
149 /* For example: the mere presence of <bfd.h> is no guarantee: e.g.
150 * OS X has that, but BFD does not seem to work on the OSX executables.
152 * Another niceness would be to able to see something about
153 * the function arguments, however gdb/lldb manage to do that. */
154 } Perl_c_backtrace_frame;
157 Perl_c_backtrace_header header;
158 Perl_c_backtrace_frame frame_info[1];
159 /* After the header come:
160 * (1) header.frame_count frames
161 * (2) frame_count times the \0-terminated strings (object_name
162 * and so forth). The frames contain the pointers to the starts
163 * of these strings, and the lengths of these strings. */
166 #define Perl_free_c_backtrace(bt) Safefree(bt)
168 #endif /* USE_C_BACKTRACE */
170 /* Use a packed 32 bit constant "key" to start the handshake. The key defines
171 ABI compatibility, and how to process the vararg list.
173 Note, some bits may be taken from INTRPSIZE (but then a simple x86 AX register
174 can't be used to read it) and 4 bits from API version len can also be taken,
175 since v00.00.00 is 9 bytes long. XS version length should not have any bits
176 taken since XS_VERSION lengths can get quite long since they are user
177 selectable. These spare bits allow for additional features for the varargs
178 stuff or ABI compat test flags in the future.
180 #define HSm_APIVERLEN 0x0000001F /* perl version string won't be more than 31 chars */
181 #define HS_APIVERLEN_MAX HSm_APIVERLEN
182 #define HSm_XSVERLEN 0x0000FF00 /* if 0, not present, dont check, die if over 255*/
183 #define HS_XSVERLEN_MAX 0xFF
184 /* uses var file to set default filename for newXS_deffile to use for CvFILE */
185 #define HSf_SETXSUBFN 0x00000020
186 #define HSf_POPMARK 0x00000040 /* popmark mode or you must supply ax and items */
187 #define HSf_IMP_CXT 0x00000080 /* ABI, threaded/MULTIPLICITY, pTHX_ present */
188 #define HSm_INTRPSIZE 0xFFFF0000 /* ABI, interp struct size */
189 /* A mask of bits in the key which must always match between a XS mod and interp.
190 Also if all ABI bits in a key are true, skip all ABI checks, it is very
191 the unlikely interp size will all 1 bits */
192 /* Maybe HSm_APIVERLEN one day if Perl_xs_apiversion_bootcheck is changed to a memcmp */
193 #define HSm_KEY_MATCH (HSm_INTRPSIZE|HSf_IMP_CXT)
194 #define HSf_NOCHK HSm_KEY_MATCH /* if all ABI bits are 1 in the key, dont chk */
197 #define HS_GETINTERPSIZE(key) ((key) >> 16)
198 /* if in the future "" and NULL must be separated, XSVERLEN would be 0
199 means arg not present, 1 is empty string/null byte */
200 /* (((key) & 0x0000FF00) >> 8) is less efficient on Visual C */
201 #define HS_GETXSVERLEN(key) ((U8) ((key) >> 8))
202 #define HS_GETAPIVERLEN(key) ((key) & HSm_APIVERLEN)
204 /* internal to util.h macro to create a packed handshake key, all args must be constants */
205 /* U32 return = (U16 interpsize, bool cxt, bool setxsubfn, bool popmark,
206 U5 (FIVE!) apiverlen, U8 xsverlen) */
207 #define HS_KEYp(interpsize, cxt, setxsubfn, popmark, apiverlen, xsverlen) \
208 (((interpsize) << 16) \
209 | ((xsverlen) > HS_XSVERLEN_MAX \
210 ? (Perl_croak_nocontext("panic: handshake overflow"), HS_XSVERLEN_MAX) \
212 | (cBOOL(setxsubfn) ? HSf_SETXSUBFN : 0) \
213 | (cBOOL(cxt) ? HSf_IMP_CXT : 0) \
214 | (cBOOL(popmark) ? HSf_POPMARK : 0) \
215 | ((apiverlen) > HS_APIVERLEN_MAX \
216 ? (Perl_croak_nocontext("panic: handshake overflow"), HS_APIVERLEN_MAX) \
218 /* overflows above will optimize away unless they will execute */
220 /* public macro for core usage to create a packed handshake key but this is
221 not public API. This more friendly version already collected all ABI info */
222 /* U32 return = (bool setxsubfn, bool popmark, "litteral_string_api_ver",
223 "litteral_string_xs_ver") */
225 # define HS_KEY(setxsubfn, popmark, apiver, xsver) \
226 HS_KEYp(sizeof(PerlInterpreter), TRUE, setxsubfn, popmark, \
227 sizeof("" apiver "")-1, sizeof("" xsver "")-1)
230 # define HS_KEY(setxsubfn, popmark, apiver, xsver) \
231 HS_KEYp(sizeof(struct PerlHandShakeInterpreter), FALSE, setxsubfn, popmark, \
232 sizeof("" apiver "")-1, sizeof("" xsver "")-1)
238 Same as L<strstr(3)>, which finds and returns a pointer to the first occurrence
239 of the NUL-terminated substring C<little> in the NUL-terminated string C<big>,
240 returning NULL if not found. The terminating NUL bytes are not compared.
246 #define instr(haystack, needle) strstr((char *) haystack, (char *) needle)
249 # define ninstr(big, bigend, little, lend) \
250 (__ASSERT_(bigend >= big) \
251 __ASSERT_(lend >= little) \
252 (char *) memmem((big), (bigend) - (big), \
253 (little), (lend) - (little)))
255 # define ninstr(a,b,c,d) Perl_ninstr(a,b,c,d)
259 /* Missing proto on LynxOS */
265 /* only useful for calls to our mkostemp() emulation */
266 # define O_VMS_DELETEONCLOSE 0x40000000
268 # error 134221 will need a new solution for VMS
271 # define O_VMS_DELETEONCLOSE 0
274 #if defined(HAS_MKOSTEMP) && defined(PERL_CORE)
275 # define Perl_my_mkostemp(templte, flags) mkostemp(templte, flags)
277 #if defined(HAS_MKSTEMP) && defined(PERL_CORE)
278 # define Perl_my_mkstemp(templte) mkstemp(templte)
281 #endif /* PERL_UTIL_H_ */
284 * ex: set ts=8 sts=4 sw=4 et: