OpenWrt 系统UCI详解(Lua、C语言调用uci接口实例)

最新推荐文章于 2024-08-20 22:40:24 发布
最新推荐文章于 2024-08-20 22:40:24 发布
阅读量2.9k 收藏 21
点赞数 3
分类专栏： openwrt C语言编程 转载记录 文章标签： openwrt lua c语言
原文链接：http://shanks.link/blog/2022/10/24/openwrt-%e7%b3%bb%e7%bb%9fuci%e8%af%a6%e8%a7%a3luac%e8%af%ad%e8%a8%80%e8%b0%83%e7%94%a8uci%e6%8e%a5%e5%8f%a3%e5%ae%9e%e4%be%8b/
版权
转载记录 同时被 3 个专栏收录
382 篇文章 16 订阅
订阅专栏
openwrt
87 篇文章 30 订阅
订阅专栏
C语言编程
14 篇文章 0 订阅
订阅专栏

目录

1 UCI简介

2 uci配置格式

3 uci命令的用法

4 常用的uci配置和命令

4.1 重要配置文件

4.2 常用配置命令

5 c语言中使用uci

5.1 引用说明

5.2 常用结构体

5.3 常用接口

5.4 C语言操作uci配置实例

5.5 Lua中使用uci

5.5.1 配置文件实例

5.5.2 cursor初始化的几种方式

5.5.3 Lua常用的uci接口

6 Lua操作uci配置实例1

6.0.4 Lua操作uci配置实例2

1 UCI简介

“uci"是"Unified Configuration Interface”(统一配置界面)的缩写,用于OpenWrt整个系统的配置集中化。

很多后台服务有自己的配置文件，并且配置文件格式都不相同，OpenWrt系统中需要开启各种服务，为了解决配置不兼容的问题，统一采用uci格式的配置文件。

img

当然统一的前提是需要各个模块做好适配，所以要想把某个服务集成到OpenWrt系统中，需要增加一个转换层，用于uci配置到服务配置的转换，通常这个工作放在init脚本中处理。

img

以samba服务器为例，

在一般的linux系统中，启动samba服务直接修改/etc/samba/smb.conf重启服务即可，但在openwrt中，不直接修改/etc/samba/smb.conf，而是修改/etc/config/samba配置文件，然后执行/etc/init.d/samba restart

img

以下为init脚本的部分代码，这段代码中就包含了uci配置到samba配置的转换工作。

img

2 uci配置格式

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

config ‘example’ ‘test’ 语句表示一个section的开始，这里的配置类型是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语法的正确配置：

  • option example value
  • option ‘example’ value
  • option example “value”
  • option “example” ‘value’
  • option ‘example’ “value”

反之，以下配置则存在语法错误

  • option ‘example" “value’ (引号不匹配)
  • option example some value with space (值中包含空格，需要为值加引号)

还有一点是必须知道的，即UCI标识符和配置文件名称所包含的字符必须是由a-z， 0-9和_组成。 选项值则可以包含任意字符，只要这个值是加了引号的。

3 uci命令的用法

img

uci配置文件支持通过uci shell命令进行操作，支持set、get、show、export等基本操作。当然最常用的就是set和get命令。

在进行uci命令操作之前，我们先查看/etc/config/有哪些配置文件，这样我们可以知道操作哪个配置文件（当然也可以直接uci show，可以看到所有的配置信息，但数据较多，还是习惯先看看config目录有哪些配置）

img

现在可以针对某个配置进行操作，比如network配置，先通过cat查看配置文件中的内容，看看数据格式

img

然后通过 uci show network命令查看具体的uci配置选项，用于查看具体的uci变量名称

img

比如我们获取单个option变量值，获取lan口ip地址

可以通过uci get network.lan.ipaddr 命令获取

img

也可以通过set命令修改某个变量的值

如设置lan口ip地址为192.168.188.1

uci set network.lan.ipaddr=192.168.188.1

img

可以看到已经成功修改了lan ip的值，但值得注意的是，通过cat /etc/config/network并不能查看到最新设置的值，这是因为通过uci set命令只修改了变量的临时值，并没有保存到配置文件中。这个临时值保存在/tmp/.uci/目录中。

img

临时目录中的文件内容只显示修改的变量，如果多次修改会显示多个内容，会显示所有的历史记录。现在我们看看多次修改后临时目录文件中的内容

img

为了让修改的值在/etc/config目录中生效，我们还需要执行uci commit命令，该命令类似于svn commit，会把修改的记录提交。

uci commit会将所有改变提交，我们也可以只提交某个配置文件的修改，如uci commit network，这样只会提交network的修改内容。

