Skip to content

Commit

Permalink
Make PInvokeStaticSigInfo always report errors (dotnet#52405)
Browse files Browse the repository at this point in the history
  • Loading branch information
@elinor-fung
elinor-fung authored May 7, 2021
1 parent b2046c7 commit 65566e7
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 97 deletions.
2 changes: 1 addition & 1 deletion src/coreclr/vm/callconvbuilder.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ namespace CallConv
//
// Returns:
// true - No errors
// false - Invalid (more than one calling convention specified)
// false - Not specified or invalid (more than one calling convention specified)
//-------------------------------------------------------------------------
bool TryGetCallingConventionFromUnmanagedCallersOnly(_In_ MethodDesc* pMD, _Out_ CorInfoCallConvExtension* callConv);
}
Expand Down
184 changes: 99 additions & 85 deletions src/coreclr/vm/dllimport.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2548,6 +2548,22 @@ namespace
_ASSERTE(*nlt == nltAnsi || *nlt == nltUnicode);
return S_OK;
}

HRESULT ParseCallingConventionFromAttributeConstructor(_Inout_ CustomAttributeParser& ca, _Out_ CorInfoCallConvExtension* callConv)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(callConv != NULL);

CaArg callConvArg;
callConvArg.InitEnum(SERIALIZATION_TYPE_I4, (ULONG)0);
HRESULT hr = ParseKnownCaArgs(ca, &callConvArg, 1);
if (FAILED(hr))
return hr;

*callConv = GetCallConvValueForPInvokeCallConv((CorPinvokeMap)(callConvArg.val.u4 << 8));
return S_OK;
}

}

void PInvokeStaticSigInfo::PreInit(Module* pModule, MethodTable * pMT)
Expand All @@ -2568,7 +2584,6 @@ void PInvokeStaticSigInfo::PreInit(Module* pModule, MethodTable * pMT)
SetThrowOnUnmappableChar (FALSE);
SetLinkFlags (nlfNone);
SetCharSet (nltAnsi);
m_error = 0;

// assembly/type level m_bestFit & m_bThrowOnUnmappableChar
BOOL bBestFit;
Expand Down Expand Up @@ -2610,14 +2625,17 @@ void PInvokeStaticSigInfo::PreInit(MethodDesc* pMD)
PInvokeStaticSigInfo::PInvokeStaticSigInfo(
_In_ MethodDesc* pMD, _Outptr_opt_ LPCUTF8 *pLibName, _Outptr_opt_ LPCUTF8 *pEntryPointName)
{
STANDARD_VM_CONTRACT;
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(CheckPointer(pMD));
}
CONTRACTL_END;

DllImportInit(pMD, pLibName, pEntryPointName);

ReportErrors();
}

