ofc_tdfs.h

/********************************************************************
*
* Filename: ofc_tdfs.h
*
* Description: This file contains structures and enums used in
*              OpenFlow client kernel module.
*
*******************************************************************/

#ifndef __OFC_TDFS_H__
#define __OFC_TDFS_H__

#include "ofc_pkt.h"

/* Common structures */
typedef struct
{
    struct task_struct *pOfcDpThread;
    struct task_struct *pOfcCpThread;
    struct nf_hook_ops netFilterOps;
    int                aDataIfSockFd[OFC_MAX_OF_IF_NUM];
    char               aDataIfName[OFC_MAX_IFNAME_LEN];
    char               aCntrlIfName[OFC_MAX_IFNAME_LEN];
    int                events;
} tOfcGlobals;

/* Data path structures */
typedef struct
{
    struct list_head list;
    __u8             *pDataPkt;
    __u16            dataPktLen;
    int              dataIfNum;
} tDataPktRxIfQ;

typedef struct
{
    struct socket      *aDataSocket[OFC_MAX_OF_IF_NUM];
    struct task_struct *aDataPktRxThread[OFC_MAX_OF_IF_NUM];
    struct semaphore   semId;
    struct semaphore   dataPktQSemId;
    struct semaphore   cpMsgQSemId;
    struct list_head   pktRxIfListHead; /* Queue for interfaces on which
                                       * data packet is received */
    struct list_head   cpMsgListHead;   /* Queue for messages from
                                       * control path sub module */
    struct list_head   flowTableListHead;
    int                events;
} tOfcDpGlobals;

/* Control path structures */
typedef struct
{
    struct socket    *pCntrlSocket;
    struct semaphore semId;
    struct semaphore dpMsgQSemId;
    struct list_head dpMsgListHead; /* Queue for messages rx from
                                     * data path sub module */
    int              events;
    int              isModInit;
    __u32            numCntrlPktInQ;
} tOfcCpGlobals;

#if 0
typedef struct _tOfcEightByte
{    
    __u32   hi;     
    __u32   lo;                    
} tOfcEightByte;
#endif

typedef struct
{
    __u32  targetIpAddr;
} tArpMtchFlds;

typedef struct
{
    __u8          inPort;
    __u8          aDstMacAddr[OFC_MAC_ADDR_LEN];
    __u8          aSrcMacAddr[OFC_MAC_ADDR_LEN];
    __u16         vlanId;
    __u16         etherType;
    __u8          protocolType;
    __u32         srcIpAddr;
    __u32         dstIpAddr;
    __u16         srcPortNum;
    __u16         dstPortNum;
    __u8          l4HeaderType;
    tArpMtchFlds  arpFlds;
} tOfcMatchFields;

typedef struct
{
    struct list_head  list;
    struct list_head  flowEntryList;
    __u32             tableId;
    __u8              numMatch;
    __u32             activeCount;
    __u32             lookupCount;
    __u32             matchCount;
    __u32             maxEntries;
    __u8              aTableName[32];
} tOfcFlowTable;

typedef struct
{
    struct list_head   list; 
    __u64              byteMatchCount;
    __u64              pktMatchCount;
    __u32              hardTimeout;
    __u32              idleTimeout;
    tOfcEightByte      cookie;
    tOfcEightByte      cookieMask;
    __u16              flags;
    __u16              priority;
    __u32              bufId;
    __u32              outPort;
    __u32              outGrp;
    __u32              tableId;
    __u32              matchCount;
    struct list_head   matchList;
    struct list_head   instrList;
    tOfcMatchFields    matchFields;
} tOfcFlowEntry;

typedef struct
{
    struct list_head list;
    tOfcFlowEntry    *pFlowEntry;
    struct list_head *pActionListHead;
    __u8             *pPkt;
    __u32            pktLen;
    __u8             inPort;
    __u8             msgType;
    __u8             tableId;
    tOfcEightByte    cookie;
} tDpCpMsgQ;

typedef struct
{
    struct list_head list;
    __u8             field;
    __u8             length;
    /* TODO: Masks not supported */
    __u8             aValue[16];
} tMatchListEntry;

typedef struct
{
    struct list_head list;
    __u16            instrType;
    union
    {
       __u8             tableId;
       struct list_head actionList;
    } u;

} tOfcInstrList;

typedef struct
{
    struct list_head list;
    __u16            actionType;
    union
    {
        __u32            outPort;
        struct list_head setFieldList;
    } u;

} tOfcActionList;

typedef struct 
{
    struct list_head list;
    __u16            type;
    __u8             aPad[2];
    __u8             aValue[16];
} tOfcSetFields;

typedef struct
{
    struct list_head list;
    __u32            outPort;
} tOfcOutPortList;

enum
{
    OFC_FLOW_MOD_ADD = 0,
    OFC_FLOW_MOD_DEL,
    OFC_PACKET_OUT
};

/* Function Declarations */
int OfcDpReceiveEvent (int events, int *pRxEvents);
int OfcDpSendEvent (int events);
void OfcDumpPacket (char *au1Packet, int len);
void OfcDumpFlows (__u8 tableId);
int OfcDumpFlowFields (tOfcFlowEntry *pFlowEntry);
struct net_device *OfcGetNetDevByName (char *pIfName);
struct net_device *OfcGetNetDevByIp (unsigned int ipAddr);
int OfcConvertStringToIp (char *pString, unsigned int *pIpAddr);
int OfcDeleteList (struct list_head *pListHead);
int OfcCalcHdrOffset (__u8 *pPkt, __u16 pktLen, __u8 hdrField,
                      __u16 *pPktOffset);

