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