IMetaDataEmit::DefineUserString returns HRESULT: -2147024882

Question

我正在玩弄CLR的非托管分析接口。

使用 netcoreapp3.1 或 net5.0 控制台应用程序运行时，在ICorProfilerCallback::JITCompilationStarted或ICorProfilerCallback::ModuleLoadFinished中，任何调用IMetaDataEmit::DefineUserString在控制台应用模块中存储字符串文本并返回mdString令牌，都会返回 -2147024882 (0x8007000E E_OUTOFMEMORY) 的 HRESULT 。无论将什么值传递给IMetaDataEmit::DefineUserString，调用都会返回相同的 HRESULT。

.NET 应用程序非常简单

using System;
namespace dotnetapp
{
class Program
{
static void Main(string[] args)
{
WriteEnvironmentVariable("CORECLR_ENABLE_PROFILING");
WriteEnvironmentVariable("CORECLR_PROFILER");
WriteEnvironmentVariable("CORECLR_PROFILER_PATH");
Console.WriteLine("Hello World!");
}
static void WriteEnvironmentVariable(string name)
{
var value = Environment.GetEnvironmentVariable(name);
Console.WriteLine($"{name} = {value}");
}
}
}

并且构建和运行

dotnet build -c Debug dotnetapp.csproj
dotnet bin/Debug/net5.0/dotnetapp.dll

在运行应用程序时设置了相关的核心 CLR 分析环境变量

CORECLR_ENABLE_PROFILING=1
CORECLR_PROFILER={PROFILER CLSID}
CORECLR_PROFILER_PATH=clr_profiler.dll

分析器是使用 com-rs 在 Rust 中编写的，对IMetaDataEmit::DefineUserString的调用定义为

impl IMetaDataEmit {
pub fn define_user_string(&self, str: &str) -> Result<mdString, HRESULT> {
let mut md_string = mdStringNil;
let mut wide_string = U16CString::from_str(str).unwrap();
let len = wide_string.len() as ULONG;
let ptr = wide_string.as_ptr();
let hr = unsafe { self.DefineUserString(ptr, len, &mut md_string) };
if FAILED(hr) {
log::error!("define user string '{}' failed. HRESULT: {} {:X}", str, hr, hr);
return Err(hr);
}
log::trace!("md_string token {}", md_string);
Ok(md_string)
}
}

其中不安全的调用是 comr-rs 生成的函数

com::interfaces! {
#[uuid("BA3FEE4C-ECB9-4E41-83B7-183FA41CD859")]
pub unsafe interface IMetaDataEmit: IUnknown {
// functions ordered by IMetaDataEmit layout
fn DefineUserString(&self,
szString: LPCWSTR,
cchString: ULONG,
pstk: *mut mdString,
) -> HRESULT;
}
}

我正在使用U16CString在探查器中的其他地方创建一个*const u16指针，以LPCWSTR传递给接口函数，例如IMetaDataImport::EnumMethodsWithName，所以我认为这不是问题，但我想我会提到它。

失败呼叫的日志是

TRACE [imetadata_emit] wide_string UCString { inner: [71, 111, 111, 100, 98, 121, 101, 32, 87, 111, 114, 108, 100, 33, 0] }, len 14
ERROR [imetadata_emit] define user string 'Goodbye World!' failed. HRESULT: -2147024882 8007000E

其中UCString.inner是指针传递到IMetaDataEmit::DefineUserString的Vec<u16>。

IMetaDataEmit从存储的ICorProfilerInfo中检索，并在初始化时使用ICorProfilerInfo::GetModuleMetaData、CorOpenFlagsofRead和ofWrite传递给探查器

。

impl ICorProfilerInfo {
pub fn get_module_metadata<I: Interface>(
&self,
module_id: ModuleID,
open_flags: CorOpenFlags,
) -> Result<I, HRESULT> {
let mut unknown = None;
let hr = unsafe {
self.GetModuleMetaData(module_id, open_flags.bits(), &I::IID as REFIID, &mut unknown as *mut _ as *mut *mut IUnknown)
};
if FAILED(hr) {
log::error!("error fetching metadata for module_id {}, HRESULT: {:X}", module_id, hr);
return Err(hr);
}
Ok(unknown.unwrap())
}
}

其中GetModuleMetaData是在用com::interfaces!宏生成的ICorProfilerInfo上定义的

com::interfaces! {
#[uuid("28B5557D-3F3F-48b4-90B2-5F9EEA2F6C48")]
pub unsafe interface ICorProfilerInfo: IUnknown {
// functions ordered by ICorProfilerInfo layout
fn GetModuleMetaData(&self,
moduleId: ModuleID,
dwOpenFlags: DWORD,
riid: REFIID,
ppOut: *mut *mut IUnknown,
) -> HRESULT;
}
}

似乎我在 Rust 的某个地方错过了一些东西。从ICorProfilerInfo、IMetaDataImport中检索数据IMetaDataImport2工作，获取和修改IL函数体(更改现有指令)也是如此。我有一个想法是IMetaDataEmit是否需要可变的，但我认为情况并非如此，因为元数据的更改发生在 FFI 边界的C++运行时端。

编辑

我整理了一个简单的 C++ 分析器，它在ICorProfilerCallback::ModuleLoadFinished中调用IMetaDataEmit::DefineUserString，并在示例 .NET 应用程序上按预期工作，因此这表明问题出在 Rust 代码中的某个地方。

浏览运行时代码，我认为RegMeta::DefineUserString是DefineUserString的实现和跟踪代码路径，我认为E_OUTOFMEMORY来自StgBlobPool::AddBlob。

Answer 1

问题(显然)是由于IMetaDataEmit接口的定义不正确。

无论目标语言是什么，COM 接口定义都必须与原始二进制布局完全匹配：所有方法的顺序相同(不要信任 MSDN 视觉顺序)，从派生接口方法(IUnknown 等)开始，以及每个方法的精确二进制兼容签名。