Skip to content

openwrt - ubus

OpenWrt 提供了一个系统总线ubus,它类似于Linux桌面操作系统的d-Bus,目标是提供系统级的进程间通信（IPC）功能。ubus在设计理念上与d-Bus基本保持一致,提供了系统级总线功能,与d-Bus相比减少了系统内存占用空间,这样可以适应于嵌入式Linux操作系统的低内存和低端CPU性能的特殊环境 ubus是OpenWrt的RPC工具,是OpenWrt的微系统总线架构,是在2011年加入OpenWrt中的。为了提供各种后台进程和应用程序之间的通信机制,ubus工程被开发出来。

ubus分三个部分:

  • ubusd精灵进程
  • ubus接口库（libubus.so）
  • ubus命令行工具

ubusd精灵进程

ubus模块的核心是ubusd精灵进程,它提供了一个总线层,在系统启动时运行,负责进程间的消息路由和传递。其他进程注册到 ubusd进程进行消息的发送和接收。这个接口是用Linux文件socket和TLV（类型-长度-值）收发消息来实现的。每一个进程在指定命名空间下注册自己的路径。每一个路径都可以提供带有各种参数的多个函数处理过程,函数处理过程程序可以在完成处理后返回消息

  • /etc/init.d/ubus: ubusd精灵进程是由/etc/init.d/ubus启动的,ubusd精灵进程在系统进程启动完成之后立即启动。它是在网络进程 netifd之前启动的,该进程监听一个文件套接字接口和其他应用程序通信。
  • 当ubusd精灵进程启动之后: 其他应用程序可基于libubus提供的接口或使用ubus命令行程序来和ubusd进程进行通信
  • ubus是为进程间发送消息而设计的,不适合传输大量数据（进程间传输大量数据应采用共享内存）

ubus提供的功能主要有以下4个方面:

  • 提供注册对象和方法供其他实体调用
  • 调用其他应用程序提供的注册对象的控制接口
  • 在特定对象上注册监听事件
  • 向特定对象发送事件消息

对象与方法

  • ubus将消息处理抽象为对象（object）和方法（method）的概念。一个对象中包含多个方法。对象和方法都有自己的名字,发送请求方在消息中指定要调用的对象和方法名字即可

订阅的概念

  • ubus的另外一个概念是订阅（subscriber）。客户端需要向服务器注册收到特定消息时的处理方法。这样当服务器在状态发生改变时会通过ubus总线来通知给客户端

传递的消息格式TLV

  • ubus可用于两个进程之间的通信,进程之间以TLV格式传递消息,用户不用关心消息的实际传输格式
  • ubus能够以JSON格式和用户进行数据交换

ubusd精灵进程的两种应用场景 * 客户端/服务器模式:即进程A提供一些逻辑较复杂的记忆状态的服务,并且常 驻内存中。进程 B 以命令行工具或函数 API 形式调用这些服务 * 订阅通知模式:即设计模式中的观察者模式。定义了对象间的一种一对多的依赖 关系,以便当一个对象的状态发生改变时,所有依赖于它的对象都得到通知并自动更新。 即进程 A 作为服务器,当对象状态改变时通知给它所有的订阅者

ubus接口库

ubus的接口库名称为libubus.so,其他进程可以通过该动态链接库来简化对ubus总线的访问。

函数 含义
ubus_add_object 将对象加入的ubus空间中,即客户端可以访问对象
ubus_register_subscriber 增加订阅通知
ubus_connect 连接指定的路径,创建并返回路径所代表的ubus上下文
ubus_send_reply 执行完成方法调用后发送响应
ubus_notify 给对象所有的订阅者发送通知
ubus_lookup 查找对象,参数path为对象的路径,如果为空则查找所有的对象。cb为回调函数,对查找结果进行处理
ubus_lookup_id 查找对象的id,并将id参数在指针中返回
ubus_invoke 调用对象的方法
ubus_register_event_handler 注册事件处理句柄
ubus_send_event 发送事件消息

