一、什么是远程过程调用 什么是远程过程调用 RPC(Remote Procedure Call)? 你可能对这个概念有点陌生, 而你可能非常熟悉 NFS, 是的, Win32 RPC 编程(一)我们从一个简单的 RPC “Hello, world!”的例子开始。 参考资料:MSDN: Win32 and COM Development -> Networking -> Network Protocols -> Remote Procedure Calls (RPC) 第1步:编写 IDL(Interface Description Language,接口描述语言)文件 ------------------------------------------------------------------------- IDL 是一个通用的工业标准语言,大家应该不陌生,因为 COM 里面也是用它来描述接口的。 Hello.idl: [ uuid("4556509F-618A-46CF-AB3D-ED736ED66477"), // 唯一的UUID,用 GUIDGen 生成 version(1.0) ] interface HelloWorld { // 我们定义的方法 void Hello([in,string]const char * psz); void Shutdown(void); } 一个可选的文件是应用程序配置文件(.acf),它的作用是对 RPC 接口进行配置,例如下面的 Hello.acf 文件: Hello.acf: [ implicit_handle(handle_t HelloWorld_Binding) ] interface HelloWorld { } 上面定义了 implicit_handle,这样客户端将绑定句柄 HelloWorld_Binding 了,后面的客户端代码中我们会看到。 编译 IDL 文件: >midl Hello.idl Microsoft (R) 32b/64b MIDL Compiler Version 6.00.0366 Copyright (c) Microsoft Corporation 1991-2002. All rights reserved. Processing ./Hello.idl Hello.idl Processing ./Hello.acf Hello.acf 我们可以看到自动生成了 Hello.h, Hello_s.c, Hello_c.c 文件,这些叫做 rpc stub 程序,不过我们可以不管这个概念, 我们只需要知道 Hello.h 里面定义了一个 extern RPC_IF_HANDLE HelloWorld_v1_0_s_ifspec; 这个 RPC_IF_HANDLE 将在后面用到。 第2步:编写服务端程序 ------------------------------------------------------------------------- 第1步中我们已经约定了调用的接口,那么现在我们开始实现其服务端。代码如下: server.c #include #include #include "Hello.h" // 引用MIDL 生成的头文件 /** * 这是我们在IDL 中定义的接口方法 * 需要注意一点,IDL 里面的声明是:void Hello([in,string]const char * psz); * 但是这里变成了const unsigned char *,为什么呢? * 参见MSDN 中的MIDL Command-Line Reference -> /char Switch * 默认的编译选项,对 IDL 中的char 按照unsigned char 处理 */ void Hello(const unsigned char * psz) { printf("%s/n", psz); } /** 这也是我们在IDL 中定义的接口方法,提供关闭server 的机制*/ void Shutdown(void) { // 下面的操作将导致 RpcServerListen() 退出 RpcMgmtStopServerListening(NULL); RpcServerUnregisterIf(NULL, NULL, FALSE); } int main(int argc,char * argv[]) { // 用Named Pipe 作为RPC 的通道,这样EndPoint 参数就是Named Pipe 的名字 // 按照Named Pipe 的命名规范,/pipe/pipename,其中pipename 可以是除了/ // 之外的任意字符,那么这里用一个GUID 串来命名,可以保证不会重复 RpcServerUseProtseqEp((unsigned char *)"ncacn_np", 20, (unsigned char *)"//pipe//{8dd50205-3108-498f-96e8-dbc4ec074cf9}", NULL); // 注册接口,HelloWorld_v1_0_s_ifspec 是在MIDL 生成的Hello.h 中定义的 RpcServerRegisterIf(HelloWorld_v1_0_s_ifspec, NULL, NULL); // 开始监听,本函数将一直阻塞 RpcServerListen(1,20,FALSE); return 0; } // 下面的函数是为了满足链接需要而写的,没有的话会出现链接错误 void __RPC_FAR* __RPC_USER midl_user_allocate(size_t len) { return(malloc(len)); } void __RPC_USER midl_user_free(void __RPC_FAR *ptr) { free(ptr); } 编译: >cl /D_WIN32_WINNT=0x500 server.c Hello_s.c rpcrt4.lib 用于 80x86 的 Microsoft (R) 32 位 C/C++ 优化编译器 14.00.50727.42 版 版权所有(C) Microsoft Corporation。保留所有权利。 server.c Hello_s.c 正在生成代码... Microsoft (R) Incremental Linker Version 8.00.50727.42 Copyright (C) Microsoft Corporation. All rights reserved. /out:server.exe server.obj Hello_s.obj rpcrt4.lib 编译时为什么要指定 _WIN32_WINNT=0x500 呢?因为如果没有的话会报告下面的错误: Hello_s.c(88) : fatal error C1189: #error : You need a Windows 2000 or later to run this stub because it uses these features: 第3步:编写客户端程序 ------------------------------------------------------------------------- 客户端的代码: client.c #include #include #include #include "Hello.h" // 引用MIDL 生成的头文件 int main(int argc, char * argv[]) { unsigned char * pszStringBinding = NULL; if ( argc != 2 ) { printf("Usage:%s return 1; } // 用Named Pipe 作为RPC 的通道。参见server.c 中的RpcServerUseProtseqEp() 部分 // 第3 个参数NetworkAddr 如果取NULL,那么就是连接本机服务 // 否则要取////servername 这样的格式,例如你的计算机名为jack,那么就是//jack RpcStringBindingCompose( NULL, (unsigned char*)"ncacn_np", /*(unsigned char*)"////servername"*/ NULL, (unsigned char*)"//pipe//{8dd50205-3108-498f-96e8-dbc4ec074cf9}", NULL, &pszStringBinding ); // 绑定接口,这里要和 Hello.acf 的配置一致,那么就是HelloWorld_Binding RpcBindingFromStringBinding(pszStringBinding, & HelloWorld_Binding ); // 下面是调用服务端的函数了 RpcTryExcept { if ( _stricmp(argv[1], "SHUTDOWN") == 0 ) { Shutdown(); } else { Hello((unsigned char*)argv[1]); } } RpcExcept(1) { printf( "RPC Exception %d/n", RpcExceptionCode() ); } RpcEndExcept // 释放资源 RpcStringFree(&pszStringBinding); RpcBindingFree(&HelloWorld_Binding); return 0; } // 下面的函数是为了满足链接需要而写的,没有的话会出现链接错误 void __RPC_FAR* __RPC_USER midl_user_allocate(size_t len) { return(malloc(len)); } void __RPC_USER midl_user_free(void __RPC_FAR *ptr) { free(ptr); } 编译: >cl /D_WIN32_WINNT=0x500 client.c Hello_c.c rpcrt4.lib 用于 80x86 的 Microsoft (R) 32 位 C/C++ 优化编译器 14.00.50727.42 版 版权所有(C) Microsoft Corporation。保留所有权利。 client.c Hello_c.c 正在生成代码... Microsoft (R) Incremental Linker Version 8.00.50727.42 Copyright (C) Microsoft Corporation. All rights reserved. /out:client.exe client.obj Hello_c.obj rpcrt4.lib 第4步:测试: ------------------------------------------------------------------------- 运行 server.exe,将弹出一个 console 窗口,等待客户端调用。 运行客户端 client.exe: >client hello 可以看到 server.exe 的 console 窗口出现 hello 的字符串。 >client shutdown server.exe 退出。 Win32 RPC 编程(二)这部分基本和上一节一样,不过上一节中 RPC 是通过 Named Pipe 调用的,这里我们再试一下 TCP 的方式。 代码大部分都是相同的, IDL 接口不用变(无论是通过什么方式 RPC,接口都是与之无关的)。 服务端要换成 TCP 的方式: --------------------------------- int main(int argc,char * argv[]) { // 用TCP 方式作为RPC 的通道。绑定端口13521。 RpcServerUseProtseqEp( (unsigned char *)"ncacn_ip_tcp", RPC_C_PROTSEQ_MAX_REQS_DEFAULT, (unsigned char *)"13521", NULL); // 注意:从Windows XP SP2 开始,增强了安全性的要求,如果用 RpcServerRegisterIf() 注册 // 接口,客户端调用时会出现 RpcExceptionCode() == 5,即Access Denied 的错误. 因此,必 // 须用 RpcServerRegisterIfEx 带 RPC_IF_ALLOW_CALLBACKS_WITH_NO_AUTH 标志允许客户端直 // 接调用。 // RpcServerRegisterIf(HelloWorld_v1_0_s_ifspec, NULL, NULL); RpcServerRegisterIfEx( HelloWorld_v1_0_s_ifspec, // Interface to register. NULL, NULL, // Use the MIDL generated entry-point vector. RPC_IF_ALLOW_CALLBACKS_WITH_NO_AUTH, 0, NULL); // 后面都相同 ... return 0; } 客户端的调用方式也要换: --------------------------------- int main(int argc, char * argv[]) { // 前面都相同 ... // 用 TCP 方式作为 RPC 的通道。服务器端口 13521。第3个 // 参数 NetworkAddr 如果取 NULL,那么就是连接本机服务, // 也可以取IP, 域名, servername 等 RpcStringBindingCompose( NULL, (unsigned char*)"ncacn_ip_tcp", (unsigned char*)"localhost" /*NULL*/, (unsigned char*)"13521", NULL, &pszStringBinding ); // 后面都相同 ... } 别的地方都是一样的。 我们在上一节的基础上,讨论如何实现异步的 RPC 调用。前两节演示的函数调用都是同步的,即调用函数 Hello() 时, 客户端将阻塞住直到服务端的 Hello() 函数返回。如果服务端函数需要进行一些费时的操作,例如复杂的计算、查询, 客户端只能一直阻塞在那里。这种情况下,我们可以使用异步的 RPC 提高客户端的性能。 异步的RPC是通过配置文件(.acf)来启用的: -------------------------------------------- Hello.acf: [ implicit_handle(handle_t HelloWorld_Binding) ] interface HelloWorld { [async] Hello(); // 增加了 [async] 表明这是异步调用 } 原来的接口 HelloWorld 有两个方法,Hello() 和 Shutdown(),Shutdown() 我们仍然让它是同步调用,所以在.acf文 件中不用列出。IDL 接口文件还是可以不用修改。 服务端的代码 server.c 中的 Hello() 要改成下面的样子: ------------------------------------------------------ void Hello(PRPC_ASYNC_STATE rpcAsyncHandle, const unsigned char * psz) { // 模拟一个长时间的操作 printf("Sleep 5 seconds.../n"); Sleep(5000); printf("%s/n", psz); // 表明调用已经完成 RpcAsyncCompleteCall(rpcAsyncHandle, NULL); } 服务端的其它代码不用修改。 客户端client.c中的调用方式也要换: --------------------------------- int main(int argc, char * argv[]) { // 前面都相同 ... // 下面是调用服务端的函数 RpcTryExcept { if ( _stricmp(argv[1], "SHUTDOWN") == 0 ) { Shutdown(); } else { // 初始化异步调用 RPC_ASYNC_STATE async; RpcAsyncInitializeHandle( &async, sizeof(async) ); async.UserInfo = NULL; async.NotificationType = RpcNotificationTypeNone; // 本函数能立即返回 Hello( &async, (unsigned char*)argv[1]); // 查询调用的状态 while ( RpcAsyncGetCallStatus(&async) == RPC_S_ASYNC_CALL_PENDING ) { printf("Call Hello() pending, wait 1s.../n"); Sleep(1000); } // 通知调用已经完成 RpcAsyncCompleteCall( &async, NULL ); } } RpcExcept(1) { printf( "RPC Exception %d/n", RpcExceptionCode() ); } RpcEndExcept // 后面都相同 ... } 这样客户端就实现了异步调用! Win32 RPC 编程(四)这节我们来谈谈 Windows NT 下 RPC 的高性能模式 - LPC。 很多 Windows 编程入门的书里面讲 Windows 的进程间通信,都会讲 WM_COPYDATA,讲匿名管道,讲命名管道,讲共享内存等等, 但是很少有讲 RPC 的,为什么呢?因为 RPC 看名字,就叫“Remote Procedure Call”,一看就是给分布式系统通信用的,虽然 也可以作为本机进程间通信用,但是性能上总是让人怀疑。所以很多人设计的进程间通信模型,都是用 WM_COPYDATA,或者管道, 或者干脆共享内存,相当于自己造轮子,一切从头做起。但 RPC 确实好用啊,调用起来就像调用库函数一样,通信的细节全给你 封装起来了。那 RPC 有没有性能好一点的模式呢?这就是下面要讲的 LPC 模式了。 LPC(Local Procedure Call)是 Windows NT 内部的高性能的通信模式。它是在内核中实现的,主要用于 Win32 子系统内部的 通信,比如 csrss, lsass 都大量的用到了 LPC。在前面演示的代码中,只需要改一行代码,我们就可使用 LPC 了,其实 RPC 就 是内部使用 LPC 来进行通信,性能大大提高。 服务端代码: server.c -------------- // 用LPC 方式通信 RpcServerUseProtseqEp( (unsigned char *)"ncalrpc", RPC_C_PROTSEQ_MAX_REQS_DEFAULT, (unsigned char *)"AppName", NULL); 客户端代码: client.c -------------- // 用LPC 方式通信 // 第3 个参数NetworkAddr 只能取NULL RpcStringBindingCompose( NULL, (unsigned char*)"ncalrpc", NULL, (unsigned char*)"AppName", NULL, &pszStringBinding ); |
|