4 常用的uci配置和命令

4.1 重要配置文件

配置文件说明
/etc/config/system系统配置，如主机名、时区等
/etc/config/network网络配置，lan口ip、wan口ip、vlan等
/etc/config/dhcpDhcp服务器配置
/etc/config/firewall防火墙配置
/etc/config/uhttpdWeb服务器配置（默认）
/etc/config/dropbearSsh服务器配置
/etc/config/luciLuci框架配置

4.2 常用配置命令

  • 网络配置
命令说明
uci show network查看所有网络配置
uci get network.lan.ipaddr获取lan口ip地址
uci set network.lan.ipaddr=192.168.2.1修改lan口ip地址为192.168.2.1
uci get network.wan.proto查看wan口ip地址获取方式（dhcp、static、pppoe）
uci set network.wan.proto=static配置wan口ip地址获取方式为静态
uci get network.wan.ipaddr获取wan口ip
uci set network.wan.ipaddr=192.168.100.100配置wan口ip为192.168.100.100
uci get network.wan.netmask获取wan口子网掩码
uci set network.wan.netmask=255.255.255.0配置wan口子网掩码为255.255.255.0
uci get network.wan.gateway获取默认网关地址
uci set network.wan.gateway=192.168.100.1配置默认网关地址为192.168.100.1
uci get network.lan.ifname获取lan口接口名(eth0)
uci get network.wan.ifname获取wan口接口名(eth1)
uci show network.wan查看所有wan配置
uci show network.lan查看所有lan配置
uci commit network保存网络配置
uci revert network放弃修改的网络配置（在commit之前可以revert）
  • 其他配置
命令说明
uci show system查看所有系统配置
uci get system.@system[0].hostname获取系统主机名
uci get system.@system[0].timezone获取当前系统时区(CST-8)
uci get system.ntp.enabled获取ntp开关
uci get luci.ccache.enable查看luci是否启用缓存
uci get luci.languages.zh_cn获取luci当前使用的语言
uci get uhttpd.main.home获取web服务器根目录
uci get uhttpd.main.listen_http获取web服务器监听ip和端口
uci get uhttpd.main.redirect_https查看web服务器是否强制https
uci get firewall.@zone[1].masq查看是否开启地址伪装(snat)
uci get dropbear.@dropbear[0].PasswordAuth查看ssh是否开启密码认证
uci get dropbear.@dropbear[0].Port查看ssh监听端口号
uci get dropbear.@dropbear[0].Interface查看ssh监听的网卡接口
uci show查看所有uci配置

5 c语言中使用uci

5.1 引用说明

头文件 <uci.h>

引用库: +libuci

5.2 常用结构体

结构体说明相关接口
struct uci_contextUci上下文，用于存储配置路径、配置package等，使用uci前必须分配一个ctxuci_loaduci_unloaduci_alloc_contextuci_free_context
struct uci_package对应一个配置包，如network、wirelessuci_lookup_packageuci_loaduci_unload
struct uci_section对应配置的一个节(section)uci_lookup_section
struct uci_option对应某个配置项uci_lookup_option_stringuci_lookup_option

5.3 常用接口

常用接口说明
int uci_set(struct uci_context *ctx, struct uci_ptr *ptr)设置uci值
int uci_del_list(struct uci_context *ctx, struct uci_ptr *ptr)删除list option
int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr)增加list option
int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr)删除节点（option）
int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended)查询元素指针
int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr)重命名节（option）
int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res)添加一个节
struct uci_context *uci_alloc_context(void)分配上下文空间
void uci_free_context(struct uci_context *ctx)释放上下文空间
int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package)加载配置到内存
int uci_set_confdir(struct uci_context *ctx, const char *dir)设置配置目录
int uci_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)提交修改的值
struct uci_option *uci_lookup_option(struct uci_context *ctx, struct uci_section *s, const char *name)查询option指针
const char *uci_lookup_option_string(struct uci_context *ctx, struct uci_section *s, const char *name)获取一个option string值
struct uci_section *uci_lookup_section(struct uci_context *ctx, struct uci_package *p, const char *name)查询package中的section
struct uci_package *uci_lookup_package(struct uci_context *ctx, const char *name)在上下文中获取package指针

5.4 C语言操作uci配置实例

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <uci.h>
 
