0731-84728105
15116127200
FAST軟件編程基礎(2)FAST編程API
發布時間:2019-04-19
     FAST編程庫Libua.a和(hé)linreg.a為(wèi)Fast軟件編程提供标準編程API。Fast編程API主要分為(wèi)三類。一(yī)是用戶UA編程API,用戶可(kě)在UA進程中直接調用這些API函數實現與FAST平台的(de)通信,包含UA管理(lǐ)、分組收發和(hé)FAST流水線管理(lǐ)三類;二是Fast平台管理(lǐ)API,實現對Fast硬件平台中FPGA OS的(de)管理(lǐ);三是擴展API,即面向FAST流水線中特定硬件模塊特定功能而設計的(de)API。
一(yī)、UA編程API
      UA編程使用的(de)基本API如(rú)下表所示。如(rú)果用戶沒有(yǒu)向硬件流水線中添加自(zì)定義的(de)模塊,那麽用戶UA隻使用以下6個函數就可(kě)以實現與Fast平台的(de)交互。如(rú)果用戶向Fast流水線中添加了定制的(de)模塊,則需要根據所添加硬件模塊的(de)功能對編程API進行(xíng)擴充。
     為(wèi)了簡化UA對硬件流水線模塊的(de)管理(lǐ),Fast編程API提供了讀寫硬件模塊的(de)函數。在Fast編程庫函數實現時,上述讀寫函數均被轉換成控制類的(de)Fast分組發往硬件流水線,并通過流水線的(de)Cin/Cout控制環操作實現對分組的(de)讀寫。
上表中的(de)6個API函數的(de)原型和(hé)參數說明如(rú)下。
   (1)int fast_ua_init(int mid, fast_ua_recv_callbackcallback);
     輸入參數mid為(wèi)用戶為(wèi)UA設置的(de)模塊号,該模塊号是FAST平台對軟硬件模塊的(de)唯一(yī)标識。根據FAST規範,軟件UA的(de)mid範圍是128-255,由于128默認為(wèi)內(nèi)核協議棧,因此用戶UA的(de)mid範圍可(kě)設置為(wèi)129-255。用戶需保證mid參數不與系統中其他UA的(de)參數沖突,如(rú)果發生沖突,函數返回值為(wèi)1,表明注冊失敗。輸入參數callback為(wèi)Fast平台在接收到發往用戶UA的(de)分組時的(de)回調函數,用戶需要在程序中對callback函數進行(xíng)定義。如(rú)果UA注冊成功,函數返回值為(wèi)0,否則返回非0值。
   (2)void fast_ua_destroy(void);
     用戶UA在退出時需執行(xíng)的(de)操作,主要是通知FAST平台釋放向UA分配的(de)mid編号。
   (3)int fast_ua_send(struct fast_packet *pkt,int pkt_len);
     用戶UA調用該函數向Fast平台發送分組。其中pkt是指向fast_packet數據結構的(de)指針。該數據結構包含了指向分組緩沖區的(de)指針以及分組的(de)目的(de)mid等參數。執行(xíng)成功返回報文長(cháng)度,執行(xíng)失敗返回-1。用戶在調用該函數時,需要注意以下兩點。一(yī)是如(rú)果UA想直接将分組從Fast平台的(de)網絡接口發出,需要将dmid設置為(wèi)5,即将目的(de)模塊設置為(wèi)Fast硬件流水線中的(de)通用輸出模塊(GOE),同時設置Outport和(hé)Outtype字段,指明輸出的(de)類型(單播/組播/廣播)以及輸出端口号或組播ID;二是如(rú)果UA想将分組發送給其他的(de)UA,則需要将dmid設置為(wèi)UA的(de)mid編号。一(yī)個用戶UA如(rú)何獲取其他UA的(de)mid不是Fast規範考慮的(de)問題。
   (4)void fast_ua_recv();
     UA啓動接收FAST報文。每當Fast內(nèi)核接收到目的(de)mid為(wèi)用戶UAmid的(de)分組後,會通過Netlink機(jī)制将分組拷貝到用戶空間,并調用UA初始化時設置好的(de)callback回調函數對報文進行(xíng)處理(lǐ)。
   (5)u32 fast_ua_hw_rd(u8 dmid, u32addr, u32 mask);
     其中dmid為(wèi)讀操作的(de)硬件流水線模塊号,addr為(wèi)模塊內(nèi)部的(de)讀地(dì)址偏移量。mask為(wèi)讀數據的(de)掩碼,目前未使用,用戶應将mask設置為(wèi)0。
   (6)void fast_ua_hw_wr(u8dmid,u32 addr,u32 value,u32 mask);
     其中dmid為(wèi)寫操作的(de)硬件流水線模塊号,addr為(wèi)模塊內(nèi)部的(de)寫地(dì)址偏移量,value為(wèi)寫數據的(de)值。mask為(wèi)寫數據的(de)掩碼,目前未使用,用戶需設置為(wèi)0。
三、擴展API
     根據Fast流水線的(de)規範,用戶可(kě)以根據分組處理(lǐ)的(de)需求對Fast硬件流水線中的(de)模塊進行(xíng)擴展和(hé)定制。因此對于不同硬件流水線模塊也會産生不同的(de)擴展API。
     典型的(de)例子(zǐ)是基于Fast的(de)SDN交換實現中,硬件流水線包含了GPP,GKE,GME,GAC和(hé)GOE5個功能模塊。用戶UA可(kě)能需要對這些功能模塊進行(xíng)管理(lǐ)。例如(rú)配置GME模塊的(de)規則表和(hé)GAC模塊中的(de)動作表等。雖然規則表和(hé)動作表在模塊中具有(yǒu)固定的(de)偏移地(dì)址,UA可(kě)使用fast_ua_hw_rd()和(hé)fast_ua_hw_wr()函數對其管理(lǐ),但這樣十分複雜。為(wèi)此,可(kě)基于基礎的(de)fast_ua_hw_rd()和(hé)fast_ua_hw_wr()函數,再封裝成fast_rule_add()和(hé)fast_rule_del()等擴展的(de)API,簡化用戶UA編程的(de)複雜性。
      關于Fast通用模塊的(de)擴展API我們将在後續文章(zhāng)中介紹。