Openwrt下C呼叫UCI API

阿新 • • 發佈：2019-01-17

“uci”是”Unified Configuration Interface”(統一配置介面)的縮寫,意在OpenWrt整個系統的配置集中化。

許多程式在系統某處擁有自己的配置檔案，比如/etc/network/interfaces, /etc/exports, /etc/dnsmasq.conf或者 /etc/samba/samba.conf，有時它們還使用稍有不同的語法。

共同原則

OpenWrt的所有配置檔案皆位於/etc/config/目錄下。每個檔案大致與它所配置的那部分系統相關。可用文字編輯器、”uci” 命令列實用程式或各種程式設計API(比如 Shell, Lua and C)來編輯/修改這些配置檔案。

配置檔案

檔案語法

在UCI的配置檔案通常包含一個或多個配置語句，包含一個或多個用來定義實際值的選項語句的所謂的節。

下面是一個簡單的配置示例檔案：

package 'example'

config 'example' 'test'
        option   'string'      'some value'
        option   'boolean'     '1'
        list     'collection'  'first item'
        list     'collection'  'second item'

config ‘example’ ‘test’ 語句標誌著一個節的開始。這裡的配置型別是example，配置名是test。配置中也允許出現匿名節，即自定義了配置型別，而沒有配置名的節。配置型別對應配置處理程式來說是十分重要的，因為配置程式需要根據這些資訊來處理這些配置項。
option ‘string’ ‘some value’ 和 option ‘boolean’ ‘1’ 定義了一些簡單值。文字選項和布林選項在語法上並沒有差異。布林選項中可以用’0’ ，’no’， ‘off’，或者’false’來表示false值，或者也可以用’1’， ‘yes’，’on’或者’true’來表示真值。
以list關鍵字開頭的多個行，可用於定義包含多個值的選項。所有共享一個名稱的list語句，會組裝形成一個值列表，列表中每個值出現的順序，和它在配置檔案中的順序相同。如上例種中，列表的名稱是’collection’，它包含了兩個值，即’first item’和’second item’。
‘option’和’list’語句的縮排可以增加配置檔案的可讀性，但是在語法不是必須的。

通常不需要為識別符號和值加引號，只有當值包括空格或者製表符的時候，才必須加引號。同時，在使用引號的時候，可以用雙引號代替單引號。

UCI的幾個結構體

1.struct uci_package：包結構體。它對應一個配置檔案內容

struct uci_package
{
    struct uci_element e;
    struct uci_list sections;
    struct uci_context *ctx;
    bool has_delta;
    char *path;

    /* private: */
    struct uci_backend *backend;
    void *priv;
    int n_section;
    struct uci_list delta;
    struct uci_list saved_delta;
};

2.struct uci_section：節結構體，它對應配置檔案中的節

struct uci_section
{
    struct uci_element e;
    struct uci_list options;
    struct uci_package *package;
    bool anonymous;
    char *type;
};

3.struct uci_option：選項結構體，它對應配置檔案裡節中的option或者list

struct uci_option
{
    struct uci_element e;
    struct uci_section *section;
    enum uci_option_type type;
    union {
        struct uci_list list;
        char *string;
    } v;
};

4.struct uci_ptr：元素位置指標結構，用來查詢並儲存對應位置元素

struct uci_ptr
{
    enum uci_type target;
    enum {
        UCI_LOOKUP_DONE =     (1 << 0),
        UCI_LOOKUP_COMPLETE = (1 << 1),
        UCI_LOOKUP_EXTENDED = (1 << 2),
    } flags;

    struct uci_package *p;
    struct uci_section *s;
    struct uci_option *o;
    struct uci_element *last;

    const char *package;
    const char *section;
    const char *option;
    const char *value;
};

5.struct uci_context： uci上下文結構，貫穿查詢、更改配置檔案全過程。

struct uci_context
{
    /* 配置檔案包列表 */
    struct uci_list root;

    /* 解析上下文，只用於錯誤處理 */
    struct uci_parse_context *pctx;

    /* 後端匯入匯出 */
    struct uci_backend *backend;
    struct uci_list backends;

    /* uci 執行標識 */
    enum uci_flags flags;

    char *confdir;
    char *savedir;

    /* search path for delta files */
    struct uci_list delta_path;

    /* 私有資料 */
    int err;
    const char *func;
    jmp_buf trap;
    bool internal, nested;
    char *buf;
    int bufsz;
};

幾個基本的API函式

1.uci_alloc_context：動態申請一個uci上下文結構

struct uci_context *uci_alloc_context(void);

2.uci_free_contex：釋放由uci_alloc_context申請的uci上下文結構且包括它的所有資料

void uci_free_context(struct uci_context *ctx);

3.uci_lookup_ptr：由給定的元組查詢元素

/**
 * uci_lookup_ptr: 分離一個uci元組字串且查詢對應元素樹
 * @ctx: uci context結構體指標
 * @ptr: 存放元素查詢結果的結構體指標
 * @str: 待查詢的uci元組字串
 * @extended: 允許擴充套件語法查詢
 *
 *如果extended被設為ture，則uci_lookup_ptr支援下列擴充套件語法：
 * 
 *例子：
 *   network.@interface[0].ifname (‘ifname‘ option of the first interface section)
 *   network.@interface[-1]       (last interface section)
 * Note: 有必要的話uci_lookup_ptr將會自動載入配置檔案包
 * @str 不能是一個const型別指標，它在使用的過程中將會被更改且用於將字串填寫到@ptr中，因此
 * 它只要@ptr還在使用，它就必須是可用的
 *
 * 這個函式在指定包元組的的字串未被找到時返回UCI_ERR_NOTFOUND，否則返回UCI_OK
 *
 * 記住在查詢其他部分失敗的情況，如果它們同樣被指定，包括section和option，同樣會返回UCI_OK，
 * 但是ptr->flags * UCI_LOOKUP_COMPLETE標誌位不會被置位
 */
