.NET Compact Framework使用P/Invoke服务(转)

一、P/Invoke
在.NET Compact Framework的支持下，可以方便高效地开发出适合于移动设备的应用程序，而不需要去考虑特定的硬件环境。.NET Compact Framework向开发者屏蔽了硬件底层的细节，使开发者可以集中精力于业务逻辑的解决方案。

　　作为.NET Framework 的一个子集，.NET Compact Framework只提供了.NET Framework的一部分功能，因此有时在实现一些功能时不得不借助于Windows CE API。另外还存在一些第三方的组件/资源，或以动态链接库形式提供，或者已经是COM组件。相对于.NET Compact Framework，它们都属于非托管资源。我们需要一种功能，实现由托管环境访问这些非托管资源。和.NET Framework 一样，平台调用P/Invoke(Platform Invocation Services)提供托管代码调用驻留于 DLL 中的非托管函数的功能。下面是一张P/Invoke原理图，来自MSDN。



归纳起来，使用P/Invoke的场合包括：
1、.NET Compact Framework没有实现某功能，需要借助Windows CE API；
2、已有DLL或COM组件等资源，希望能充分利用，减少开发成本和风险；
3、鉴于DLL的执行性能和反编译能力都可能高于.NET Compact Framework，借助DLL提高程序性能和安全性。当然关于DLL的执行性能是否高于托管代码，不能一概而论。

二、.NET Compact Framework下的P/Invoke
先看一个P/Invoke的例子。下面使用DllImport特征导入Windows CE的API函数MessageBoxW的定义。

[align=left]public class APIHelper[/align]
[align=left]{[/align]
[align=left][DllImport("coredll.dll", SetLastError = true)][/align]
[align=left]public static extern int MessageBoxW(IntPtr hWnd, String text, String caption, uint type);[/align]
}

然后可以对它进行调用。
[align=left]private void button1_Click(object sender, EventArgs e)[/align]
[align=left]{[/align]
[align=left]APIHelper.MessageBoxW(IntPtr.Zero, "测试MessageBoxW函数",[/align]
[align=left]"api调用", 0);[/align]
}

　　可以看到，使用P/Invoke包括声明和调用两个过程，另外还有一个错误处理的过程。通过声明来指定要调用的非托管函数，.NET Compact Framework也是使用DllImport特性来进行声明，包括模块名、函数名及调用约定。与.NET Framework完整版的DllImport特性不同，.NET Compact Framework的一共包括五个公共字段：CallingConvention，CharSet，EntryPoint，PreserveSig和SetLastError。具体各字段的说明可以参考MSDN。

EntryPoint可以指定为函数名或函数的序号值，如EntryPoint = "MessageBoxW"或EntryPoint = "#858"。值得注意的是.NET Compact Framework 下CallingConvention只支持CallingConvention.Winapi，即默认的平台调用；编码方式只支持Unicode，因此CharSet实际只有CharSet.Unicode一个取值。因此在导入定义时省略CallingConvention和CharSet字段的效果没有分别。

另外，DllImport修饰的方法必须用 static 和 extern 关键字来指明方法是在外部实现的，对其可见性修饰符则没有限制。

调用DllImport导入的非托管函数时，CLR的P/Invoke服务从声明中提取出元数据，定位要调用的模块（coredll.dll），将其加载到内存，然后根据入口点信息检索非托管函数地址。如果不出现错误，则P/Invoke完成参数的封送并调用该函数，并把返回函数的返回值。

P/Invoke会产生两种错误，一种是上面说到的P/Invoke在定位调用模块，检索函数地址时出错。如P/Invoke找不到入口点时会出错，并抛出MissingMethodException异常；函数的调用约定声明有误时会抛出NotSupportedException异常，这时应检查函数的参数及返回值定义是否与模块中函数吻合。P/Invoke的另一种错误是执行非托管函数过程中发生的错误。

另一个需要特别注意的是，.NET Compact Framework下P/Invoke不支持回调，即无法向非托管函数传递一个委托并在非托管函数中被调用。使用需要回调的非托管函数时会引发异常。

三、P/Invoke的参数封送
我们知道，托管代码与非托管代码存在很大的差异，P/Invoke在传递参数、返回值时需要先在托管类型和非托管类型之间进行转换，这整个过程有个专门术语，就叫做封送(Marshal)。

P/Invoke可以为常规的数据类型进行正确地封送处理，如整型int，字节型byte。这些常规的数据类型被称为blittable 类型，它们在托管代码和非托管代码中具有相同的表示，P/Invoke在对它们进行封送时不需要进行任何特殊处理。因此使用blittable 类型的非托管函数以用相同表示的托管类型导入其定义。假如有一个DLL中的函数的C++签名为：
int DllFunction_1(int index);

按如下方式导入定义：
[align=left][DllImport("dllfile.dll")][/align]
public static extern int DllFunction_1(int i);
在这种情况下，P/Invoke不需要进行任何特殊处理，可以正确地进行参数和返回值的封送。

具体blittable 类型包括：

