嵌入式远程过程调用组件--eRPC

概述

1. RPC（Remote Procedure call）远程过程调用。其分为两部分：远程过程和过程调用。远程过程是指每台机器上提供的服务，过程调用就是对远程过程调用以及数据传输。
2. RPC用通俗的语言描述：客户端在不知道调用细节的情况下，调用存在于远程设备上的某个对象，就像调用本地应用程序中的对象一样。RPC比较正式的描述：一种通过传输介质从远程设备程序上请求服务，而不需要了解底层传输介质的协议。
3. 按照我对RPC的理解，我将RPC分为三层：接口层，协议层，传输层。

• 接口层：客户端实现了服务端的接口代理，而服务端的接口为具体实现。
• 协议层：客户端根据规则实现接口参数的打包，序列化等动作。服务端根据规则将参数反序列化，并将其传输到服务接口。
• 传输层：传输介质：TCP/UDP，HTTP，蓝牙，串口，USB等。

RPC流程图

RPC的特点：

1. RPC是协议：它是一套协议规范，需要遵循这套规范来实现。目前典型的RPC实现包括：Dubbo，eRPC，GRPC等。目前技术的发展趋势来看，实现了RPC协议的应用工具往往都会附加其他重要功能。
2. 传输层对其透明：RPC的客户端调用就像调用本地应用程序中的对象，所以传输层使用TPC/UDB、UART、USB等协议，它本省是不需要关心的。
3. 协议格式对其透明：RPC客户端调用远程对象需要传递一些参数，并且返回一个调用结果，至于被调用的对象内部是如何使用这些参数，并计算出结果的。调用方是不需要关系的。也就传输的协议格式的构成，调用方是不需要关心的。
4. 跨语言能力：调用方实际是不需要关心被调用方是什么设备，使用什么语言。它可以是一个云服务器，也可以是一个小的单片机。至于这些设备使用的语言无需关心，被调用方只需要能够解析调用方的数据及能返回正确的结果即可。

RPC的优缺点:

• 优点：实现模块的分布式部署，可以实现更好的维护性，扩展性以及协同式开发。

• 缺点：①通信延迟；②地址空间隔离；③局部故障；④并发问题。

eRPC (Embedded RPC)

eRPC是什么

eRPC (Embedded RPC) is an open source Remote Procedure Call (RPC) system for multichip embedded systems and heterogeneous multicore SoCs.

eRPC（嵌入式RPC）是一种用于多芯片嵌入式系统和异构多核SoC的开源远程过程调用（RPC）系统。

Unlike other modern RPC systems, such as the excellent Apache Thrift, eRPC distinguishes itself by being designed for tightly coupled systems, using plain C for remote functions, and having a small code size (<5kB). It is not intended for high performance distributed systems over a network.

与其他现代RPC系统（如出色的Apache Thrift）不同，eRPC的与众不同之处在于它是为紧密耦合的系统设计的，使用纯C实现远程功能，并且代码大小较小（<5kB）。它不适用于网络上的高性能分布式系统。

eRPC源码

eRPC源码路径

「https://github.com/EmbeddedRPC/erpc」

eRPC源码目录

我们关注两个目录erpc_c和erpcgen。其中：erpc_c是eRPC的C/C++实现。erpcgen是将IDL文件转为C或Python源文件。

.
├── doxygen
├── erpc_c
│   ├── config
│   ├── infra
│   ├── port
│   ├── setup
│   └── transports
├── erpcgen
├── erpc_python
├── erpcsniffer
├── examples
├── mk
├── README.md
├── test
└── utilities

目录	说明
erpc_c/config	eRPC的配置文件
erpc_c/infra	eRPC的核心代码
erpc_c/port	eRPC的移植层，适配不同的开发环境
erpc_c/setup	eRPC的C接口
erpc_c/transports	eRPC的传输层，包含不同介质的驱动

eRPC编译

我们需要编译两个东西，其中：①需要将编译erpc_c编译成库，②编译erpcgen编译成可执行文件，用于.erpc的IDL语法生成service和client的代码。

编译eRPC库

为了方便我们编译，我们将eRPC编程库，然后我们的应用通过链接方式生成可执行文件。步骤：

1. 进入erpc_c目录。
2. 执行 make build=release，编译生成release版本的eRPC库。
3. 执行 make build=release install，安装release版本的eRPC库。其中：默认安装路径是：/usr/local/lib，头文件安装路径是：/usr/local/include。

编译erpcgen

eRPC为了能过够更加方便供开发者使用，提供了IDL的解析器erpcgen及生成规则，减少了我们编码。erpcgen在eRPC中非常重要。步骤：

1. 进入erpcgen目录。
2. 执行 make build=release，编译生成可执行程序。
3. 执行 make build=release install，安装，其中：默认安装路径是：/usr/local/bin。

eRPC例子

我们写一个简单的例子，传输层采用TCP，Client发一个字符串，Server端回复一个字符串。步骤：

