This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
use Perl_my_mkstemp() where appropriate
[perl5.git] / util.h
diff --git a/util.h b/util.h
index 57a3ad0..71531c7 100644 (file)
--- a/util.h
+++ b/util.h
@@ -8,6 +8,10 @@
  *
  */
 
+#ifndef PERL_UTIL_H_
+#define PERL_UTIL_H_
+
+
 #ifdef VMS
 #  define PERL_FILE_IS_ABSOLUTE(f) \
        (*(f) == '/'                                                    \
             || ((*(f) == '[' || *(f) == '<')                           \
                 && (isWORDCHAR((f)[1]) || strchr("$-_]>",(f)[1])))))
 
-#else          /* !VMS */
-#  if defined(WIN32) || defined(__CYGWIN__)
-#    define PERL_FILE_IS_ABSOLUTE(f) \
+#elif defined(WIN32) || defined(__CYGWIN__)
+#  define PERL_FILE_IS_ABSOLUTE(f) \
        (*(f) == '/' || *(f) == '\\'            /* UNC/rooted path */   \
         || ((f)[0] && (f)[1] == ':'))          /* drive name */
-#  else                /* !WIN32 */
-#  ifdef NETWARE
-#    define PERL_FILE_IS_ABSOLUTE(f) \
+#elif defined(NETWARE)
+#  define PERL_FILE_IS_ABSOLUTE(f) \
        (((f)[0] && (f)[1] == ':')              /* drive name */        \
         || ((f)[0] == '\\' && (f)[1] == '\\')  /* UNC path */  \
         ||     ((f)[3] == ':'))                                /* volume name, currently only sys */
-#  else                /* !NETWARE */
-#    if defined(DOSISH) || defined(__SYMBIAN32__)
-#      define PERL_FILE_IS_ABSOLUTE(f) \
+#elif defined(DOSISH) || defined(__SYMBIAN32__)
+#  define PERL_FILE_IS_ABSOLUTE(f) \
        (*(f) == '/'                                                    \
         || ((f)[0] && (f)[1] == ':'))          /* drive name */
-#    else      /* NEITHER DOSISH NOR SYMBIANISH */
-#      define PERL_FILE_IS_ABSOLUTE(f) (*(f) == '/')
-#    endif     /* DOSISH */
-#   endif      /* NETWARE */
-#  endif       /* WIN32 */
-#endif         /* VMS */
+#else  /* NEITHER DOSISH NOR SYMBIANISH */
+#  define PERL_FILE_IS_ABSOLUTE(f)     (*(f) == '/')
+#endif
 
 /*
 =head1 Miscellaneous Functions
 
 =for apidoc ibcmp
 
-This is a synonym for (! foldEQ())
+This is a synonym for S<C<(! foldEQ())>>
 
 =for apidoc ibcmp_locale
 
-This is a synonym for (! foldEQ_locale())
+This is a synonym for S<C<(! foldEQ_locale())>>
 
 =cut
 */
@@ -85,6 +83,12 @@ typedef struct PERL_DRAND48_T 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 {
@@ -121,6 +125,12 @@ typedef struct {
      * 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() +
@@ -157,12 +167,94 @@ typedef struct {
 
 #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/PERL_IMPLICIT_CONTEXT, 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) ((key) >> 8 & 0xFF)
+#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 PERL_IMPLICIT_CONTEXT
+#  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
+
+#define instr(haystack, needle) strstr(haystack, needle)
+
+#ifdef HAS_MEMMEM
+#   define ninstr(big, bigend, little, lend)                                \
+            ((char *) memmem((big), (bigend) - (big),                       \
+                             (little), (lend) - (little)))
+#endif
+
+#ifdef __Lynx__
+/* Missing proto on LynxOS */
+int mkstemp(char*);
+#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_ */
+
 /*
- * Local variables:
- * c-indentation-style: bsd
- * c-basic-offset: 4
- * indent-tabs-mode: nil
- * End:
- *
  * ex: set ts=8 sts=4 sw=4 et:
  */