CWMP開源代碼研究番外篇——博通方案

聲明：本篇文章來自於某公司Cable Modem產品的文檔資料，源碼來自於博通公司，只提供參考（為保護產權，本人沒有源碼）。

前文曾提到會寫一篇關於博通的tr069，那么福利來了。福利，福利，福利，重要的事情說三遍！

如果你正在閱讀博通的相關產品代碼而又苦於沒有文檔參閱，那么我相信本文將會非常適合你。

一. TR069的Makefile和源碼
1. 編譯:

在編譯選項中添加“tr69”, 對應的makefile為:   REV/rbb_cm_src/Bfc/make/BfcTR69.mak　　

2. 相關源碼

主要有3部分代碼：tr069 client agent代碼，用c實現；TR069Thread和CLI配置代碼，c++實現；client agent與系統間的接口代碼，c++實現。(具體實現在后文講解)

//tr069 client agent代碼
REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/
inc/  #放置與數據模型相關的宏定義，數據結構定義頭文件
main/ #agent實現文件，main,informer,event
nanoxml/ #
SOAPParser/ #soap解析，其中RPCState.c為RPC命令處理接口
standard/ #節點數據模型定義文件
webproto/ #

//tr069thread與CLI參數配置
REV/rbb_cm_src/Bfc/IpHelpers/TR069/
BcmBfcTr69CommandTable.cpp #tr69 CLI實現
BcmBfcTr69SnmpApi.cpp  #提供了通過snmp進行對系統參數的get/set接口，tr69 agent利用這些接口進行大部分參數的get/set
BcmBfcTr69ThreadIpStackACT.cpp #ip_stack ip變化時，通知TR069Thread啟動或停止agent
BcmBfcTr69SocketApi.cpp  #提供系統與agent間有關socket操作的接口，供agent調用
BcmBfcTr69Entry.cpp  #
BfcTr69NonVolSettings.cpp
BfcTr69NonVolSettingsCommandTable.cpp  #tr69 non-vol參數配置CLI
BcmBfcTr69NonVolApi.cpp  #提供non-vol存取的接口，供agent調用
BcmBfcTr69Thread.cpp  #tr069進程實現，控制agent的運行/停止/重啟

//client agent系統調用接口
REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/bcmBfcIf/
其中的文件定義了與standard/目錄下數據模型結構中對應的object的add/del，parameters的get/set api

二. 配置參數　　

1. CLI

CM>cd non-vol/tr69
CD>ls
acs_password acs_url acs_username conn_req_password conn_req_url conn_req_username
ip_stack_num periodic_inform_enable periodic_inform_interval
stun_enable stun_max_keepalive stun_mix_keepalive stun_password stun_server stun_username  

其中，ip_stack_num為tr69 agent關聯的wan interface對應的ipstack number，默認指定為3

此外，可使用的命令有如下:

CM>cd tr69
CM>ls
acs_url log send_inform show start_client stop_client test walk_tree

其中： client可理解為tr069 client agent
acs_url 修改acsurl
send_inform agent運行前提下，立即發送inform
start_client 如ip_stack_num對應的wan interface處於可用狀態，則會運行agent
walk_tree 查看節點結構

2. CM ConfigFile

參數配置 CM Config有定義TR-069參數

eRouter Configuration Encodings (202)
  eRouter TR-069 Management Server (2)
    EnableCWMP (1)
    URL (2)
    Username (3)
    Password (4)
    ConnectionRequestUserName (5)
    ConnectionRequestPassword (6)
    ACSOverride (7)

其中，EnableSWMP和ACSOverride會影響tr69 agent的行為。 下文詳述

3. DHCP option

利用DHCPv6 Option17或DHCPv4 Option125來配置ACSUrl參數

三. 多種配置參數的優先順序

1. 啟動方式　　

• 通過CLI(start_client)啟動，此時使用的為通過CLI配置的參數，即在NonVol中的參數
• 自動啟動，條件為CM Config中的EnableCWMP為true，或者得到有效的DHCPv6 Option17或DHCPv4 Option125。此時的參數選擇如下

2. 自動啟動時的參數選擇　　