static struct uci_context *uci_ctx = NULL;
static struct uci_package *uci_test;
static struct uci_package *
config_init_package(const char *config)
{
    struct uci_context *ctx = uci_ctx;
    struct uci_package *p = NULL;
 
    if (!ctx)
    {
        ctx = uci_alloc_context();
        uci_ctx = ctx;
        ctx->flags &= ~UCI_FLAG_STRICT;
        //if (config_path)
        //  uci_set_confdir(ctx, config_path);
    }
    else
    {
        p = uci_lookup_package(ctx, config);
        if (p)
            uci_unload(ctx, p);
    }
 
    if (uci_load(ctx, config, &p))
        return NULL;
 
    return p;
}
int config_alloc(void)
{
    uci_test = config_init_package("test");
    if (!uci_test)
    {
        printf("Failed to load test config\n");
        return -1;
    }
    return 0;
}
 
int config_free(void)
{
    if (uci_test)
    {
        uci_unload(uci_ctx, uci_test);
        uci_test = NULL;
    }
    if (uci_ctx)
    {
        uci_free_context(uci_ctx);
        uci_ctx = NULL;
    }
}
 
int main(int argc, char *argv[])
{
    int ret = 0;
    int enable = 0;
    config_alloc();
    struct uci_section *global_sec = uci_lookup_section(uci_ctx, uci_test, "global");
    if (!global_sec)
    {
        printf("get global section failed\n");
        config_free();
        return 0;
    }
 
    char *name = uci_lookup_option_string(uci_ctx, global_sec, "name");
    if (!name)
    {
        printf("name option not found.\n");
        config_free();
        return 0;
    }
    printf("name = %s\n", name);
    free(name);
    struct uci_ptr ptr ={
                .package = "test",
                .section = "global",
                .option = "name",
                .value = "xxxxxxxxxx"
            };
    ret = uci_set(uci_ctx, &ptr);   
    if(ret != UCI_OK)
    {
        printf("set name...failed\n");
    }
    else{
        printf("set name...ok\n");
    }
    uci_save(uci_ctx, ptr.p);
    uci_commit(uci_ctx, &ptr.p, false);
    config_free();
    return 0;
}

5.5 Lua中使用uci

5.5.1 配置文件实例

/etc/config/test

config global 'global'
    option name 'derry'
    option id '1'
    list address 'shenzhen'
    list address 'guangzhou'
    list address 'beijing'
5.5.2 cursor初始化的几种方式
1. 不带参数初始化（配置目录默认/etc/config）

x = uci.cursor()

2. 包含状态值

x = uci.cursor(nil, "/var/state")

3. 指定配置目录