int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);

現在我們來看一個示例來進一步瞭解：

#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <uci.h>

#define UCI_CONFIG_FILE "/etc/config/meter"
static struct uci_context * ctx = NULL; //定義一個UCI上下文的靜態變數.
/*********************************************
*   載入配置檔案,並遍歷Section.
*/
bool load_config()
{
    struct uci_package * pkg = NULL;
    struct uci_element *e;
    char *tmp;
    const char *value;


    ctx = uci_alloc_context(); // 申請一個UCI上下文.
    if (UCI_OK != uci_load(ctx, UCI_CONFIG_FILE, &pkg))
        goto cleanup; //如果開啟UCI檔案失敗,則跳到末尾 清理 UCI 上下文.


    /*遍歷UCI的每一個節*/
    uci_foreach_element(&pkg->sections, e)
    {
        struct uci_section *s = uci_to_section(e);

    printf("section s's type is %s.\n",s->type);

    if(!strcmp)

    if(!strcmp("meter",s->type)) //this section is a meter
    {
        printf("this seciton is a meter.\n");
            if (NULL != (value = uci_lookup_option_string(ctx, s, "modbus_id")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's modbus_id is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "num_attr")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's num_attr is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "sender_id")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's sender_id is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "customer_id")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's customer_id is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "customer_name")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's customer_name is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "account_id")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's account_id is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "account_name")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's account_name is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "meter_id")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's meter_id is %s.\n",s->e.name,value);
            }
            if (NULL != (value = uci_lookup_option_string(ctx, s, "commodity")))
            {
                    tmp = strdup(value); //如果您想持有該變數值，一定要拷貝一份。當 pkg銷燬後value的記憶體會被釋放。
                    printf("%s's commodity is %s.\n",s->e.name,value);
            }
    }
        // 如果您不確定是 string型別 可以先使用 uci_lookup_option() 函式得到Option 然後再判斷.
        // Option 的型別有 UCI_TYPE_STRING 和 UCI_TYPE_LIST 兩種.


    }
    uci_unload(ctx, pkg); // 釋放 pkg 
cleanup:
    uci_free_context(ctx);
    ctx = NULL;
}
int main(int argc, char* argv[])
{

    load_config();
}

遍歷一個UCI_TYPE_LIST 型別

config  "server" "webserver"  
    list    "index" "index.html"  
    list    "index" "index.php"  
    list    "index" "default.html"

程式碼段：

// s 為 section.  
struct uci_option * o = uci_lookup_option(ctx, s, "index");  
if ((NULL != o) && (UCI_TYPE_LIST == o->type)) //o存在 且 型別是 UCI_TYPE_LIST則可以繼續.  
{  
    struct uci_element *e;  
    uci_foreach_element(&o->v.list, e)  
    {  
        //這裡會迴圈遍歷 list  
        // e->name 的值依次是 index.html, index.php, default.html  
    }  
}

寫配置

UCI提供了一個簡潔的辦法來操作配置資訊,例如有一個配置檔案

#檔名: testconfig  
config  'servver'  
    option  'value' '123' # 我們想修改 'value' 的值為 '456'

程式碼如下:

struct uci_context * ctx = uci_alloc_context(); //申請上下文  
struct uci_ptr ptr ={  
    .package = "config",  
    .section = "servver",  
    .option = "value",  
    .value = "256",  
};  
uci_set(_ctx,&ptr); //寫入配置  
uci_commit(_ctx, &ptr.p, false); //提交儲存更改  
uci_unload(_ctx,ptr.p); //解除安裝包  


uci_free_context(ctx); //釋放上下文

Openwrt下C呼叫UCI API

共同原則

配置檔案

檔案語法

UCI的幾個結構體

幾個基本的API函式

寫配置

Openwrt下C呼叫UCI API

用Visual C#呼叫Windows API函式

Windows下C++呼叫系統軟鍵盤及其需要注意的點

Linux下C++呼叫Java簡單例項（jni）

win64下C++呼叫python指令碼

C#呼叫RESTful API

debian系列下c++呼叫mysql， linux下面安裝mysql.h檔案

用C#呼叫Windows API和其它程序通訊及C# 獲得另外一程式控制代碼後控制該程式控制其透明窗體大小

VS2015下C++呼叫Python指令碼

linux下系統呼叫、API、系統命令，核心函式的區別與聯絡

Linux下c++呼叫自己編寫的matlab函式：通過mcc動態連結庫.so實現

C#呼叫Windows API(示例：顯示工作管理員裡的程式名稱)

C程式碼呼叫uci的API讀openwrt配置檔案指南

OpenWRT UCI API的使用——C語言

centos下C程式設計呼叫libvirt的API訪問KVM虛擬機器

windows 下 c++ 如何呼叫 python 3

Linux下C程式動態庫的生成和呼叫

windows 下C++動態庫的封裝以及呼叫

c++ 呼叫Python指令碼或者動態庫——環境Ubuntu 16.04下用codeblocks

C#呼叫百度api，根據經度和緯度獲取地理位置資訊

Openwrt下C呼叫UCI API

共同原則

配置檔案

檔案語法

UCI的幾個結構體

幾個基本的API函式

寫配置

相關推薦