PInvokeStaticSigInfo::PInvokeStaticSigInfo(MethodDesc* pMD, ThrowOnError throwOnError)
PInvokeStaticSigInfo::PInvokeStaticSigInfo(_In_ MethodDesc* pMD)
{
CONTRACTL
{
Expand All @@ -2642,20 +2660,16 @@ PInvokeStaticSigInfo::PInvokeStaticSigInfo(MethodDesc* pMD, ThrowOnError throwOn
// System.Runtime.InteropServices.UnmanagedFunctionPointerAttribute
BYTE* pData = NULL;
LONG cData = 0;
CorPinvokeMap callConv = (CorPinvokeMap)0;
CorInfoCallConvExtension callConv = CallConvWinApiSentinel;

hr = pMT->GetCustomAttribute(
WellKnownAttribute::UnmanagedFunctionPointer, (const VOID **)(&pData), (ULONG *)&cData);
IfFailThrow(hr);
IfFailGo(hr);
if (cData != 0)
{
CustomAttributeParser ca(pData, cData);

CaArg args[1];
args[0].InitEnum(SERIALIZATION_TYPE_I4, (ULONG)m_callConv);

IfFailGo(ParseKnownCaArgs(ca, args, lengthof(args)));
callConv = (CorPinvokeMap)(args[0].val.u4 << 8);
IfFailGo(ParseCallingConventionFromAttributeConstructor(ca, &callConv));

enum UnmanagedFunctionPointerNamedArgs
{
Expand Down Expand Up @@ -2684,18 +2698,15 @@ PInvokeStaticSigInfo::PInvokeStaticSigInfo(MethodDesc* pMD, ThrowOnError throwOn
SetLinkFlags ((CorNativeLinkFlags)(nlfLastError | GetLinkFlags()));
}

InitCallConv(GetCallConvValueForPInvokeCallConv(callConv), pMD->IsVarArg());
InitCallConv(callConv, pMD->IsVarArg());

ErrExit:
if (FAILED(hr))
SetError(IDS_EE_NDIRECT_BADNATL);

if (throwOnError)
ReportErrors();
ThrowError(IDS_EE_NDIRECT_BADNATL);
}

PInvokeStaticSigInfo::PInvokeStaticSigInfo(
Signature sig, Module* pModule)
_In_ const Signature& sig, _In_ Module* pModule)
{
CONTRACTL
{
Expand All @@ -2709,8 +2720,6 @@ PInvokeStaticSigInfo::PInvokeStaticSigInfo(
m_sig = sig;
SetIsStatic(!(MetaSig::GetCallingConvention(sig) & IMAGE_CEE_CS_CALLCONV_HASTHIS));
InitCallConv(CallConvWinApiSentinel, FALSE);

ReportErrors();
}

void PInvokeStaticSigInfo::DllImportInit(_In_ MethodDesc* pMD, _Outptr_opt_ LPCUTF8 *ppLibName, _Outptr_opt_ LPCUTF8 *ppEntryPointName)
Expand Down Expand Up @@ -2738,16 +2747,6 @@ void PInvokeStaticSigInfo::DllImportInit(_In_ MethodDesc* pMD, _Outptr_opt_ LPCU
mdModuleRef modref = mdModuleRefNil;
if (FAILED(pInternalImport->GetPinvokeMap(pMD->GetMemberDef(), (DWORD*)&mappingFlags, ppEntryPointName, &modref)))
{
#if !defined(CROSSGEN_COMPILE) // IJW
// The guessing heuristic has been broken with NGen for a long time since we stopped loading
// images at NGen time using full LoadLibrary. The DLL references are not resolved correctly
// without full LoadLibrary.
//
// Disable the heuristic consistently during NGen so that it does not kick in by accident.
if (!IsCompilationProcess())
BestGuessNDirectDefaults(pMD);
#endif

InitCallConv(CallConvWinApiSentinel, pMD->IsVarArg());
return;
}
Expand All @@ -2761,8 +2760,7 @@ void PInvokeStaticSigInfo::DllImportInit(_In_ MethodDesc* pMD, _Outptr_opt_ LPCU
{
if (FAILED(pInternalImport->GetModuleRefProps(modref, ppLibName)))
{
SetError(IDS_CLASSLOAD_BADFORMAT);
return;
ThrowError(IDS_CLASSLOAD_BADFORMAT);
}
}

Expand Down Expand Up @@ -2809,14 +2807,10 @@ void PInvokeStaticSigInfo::DllImportInit(_In_ MethodDesc* pMD, _Outptr_opt_ LPCU
break;
}

if (SUCCEEDED(RemapLinkType(nlt, &nlt)))
{
SetCharSet(nlt);
}
else
{
SetError(IDS_EE_NDIRECT_BADNATL);
}
if (FAILED(RemapLinkType(nlt, &nlt)))
ThrowError(IDS_EE_NDIRECT_BADNATL);

SetCharSet(nlt);
}

#if !defined(CROSSGEN_COMPILE) // IJW
Expand Down Expand Up @@ -2920,43 +2914,6 @@ DWORD STDMETHODCALLTYPE FalseGetLastError()
return GetThread()->m_dwLastError;
}

void PInvokeStaticSigInfo::BestGuessNDirectDefaults(MethodDesc* pMD)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;

if (!pMD->IsNDirect())
return;

NDirectMethodDesc* pMDD = (NDirectMethodDesc*)pMD;

if (!pMDD->IsEarlyBound())
return;

LPVOID pTarget = NULL;

// NOTE: If we get inside this block, and this is a call to GetLastError,
// then InitEarlyBoundNDirectTarget has not been run yet.
if (pMDD->NDirectTargetIsImportThunk())
{
// Get the unmanaged callsite.
pTarget = (LPVOID)pMDD->GetModule()->GetInternalPInvokeTarget(pMDD->GetRVA());

// If this is a call to GetLastError, then we haven't overwritten m_pNativeNDirectTarget yet.
if (HeuristicDoesThisLookLikeAGetLastErrorCall((LPBYTE)pTarget))
pTarget = (BYTE*)FalseGetLastError;
}
else
{
pTarget = pMDD->GetNativeNDirectTarget();
}
}

#endif // !CROSSGEN_COMPILE

CorInfoCallConvExtension GetDefaultCallConv(BOOL bIsVarArg)
Expand All @@ -2973,8 +2930,8 @@ void PInvokeStaticSigInfo::InitCallConv(CorInfoCallConvExtension callConv, BOOL
HRESULT hr = CallConv::TryGetUnmanagedCallingConventionFromModOpt(GetScopeHandle(m_pModule), m_sig.GetRawSig(), m_sig.GetRawSigLen(), &builder, &errorResID);
if (FAILED(hr))
{
// Set an error message specific to P/Invokes or UnmanagedFunction for bad format.
SetError(hr == COR_E_BADIMAGEFORMAT ? IDS_EE_NDIRECT_BADNATL : errorResID);
// Use an error message specific to P/Invokes or UnmanagedFunction for bad format.
ThrowError(hr == COR_E_BADIMAGEFORMAT ? IDS_EE_NDIRECT_BADNATL : errorResID);
}

CorInfoCallConvExtension sigCallConv = builder.GetCurrentCallConv();
Expand All @@ -2984,7 +2941,7 @@ void PInvokeStaticSigInfo::InitCallConv(CorInfoCallConvExtension callConv, BOOL
// If no calling convention is provided, then use the default calling convention for the platform.

if (callConv != CallConvWinApiSentinel && sigCallConv != CallConvWinApiSentinel && callConv != sigCallConv)
SetError(IDS_EE_NDIRECT_BADNATL_CALLCONV);
ThrowError(IDS_EE_NDIRECT_BADNATL_CALLCONV);

if (callConv == CallConvWinApiSentinel && sigCallConv == CallConvWinApiSentinel)
m_callConv = GetDefaultCallConv(bIsVarArg);
Expand All @@ -2994,25 +2951,82 @@ void PInvokeStaticSigInfo::InitCallConv(CorInfoCallConvExtension callConv, BOOL
m_callConv = sigCallConv;

if (bIsVarArg && m_callConv != CorInfoCallConvExtension::C)
SetError(IDS_EE_NDIRECT_BADNATL_VARARGS_CALLCONV);
ThrowError(IDS_EE_NDIRECT_BADNATL_VARARGS_CALLCONV);

_ASSERTE(m_callConv != CallConvWinApiSentinel);
}

void PInvokeStaticSigInfo::ReportErrors()
void PInvokeStaticSigInfo::ThrowError(WORD errorResourceID)
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
PRECONDITION(errorResourceID != 0);
}
CONTRACTL_END;

if (m_error != 0)
COMPlusThrow(kTypeLoadException, m_error);
COMPlusThrow(kTypeLoadException, errorResourceID);
}

CorInfoCallConvExtension NDirect::GetCallingConvention_IgnoreErrors(_In_ MethodDesc* pMD)
{
CONTRACTL
{
STANDARD_VM_CHECK;
PRECONDITION(pMD != NULL);
PRECONDITION(pMD->IsNDirect());
}
CONTRACTL_END;

// This method intentionally does not check that any calling convention specified through
// attributes match that in the signature. We just return once a non-sentinel calling
// convention is found.
CorInfoCallConvExtension callConv;
MethodTable* pMT = pMD->GetMethodTable();
if (pMT->IsDelegate())
{
// System.Runtime.InteropServices.UnmanagedFunctionPointerAttribute
BYTE* pData = NULL;
LONG cData = 0;
HRESULT hr = pMT->GetCustomAttribute(WellKnownAttribute::UnmanagedFunctionPointer, (const VOID **)(&pData), (ULONG *)&cData);
if (hr == S_OK)
{
_ASSERTE(cData > 0);
CustomAttributeParser ca(pData, cData);
hr = ParseCallingConventionFromAttributeConstructor(ca, &callConv);
if (SUCCEEDED(hr) && callConv != CallConvWinApiSentinel)
return callConv;
}
}
else
{
// P/Invoke metadata
IMDInternalImport* pInternalImport = pMD->GetMDImport();
CorPinvokeMap mappingFlags = pmMaxValue;
HRESULT hr = pInternalImport->GetPinvokeMap(pMD->GetMemberDef(), (DWORD*)&mappingFlags, NULL /*pszImportName*/, NULL /*pmrImportDLL*/);
if (SUCCEEDED(hr))
{
callConv = GetCallConvValueForPInvokeCallConv((CorPinvokeMap)(mappingFlags & pmCallConvMask));
if (callConv != CallConvWinApiSentinel)
return callConv;
}
}

const Signature& sig = pMD->GetSignature();
Module* module = pMD->GetModule();

// modopts
CallConvBuilder builder;
UINT errorResID;
(void)CallConv::TryGetUnmanagedCallingConventionFromModOpt(GetScopeHandle(module), sig.GetRawSig(), sig.GetRawSigLen(), &builder, &errorResID);
callConv = builder.GetCurrentCallConv();
if (callConv != CallConvWinApiSentinel)
return callConv;

return GetDefaultCallConv(pMD->IsVarArg());
}

//---------------------------------------------------------
// Does a class or method have a NAT_L CustomAttribute?
Expand Down Expand Up @@ -4172,7 +4186,7 @@ static void CreateNDirectStubAccessMetadata(

namespace
{
void PopulateNDirectMethodDescImpl(_Inout_ NDirectMethodDesc* pNMD, _In_ const PInvokeStaticSigInfo& sigInfo, _In_z_ LPCUTF8 libName, _In_z_ LPCUTF8 entryPointName)
void PopulateNDirectMethodDescImpl(_Inout_ NDirectMethodDesc* pNMD, _In_ const PInvokeStaticSigInfo& sigInfo, _In_opt_z_ LPCUTF8 libName, _In_opt_z_ LPCUTF8 entryPointName)
{
CONTRACTL
{
Expand Down
21 changes: 12 additions & 9 deletions src/coreclr/vm/dllimport.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ struct StubSigDesc
class NDirect
{
public:
// Get the calling convention for a method by checking:
// - For delegates: UnmanagedFunctionPointer attribute
// - For non-delegates: P/Invoke metadata
// - Any modopts encoded in the method signature
// If no calling convention is specified, the default calling convention is returned
// This function ignores any errors when reading attributes/metadata, treating them as
// if no calling convention was specified through that mechanism.
static CorInfoCallConvExtension GetCallingConvention_IgnoreErrors(_In_ MethodDesc* pMD);

//---------------------------------------------------------
// Does a class or method have a NAT_L CustomAttribute?
//
Expand Down Expand Up @@ -295,26 +304,21 @@ enum ETW_IL_STUB_FLAGS
//---------------------------------------------------------
struct PInvokeStaticSigInfo
{
public:
enum ThrowOnError { THROW_ON_ERROR = TRUE, NO_THROW_ON_ERROR = FALSE };

public:
PInvokeStaticSigInfo() { LIMITED_METHOD_CONTRACT; }

PInvokeStaticSigInfo(Signature sig, Module* pModule);
PInvokeStaticSigInfo(_In_ const Signature& sig, _In_ Module* pModule);

PInvokeStaticSigInfo(MethodDesc* pMdDelegate, ThrowOnError throwOnError = THROW_ON_ERROR);
PInvokeStaticSigInfo(_In_ MethodDesc* pMdDelegate);

PInvokeStaticSigInfo(_In_ MethodDesc* pMD, _Outptr_opt_ LPCUTF8 *pLibName, _Outptr_opt_ LPCUTF8 *pEntryPointName);

private:
void ReportErrors();
void ThrowError(WORD errorResourceID);
void InitCallConv(CorInfoCallConvExtension callConv, BOOL bIsVarArg);
void DllImportInit(_In_ MethodDesc* pMD, _Outptr_opt_ LPCUTF8 *pLibName, _Outptr_opt_ LPCUTF8 *pEntryPointName);
void PreInit(Module* pModule, MethodTable *pClass);
void PreInit(MethodDesc* pMD);
void SetError(WORD error) { if (!m_error) m_error = error; }
void BestGuessNDirectDefaults(MethodDesc* pMD);

private:
enum
Expand Down Expand Up @@ -407,7 +411,6 @@ struct PInvokeStaticSigInfo
Module* m_pModule;
Signature m_sig;
CorInfoCallConvExtension m_callConv;
WORD m_error;
WORD m_wFlags;
};

Expand Down
3 changes: 1 addition & 2 deletions src/coreclr/vm/jitinterface.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9954,8 +9954,7 @@ namespace
*pSuppressGCTransition = pMD->ShouldSuppressGCTransition();
}

PInvokeStaticSigInfo sigInfo(pMD, PInvokeStaticSigInfo::NO_THROW_ON_ERROR);
return sigInfo.GetCallConv();
return NDirect::GetCallingConvention_IgnoreErrors(pMD);
}
else
{
Expand Down

0 comments on commit 65566e7

Please sign in to comment.