X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/3e2f796abf3f79e1ab191424e6c63f33a4ee4497..HEAD:/util.h diff --git a/util.h b/util.h index d188e34..d9b6161 100644 --- a/util.h +++ b/util.h @@ -1,36 +1,285 @@ /* util.h * - * Copyright (c) 1991-2001, Larry Wall + * Copyright (C) 1991, 1992, 1993, 1999, 2001, 2002, 2003, 2004, 2005, + * 2007, by Larry Wall and others * * You may distribute under the terms of either the GNU General Public * License or the Artistic License, as specified in the README file. * */ +#ifndef PERL_UTIL_H_ +#define PERL_UTIL_H_ + + #ifdef VMS # define PERL_FILE_IS_ABSOLUTE(f) \ - (*(f) == '/' \ - || (strchr(f,':') \ - || ((*(f) == '[' || *(f) == '<') \ - && (isALNUM((f)[1]) || strchr("$-_]>",(f)[1]))))) - -#else /* !VMS */ -# ifdef WIN32 -# define PERL_FILE_IS_ABSOLUTE(f) \ - (*(f) == '/' \ - || ((f)[0] && (f)[1] == ':') /* drive name */ \ - || ((f)[0] == '\\' && (f)[1] == '\\')) /* UNC path */ -# else /* !WIN32 */ -# if defined( DOSISH) || defined(EPOC) -# define PERL_FILE_IS_ABSOLUTE(f) \ - (*(f) == '/' \ - || ((f)[0] && (f)[1] == ':')) /* drive name */ -# else /* NEITHER DOSISH NOR EPOCISH */ -# ifdef MACOS_TRADITIONAL -# define PERL_FILE_IS_ABSOLUTE(f) (strchr(f, ':') && *(f) != ':') -# else /* !MACOS_TRADITIONAL */ -# define PERL_FILE_IS_ABSOLUTE(f) (*(f) == '/') -# endif /* MACOS_TRADITIONAL */ -# endif /* DOSISH */ -# endif /* WIN32 */ -#endif /* VMS */ + (*(f) == '/' \ + || (strchr(f,':') \ + || ((*(f) == '[' || *(f) == '<') \ + && (isWORDCHAR((f)[1]) || memCHRs("$-_]>",(f)[1]))))) + +#elif defined(WIN32) || defined(__CYGWIN__) +# define PERL_FILE_IS_ABSOLUTE(f) \ + (*(f) == '/' || *(f) == '\\' /* UNC/rooted path */ \ + || ((f)[0] && (f)[1] == ':')) /* drive name */ +#elif defined(DOSISH) +# define PERL_FILE_IS_ABSOLUTE(f) \ + (*(f) == '/' \ + || ((f)[0] && (f)[1] == ':')) /* drive name */ +#else /* NOT DOSISH */ +# define PERL_FILE_IS_ABSOLUTE(f) (*(f) == '/') +#endif + +/* +=for apidoc_section $string + +=for apidoc ibcmp + +This is a synonym for S> + +=for apidoc ibcmp_locale + +This is a synonym for S> + +=for apidoc ibcmp_utf8 + +This is a synonym for S> + +=cut +*/ +#define ibcmp(s1, s2, len) cBOOL(! foldEQ(s1, s2, len)) +#define ibcmp_locale(s1, s2, len) cBOOL(! foldEQ_locale(s1, s2, len)) +#define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \ + cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2)) + +/* outside the core, perl.h undefs HAS_QUAD if IV isn't 64-bit + We can't swap this to HAS_QUAD, because the logic here affects the type of + perl_drand48_t below, and that is visible outside of the core. */ +#if defined(U64TYPE) +/* use a faster implementation when quads are available */ +# define PERL_DRAND48_QUAD +#endif + +#ifdef PERL_DRAND48_QUAD + +/* U64 is only defined under PERL_CORE, but this needs to be visible + * elsewhere so the definition of PerlInterpreter is complete. + */ +typedef U64TYPE perl_drand48_t; + +#else + +struct PERL_DRAND48_T { + U16 seed[3]; +}; + +typedef struct PERL_DRAND48_T perl_drand48_t; + +#endif + +#define PL_RANDOM_STATE_TYPE perl_drand48_t + +#define Perl_drand48_init(seed) (Perl_drand48_init_r(&PL_random_state, (seed))) +#define Perl_drand48() (Perl_drand48_r(&PL_random_state)) + +#ifdef PERL_CORE +/* uses a different source of randomness to avoid interfering with the results + * of rand() */ +#define Perl_internal_drand48() (Perl_drand48_r(&PL_internal_random_state)) +#endif + +#ifdef USE_C_BACKTRACE + +typedef struct { + /* The number of frames returned. */ + UV frame_count; + /* The total size of the Perl_c_backtrace, including this header, + * the frames, and the name strings. */ + UV total_bytes; +} Perl_c_backtrace_header; + +typedef struct { + void* addr; /* the program counter at this frame */ + + /* We could use Dl_info (as used by dladdr()) for many of these but + * that would be naughty towards non-dlfcn systems (hi there, Win32). */ + + void* symbol_addr; /* symbol address (hint: try symbol_addr - addr) */ + void* object_base_addr; /* base address of the shared object */ + + /* The offsets are from the beginning of the whole backtrace, + * which makes the backtrace relocatable. */ + STRLEN object_name_offset; /* pathname of the shared object */ + STRLEN object_name_size; /* length of the pathname */ + STRLEN symbol_name_offset; /* symbol name */ + STRLEN symbol_name_size; /* length of the symbol name */ + STRLEN source_name_offset; /* source code file name */ + STRLEN source_name_size; /* length of the source code file name */ + STRLEN source_line_number; /* source code line number */ + + /* OS X notes: atos(1) (more recently, "xcrun atos"), but the C + * API atos() uses is unknown (private "Symbolicator" framework, + * might require Objective-C even if the API would be known). + * Currently we open read pipe to "xcrun atos" and parse the + * output - quite disgusting. And that won't work if the + * Developer Tools isn't installed. */ + + /* FreeBSD notes: execinfo.h exists, but probably would need also + * the library -lexecinfo. BFD exists if the pkg devel/binutils + * has been installed, but there seems to be a known problem that + * the "bfd.h" getting installed refers to "ansidecl.h", which + * doesn't get installed. */ + + /* Win32 notes: as moral equivalents of backtrace() + dladdr(), + * one could possibly first use GetCurrentProcess() + + * SymInitialize(), and then CaptureStackBackTrace() + + * SymFromAddr(). */ + + /* Note that using the compiler optimizer easily leads into much + * of this information, like the symbol names (think inlining), + * and source code locations getting lost or confused. In many + * cases keeping the debug information (-g) is necessary. + * + * Note that for example with gcc you can do both -O and -g. + * + * Note, however, that on some platforms (e.g. OSX + clang (cc)) + * backtrace() + dladdr() works fine without -g. */ + + /* For example: the mere presence of is no guarantee: e.g. + * OS X has that, but BFD does not seem to work on the OSX executables. + * + * Another niceness would be to able to see something about + * the function arguments, however gdb/lldb manage to do that. */ +} Perl_c_backtrace_frame; + +typedef struct { + Perl_c_backtrace_header header; + Perl_c_backtrace_frame frame_info[1]; + /* After the header come: + * (1) header.frame_count frames + * (2) frame_count times the \0-terminated strings (object_name + * and so forth). The frames contain the pointers to the starts + * of these strings, and the lengths of these strings. */ +} Perl_c_backtrace; + +#define Perl_free_c_backtrace(bt) Safefree(bt) + +#endif /* USE_C_BACKTRACE */ + +/* Use a packed 32 bit constant "key" to start the handshake. The key defines + ABI compatibility, and how to process the vararg list. + + Note, some bits may be taken from INTRPSIZE (but then a simple x86 AX register + can't be used to read it) and 4 bits from API version len can also be taken, + since v00.00.00 is 9 bytes long. XS version length should not have any bits + taken since XS_VERSION lengths can get quite long since they are user + selectable. These spare bits allow for additional features for the varargs + stuff or ABI compat test flags in the future. +*/ +#define HSm_APIVERLEN 0x0000001F /* perl version string won't be more than 31 chars */ +#define HS_APIVERLEN_MAX HSm_APIVERLEN +#define HSm_XSVERLEN 0x0000FF00 /* if 0, not present, dont check, die if over 255*/ +#define HS_XSVERLEN_MAX 0xFF +/* uses var file to set default filename for newXS_deffile to use for CvFILE */ +#define HSf_SETXSUBFN 0x00000020 +#define HSf_POPMARK 0x00000040 /* popmark mode or you must supply ax and items */ +#define HSf_IMP_CXT 0x00000080 /* ABI, threaded, MULTIPLICITY, pTHX_ present */ +#define HSm_INTRPSIZE 0xFFFF0000 /* ABI, interp struct size */ +/* A mask of bits in the key which must always match between a XS mod and interp. + Also if all ABI bits in a key are true, skip all ABI checks, it is very + the unlikely interp size will all 1 bits */ +/* Maybe HSm_APIVERLEN one day if Perl_xs_apiversion_bootcheck is changed to a memcmp */ +#define HSm_KEY_MATCH (HSm_INTRPSIZE|HSf_IMP_CXT) +#define HSf_NOCHK HSm_KEY_MATCH /* if all ABI bits are 1 in the key, dont chk */ + + +#define HS_GETINTERPSIZE(key) ((key) >> 16) +/* if in the future "" and NULL must be separated, XSVERLEN would be 0 +means arg not present, 1 is empty string/null byte */ +/* (((key) & 0x0000FF00) >> 8) is less efficient on Visual C */ +#define HS_GETXSVERLEN(key) ((U8) ((key) >> 8)) +#define HS_GETAPIVERLEN(key) ((key) & HSm_APIVERLEN) + +/* internal to util.h macro to create a packed handshake key, all args must be constants */ +/* U32 return = (U16 interpsize, bool cxt, bool setxsubfn, bool popmark, + U5 (FIVE!) apiverlen, U8 xsverlen) */ +#define HS_KEYp(interpsize, cxt, setxsubfn, popmark, apiverlen, xsverlen) \ + (((interpsize) << 16) \ + | ((xsverlen) > HS_XSVERLEN_MAX \ + ? (Perl_croak_nocontext("panic: handshake overflow"), HS_XSVERLEN_MAX) \ + : (xsverlen) << 8) \ + | (cBOOL(setxsubfn) ? HSf_SETXSUBFN : 0) \ + | (cBOOL(cxt) ? HSf_IMP_CXT : 0) \ + | (cBOOL(popmark) ? HSf_POPMARK : 0) \ + | ((apiverlen) > HS_APIVERLEN_MAX \ + ? (Perl_croak_nocontext("panic: handshake overflow"), HS_APIVERLEN_MAX) \ + : (apiverlen))) +/* overflows above will optimize away unless they will execute */ + +/* public macro for core usage to create a packed handshake key but this is + not public API. This more friendly version already collected all ABI info */ +/* U32 return = (bool setxsubfn, bool popmark, "litteral_string_api_ver", + "litteral_string_xs_ver") */ +#ifdef MULTIPLICITY +# define HS_KEY(setxsubfn, popmark, apiver, xsver) \ + HS_KEYp(sizeof(PerlInterpreter), TRUE, setxsubfn, popmark, \ + sizeof("" apiver "")-1, sizeof("" xsver "")-1) +# define HS_CXT aTHX +#else +# define HS_KEY(setxsubfn, popmark, apiver, xsver) \ + HS_KEYp(sizeof(struct PerlHandShakeInterpreter), FALSE, setxsubfn, popmark, \ + sizeof("" apiver "")-1, sizeof("" xsver "")-1) +# define HS_CXT cv +#endif + +/* +=for apidoc instr +Same as L, which finds and returns a pointer to the first occurrence +of the NUL-terminated substring C in the NUL-terminated string C, +returning NULL if not found. The terminating NUL bytes are not compared. + +=cut +*/ + + +#define instr(haystack, needle) strstr((char *) haystack, (char *) needle) + +#ifdef HAS_MEMMEM +# define ninstr(big, bigend, little, lend) \ + (__ASSERT_(bigend >= big) \ + __ASSERT_(lend >= little) \ + (char *) memmem((big), (bigend) - (big), \ + (little), (lend) - (little))) +#else +# define ninstr(a,b,c,d) Perl_ninstr(a,b,c,d) +#endif + +#ifdef __Lynx__ +/* Missing proto on LynxOS */ +int mkstemp(char*); +#endif + +#ifdef PERL_CORE +# if defined(VMS) +/* only useful for calls to our mkostemp() emulation */ +# define O_VMS_DELETEONCLOSE 0x40000000 +# ifdef HAS_MKOSTEMP +# error 134221 will need a new solution for VMS +# endif +# else +# define O_VMS_DELETEONCLOSE 0 +# endif +#endif +#if defined(HAS_MKOSTEMP) && defined(PERL_CORE) +# define Perl_my_mkostemp(templte, flags) mkostemp(templte, flags) +#endif +#if defined(HAS_MKSTEMP) && defined(PERL_CORE) +# define Perl_my_mkstemp(templte) mkstemp(templte) +#endif + +#endif /* PERL_UTIL_H_ */ + +/* + * ex: set ts=8 sts=4 sw=4 et: + */