[align=left]托管代码类型[/align]	[align=left]C++代码类型[/align]
[align=left]System.Byte[/align]	[align=left]unsigned char[/align]
[align=left]System.SByte[/align]	[align=left]byte[/align]
[align=left]System.Int16[/align]	[align=left]short[/align]
[align=left]System.UInt16[/align]	[align=left]unsigned short[/align]
[align=left]System.Int32[/align]	[align=left]int[/align]
[align=left]System.Int64[/align]	[align=left]long[/align]
[align=left]System.UInt64[/align]	[align=left]unsigned long[/align]
[align=left]System.IntPtr[/align]	[align=left]指针、句柄[/align]
[align=left]System.Boolean[/align]	[align=left]bool[/align]
[align=left]System.Char[/align]	[align=left]wchar_t或TCHAR(16位UNICODE字符)[/align]
[align=left]System.String*[/align]	[align=left]TCHAR *或LPWSTR(UNICODE字符数组)[/align]

不仅以blittable 类型本身作为参数或返回值的非托管函数可以用相同表示的托管类型导入其定义，只包含blittable 类型（除标记*的System.String外）字段成员的构成的类或结构同样遵守这条规则。需要特别说明的是System.String是一个特例，它作为字段成员构成类或结构时不遵守这条规则。

然而，其它的类型无法不能直接按这种对应方式导入调用约定。假如有一个DLL中的函数的C++签名为：
double DllFunction_2(int index);

按如下方式导入定义：
[align=left][DllImport("dllfile.dll")][/align]
public static extern double DllFunction_2(int i);

在这种情况下，会引发一个NotSupportedException异常。这是因为托管世界的double类型和非托管世界的double类型（这里是C++）有着显著的不同，P/Invoke无法正确地将返回值从非托管的double类型转换到托管double类型，因此调用失败。应该说，P/Invoke同样无法正确的完成参数从托管double类型转换到非托管的double类型，但测试发现，实际上是可以完成的。如下C++签名为：
int DllFunction_3(double index);
按如下方式导入定义：
[align=left][DllImport("dllfile.dll")][/align]
public static extern int DllFunction_3(double d);

作为参数值的托管double类型实际上可以被正确转换为非托管的double类型，P/Invoke正确地完成了封送。但MSDN文档明确说明.NET Compact Framework 的P/Invoke是无法支持对浮点类型通过值进行封送处理的，因此我们不能依赖作为参数的double类型可以被封送这个特例。在需要在托管世界和非托管世界之间传递double类型时，应该借助引用来对其进行封送，该引用将由P/Invoke封送为非托管世界的指针。下面是一个处理的例子

//原有函数，由于返回值是double类型，无法被封送，需要改写
double DllFunction_2(int index);

//对DllFunction_2函数加上一个包装，改为以指针作为参数值递返回值
void DllFunction_Sub(int index, double * result)
{
*result = DllFunction_2(index);//这里调用原有函数
}

按如下方式导入定义，注意导入的函数是DllFunction_Sub：
[align=left][DllImport("dllfile.dll")][/align]
public static extern void DllFunction_Sub(int index, out double result);

　　可以为托管代码的调用再增加一个包装，保持与实际调用函数具有相同的签名：
[align=left]public static double DllFunction_2(int index)[/align]
[align=left]{[/align]
[align=left]double result;[/align]
[align=left]DllFunction_Sub(index, out result);[/align]
[align=left]return result;[/align]
}

通过增加一个包装这种间接的方式，我们利用P/Invoke可以对引用进行封送的特性，完成了对实际具有如下签名的非托管函数的调用：
double DllFunction_2(int index);

四、使用P/Invoke调用Windows CE的API

coredll.dll是Windows CE的核心模块，大致相当于Windows 2000/XP的kernel32.dll。coredll.dll是Windows CE系统最重要的文件，基本上每个CE系统都会在ROM中包括该文件。在Pocket PC 2003 Second Edition(Window CE 4.2，以下简称PPC)系统中，其全路径为\windows\coredll.dll。由于该文件在ROM中，因此使用PPC自带的资源管理器无法看到该文件。可以通过TotalCommander查看该文件，但仍然无法复制该文件。在安装了platform builder后可以在安装目录下找到coredll.dll文件。

绝大多数的Windows CE API都是通过coredll.dll向外暴露。因此在使用P/Invoke调用coredll.dll中的api时，值得关心的是该文件中所包含的api函数。可以通过dumpbin.exe来查看其导出符号。

在无法直接得到coredll.dll时，可以通过该文件对应的LIB导入文件进行分析而获知coredll.dll包含的api函数。安装vs2005后，可以在[安装目录]\SmartDevices\SDK\PocketPC2003\Lib\armv4下找到coredll.lib文件，它就是coredll.dll对应的LIB导入文件。运行vs2005命令行工具，执行dumpbin /exports [安装目录]\SmartDevices\SDK\PocketPC2003\Lib\armv4\coredll.lib即可得到coredll.dll包含函数的列表。如果进一步需要得到某个api函数的参数及返回值类型则需要进行深入逆向工程分析了，就比较复杂。好在这些可以从微软的MSDN文档中得到某api的具体说明。

当需要确定其它dll中有什么函数时，同样可以通过使用dumpbin导出查看其中包含的函数。

文中代码全部在vs2005(C#智能设备Pocket PC 2003应用程序和MFC智能设备DLL)和PPC模拟器下运行通过。