12-Openwrt libubox ulog md5 list

openwrt下面的libubox库可谓是非常的强大，很多库都会调用到其中的接口，如ubus,uhttpd

libubox主要提供一下两种功能：

• 提供一套基于事件驱动的机制。
• 提供多种开发支持接口。（如：链表、kv链表、平衡查找二叉树、md5、json）

使用libubox开发的好处有如下几点：

• 可以使程序基于事件驱动，从而可实现在单线程中处理多个任务。
• 基于libubox提供的开发API可以加快开发进度的同事提高程序的稳定性。
• 能更好的将程序融入openwrt的架构中，因为新的openwrt的很多应用和库都基于libubox开发的。

综上所述，libubox是您玩新版openwrt必修的一个东东，相信它也值得大家去研究学习。

libubox源代码如下，我们所有调用的接口都可以在里面找到，查看其原理。

libubox-2016-11-29$ ls
avl.c           blobmsg_json.h        jshn.c              list.h       ulog.c          ustream.h
avl-cmp.c       CMakeCache.txt        json_script.c       lua          ulog.h          utils.c
avl-cmp.h       CMakeFiles            json_script.h       Makefile     uloop.c         utils.h
avl.h           cmake_install.cmake   kvlist.c            md5.c        uloop-epoll.c   vlist.c
base64.c        CMakeLists.txt        kvlist.h            md5.h        uloop.h         vlist.h
blob.c          examples              libblobmsg_json.a   runqueue.c   uloop-kqueue.c
blob.h          install_manifest.txt  libblobmsg_json.so  runqueue.h   usock.c
blobmsg.c       ipkg-install          libjson_script.so   safe_list.c  usock.h
blobmsg.h       ipkg-mtk_24kec        libubox.a           safe_list.h  ustream.c
blobmsg_json.c  jshn                  libubox.so          sh           ustream-fd.c

1.环境搭建

首先在package下面添加一个ztest模块，修改对应的Makefile，并在config里面添加CONFIG_PACKAGE_ztest=y选项

linye@ubuntu:~/packages/ztest$ tree 
.
├── files
│   └── ztest.init
├── Makefile
└── src
    ├── Makefile
    ├── ubus.c
    ├── ztest.c
    └── ztest.h

2 directories, 6 files

编译的时候不用全部编译，可以直接编译ztest模块即可

make package/ztest/compile V=s

编译完在14.07/build_dir/target-mipsel_1004kc_uClibc-0.9.33.2/ztest_1.0/下面拷贝最新的ztest文件上传到板子/usr/bin/下面跑即可。

2.使用syslog打印调试日志

vim ztest/src/ztest.h

#include 

extern int debugLevel;

enum{
    MSG_ERROR,
    MSG_WARNING,
    MSG_INFO,
    MSG_DEBUG,
    MSG_MSGDUMP,
    MSG_EXCESSIVE,
};

#define dbg_printf(level, ...)                      \
do                                                  \
{                                                   \
    if (debugLevel > level)                         \
    {                                               \
        syslog(LOG_WARNING, __VA_ARGS__);           \
    }                                               \
}                                                   \
while (0)

vim ztest/src/ztest.c

int debugLevel = MSG_DEBUG;

int main(int argc, char **argv){

    dbg_printf(MSG_INFO, "ztest\n");
  
    return 1;
}

这边直接使用系统接口syslog来打印调试信息，代码跑起来后可以使用logread来查看调试信息

使用logread -f可以在线查看log

root@zihome:/# logread -f
Fri May 31 16:49:07 2019 user.warn syslog: ztest

3.libubox/ulog打印调试日志

上面使用的syslog是我们自己又封装了一遍，其实libubox里面也已经帮我们搞定了这个接口，我们只需要调用初始化下即可。

查看libubox/ulog.c里面的源代码，其实也是很简单，封装了三种接口，ULOG_KMSG、ULOG_STDIO、ULOG_SYSLOG分别对应，/dev/kmsg、fprintf、vsyslog三种形式。如果我们选择了ULOG_SYSLOG那就跟上面的syslog一模一样了。

if (_ulog_channels & ULOG_KMSG)
{
	va_start(ap, fmt);
	ulog_kmsg(priority, fmt, ap);
	va_end(ap);
}