// ACSUrl的優先順序：
if(ACSOverride==true || (ACSOverride==false && ACSUrl in NonVol=="http://10.10.10.10:8080/acs"))
  DHCPv6 Option17 > DHCPv4 Option125 > CM Config > NonVol
else if(ACSOverride==false and ACSUrl in NonVol!="http://10.10.10.10:8080/acs")
  DHCPv6 Option17 > DHCPv4 Option125 > NonVol > CM Config

// 其他參數(acsusername,acspassword,connrequsername,connreqpassword)的選擇：
if(ACSOverride==true || (ACSOverride==false && ACSUrl in NonVol=="http://10.10.10.10:8080/acs"))
  CM Config > NonVol
else if(ACSOverride==false && ACSUrl in NonVol!="http://10.10.10.10:8080/acs")
    !NonVol > CM Config

3.ipv4 or ipv6

如果ACSUrl中使用"[]"包含IP地址或者由DHCPv6 Option17得到的ACSUrl，則嘗試首先使用IPv6發起連接.

四. 具體實現

1. TR069 Thread狀態控制　　　　

// tr069thread有以下狀態和消息類型：
    enum
    {
        kStartThread = 0, //目前此msg僅自CLI
        kStopThread, //同上
        kStartClient,//同上
        kStopClient, //同上
        kSendInform, //同上
        kIpAddressChanged //當相關的ip_stack ip發生變化時，會收到此消息類型      
    }QCommands;

    typedef enum
    {
        kClientStarting = 0,
        kClientReady,       // Thread initialized and ready for Core
        kClientRunning,
        kClientStopping,
        kClientStopped,     // Client (core) is stopped, thread running
        kExitingThread      // Going away completely.
    } ThreadState;

 進程根據進程狀態和收到的消息類型來控制tr69 client agent，start/stop agent的過程用下圖簡單描述：

2. Socket建立

建立2個socket，acsconnection socket用於連接ACS;acslisten socket用於接收acs的RPC.

// acs connection socket建立
wget.c wget_Connect()
             \_www.c www_EstablishConnection()
                          \_BcmBfcTr69SocketApi.cpp BfcTr69Api_SocketAcsConnection()
                                  \_BcmBfcTr69Thread::SocketAcsConnection()

// acs listen socket建立
tr69c_main() -> initTask()
                  \_informer.c initInformer() -> startACSComm() ->
                     startACSListener() -> startACScallback()
                                              \_BfcTr69Api_SocketACSListenSocket()
                                                   \_BcmBfcTr69Thread::SocketACSListenSocket()

3. 數據模型的建立

數據模型標准：TR-181_Issue-2.pdf,非TR-98 Gataway模型

1)模型對應數據結構

//節點數據結構定義：
REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/inc/tr69cdef.h
 typedef union TRxPAttrib {
    struct Attrib {
    eTRxType    etype:8;
    unsigned    slength:16;
    unsigned    inhibitActiveNotify:1; /* set to always inhibit change notification: use on counters */
    } attrib;
    InstanceDesc    *instance;
 } TRxPAttrib;

 typedef struct TRxObjNode {
    const char  *name;//節點或參數名稱
    TRxPAttrib  paramAttrib;//主要指示參數類型，object/string/bool...
    TRxSETFUNC  setTRxParam;//object的del，parameter的set    
    TRxGETFUNC  getTRxParam;//object的add，parameter的get
    void        *objDetail; //節點類型為object時，對應object的詳細內容(包含parameter和下級object)
    InstanceDope *instanceDope;
 } TRxObjNode;

 用以上結構表示以下節點:

 Device.InterfaceStackNumberOfEntries //unsigned類型parameter，readonly
 Device.DeviceSummary //string類型parameter，readonly                                          
 Device.IP. //不可動態添加的object類型，readonly

 Device.IP.IPv4Capable
 Device.IP.IPv4Enable
 ...
 Device.IP.InterfaceNumberOfEntries
 Device.IP.Interface.{i}. //可動態添加的object類型，read-write

 Device.IP.Interface.i.Enable //read-write
 Device.IP.Interface.i.IPv4Enable //read-write
 ...                               

的實例對應為