int OfcDpMainTask (void *args);
int OfcDpCreateSocketsForDataPkts (void);
int OfcDpCreateThreadsForRxDataPkts (void);
int OfcDpRxDataPacket (void);
int OfcDpSendToDataPktQ (int dataIfNum, __u8 *pDataPkt, 
                         __u16 dataPktLen);
tDataPktRxIfQ *OfcDpRecvFromDataPktQ (void);
tDpCpMsgQ *OfcDpRecvFromCpMsgQ (void);
int OfcDpSendToCpQ (tDpCpMsgQ *pMsgParam);
int OfcDpCreateFlowTables (void);
__u32 OfcDpRcvDataPktFromSock (__u8 dataIfNum, __u8 **ppPkt,
                               __u32 *pPktLen);
int OfcDpSendDataPktOnSock (__u8 dataIfNum, __u8 *pPkt,
                            __u32 pktLen);
tOfcFlowTable *OfcDpGetFlowTableEntry (__u8 tableId);
int OfcDpRxDataPktThread (void *args);
int OfcDpProcessPktOpenFlowPipeline (__u8 *pPkt, __u32 pktLen,
                                     __u8 inPort);
int OfcDpExecuteFlowInstr (__u8 *pPkt, __u32 pktLen, __u8 inPort,
                           struct list_head *pInstrList, __u8 *pTableId,
                           __u32 *pOutPortList, __u8 *pNumOutPorts);
int OfcDpApplyInstrActions (__u8 *pPkt, __u32 pktLen, __u8 inPort,
                            struct list_head *pActionsList,
                            __u32 *pOutPortList, __u8 *pNumOutPorts);
tOfcFlowEntry *OfcDpGetBestMatchFlow (tOfcMatchFields pktMatchFields,
                                      struct list_head *pFlowEntryList,
                                      __u8 *pIsTableMiss);
int OfcDpExtractPktHdrs (__u8 *pPkt, __u32 pktLen, __u8 inPort,
                         tOfcMatchFields *pPktMatchFields);
int OfcDpRxControlPathMsg (void);
int OfcDpInsertFlowEntry (tOfcFlowEntry *pFlowEntry);
int OfcDpDeleteFlowEntry (tOfcFlowEntry *pFlowEntry);
int OfcDpExecPktOutActions (__u8 *pPkt, __u16 pktLen,
                            struct list_head *pActionsListHead);

int OfcCpMainTask (void *args);
int OfcCpReceiveEvent (int events, int *pRxEvents);
int OfcCpSendEvent (int events);
int OfcCpCreateCntrlSocket (void);
int OfcCpRxControlPacket (void);
int OfcCpSendToDpQ (tDpCpMsgQ *pMsgParam);
tDpCpMsgQ *OfcCpRecvFromDpMsgQ (void);
int OfcCpSendToCntrlPktQ (void);
__u32 OfcCpRecvFromCntrlPktQ (void);
int OfcCpRecvCntrlPktOnSock (__u8 **ppPkt, __u16 *pPktLen);
int OfcCpSendCntrlPktFromSock (__u8 *pPkt, __u32 pktLen);
void OfcCpRxDataPathMsg (void);
int OfcCpAddOpenFlowHdr (__u8 *pPktHdr, __u16 pktHdrLen,
                         __u8 msgType, __u32 xid,
                         __u8 **ppOfPkt);
int OfcCpSendHelloPacket (__u32 xid);
int OfcCpSendEchoReply (__u8 *pCntrlPkt, __u16 cntrlPktLen);
int OfcCpSendFeatureReply (__u8 *pCntrlPkt);
int OfcCpConstructPacketIn (__u8 *pPkt, __u32 pktLen, __u8 inPort,
                            __u8 msgType, __u8 tableId,
                            tOfcEightByte cookie,
                            tOfcMatchFields matchFields,
                            __u8 **ppOpenFlowPkt);
int OfcCpProcessPktOut (__u8 *pPkt, __u16 pktLen);
int OfcCpProcessFlowMod (__u8 *pPkt, __u16 pktLen);
tOfcFlowEntry *OfcCpExtractFlow (tOfcFlowModHdr *pFlowMod,
                                 __u16 flowModLen);
int OfcCpAddMatchFieldsInFlow (tOfcFlowModHdr *pFlowMod, __u16 flowModLen,
                               tOfcFlowEntry *pFlowEntry);
int OfcCpAddInstrListInFlow (tOfcFlowModHdr *pFlowMod,
                             __u16 flowModLen,
                             tOfcFlowEntry *pFlowEntry);
int OfcCpAddActionListToInstr (tOfcActionTlv *pActionTlv,
                               __u16 actionTlvLen,
                               tOfcInstrList *pInstrList);
int OfcCpProcessMultipartReq (__u8 *pCntrlPkt, __u16 cntrlPktLen);
int OfcCpHandleMultipartSwitchDesc (__u8 *pCntrlPkt,
                                    __u16 cntrlPktLen);
int OfcCpHandleMultipartPortDesc (__u8 *pCntrlPkt, __u16 cntrlPktLen);
int OfcCpSendBarrierReply (__u32 xid);

#endif /* __OFC_TDFS_H__ */