X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/b6d726d6151ea6181b3dfcc77fb660af507482eb..a68ea46312935021280f02a7264d25531882473a:/XSUB.h diff --git a/XSUB.h b/XSUB.h index af19c81..94e9dad 100644 --- a/XSUB.h +++ b/XSUB.h @@ -1,32 +1,34 @@ /* XSUB.h * - * Copyright (c) 1997-2002, Larry Wall + * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, + * 2003, 2004, 2005, 2006, 2007, 2008 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 _INC_PERL_XSUB_H -#define _INC_PERL_XSUB_H 1 +#ifndef PERL_XSUB_H_ +#define PERL_XSUB_H_ 1 /* first, some documentation for xsubpp-generated items */ /* -=head1 Variables created by C and C internal functions +=head1 C variables and internal functions =for apidoc Amn|char*|CLASS Variable which is setup by C to indicate the -class name for a C++ XS constructor. This is always a C. See C. +class name for a C++ XS constructor. This is always a C. See +C>. =for apidoc Amn|(whatever)|RETVAL Variable which is setup by C to hold the return value for an -XSUB. This is always the proper type for the XSUB. See +XSUB. This is always the proper type for the XSUB. See L. =for apidoc Amn|(whatever)|THIS Variable which is setup by C to designate the object in a C++ -XSUB. This is always the proper type for the C++ object. See C and +XSUB. This is always the proper type for the C++ object. See C> and L. =for apidoc Amn|I32|ax @@ -45,47 +47,134 @@ XSUB's aliases was used to invoke it. See L. =for apidoc Am|SV*|ST|int ix Used to access elements on the XSUB's stack. -=for apidoc AmU||XS +=for apidoc AmnU||XS Macro to declare an XSUB and its C parameter list. This is handled by -C. +C. It is the same as using the more explicit C macro. + +=for apidoc AmU||XS_INTERNAL +Macro to declare an XSUB and its C parameter list without exporting the symbols. +This is handled by C and generally preferable over exporting the XSUB +symbols unnecessarily. -=for apidoc Ams||dAX +=for apidoc AmnU||XS_EXTERNAL +Macro to declare an XSUB and its C parameter list explicitly exporting the symbols. + +=for apidoc Amns||dAX Sets up the C variable. This is usually handled automatically by C by calling C. -=for apidoc Ams||dITEMS +=for apidoc Amns||dAXMARK +Sets up the C variable and stack marker variable C. +This is usually handled automatically by C by calling C. + +=for apidoc Amns||dITEMS Sets up the C variable. This is usually handled automatically by C by calling C. -=for apidoc Ams||dXSARGS -Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. +=for apidoc Amns||dXSARGS +Sets up stack and mark pointers for an XSUB, calling C and C. Sets up the C and C variables by calling C and C. This is usually handled automatically by C. -=for apidoc Ams||dXSI32 +=for apidoc Amns||dXSI32 Sets up the C variable for an XSUB which has aliases. This is usually handled automatically by C. +=for apidoc Amns||dUNDERBAR +Sets up any variable needed by the C macro. It used to define +C, but it is currently a noop. However, it is strongly advised +to still use it for ensuring past and future compatibility. + +=for apidoc AmnU||UNDERBAR +The SV* corresponding to the C<$_> variable. Works even if there +is a lexical C<$_> in scope. + =cut */ +#ifndef PERL_UNUSED_ARG +# define PERL_UNUSED_ARG(x) ((void)x) +#endif +#ifndef PERL_UNUSED_VAR +# define PERL_UNUSED_VAR(x) ((void)x) +#endif + #define ST(off) PL_stack_base[ax + (off)] -#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING) -# define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv) -#else -# define XS(name) void name(pTHX_ CV* cv) -#endif +/* XSPROTO() is also used by SWIG like this: + * + * typedef XSPROTO(SwigPerlWrapper); + * typedef SwigPerlWrapper *SwigPerlWrapperPtr; + * + * This code needs to be compilable under both C and C++. + * + * Don't forget to change the __attribute__unused__ version of XS() + * below too if you change XSPROTO() here. + */ -#define dAX I32 ax = MARK - PL_stack_base + 1 +/* XS_INTERNAL is the explicit static-linkage variant of the default + * XS macro. + * + * XS_EXTERNAL is the same as XS_INTERNAL except it does not include + * "STATIC", ie. it exports XSUB symbols. You probably don't want that. + */ -#define dITEMS I32 items = SP - MARK +#define XSPROTO(name) void name(pTHX_ CV* cv __attribute__unused__) -#define dXSARGS \ - dSP; dMARK; \ - dAX; dITEMS +#undef XS +#undef XS_EXTERNAL +#undef XS_INTERNAL +#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING) +# define XS_EXTERNAL(name) __declspec(dllexport) XSPROTO(name) +# define XS_INTERNAL(name) STATIC XSPROTO(name) +#elif defined(__SYMBIAN32__) +# define XS_EXTERNAL(name) EXPORT_C XSPROTO(name) +# define XS_INTERNAL(name) EXPORT_C STATIC XSPROTO(name) +#elif defined(__cplusplus) +# define XS_EXTERNAL(name) extern "C" XSPROTO(name) +# define XS_INTERNAL(name) static XSPROTO(name) +#elif defined(HASATTRIBUTE_UNUSED) +# define XS_EXTERNAL(name) void name(pTHX_ CV* cv __attribute__unused__) +# define XS_INTERNAL(name) STATIC void name(pTHX_ CV* cv __attribute__unused__) +#else +# define XS_EXTERNAL(name) XSPROTO(name) +# define XS_INTERNAL(name) STATIC XSPROTO(name) +#endif -#define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \ +/* We do export xsub symbols by default for the public XS macro. + * Try explicitly using XS_INTERNAL/XS_EXTERNAL instead, please. */ +#define XS(name) XS_EXTERNAL(name) + +#define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1) + +#define dAXMARK \ + I32 ax = POPMARK; \ + SV **mark = PL_stack_base + ax++ + +#define dITEMS I32 items = (I32)(SP - MARK) + +#define dXSARGS \ + dSP; dAXMARK; dITEMS +/* These 3 macros are replacements for dXSARGS macro only in bootstrap. + They factor out common code in every BOOT XSUB. Computation of vars mark + and items will optimize away in most BOOT functions. Var ax can never be + optimized away since BOOT must return &PL_sv_yes by default from xsubpp. + Note these macros are not drop in replacements for dXSARGS since they set + PL_xsubfilename. */ +#define dXSBOOTARGSXSAPIVERCHK \ + I32 ax = XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK; \ + SV **mark = PL_stack_base + ax; dSP; dITEMS +#define dXSBOOTARGSAPIVERCHK \ + I32 ax = XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK; \ + SV **mark = PL_stack_base + ax; dSP; dITEMS +/* dXSBOOTARGSNOVERCHK has no API in xsubpp to choose it so do +#undef dXSBOOTARGSXSAPIVERCHK +#define dXSBOOTARGSXSAPIVERCHK dXSBOOTARGSNOVERCHK */ +#define dXSBOOTARGSNOVERCHK \ + I32 ax = XS_SETXSUBFN_POPMARK; \ + SV **mark = PL_stack_base + ax; dSP; dITEMS + +#define dXSTARG SV * const targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \ ? PAD_SV(PL_op->op_targ) : sv_newmortal()) /* Should be used before final PUSHi etc. if not in PPCODE section. */ @@ -97,13 +186,18 @@ handled automatically by C. #ifdef __cplusplus # define XSINTERFACE_CVT(ret,name) ret (*name)(...) +# define XSINTERFACE_CVT_ANON(ret) ret (*)(...) #else # define XSINTERFACE_CVT(ret,name) ret (*name)() +# define XSINTERFACE_CVT_ANON(ret) ret (*)() #endif #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION) -#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f)) +#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT_ANON(ret))(f)) #define XSINTERFACE_FUNC_SET(cv,f) \ - CvXSUBANY(cv).any_dptr = (void (*) (pTHX_ void*))(f) + CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f) + +#define dUNDERBAR dNOOP +#define UNDERBAR find_rundefsv() /* Simple macros to put new mortal values onto the stack. */ /* Typically used to return values from XS functions. */ @@ -123,6 +217,10 @@ is stored in a new mortal SV. Place a copy of a string into the specified position C on the stack. The value is stored in a new mortal SV. +=for apidoc Am|void|XST_mUV|int pos|UV uv +Place an unsigned integer into the specified position C on the stack. The +value is stored in a new mortal SV. + =for apidoc Am|void|XST_mNO|int pos Place C<&PL_sv_no> into the specified position C on the stack. @@ -142,57 +240,87 @@ handled by C. =for apidoc Am|void|XSRETURN_IV|IV iv Return an integer from an XSUB immediately. Uses C. +=for apidoc Am|void|XSRETURN_UV|IV uv +Return an integer from an XSUB immediately. Uses C. + =for apidoc Am|void|XSRETURN_NV|NV nv Return a double from an XSUB immediately. Uses C. =for apidoc Am|void|XSRETURN_PV|char* str Return a copy of a string from an XSUB immediately. Uses C. -=for apidoc Ams||XSRETURN_NO +=for apidoc Amns||XSRETURN_NO Return C<&PL_sv_no> from an XSUB immediately. Uses C. -=for apidoc Ams||XSRETURN_YES +=for apidoc Amns||XSRETURN_YES Return C<&PL_sv_yes> from an XSUB immediately. Uses C. -=for apidoc Ams||XSRETURN_UNDEF +=for apidoc Amns||XSRETURN_UNDEF Return C<&PL_sv_undef> from an XSUB immediately. Uses C. -=for apidoc Ams||XSRETURN_EMPTY +=for apidoc Amns||XSRETURN_EMPTY Return an empty list from an XSUB immediately. =head1 Variables created by C and C internal functions -=for apidoc AmU||newXSproto +=for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to the subs. -=for apidoc AmU||XS_VERSION +=for apidoc AmnU||XS_VERSION The version identifier for an XS module. This is usually -handled automatically by C. See C. +handled automatically by C. See +C>. -=for apidoc Ams||XS_VERSION_BOOTCHECK -Macro to verify that a PM module's $VERSION variable matches the XS +=for apidoc Amns||XS_VERSION_BOOTCHECK +Macro to verify that a PM module's C<$VERSION> variable matches the XS module's C variable. This is usually handled automatically by C. See L. +=for apidoc Amns||XS_APIVERSION_BOOTCHECK +Macro to verify that the perl api version an XS module has been compiled against +matches the api version of the perl interpreter it's being loaded into. + +=head1 Exception Handling (simple) Macros + +=for apidoc Amns||dXCPT +Set up necessary local variables for exception handling. +See L. + +=for apidoc AmnU||XCPT_TRY_START +Starts a try block. See L. + +=for apidoc AmnU||XCPT_TRY_END +Ends a try block. See L. + +=for apidoc AmnU||XCPT_CATCH +Introduces a catch block. See L. + +=for apidoc Amns||XCPT_RETHROW +Rethrows a previously caught exception. See L. + =cut */ #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) ) +#define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) ) #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) ) #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0))) -#define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n))) +#define XST_mPVN(i,v,n) (ST(i) = newSVpvn_flags(v,n, SVs_TEMP)) #define XST_mNO(i) (ST(i) = &PL_sv_no ) #define XST_mYES(i) (ST(i) = &PL_sv_yes ) #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef) #define XSRETURN(off) \ STMT_START { \ - PL_stack_sp = PL_stack_base + ax + ((off) - 1); \ + const IV tmpXSoff = (off); \ + assert(tmpXSoff >= 0);\ + PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \ return; \ } STMT_END #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END +#define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END @@ -201,45 +329,82 @@ C. See L. #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END -#define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d) +#define newXSproto(a,b,c,d) newXS_flags(a,b,c,d,0) #ifdef XS_VERSION -# define XS_VERSION_BOOTCHECK \ - STMT_START { \ - SV *tmpsv; STRLEN n_a; \ - char *vn = Nullch, *module = SvPV(ST(0),n_a); \ - if (items >= 2) /* version supplied as bootstrap arg */ \ - tmpsv = ST(1); \ - else { \ - /* XXX GV_ADDWARN */ \ - tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ - vn = "XS_VERSION"), FALSE); \ - if (!tmpsv || !SvOK(tmpsv)) \ - tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ - vn = "VERSION"), FALSE); \ - } \ - if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \ - Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\ - module, XS_VERSION, \ - vn ? "$" : "", vn ? module : "", vn ? "::" : "", \ - vn ? vn : "bootstrap parameter", tmpsv); \ - } STMT_END +# define XS_VERSION_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(FALSE, FALSE, "", XS_VERSION), HS_CXT, __FILE__, \ + items, ax, XS_VERSION) #else # define XS_VERSION_BOOTCHECK #endif -/* - The DBM_setFilter & DBM_ckFilter macros are only used by - the *DB*_File modules +#define XS_APIVERSION_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(FALSE, FALSE, "v" PERL_API_VERSION_STRING, ""), \ + HS_CXT, __FILE__, items, ax, "v" PERL_API_VERSION_STRING) +/* public API, this is a combination of XS_VERSION_BOOTCHECK and + XS_APIVERSION_BOOTCHECK in 1, and is backportable */ +#ifdef XS_VERSION +# define XS_BOTHVERSION_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(FALSE, FALSE, "v" PERL_API_VERSION_STRING, XS_VERSION), \ + HS_CXT, __FILE__, items, ax, "v" PERL_API_VERSION_STRING, XS_VERSION) +#else +/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */ +# define XS_BOTHVERSION_BOOTCHECK XS_APIVERSION_BOOTCHECK +#endif + +/* private API */ +#define XS_APIVERSION_POPMARK_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(FALSE, TRUE, "v" PERL_API_VERSION_STRING, ""), \ + HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING) +#ifdef XS_VERSION +# define XS_BOTHVERSION_POPMARK_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(FALSE, TRUE, "v" PERL_API_VERSION_STRING, XS_VERSION), \ + HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING, XS_VERSION) +#else +/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */ +# define XS_BOTHVERSION_POPMARK_BOOTCHECK XS_APIVERSION_POPMARK_BOOTCHECK +#endif + +#define XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(TRUE, TRUE, "v" PERL_API_VERSION_STRING, ""), \ + HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING) +#ifdef XS_VERSION +# define XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK \ + Perl_xs_handshake(HS_KEY(TRUE, TRUE, "v" PERL_API_VERSION_STRING, XS_VERSION),\ + HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING, XS_VERSION) +#else +/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */ +# define XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK +#endif + +/* For a normal bootstrap without API or XS version checking. + Useful for static XS modules or debugging/testing scenarios. + If this macro gets heavily used in the future, it should separated into + a separate function independent of Perl_xs_handshake for efficiency */ +#define XS_SETXSUBFN_POPMARK \ + Perl_xs_handshake(HS_KEY(TRUE, TRUE, "", "") | HSf_NOCHK, HS_CXT, __FILE__) + +#ifdef NO_XSLOCKS +# define dXCPT dJMPENV; int rEtV = 0 +# define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0) +# define XCPT_TRY_END JMPENV_POP; +# define XCPT_CATCH if (rEtV != 0) +# define XCPT_RETHROW JMPENV_JUMP(rEtV) +#endif + +/* + The DBM_setFilter & DBM_ckFilter macros are only used by + the *DB*_File modules */ #define DBM_setFilter(db_type,code) \ - { \ + STMT_START { \ if (db_type) \ RETVAL = sv_mortalcopy(db_type) ; \ ST(0) = RETVAL ; \ if (db_type && (code == &PL_sv_undef)) { \ - SvREFCNT_dec(db_type) ; \ + SvREFCNT_dec_NN(db_type) ; \ db_type = NULL ; \ } \ else if (code) { \ @@ -248,9 +413,10 @@ C. See L. else \ db_type = newSVsv(code) ; \ } \ - } + } STMT_END #define DBM_ckFilter(arg,type,name) \ + STMT_START { \ if (db->type) { \ if (db->filtering) { \ croak("recursion detected in %s", name) ; \ @@ -259,8 +425,10 @@ C. See L. SAVETMPS ; \ SAVEINT(db->filtering) ; \ db->filtering = TRUE ; \ - SAVESPTR(DEFSV) ; \ - DEFSV = arg ; \ + SAVE_DEFSV ; \ + if (name[7] == 's') \ + arg = newSVsv(arg); \ + DEFSV_set(arg) ; \ SvTEMP_off(arg) ; \ PUSHMARK(SP) ; \ PUTBACK ; \ @@ -269,13 +437,15 @@ C. See L. PUTBACK ; \ FREETMPS ; \ LEAVE ; \ - } + if (name[7] == 's'){ \ + arg = sv_2mortal(arg); \ + } \ + } } STMT_END #if 1 /* for compatibility */ # define VTBL_sv &PL_vtbl_sv # define VTBL_env &PL_vtbl_env # define VTBL_envelem &PL_vtbl_envelem -# define VTBL_sig &PL_vtbl_sig # define VTBL_sigelem &PL_vtbl_sigelem # define VTBL_pack &PL_vtbl_pack # define VTBL_packelem &PL_vtbl_packelem @@ -368,6 +538,12 @@ C. See L. # undef setservent #endif /* NETWARE */ +/* to avoid warnings: "xyz" redefined */ +#ifdef WIN32 +# undef popen +# undef pclose +#endif /* WIN32 */ + # undef socketpair # define mkdir PerlDir_mkdir @@ -391,6 +567,7 @@ C. See L. # define ferror PerlSIO_ferror # define clearerr PerlSIO_clearerr # define getc PerlSIO_getc +# define fgets PerlSIO_fgets # define fputc PerlSIO_fputc # define fputs PerlSIO_fputs # define fflush PerlSIO_fflush @@ -436,6 +613,7 @@ C. See L. # define utime PerlLIO_utime # define write PerlLIO_write # define malloc PerlMem_malloc +# define calloc PerlMem_calloc # define realloc PerlMem_realloc # define free PerlMem_free # define abort PerlProc_abort @@ -510,20 +688,22 @@ C. See L. # define socketpair PerlSock_socketpair # endif /* NETWARE && USE_STDIO */ -# ifdef USE_SOCKETS_AS_HANDLES -# undef fd_set -# undef FD_SET -# undef FD_CLR -# undef FD_ISSET -# undef FD_ZERO -# define fd_set Perl_fd_set -# define FD_SET(n,p) PERL_FD_SET(n,p) -# define FD_CLR(n,p) PERL_FD_CLR(n,p) -# define FD_ISSET(n,p) PERL_FD_ISSET(n,p) -# define FD_ZERO(p) PERL_FD_ZERO(p) -# endif /* USE_SOCKETS_AS_HANDLES */ +# undef fd_set +# undef FD_SET +# undef FD_CLR +# undef FD_ISSET +# undef FD_ZERO +# define fd_set Perl_fd_set +# define FD_SET(n,p) PERL_FD_SET(n,p) +# define FD_CLR(n,p) PERL_FD_CLR(n,p) +# define FD_ISSET(n,p) PERL_FD_ISSET(n,p) +# define FD_ZERO(p) PERL_FD_ZERO(p) # endif /* NO_XSLOCKS */ #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */ -#endif /* _INC_PERL_XSUB_H */ /* include guard */ +#endif /* PERL_XSUB_H_ */ /* include guard */ + +/* + * ex: set ts=8 sts=4 sw=4 et: + */