x = uci.cursor("/etc/mypackage/config", "/tmp/mypackage/.uci")
5.5.3 Lua常用的uci接口
lua接口说明
x:get(“config”, “sectionname”, “option”)返回字符串 或 nil(没找到数据时)
x:set(“config”, “sectionname”, “option”, “value”)设置简单的字符串变量
x:set(“config”, “sectionname”, “option”, { “foo”, “bar” })设置列表变量
x:delete(“config”, “section”, “option”)删除选项
x:delete(“config”, “section”)删除段
x:add(“config”, “type”)添加一个匿名section（段）
x:set(“config”, “name”, “type”)添加一个类型为 “type”的section（段），名称为”name”
x:foreach(“config”, “type”, function(s) … end)遍历所有类型为的"type"段,并以每个"s"为参数调用回调函数. s 是一个包含所有选型和两个特有属性的列表s['.type’] → 段类型s['.name'] → 段名称如果回调函数返回 false [NB: not nil!], foreach() 在这个点会终止,不再继续遍历任何剩余的段. 如果至少存在一个段且回调函数没有产生错误,foreach() 会返回 true; 否则返回false.
x:revert(“config”)取消修改的值
x:commit(“config”)保存修改的值到配置目录文件，默认目录/etc/config

6 Lua操作uci配置实例

6.1 Lua操作uci配置实例1

#!/usr/bin/lua
require("uci")
x = uci.cursor()
function show_test_config()
    name = x:get("test", "global", "name")
    id = x:get("test", "global", "id")
    addr_list = x:get("test", "global", "address")
    print("name="..name)
    print("id="..id)
for key, value in ipairs(addr_list) 
do 
print("address["..key.."]----"..value) 
end
end
 
print("==========before change=========")
show_test_config()
x:set("test", "global", "name", "xxxxxxx")
x:set("test", "global", "id", "8888888")
 
x:set("test","global","address",{"1111","2222","33333","4444","5555"})
x:commit("test")
print("==========after change=========")
show_test_config()

运行结果：

img

6.2 Lua操作uci配置实例2

x=uci.cursor()

conf=x:get_all(“test”, “global”)

#!/usr/bin/lua
require("uci")
x=uci.cursor()
conf=x:get_all("test", "global")
 
print(conf["name"]);
print(conf["id"]);
for key, value in ipairs(conf["address"])
do
    print(value);
end

运行结果：

img

it潮人
关注
  • 3
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
UCI 接口详解
08-22
uci 脚本详细教程
OpenWrt上UCI库的使用(C语言调用)
有理论，有实验，有结论，可为一篇文章
10-15 7245
文章目录1 LUCI 配置文件简介2 简单的基本关系3 结构体介绍4 部分API介绍5 代码实战 1 LUCI 配置文件简介 LUCI 的配置文件一般存储在 /etc/config 目录下。比如网络配置文件则是 /etc/config/network，无线的配置文件是 /etc/config/wireless。更多配置文件的含义参考官方 WIKI. 2 简单的基本关系 这里画一个图让大家大致了解配置文件的内容和 uci 的几个基本结构之间的对应关系。（例举文件为 uhttpd 的配置文件） 3 结构
openwrt--uci指令的使用
qq_28689569的博客
01-08 3387
UCI的介绍
OpenWrt系统配置UCI
hzlarm的博客
11-10 8700
UCI简介 MVC(Model-View-Control)模式是经典的Web开发编程模式。 openWrt也是采用该设计模式，模型层采用统一配置接口UCI，是Unified Configuration Interface的缩写，翻译成中文就是统一配置接口，用途就是为OpenWrt提供一个集中控制的接口。OpenWrt实现的这个工具，能够让你的不管是Lua还是PHP程序，或者SHELL程序或C程序...
OpenWrt项目UCI配置介绍
酌沧
05-12 1175
UCI（Unified Configuration Interface）是 OpenWrt 项目中使用的一种配置管理系统。它旨在为嵌入式设备提供一个统一且易于理解的配置接口。UCI 主要用于简化 OpenWrt 系统的各种配置过程，使得管理网络、服务和其他系统参数变得更加方便。
OpenWrt UCI详解(C和Lua语言使用uci接口实例).docx
04-15
OpenWrt UCI详解，包含uci命令的基本操作，c语言、lua语言调用uci接口实例
openwrt之Uci
lighthouse_s的博客
05-30 1076
uci delete 配置文件名.section名.option名=option值 //section的类型名没有在命令中使用uci delete 配置文件名.section名.option名 //section的类型名没有在命令中使用。uci del_list 配置文件名.section名.list的option名=list 的option值。test指的是section的名字。option 指的是一个选项 ，name指的是选项的名称， value指的是选项的值。
Openwrt UCI入门操作
qq_60504871的博客
07-21 4109
很多后台服务有自己的配置文件，并且配置文件格式都不相同，OpenWrt系统中需要开启各种服务，为了解决配置不兼容的问题，统一采用uci格式的配置文件。常用的有ucishow、uciset、uciget等，如ucishownetwork。option对应的结构体（选项结构体）对应配置文件里节中的option或者list。package对应的结构体如下（包结构体）它对应一个配置文件内容。section对应的结构体（节结构体）它对应配置文件中的节。3.UCI-C使用方法。.........
第8章 OpenWrt-UCI的使用（一）
马小橙的专栏
03-18 1403
本章作为介绍UCI使用的第一章，主要讲述了UCI指令的使用，下一章将讲述UCI API编程
UCI命令详解
一只青木呀
10-29 5687
UCI命令详解1.UCI命令2.UCI的文件和流程3.UCI的文件语法4.UCI 命令读写配置** 1.UCI命令 一个众所周知的原因，在Linux下各种软件包有各种不同的配置脚本，每个配置脚本的语法格式和操作方式不同， 这样的设计虽然可以体现出各软件包自身的优势，同时也增加了学习曲线。在这一点上OpenWrt的UCI无疑处理的更 胜一筹。UCI是集中式配置信息管理接口(Unified Configuration Interface)的缩写，他是OpenWrt引进的一套配置 参数管理系统。UCI管理了Ope
openwrt7628配置WiFi的AP+STA中继
09-18
5. **uci2dat源码**：`uci2dat`是一个用于处理OpenWrt的配置数据库（UCI）的工具，将配置信息转换成二进制格式，可以提高系统性能。通常，在配置修改后，运行`/etc/init.d/network restart`以应用更改，但使用uci2...
luci-app-wrtbwmon：OpenWRT的带宽监视器
02-19
luci-app-wrtbwmon 该回购还提供了另一种wrtbwmon LUCI模块，它具有类似的功能。 不同之处在于此功能支持更多功能： 支持IPV6。 通过唯一的MAC而不是其IP标识主机。...信息原则上，从， 支持lua版本
OpenWrt开发入门培训视频.zip
02-21
13.OpenWrt UCI框架分析，/etc/config/network、/etc/config/wireless 等文件讲解。 14.OpenWrt sysupgrade命令实现原理分析。 15.OpenWrt 启动过程分析。 16.OpenWrt ipkg软件包结构分析。 17.OpenWrt mtd flash...
OpenWrt之lua网络编程_luci下的luasocket安装
fager漫长路
06-15 3213
写在前 openwrt的软路由上，提供了nixio，可以依赖它的socket进行编程，但是语法语义比较原始，不太容易使用，使用的样例可以参照： 自定义openwrt的配置界面：luci进阶之路 里面定义了如何使用luci的http方法，和自定义的resttemplate.lua工具文件(里面封装了如何使用nixio进行socket编程) 本篇文章，将使用大家都在用的luasocket库，因为lua语言官方并不提供网络编程模块，luasocket库是外部库，使用c语言和lua语言编写而成的现成的库，可以用来
uci 命令、shell接口、API接口
u011029104的专栏
01-14 608
set <config>.<section>[.<option>]=<value> 设置指定配置节选项的值，或者是增加一个配置节，类型设置为指定的值。">，供uci.sh调用</span>delete <config>[.<section>[[.<option>][=<id>]]] 删除指定配置节或选项。rename <config>.<section>[.<option>]=<name> 对指定的选项或配置节重命名。
openwrt学习之UCI模块
guanjie_chen的博客
08-07 1654
UCI模块，Unified Configuration Interface，通用配置接口，是openwrt的核心模块之一 是用于管理openwrt系统的配置文件，提供了API库函数和命令行接口供用户调用 这些配置文件默认保存在/etc/config/目录下，每一个文件即是一个uci配置文件 文件语法： UCI配置文件通常由一个或多个config语句组成 config后面的interface是一个config的type，由自己定义，可以重复出现 type后面是sec...
OpenWrt-uci脚本命令
flexman09的专栏
06-16 3308
转自：http://developer.t-firefly.com/thread-1035-1-1.html 目录： 1.UCI命令 2.UCI的文件和流程 3.UCI 的文件语法 4.UCI 命令读写配置 5.综合实例 1.UCI命令 一个众所周知的原因，在Linux下各种软件包有各种不同的配置脚本，每个配置脚本的语法格式和操作方式不同， 这样的设计虽然可以体现
OpenWrt uci网络配置详解
Derry的专栏
06-21 2383
OpenWrt网络接口一般包含lan口和wan口，但如果是X86等设备，只设置了一张网卡，只会生成lan口信息，在虚拟机中我们默认只配置一个网卡，方便配置网络，等熟悉基本网络配置后再尝试将OpenWrt打造成一台路由器。
高性能 Web 服务器：让网页瞬间绽放的魔法引擎（下）
最新发布
weixin_64373152的博客
08-20 1360
PHP-FPM(FastCGI Process Manager： FastCGI进程管理器)是一个实现了Fastcgi的程序，并且提供进程管理的功能。进程包括master进程和worker进程。master进程只有一个，负责监听端口，接受来自web server 的请求 worker进程一般会有多个，每个进程中会嵌入一个PHP解析器，进行PHP代码的处理。
openwrt中使用lua脚本判断路由器断网原因
05-20
在OpenWrt中，可以使用Lua脚本来判断路由器断网的原因。以下是一个示例脚本： ```lua local uci = require("uci").cursor() local net = require("luci.model.network").init() -- 获取wan口状态 local wan_iface = uci:get("network", "wan", "ifname") local wan_up = net:iface(wan_iface):is_up() -- 获取wan口IP地址 local wan_ip = uci:get("network", "wan", "ipaddr") -- 获取dns服务器地址 local dns_servers = uci:get("network", "wan", "dns") -- 判断wan口是否连接成功 if wan_up and wan_ip ~= "" and dns_servers ~= "" then print("WAN connected successfully!") else print("WAN connection failed!") end ``` 该脚本使用OpenWrt的UCI库来获取网络配置信息，并使用LuCI模块来初始化网络模型。然后，它检查WAN口的状态、IP地址和DNS服务器地址，以判断WAN口是否已连接成功。如果连接成功，则输出“WAN connected successfully!”，否则输出“WAN connection failed!”。 需要注意的是，该脚本只能判断WAN口是否连接成功，而不能判断具体的断网原因。如果需要更详细的信息，可以考虑使用ping或traceroute等工具来进行网络诊断。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值