netifd模块就是通过libubus动态链接库提供的API接口向ubus总线注册了很多对象和方法

ubus命令行工具

ubus命令行工具也使用libubus提供的API接口来和ubusd服务器交互。这在调试注册的命名空间对象和编写shell脚本时非常有用。ubus调用参数和返回响应都使用非常友好的JSON格式。ubus提供5种命令来进行消息通信 

Usage: ubus [<options>] <command> [arguments...]
Options:
 -s <socket>:           Set the unix domain socket to connect to
 -t <timeout>:          Set the timeout (in seconds) for a command to complete
 -S:                    Use simplified output (for scripts)
 -v:                    More verbose output
 -m <type>:             (for monitor): include a specific message type
                        (can be used more than once)
 -M <r|t>               (for monitor): only capture received or transmitted traffic

Commands:
 - list [<path>]                        List objects
 - call <path> <method> [<message>]     Call an object method
 - listen [<path>...]                   Listen for events
 - send <type> [<message>]              Send an event
 - wait_for <object> [<object>...]      Wait for multiple objects to appear on ubus
 - monitor                              Monitor ubus traffic

list

  • list命令在默认情况下,输出所有注册到ubus RPC服务器的对象
  • list命令是通过**调用ubus_lookup接口函数**来列出所有的服务器对象的。返回信息由传入ubus_lookup函数的第三个参数receive_list_result处理,这个参数是一个回调函数,负责将结果输出到屏幕上
  • **如果使用-v参数:**指定对象（命名空间路径）的所有方法和参数将全部输出屏幕中。需要加在ubus后。

ubus list : 输出 所有注册到ubus RPC服务器的对象

# ubus -v list network.interface.lan 
'network.interface.lan' @c149980d
        "up":{}
        "down":{}
        "renew":{}
        "status":{}
        "prepare":{}
        "dump":{}
        "add_device":{"name":"String","link-ext":"Boolean"}
        "remove_device":{"name":"String","link-ext":"Boolean"}
        "notify_proto":{}
        "remove":{}
        "set_data":{}

call

  • Call命令在**指定对象里调用指定的方法并传递消息参数**
  • Call命令首先**调用ubus_ lookup_id函数**找到指定对象的ID,然后**通过ubus_invoke函数**调用来请求服务器,返回的结果**使用 receive_call_result_data来处理**
  • 消息格式必须是合法的JSON字符串格式,根据函数签名来传递正确的JSON字符串作为方法参数

ubus call network.device status '{"name":"eth0"}'

listen

  • listen命令**设置一个监听套接字**来接收服务器发出的消息
  • listen 命令是**通过ubus_register_event_handler函数**来注册事件回调处理函数的

ubus listen 监听所有 or ubus listen *

#终端1
ubus listen  #进入阻塞
{ "network.interface": {"action":"ifdown","interface":"lan"} }
{ "network.interface": {"action":"ifup","interface":"lan"} }

#终端2
ubus call network.interface.lan down
ubus call network.interface.lan up

send

  • send命令用于发出一个通知事件,这个事件可以使用listen命令监听到
  • send 命令是 通过调用ubus_send_event函数来实现的
  • 命令行的发送数据格式必须为JSON格式,在程序中通过调用 blobmsg_add_json_from_string函数转换为ubus的TLV格式
  • 如果有多个监听客户端,多个监听客户端会同时收到事件
  • 发送通知事件通常需要两个参数,第一个参数为指定对象,第二个参数为事件消息内容

例如:第一个终端启动监听hello对象的事件消息,然后在第二个终端使用send命令向hello 

#终端1
ubus listen hi #阻塞状态

#终端2
ubus send hi '{"a":"123"}'

#终端1
ubus listen hi
{ "hi": {"a":"123"} }

wait_for

  • wait_for 命令用于等待多个对象注册到ubus中,当等待的对象注册成功后即退出