if (_ulog_channels & ULOG_STDIO)
{
	va_start(ap, fmt);
	ulog_stdio(priority, fmt, ap);
	va_end(ap);
}

if (_ulog_channels & ULOG_SYSLOG)
{
	va_start(ap, fmt);
	ulog_syslog(priority, fmt, ap);
	va_end(ap);
}

调用下面两个接口后，就可以使用了

void log_test(void)
{
    ulog_open(ULOG_SYSLOG, LOG_USER, NULL);
    ulog_threshold(LOG_INFO);
    
    ULOG_INFO("info\n");
    ULOG_NOTE("notice\n");
    ULOG_WARN("warn\n");
    ULOG_ERR("err\n");
    
    ulog_close();
}

4.libubox/md5接口使用

libubox为我们提供了md5的两种算法，一个是数据的md5，还有一个是文件的md5sum

具体使用如下,比较简单：

void md5_test(void)
{
    char* data = "test data";
    unsigned char buf[16] = {0};
    md5_ctx_t ctx;

    md5_begin(&ctx);
    md5_hash(data, strlen(data), &ctx);
    md5_end(buf, &ctx);

#if 1
    {
        char PrintBuff[1024];
        int uiPrintLen = 0;

        uiPrintLen = sprintf((PrintBuff + uiPrintLen), "test data md5:");
        for(int ii = 0; ii < 16; ii++)
        {
            uiPrintLen += sprintf((PrintBuff + uiPrintLen),"%02x ", buf[ii]);
        }
        dbg_printf(MSG_INFO, PrintBuff);
    }   
#endif

    memset(buf, 0, sizeof(buf));
    md5sum("/usr/bin/ztest", buf);

#if 1
    {
        char PrintBuff[1024];
        int uiPrintLen = 0;

        uiPrintLen = sprintf((PrintBuff + uiPrintLen), "/usr/bin/ztest md5sum:");
        for(int ii = 0; ii < 16; ii++)
        {
            uiPrintLen += sprintf((PrintBuff + uiPrintLen),"%02x ", buf[ii]);
        }
        dbg_printf(MSG_INFO, PrintBuff);
    }  
#endif
}

5.libubox/list接口使用

libubox里面的list（仔细看一下它应该是从内核中移植过来的）可称之为侵入式链表，这种list最突出的特征就是其节点中不含有任何数据，相反，list节点是嵌入到特定的数据结构中的。

这样做有两点好处：

• 链表自身导出的方法比较简洁，由于不涉及到数据的操作，因而list的所有API都可以实现通用；
• 不用为每种数据类型实现一套链表的操作，当然在支持泛型的语言里可以使用模板来实现这种通用list。

https://segmentfault.com/a/1190000012042209

typedef struct _ListData {
    char data;
    struct list_head list;
} ListData;

void list_test(void)
{
    ListData mylist, *tmp = NULL;
    struct list_head *pos = NULL, *p = NULL;
    char ch = '0';
    long dec = 1;
    long dec_number = 0;
    int i = 0;
    INIT_LIST_HEAD(&mylist.list);

    while((ch == '0') || (ch == '1')) {
        tmp = (ListData *)malloc(sizeof(ListData));
        tmp->data = ch;
        list_add(&(tmp->list), &(mylist.list));
        printf("list_add %d\n", tmp->data);
        ch = '1';
        i++;
        if(i == 10)
        {
            ch = '2';
        }
    }

    // 遍历过程不可操作链表
    list_for_each(pos, &mylist.list) {
        tmp = list_entry(pos, ListData,list);
        printf("list_entry %d\n", tmp->data);
        dec_number += (int)(tmp->data - '0') * dec;
        dec *= 2;
    }

    printf("Decimal number is %ld\n", dec_number);

    // 遍历过程可操作链表
    list_for_each_safe(pos, p, &mylist.list) {
        tmp = list_entry(pos, ListData, list);
        printf("list_del %d\n", tmp->data);
        list_del(pos);
        free(tmp);
    }

    if(list_empty(&mylist.list)){
        printf("The list now is empty!\n");
    }

    return;
}

代码位于github:https://github.com/creatorly/TestCode/tree/master/openwrt/ztest