【BBF系列协议】Data Models Library数据模型库设计与实现

目录Data Models Library (dmlib)dmlib的设计dmlib 的代码结构:dmlib 主要数据结构操作上下文对象dmctx对象定义DMOBJ参数定义DMLEAF多实例遍历函数实现browseinstobj参数树遍历规则关键函数dmlib的库依赖Data Models Library (dmlib)dmlib是一种数据模型库实现将TR069系列数据模型拆分成对象Object和参数Paramters来定义标准操作接口可用于通过远程控制协议如TR-069/CWMP 或 TR-369/USP管理的CPE设备上。 这个库主要特性如下:特性描述协议无关,跨平台解耦cwmp协议独立成模块,提供统一的接口标准来适配不同平台的操作可拓展可适配tr369mqtt等其他协议,可拓展tr181,tr098,tr104等数据模型规范统一数据模型操作入口该库提供了使用统一入口添加新参数或扩展现有数据模型树的机制外部数据接口库封装该库提供了UCI、JSON和动态内存管理等统一接口dmlib的设计dmlib的代码结构:├── dmtree │ └── tr098 │ ├── root.c │ ├── deviceinfo.c │ └── wandevice.c ├── include │ ├── dmcommon.h │ ├── dmentry.h │ ├── dmjson.h │ ├── dmmem.h │ ├── dmtr098.h │ ├── dmuci.h │ └── dmtree │ ├── root.h │ ├── deviceinfo.h │ └── wandevice.h ├── dmentry.c ├── dmtr098.c ├── dmcommon.c ├── dmjson.c ├── dmmem.c └── dmuci.cdmtree文件夹包含所有支持的数据模型tr098: TR-098 数据模型操作接口实现按照操作对象(Object)来拆分c文件,方便后期维护other: 可自行拓展不同数据模型如tr181tr104等dmentry.c主要实现TR069协议对参数和对象的CRUD操作dmctx全局上下文的初始化和销毁以及参数值变化更新等入口函数。dmtr098.c主要实现参数树的遍历和CRUD操作回调函数的挂载dmcommon.c公共的工具类处理函数dmmem.c统一的动态内存管理接口dmuci.cUCI接口封装dmlib主要数据结构操作上下文对象dmctx结构体成员描述stopdm_browse遍历停止标志method_param参数操作回调函数method_obj对象操作回调函数checkobj对象路径校验回调函数checkleaf参数路径校验回调函数list_parameter操作结果返回值链表set_list_tmpsetvalue的临时保存链表list_fault_param操作错误返回值链表dm_entryobj操作数据模型树nextlevelgetnames是否获取下一级faultcode操作错误码setactionsetvalue/setnotification的动作VALUECHECK or VALUESETin_param操作入参in_notificationsetnotification的动作的设置值in_valuesetvalue的设置值addobj_instanceaddobject新增实例的下标返回值instance_mode实例模式 别名INSTANCE_MODE_ALIAS or 数字INSTANCE_UPDATE_NUMBERinparam_isparam操作入参是否为参数(DMLEAF)findparam操作入参全匹配改标志置:‘1’add_list_value_changevalueschange保存链表回调函数send_active_value_changevalueschange事件发送回调函数对象定义DMOBJ结构体成员描述obj对象名称的字符串。示例“Bridging”、“IP”、“DeviceInfo”、“WiFi”permission对象的权限。DMREAD或DMWRITE。如果是DMWRITE则可以添加/删除此对象的实例addobj用于在此对象下添加新实例的函数。当ACS/Controller调用此对象的AddObject时将触发此函数delobj删除此对象下实例的函数。当ACS/Controller调用此对象实例的DeleteObject时将触发此函数checkobj对象依赖检查一般为空忽略该检查browseinstobj此函数允许浏览此对象下的所有实例nextobj指向包含子对象列表的DMOBJ数组的指针leaf指向包含子参数列表的DMLEAF数组的指针参数定义DMLEAF结构体成员描述parameter参数名称的字符串。示例“Enable”、“Status”、“Name”permission参数的权限。DMREAD或DMWRITE。如果是DMWRITE则可以为该参数设置一个值type参数的类型DM_STRINGDM_BOOLDM_UNINT…getvalue获取此参数值的函数setvalue设置此参数值的函数forced_inform该参数为强制上报参数notification参数属性默认值多实例遍历函数实现browseinstobj浏览功能允许浏览当前对象的所有实例并将它们链接到数据模型树。在此函数中需要定义两个函数通过函数来检索实例例如uci_foreach_sections: 通过uci.sections来遍历实例handle_update_instance: 通过指定属性来获取实例下标.函数链接实例我们需要为每个实例调用DM_LINK_INST_OBJ()函数以便将实例链接到数据模型树。我们还需要指定此实例级别的data。此data可稍后在子对象和参数函数 (Get/Set/Add/Delete) 中使用。注意1: 遍历函数仅针对多实例对象开发.参数树遍历规则参数树在初始化时dm_ctx_init_custom传入dmctx-dm_entryobj入参路径传入dmctx-in_param inparamCRUD操作注册不同的回调函数主要注册四个回调函数对象操作回调函数dmctx-method_obj参数操作回调函数dmctx-method_param对象校验回调函数dmctx-checkobj参数校验回调函数dmctx-checkleaf结果存放于dmctx-list_parameter多个set的操作临时值存放于dmctx-set_list_tmp由dm_entry_apply统一生效错误存放于dmctx-list_fault_param添加实例下标存放于dmctx-addobj_instance示例 get/set路径InternetGatewayDevice.DeviceInfo.Manufacturer InternetGatewayDevice. entryobj-nextobj --dm_browse InternetGatewayDevice.DeviceInfo. entryobj-leaf --dm_browse_leaf InternetGatewayDevice.DeviceInfo.Manufacturer dmctx-method_param --strcmp mark --(get_cmd/set_cmd)get/set多实例路径InternetGatewayDevice.WANDevice.1.WANConnectionDevice.Params InternetGatewayDevice. entryobj-nextobj --dm_browse InternetGatewayDevice.WANDevice. entryobj-browseinstobj --DM_LINK_INST_OBJ InternetGatewayDevice.WANDevice.1 entryobj-nextobj --dm_browse InternetGatewayDevice.WANDevice.1.WANConnectionDevice entryobj-leaf --dm_browse_leaf InternetGatewayDevice.WANDevice.1.WANConnectionDevice.Params dmctx-method_param --strcmp mark --(get_cmd/set_cmd)add:InternetGatewayDevice.Layer3Forwarding.Forwarding. InternetGatewayDevice. entryobj-nextobj --dm_browse InternetGatewayDevice.Layer3Forwarding. entryobj-nextobj --dm_browse InternetGatewayDevice.Layer3Forwarding.Forwarding. check mark --dmctx-method_obj --(addobj)--返回新增实例addobj_instance del:InternetGatewayDevice.Layer3Forwarding.Forwarding.1. InternetGatewayDevice. entryobj-nextobj --dm_browse InternetGatewayDevice.Layer3Forwarding. entryobj-nextobj --dm_browse InternetGatewayDevice.Layer3Forwarding.Forwarding. entryobj-browseinstobj --DM_LINK_INST_OBJ InternetGatewayDevice.Layer3Forwarding.Forwarding.1. check mark --dmctx-method_obj --(delobj)InternetGatewayDevice. --DeviceInfo(nextobj). --Manufacturer(leaf)--ManagementServer(nextobj). --xxx(leaf)--Layer3Forwarding(nextobj). --xxx(leaf)--Forwarding(nextobj). --xxx(leaf)关键函数dmentry.c该文件中所有入口函数都为关键函数dm_ctx_init: 初始化uci,操作结果等临时链表参数树等全局上下文成员dm_ctx_clean: 销毁uci清除操作结果等临时链表以及动态分配的内存dm_entry_load_enabled_notify: 注册发送值变化事件回调和存放参数链表回调初始化时加载dm_entry_reload_enabled_notify: 值变化更新定时更新需要主动上报的值变化dm_entry_param_method: 数据模型树CRUD操作入口dm_entry_apply: set值和属性统一生效函数dmtr098.c数据模型树的主要遍历逻辑dm_browse: 遍历数据模型树的主入口dm_browse_leaf: 遍历参数叶子节点函数dm_entry_*get_value/set_value/get_name/add_object/delete_object: 数据模型树CRUD操作具体实现dmlib的库依赖为了成功编译该库 , 下面的库是必须的:DependencyLinkLicenselibucihttps://git.openwrt.org/project/uci.gitLGPL 2.1libuboxhttps://git.openwrt.org/project/libubox.gitBSDlibjson-chttps://s3.amazonaws.com/json-c_releasesMITtr369服务端开源项目: AgenticAIoT‍♂️ 个人主页帐篷Li的个人主页✍作者简介专注智能物联网设备云管解决方案 希望大家多多支持我们一起进步项目合作开发定制技术交流可私聊右侧扫码。欢迎评论 点赞 收藏 加关注技术交流需求定制可以扫码添加相互学习交流