うたカモ技術ブログ

UBUS学習の参考サイト紹介
UBUSの学習に役立つサイトを紹介します。以下のサイトを読むことでコマンドの使用方法だけでなく、その実装方法についても理解できます。 私の記事と併用して読むとより理解に繋がると思います。

1. What is UBUS?
2. OpenWRT UBUS mechanism

【ラズパイ限定】このサイトからパッケージを入手してインストールする。

このサイトでは、ラズベリーパイ限定でパッケージを配布しています。 シリーズ別のパッケージを以下に掲載しますので、インストールしてみてください。

次のコマンドを実行すると、パッケージをインストールすることができます。（以下はRaspberry Pi3用パッケージのインストール例です。）

root@OpenWrt:~# wget https://utakamo.com/repo/openwrt/raspi3/ubus/ubus-sample02_1.0-1_aarch64_cortex-a53.ipk
root@OpenWrt:~# opkg install ubus-sample02_1.0-1_aarch64_cortex-a53.ipk

ubus-sample02の初期化スクリプト

このサイトで紹介している他のサンプルプログラムと同じ内容です。

ubus-sample02はprocdによってシステムブート時に優先順位99番目（START=99）に起動され、シャットダウン時に 優先順位10番目(STOP=10)で終了するように設定しています。

#!/bin/sh /etc/rc.common

USE_PROCD=1
START=99
STOP=10

start_service() {
    echo 'ubus-sample02 start'
    procd_open_instance 'ubus-sample02'
    procd_set_param command /usr/bin/ubus-sample02
    procd_close_instance
}

ubus-sample02のソースコード

今回はubus-sample02と命名したサンプルプログラムにlistenコマンドと同等な処理を実装しました。

UBUSの各コマンド実装は、libubus.hに記述されていますので、これを利用して以下のように listenコマンドの処理をする関数（reply_sample_event）を定義しました。

#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <libubus.h>
#include <libubox/uloop.h>
#include <libubox/blobmsg_json.h>

enum {
    TEST_MESSAGE,
    TEST_MAX
};

static const struct blobmsg_policy test_policy[] = {
    [TEST_MESSAGE] = { .name = "message", .type = BLOBMSG_TYPE_STRING },
};

void ubus_process(void);
static void ubus_sample_handle_signal(int signo);
static void ubus_sample_setup_signals(void);

static int reply_cnt;
static void reply_sample_event(struct ubus_context *, struct ubus_event_handler *, const char *, struct blob_attr *);

struct ubus_event_handler ev = {
    .cb = reply_sample_event,
};

int main () {
    ubus_sample_setup_signals();
    ubus_process();
    return 0;
}

void ubus_process(void) {
    uloop_init();
    struct ubus_context *ctx = ubus_connect(NULL);
    ubus_add_uloop(ctx);
    ubus_register_event_handler(ctx, &ev, "sample-event");
    uloop_run();
    uloop_done();
}

static void ubus_sample_handle_signal(int signo)
{
    uloop_end();
}

static void ubus_sample_setup_signals(void)
{
    struct sigaction s;

    memset(&s, 0, sizeof(s));
    s.sa_handler = ubus_sample_handle_signal;
    s.sa_flags = 0;
    sigaction(SIGTERM, &s, NULL);
}

static void reply_sample_event(struct ubus_context *ctx, struct ubus_event_handler *ev,
                      const char *method, struct blob_attr *msg) {

    struct blob_attr *tb[TEST_MESSAGE];
    blobmsg_parse(test_policy, TEST_MAX, tb, blob_data(msg), blob_len(msg));

    if (!tb[TEST_MESSAGE]) {
            return;
    }

    char *message = blobmsg_get_string(tb[TEST_MESSAGE]);

    FILE *fp = NULL;
    mkdir("/tmp/ubus-sample02", 0755);

    if ((fp = fopen("/tmp/ubus-sample02/reply", "a")) == NULL) {
            return;
    }

    reply_cnt++;

    fprintf(fp, "[count:%d], message = %s\n", reply_cnt, message);

    fclose(fp);
}

このubus-sample02はイベントのsample-eventをリッスンします。

sample-eventがubusdから通知されると、sample-eventが持つJSONのmessageの 内容を一時ファイルの/tmp/ubus-sample02/replyに描きだします。

受け取ったsample-eventのJSONを受け取り、その内容を一時ファイルに出力する処理がreply_sample_eventです。

reply_sample_eventは受け取ったsample-eventがメッセージデータ場合に限り反応します。 つまり、他のプロセスが次のようにイベントを発行しない限り、ubus-sample02は結果を一時ファイルに出力しません。

reply_sample_eventはイベント受信時にコールバックされるように、ubus-sample02起動時にubus_register_event_handler関数によって 登録する必要があります。