tr181i2DeviceParams.c
  TRxObjNode  tr181i2DeviceDesc[] = {
    {InterfaceStackNumberOfEntries,{{tUnsigned,0,0}}, NULL, getInterfaceStackNumEntries,NULL,NULL},
    {DeviceSummary,{{tString}}, NULL, getDeviceSummary,NULL,NULL},
    {IP,{{tObject,0,0}}, NULL,NULL, ipDesc,NULL},
    {NULL}
  };

tr181i2DeviceParams.c  
  TRxObjNode  ipDesc[] = {
    {IPv4Capable,{{tBool,0}}, NULL,getIPv4Capable,NULL,NULL},
    {IPv4Enable,{{tBool,0}}, NULL,getIPv4Enable,NULL,NULL},
    {InterfaceNumberOfEntries,{{tUnsigned,0,16}}, NULL,getIPInterfaceNumberOfEntries,NULL,NULL},
    {ActivePortNumberOfEntries,{{tUnsigned,0,16}}, NULL,getIPActivePortNumberOfEntries,NULL,NULL},
    {Interface,{{tObject,0,0}}, NULL,NULL, ipInterfaceDesc,NULL},
    {NULL}
  };

tr181i2IPInterfaceParams.c
  TRxObjNode  ipInterfaceDesc[] = {
    {instanceIDMASK,{{0}}, deleteIPInterfaceInstance, addIPInterfaceInstance, ipInterfaceInstanceDesc},
  };//其中，instanceIDMASK為新節點標識，deleteIPInterfaceInstance為delete Interface節點的API名稱

  TRxObjNode  ipInterfaceInstanceDesc[] = {
    {Enable,{{tBool,0}},setIPInterfaceEnable,getIPInterfaceEnable,NULL,NULL},
    {IPv4Enable,{{tBool,0}},setIPInterfaceIPv4Enable,getIPInterfaceIPv4Enable,NULL,NULL},
    {NULL}//其中，setIPInterfaceIPv4Enable/getIPInterfaceIPv4Enable為Device.IP.Interface.i.IPv4Enable參數的set/get API名稱
};

以上，根據　　

tr181i2DeviceDesc[]
    \_ipDesc[]
        \_ipInterfaceDesc[]

連接成了

Device.
   \_IP.
      \_Interface.

節點樹形結構 

4. RPC處理過程

1) 入口函數

   對應處理函數入戶為： REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/SOAPParser/RPCState.c runRPC()

