​想了解SOME/IP协议,可以移步:

SOME/IP 协议介绍

SOME/IP-SD 深入浅出

在说vsomeip之前,先介绍一下它的贡献者——GENIVI,是一个非营利汽车行业联盟。这个联盟成立于2009年,已经成功地完成了最初的使命,提供了一个开放的、基于linux的车载信息娱乐(IVI)平台,并扩大了其范围,帮助汽车制造商及其供应商开发标准方法。

在汽车行业,GENIVI的项目被非常广泛地应用,比如:vsomeip,CommonAPI C++,DLT…没见用过的就不列出来了,感兴趣可以到官网了解更多。

vsomeip是一个开源C++库,它实现了SOME/IP协议栈。接下来,我们通过一个demo,感受一下SOME/IP的通信过程,以及如何使用vsomeip,废话不多说,让我们开始吧~

首先,需要搭建环境(这里以Ubuntu16.04为例),vsomeip依赖Boost(1.55以上版本),因此我们需要先编译和安装Boost:

cd boost_1_57_0
./bootstrap.sh
./b2 link=shared
sudo ./b2 install

接着,编译和安装vsomeip:

git clone https://github.com/GENIVI/vsomeip.git
cd vsomeip
mkdir build
cd build
cmake -DENABLE_SIGNAL_HANDLING=1 -DDIAGNOSIS_ADDRESS=0x10 ..
make
sudo make install

官方的helloworld,稍微有点简单,demo的思路是这样的:

  • 实现一个服务端,可以:1. 响应请求,内容为请求的反转;2. 触发事件

  • 实现一个客户端,可以:1. 发送请求;2. 订阅、接收事件

首先,服务端和客户端需要约定一些ID,包括:

#define SAMPLE_SERVICE_ID 0x1234
#define SAMPLE_INSTANCE_ID 0x5678
#define SAMPLE_METHOD_ID 0x0421
#define SAMPLE_EVENTGROUP_ID 0x001
#define SAMPLE_EVENT_ID 0x002

对于服务端,主要代码如下:

// 创建应用对象
app = vsomeip::runtime::get()->create_application("World");
// 创建事件组,并添加事件组SAMPLE_EVENTGROUP_ID
std::set<vsomeip::eventgroup_t> its_groups;
its_groups.insert(SAMPLE_EVENTGROUP_ID);
// 初始化应用
app->init();
// 注册消息SAMPLE_METHOD_ID的回调
app->register_message_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_METHOD_ID, on_message);
// 提供服务
app->offer_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
// 提供事件SAMPLE_EVENT_ID,最后一个参数为true表示这是一个Field
app->offer_event(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_groups, true);
// 启动应用
app->start();

其中,请求消息的回调函数:

void on_message(const std::shared_ptr<vsomeip::message> &_request) {
    std::shared_ptr<vsomeip::payload> its_payload = _request->get_payload();
    vsomeip::length_t l = its_payload->get_length();
​
    // 获取Payload
    std::stringstream ss;
    for (vsomeip::length_t i=0; i<l; i++) {
        ss << std::setw(2) << std::setfill('0') << std::hex
            << (int)*(its_payload->get_data()+i) << " "; }
​
    std::cout << "SERVICE: Received message with Client/Session ["
        << std::setw(4) << std::setfill('0') << std::hex << _request->get_client() << "/"
        << std::setw(4) << std::setfill('0') << std::hex << _request->get_session() << "] "
        << ss.str() << std::endl;
        
    // 发送SAMPLE_METHOD_ID响应
    std::shared_ptr<vsomeip::message> its_response = vsomeip::runtime::get()->create_response(_request);
    its_payload = vsomeip::runtime::get()->create_payload();
    std::vector<vsomeip::byte_t> its_payload_data;
    for (int i=9; i>=0; i--) {
        its_payload_data.push_back(i % 256); }
    its_payload->set_data(its_payload_data);
    its_response->set_payload(its_payload);
    app->send(its_response, true);
​
    // 触发SAMPLE_EVENT_ID事件,因为Demo没有什么触发机制,所以就偷个懒,直接在发送响应之后触发事件啦:)
    const vsomeip::byte_t its_data[] = { 0x10 };
    its_payload = vsomeip::runtime::get()->create_payload();
    its_payload->set_data(its_data, sizeof(its_data));
    app->notify(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_payload);
}