1. 新建一个目录：youyeetoo，并新建一个eRPC的IDL文件：youyeetoo.erpc

program youyeetoo  //指定生成的文件名

interface youyeetoo {                           //接口定义，包好一个或者多个函数
    helloYouyeetoo(binary txInput) -> binary,   //函数：helloYouyeetoo，入参类型：binary，返回值类型：binary
}

2. 将youyeetoo.erpc作为参数，使用刚刚编译的erpcgen可执行文件，生成客户端和服务端的代码：

youyeetoo@youyeetoo:~/youyeetoo$ erpcgen ./youyeetoo.erpc

3. 上述执行完会在当前目录下生成4个文件："youyeetoo_client.cpp"，"youyeetoo_server.cpp"，"youyeetoo_server.h"，"youyeetoo.h"。其中：

• 根据.erpc文件会生成一个接口：binary_t * helloYouyeetoo(const binary_t * txInput);。
• 客户端无需实现这个接口的定义，它的实现已经自动生成放在youyeetoo_client.cpp。上层应用直接使用即可。
• 服务端需要没有实现这个接口，所以需要在上层应用实现函数体的内容。

• 创建一个客户端的上层应用文件：client_app.cpp。其中：

• 创建一个TCP传输层通道。
• 初始化eRPC客户端对象。
• 通过helloYouyeetoo函数进行远程调用，发送一条消息："hello youyeetoo!"。
• 将远程调用的返回值打印出来。
• 编译命令：「g++ -Wall -I. -I/usr/local/include/erpc -L/usr/local/lib youyeetoo_client.cpp client_app.cpp -lerpc -lpthread -o client_app」
• 生成client_app可执行文件。

#include 
#include 
#include 
#include 
#include 
#include "youyeetoo.h"

static void free_binary_t_struct(binary_t *data)
{
    if (data->data) {
        erpc_free(data->data);
    }
}

int main(int argc, char *argv[])
{
    erpc_transport_t transport = erpc_transport_tcp_init("127.0.0.1", 5555, false);
    erpc_mbf_t message_buffer_factory = erpc_mbf_dynamic_init();
    erpc_client_init(transport, message_buffer_factory);
    char *msg = "hello, youyeetoo!";
    binary_t b = {(uint8_t *)msg, (uint32_t)strlen(msg)};
    printf("Request: %sn", msg);
    binary_t *resp = helloYouyeetoo(&b);
    if (resp != NULL) {
        char *buf = (char *)malloc(resp->dataLength + 1);
        strncpy(buf, (const char *)resp->data, resp->dataLength);
        buf[resp->dataLength] = '';
        printf("Respond: %sn", buf);
        free_binary_t_struct(resp);
        free(buf);
    }

    erpc_transport_tcp_close();

    return 0;
}

5. 创建一个服务端的上层应用文件：server_app.cpp。其中：

• 创建一个TCP传输层通道。
• 初始化eRPC服务端对象。
• 注册服务到服务端对象中。
• 运行服务端线程。
• 当客户端进行远程调用时，将会进入helloYouyeetoo函数，并返回。
• 编译命令：「g++ -Wall -I. -I/usr/local/include/erpc -L/usr/local/lib youyeetoo_server.cpp server_app.cpp -lerpc -lpthread -o server_app」
• 生成client_app可执行文件。

#include 
#include 
#include 
#include 
#include 
#include 
#include "youyeetoo_server.h"

binary_t * helloYouyeetoo(const binary_t * input)
{
    size_t len = 0;
    char *buf;

    printf("recv: %srn", input->data);

    buf = (char *)malloc(strlen("hi, good!"));
    memset(buf, 0, strlen("hi, good!"));
    strncpy(buf, "hi, good!", strlen("hi, good!"));
    printf("send: hi, good!n");
    len = strlen("hi, good!");

    return new binary_t{(uint8_t*)buf, (uint32_t)len};
}

int main(int argc, char *argv[])
{
    erpc_transport_t transport = erpc_transport_tcp_init("127.0.0.1", 5555, true);
    erpc_mbf_t message_buffer_factory = erpc_mbf_dynamic_init();
    erpc_server_t server = erpc_server_init(transport, message_buffer_factory);
    erpc_add_service_to_server(server, create_youyeetoo_service());
    while(1){
        erpc_server_run(server);
    }
    erpc_transport_tcp_close();

    return 0;
}

6. 执行结果：

eRPC运行结果

总结

1. eRPC确实是一个不错的组件，它对底层传输层做了抽象，使其RPC组件不局限传统的仅在TPC/UDP条件下运行。
2. eRPC的传输层缺少可行认证，它的传输时明文的，对于数据来说是不安全的，应该提供安全认证的能力。
3. eRPC提供IDL(接口定义语言)，是我们使用起来更加方便，我们不在需要知道eRPC的具体实现，便可以完成客户端与服务端的调用。

欢迎关注微信公众号『Rice嵌入式开发技术分享』