目前，支持如下方法：

      switch (rpcAction->rpcMethod) {
        case rpcGetRPCMethods:
            ...
        case rpcSetParameterValues:
            ...
        case rpcGetParameterValues:
            ...
        case rpcGetParameterNames:
            ...
        case rpcGetParameterAttributes:
            ...
        case rpcSetParameterAttributes:
            ...
        case rpcAddObject:
            ...
        case rpcDeleteObject:
            ...
        case rpcReboot:
            ...
        case rpcFactoryReset:
            ...
#if DOWNLOAD_SUPPORTED
        case rpcDownload:
            ...
#endif
        case rpcInformResponse:
            ...
        case rpcTransferCompleteResponse:
            ...
        case rpcGetRPCMethodsResponse:
            ...
        case rpcFault:
            ...

2） parameters對應的get/set api　　

仍以上述Device.IP.Interface.節點為例，此節點對應的api位於：

1 REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/bcmBfcIf/BcmBfcTr181i2IPInterfaceHandlers.cpp

注意到實際上這里大部分API沒有實現實際功能。
實際上，TR069的get/set是通過SNMP實現的，比如WiFi.Radio.{i}.Enable這個參數的get/set：

3）notify機制

passive notify：（1）在agent啟動或者收到inform response后，遍歷rootDevice的所有節點參數，將attribute為非none的參數的值更新為從對應mib中獲取的值。　　change parameter value to mib in some where  (2) 在發送inform之前，再遍歷所有attribute為非none的參數，將其值與mib中獲取的值比較，如有變化，則將其加入到inform發送出去

active notify: 未分析

5. 如何添加object/parameter

以添加如下節點和參數為例：

<object ref="Device.NAT.PortMapping.{i}." requirement="createDelete">
...
<parameter ref="RemoteHost" requirement="readWrite"/>
<parameter ref="ExternalPort" requirement="readWrite"/>
...
</object>

1）添加參數對應數據結構定義

添加tr181i2NATPortMappingParams.c/h，定義節點參數結構：

--- /dev/null
+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/tr181i2NATPortMappingParams.c
@@ -0,0 +1,35 @@
+//  Filename:       tr181i2NATPortMappingParams.c
+
+#include "sharedparams.h"
+#include "tr181i2NATPortMappingParams.h"
+
+/* Device.NAT.PortMapping.{i} */
+TRXGFUNC(getPortMappingRemoteHost);
+TRXSFUNC(setPortMappingRemoteHost);
+TRXGFUNC(getPortMappingExternalPort);
+TRXSFUNC(setPortMappingExternalPort);
+
+TRxObjNode  natPortMappingInstanceDesc[] = {
+    {RemoteHost,{{tString,0,64}}, setPortMappingRemoteHost, getPortMappingRemoteHost, NULL,NULL},
+    {ExternalPort,{{tUnsigned,0,16}}, setPortMappingExternalPort,getPortMappingExternalPort,NULL,NULL},
+    {NULL}
+};
+
+/* Device.NAT.PortMapping. */
+TRXGFUNC(addPortMappingInstance);
+TRXSFUNC(deletePortMappingInstance);
+
+TRxObjNode  natPortMappingDesc[] = {
+    {instanceIDMASK,{{0}}, deletePortMappingInstance, addPortMappingInstance, natPortMappingInstanceDesc},
+};
diff --git a/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/tr181i2NATPortMappingParams.h b/REV/rbb_cm_src/Bf
new file mode 100755
index 0000000..f45b208
--- /dev/null
+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/tr181i2NATPortMappingParams.h
@@ -0,0 +1,24 @@
+//  Filename:       tr181i2NATPortMappingParams.h
+
+#ifndef TR181I2_NAT_PORTMAPPING_PARAMS_H
+#define TR181I2_NAT_PORTMAPPING_PARAMS_H
+
+#include "../inc/tr69cdefs.h"
+
+/* Device.NAT.PortMapping.{i}*/
+SVAR(RemoteHost);
+SVAR(ExternalPort);
+
+#endif   // TR181I2_NAT_PARAMS_H

將增加的PortMapping節點加入Device.NAT.節點下：

+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/standardparams.c
   #include "../standard/tr181i2NATParams.h"
+  #include "../standard/tr181i2NATPortMappingParams.h"
   #include "../standard/tr181i2UPnPParams.h"

+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/tr181i2NATParams.c
 #include "tr181i2NATParams.h"
 
+extern TRxObjNode natPortMappingDesc[];
 
 TRxObjNode  natDesc[] = {
     {InterfaceSettingNumberOfEntries,{{tUnsigned,0,16}}, NULL,getNATInterfaceSettingNumberOfEntries,NULL,NULL},
     {PortMappingNumberOfEntries,{{tUnsigned,0,16}}, NULL,getNATPortMappingNumberOfEntries,NULL,NULL},
+    {PortMapping,{{tObject,0,0}},NULL,NULL,natPortMappingDesc,NULL},
     {NULL}
 };
 
+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/standard/tr181i2NATParams.h
@@ -60,5 +60,6 @@
 
 SVAR(InterfaceSettingNumberOfEntries);
 SVAR(PortMappingNumberOfEntries);
+SVAR(PortMapping);

2） 添加對應Add/Del object,Get/Set parameter API

NAT.PortMapping.對應的api添加在BcmBfcTr181i2NATPortMappingHandlers.cpp：

+++ b/REV/rbb_cm_src/Bfc/IpHelpers/TR069/tr69c/bcmBfcIf/BcmBfcTr181i2NATPortMappingHandlers.cpp

+ * File Name  : BcmBfcTr181i2NATPortMappingHandlers.c
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "bcmtypes.h"
+#include "BcmBfcTr69SnmpApi.h"
+
+// Give these CPP functions C linkage
+extern "C" 
+{
+
+#include "../inc/tr69cdefs.h"
+#include "BcmBfcTr69Log.h"
+
+extern char* strdup (char * str);
+
+TRX_STATUS getPortMappingRemoteHost(char **value)
+{
+    InstanceDesc *idp;
+
+    if ((idp = getCurrentInstanceDesc()) == NULL)
+        return TRX_ERR;
+
+    BfcTr69Api_GetFromSnmp(kOID_clabNATPortMappingRemoteHost, idp->hwUserData, value);
+
+    return TRX_OK;
+}
+
+TRX_STATUS setPortMappingRemoteHost(char *value)
+{ 
+    InstanceDesc *idp;
+    
+    if ((idp = getCurrentInstanceDesc()) == NULL)
+        return TRX_ERR;
+    if(value == NULL)
+        return TRX_ERR;
+
+    if(BfcTr69Api_SnmpSetString(kOID_clabNATPortMappingRemoteHost, idp->hwUserData, value))
+        return TRX_OK;
+
+    return TRX_ERR;
+}

+TRX_STATUS addPortMappingInstance(char **value)
+{
+    InstanceDesc *idp;
+
+    if ((idp = getNewInstanceDesc(getCurrentNode(), getCurrentInstanceDesc(), 0)))//添加新節點
+    {
+        idp->hwUserData = *value;
+        idp->instanceID = BfcTr69Api_SnmpToTr69Index(idp->hwUserData);//此api僅從snmp獲取相應節點id，作用不詳
+        return TRX_OK;
+    }
+    return TRX_ERR;
+}
+
+TRX_STATUS deletePortMappingInstance(char *value)
+{
+    TRxObjNode *n;
+    InstanceDesc *idp;
+    int id = atoi(value);
+    
+    if ((idp = findInstanceDesc(n=getCurrentNode(), id)))
+    {
+        if (!deleteInstanceDesc(n, id))//刪除節點，但不會通知snmp刪除相應節點
+        {
+            return TRX_OK;
+        }
+    }
+    return TRX_ERR;
+}
+
+} // extern "C"

3) 修改BfcTR69.mak