​对于客户端,主要代码如下:

// 同样地,创建应用对象
app = vsomeip::runtime::get()->create_application("Hello");
// 初始化应用
app->init();
// 注册服务是否可用的回调
app->register_availability_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, on_availability);
// 请求服务
app->request_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
// 注册接收所有消息的回调
app->register_message_handler(vsomeip::ANY_SERVICE, vsomeip::ANY_INSTANCE, vsomeip::ANY_METHOD, on_message);
// 发送请求线程
std::thread sender(run);
// 启动应用
app->start();

其中,监听服务是否可用的回调函数:

void on_availability(vsomeip::service_t _service, vsomeip::instance_t _instance, bool _is_available) {
    std::cout << "CLIENT: Service ["
              << std::setw(4) << std::setfill('0') << std::hex << _service << "." << _instance
              << "] is "
              << (_is_available ? "available." : "NOT available.")
              << std::endl;
    // 服务可用了,可以去发送请求啦:)
    if (_is_available) { condition.notify_one(); }
}

接收所有消息的回调函数:

void on_message(const std::shared_ptr<vsomeip::message> &_response) {
    std::stringstream its_message;
    its_message << "CLIENT: received a notification for event ["
            << std::setw(4) << std::setfill('0') << std::hex
            << _response->get_service() << "."
            << std::setw(4) << std::setfill('0') << std::hex
            << _response->get_instance() << "."
            << std::setw(4) << std::setfill('0') << std::hex
            << _response->get_method() << "] to Client/Session ["
            << std::setw(4) << std::setfill('0') << std::hex
            << _response->get_client() << "/"
            << std::setw(4) << std::setfill('0') << std::hex
            << _response->get_session()
            << "] = ";
    std::shared_ptr<vsomeip::payload> its_payload = _response->get_payload();
    its_message << "(" << std::dec << its_payload->get_length() << ") ";
    for (uint32_t i = 0; i < its_payload->get_length(); ++i)
        its_message << std::hex << std::setw(2) << std::setfill('0')
            << (int) its_payload->get_data()[i] << " ";
    std::cout << its_message.str() << std::endl;
}

客户端发送请求线程函数:

void run() {
    std::unique_lock<std::mutex> its_lock(mutex);
    condition.wait(its_lock);
    // 服务可用后,进行一系列常规操作:
    // 订阅事件组SAMPLE_EVENTGROUP_ID和事件SAMPLE_EVENT_ID
    std::set<vsomeip::eventgroup_t> its_groups;
    its_groups.insert(SAMPLE_EVENTGROUP_ID);
    app->request_event(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_groups, true);
    app->subscribe(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENTGROUP_ID);
​
    // 发送SAMPLE_METHOD_ID请求
    std::shared_ptr< vsomeip::message > request;
    request = vsomeip::runtime::get()->create_request();
    request->set_service(SAMPLE_SERVICE_ID);
    request->set_instance(SAMPLE_INSTANCE_ID);
    request->set_method(SAMPLE_METHOD_ID);
​
    std::shared_ptr< vsomeip::payload > its_payload = vsomeip::runtime::get()->create_payload();
    std::vector< vsomeip::byte_t > its_payload_data;
    for (vsomeip::byte_t i=0; i<10; i++) {
      its_payload_data.push_back(i % 256); }
    its_payload->set_data(its_payload_data);
    request->set_payload(its_payload);
    app->send(request, true);
}

编译,运行结果如下:

通过打印出来的日志,我们可以比较清晰地看到整个通信的过程,并且实现了预期的效果。这个例子只能说明如何快速地上手vsomeip,其实,还有很多东西可以挖掘,比如vsomeip怎么配置,routing manager怎么配置,和dlt怎么联动等等,真是学无止境呀,今天就先到这儿吧~

关注公众号,回复“演示代码”,就可以看到全部文章里涉及到的工程地址啦~

Logo

为开发者提供学习成长、分享交流、生态实践、资源工具等服务,帮助开发者快速成长。

更多推荐