Windows RPC程式設計詳解
轉載自：https://blog.csdn.net/xxxluozhen/article/details/5605818
一、什麼是遠端過程呼叫
什麼是遠端過程呼叫 RPC(Remote Procedure Call)? 你可能對這個概念有點陌生, 而你可能非常熟悉 NFS, 是的,
NFS 就是基於 RPC 的. 為了理解遠端過程呼叫，我們先來看一下過程呼叫。
所謂過程呼叫，就是將控制從一個過程 A 傳遞到另一個過程 B, 返回時過程 B 將控制程序交給過程 A。目前大多數系統
中, 呼叫者和被呼叫者都在給定主機系統中的一個程序中, 它們是在生成可執行檔案時由連結器連線起來的, 這類過程呼叫稱
為本地過程呼叫。
遠端過程呼叫(RPC)指的是由本地系統上的程序啟用遠端系統上的程序, 我們將此稱為過程呼叫是因為它對程式設計師來說表現
為常規過程呼叫。處理遠端過程呼叫的程序有兩個, 一個是本地客戶程序, 一個是遠端伺服器程序。對本地程序來說, 遠端過
程呼叫表現這對客戶程序的控制, 然後由客戶程序生成一個訊息, 通過網路系統呼叫發往遠端伺服器。網路資訊中包括過程調
用所需要的引數, 遠端伺服器接到訊息後呼叫相應過程, 然後將結果通過網路發回客戶程序, 再由客戶程序將結果返回給呼叫
程序。因此, 遠端系統呼叫對呼叫者表現為本地過程呼叫, 但實際上是呼叫了遠端系統上的過程。
二、遠端過程呼叫模型
本地過程呼叫: 一個傳統程式由一個或多個過程組成。它們往往按照一種呼叫等級來安排。如下圖所示:
遠端過程呼叫: 使用了和傳統過程一樣的抽象, 只是它允許一個過程的邊界跨越兩臺計算機。如下圖所示:
三、遠端過程和本地過程的對比
首先, 網路延時會使一個遠端過程的開銷遠遠比本地過程要大
其次, 傳統的過程呼叫因為被呼叫過程和呼叫過程執行在同一塊記憶體空間上, 可以在過程間傳遞指標。而遠端過程不能夠將
指標作為引數, 因為遠端過程與呼叫者執行在完全不同的地址空間中。
再次, 因為一個遠端呼叫不能共享呼叫者的環境, 所以它就無法直接訪問呼叫者的 I/O 描述符或作業系統功能。
四、遠端過程呼叫的幾種版本
(1) Sun RPC (UDP, TCP)
(2) Xerox Courier (SPP)
(3) Apollo RPC (UDP, DDS)
其中 Sun RPC 可用於面向連線或非面向連線的協議; Xerox Courier 僅用於面向連線的協議; Apollo RPC 僅用於非連線的協議
五、如何編寫遠端過程呼叫程式
為了將一個傳統的程式改寫成 RPC 程式, 我們要在程式里加入另外一些程式碼, 這個過程稱作 stub 過程。我們可以想象一
個傳統程式, 它的一個過程被轉移到一個遠端機器中。在遠端過程一端, stub 過程取代了呼叫者。這樣 stub 實現了遠端過
程呼叫所需要的所有通訊。因為 stub 與原來的呼叫使用了一樣的介面, 因此增加這些 stub 過程既不需要更改原來的呼叫過
程, 也不要求更改原來的被呼叫過程。如下圖所示:
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 <stdlib.h>
#include <stdio.h>
#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 <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "Hello.h" // 引用MIDL 生成的標頭檔案
int main(int argc, char * argv[])
{
unsigned char * pszStringBinding = NULL;
if ( argc != 2 )
{
printf("Usage:%s <Hello Text>/n", argv[0]);
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 );