因新增加了tr181i2NATPortMappingParams.c和BcmBfcTr181i2NATPortMappingHandlers.cpp文件，需要修改Makefile:

+++ b/REV/rbb_cm_src/Bfc/make/BfcTR69.mak

 BFC_TR69C_OBJECTS += BcmBfcTr181i2NATHandlers.o
+BFC_TR69C_OBJECTS += BcmBfcTr181i2NATPortMappingHandlers.o
 BFC_TR69C_OBJECTS += BcmBfcTr181i2UPnPHandlers.o

 BFC_TR69C_OBJECTS += tr181i2NATParams.o
+BFC_TR69C_OBJECTS += tr181i2NATPortMappingParams.o
 BFC_TR69C_OBJECTS += tr181i2UPnPParams.o

4) 增加SNMP對節點的實現

依照目前的實現，TR069對節點/參數的操作，最終是通過SNMP Agent來達成。如果要新添加的節點/參數還未包含在SNMP Agent中，

需先增加SNMP Agent對此節點/參數的實現，包括mib定義，節點的Add/Del。

五. 改善或問題

1. set parameter時的數據有效性檢測

目前的實現中，tr69c/SOAPParser/RPCState.c char *doSetParameterValues(RPCAction *a)

有支持對參數名稱/參數是否可寫做檢查，但對設置值的有效性檢查只有簡單的“對非字符型參數不可設置為空”做了檢查，而未對數據范圍等做檢查。 改進的方法可擴展參數設置SetFunc()的返回類型，在SetFunc中檢查數據有效性，如數據無效，返回9007.

2. 增加/刪除節點與SNMP同步　　

從目前已有實現節點中來看，當TR069 Add/Del一個節點時，並沒有通知SNMP Add/Del相應節點。而TR069的Get/Set又依賴於SNMP，理論上，TR069和SNMP的Add/Del節點操作應該需要同步。

3. 節點模板　　

構建節點數據結構的形式相對固定，設想可用模板程序根據節點信息自動生成。如從xml -> *.c