TOECAM

Content-Addressable Memory (CAM) for the TCP Offload Engine (TOE) of the Network Transport Stack (NTS). More...

Collaboration diagram for TOECAM:

Modules
	TOECAM_TEST
	Testbench for the Content-Addressable Memory (CAM) for the TCP Offload Engine (TOE) of the Network Transport Stack (NTS).

Files
file	test_toecam.cpp
	: Testbench for the Content-Addressable Memory (CAM).

Classes
class	KeyValuePair< K, V >

Macros
#define	THIS_NAME   "TOECAM"
#define	TRACE_OFF   0x0000
#define	TRACE_CAM   1 << 1
#define	TRACE_ALL   0xFFFF
#define	DEBUG_LEVEL   (TRACE_OFF)
#define	MAX_CAM_LATENCY   0
#define	CAM_ARRAY_SIZE   2

Functions
bool	camLookup (FourTuple key, RtlSessId &value)
	Search the CAM array for a key. More...
bool	camInsert (KeyValuePair kVP)
	Insert a new key-value pair in the CAM array. More...
bool	camDelete (FourTuple key)
	Remove a key-value pair from the CAM array. More...
void	toecam (ap_uint< 1 > *poMMIO_CamReady, stream< CamSessionLookupRequest > &siTOE_SssLkpReq, stream< CamSessionLookupReply > &soTOE_SssLkpRep, stream< CamSessionUpdateRequest > &siTOE_SssUpdReq, stream< CamSessionUpdateReply > &soTOE_SssUpdRep)
	Main process of the Content-Addressable Memory (TOECAM). More...
void	toecam_top (ap_uint< 1 > *poMMIO_CamReady, stream< CamSessionLookupRequest > &siTOE_SssLkpReq, stream< CamSessionLookupReply > &soTOE_SssLkpRep, stream< CamSessionUpdateRequest > &siTOE_SssUpdReq, stream< CamSessionUpdateReply > &soTOE_SssUpdRep)
	Top of Content-Addressable Memory (TOECAM). More...

Variables
bool	gTraceEvent

Detailed Description

Content-Addressable Memory (CAM) for the TCP Offload Engine (TOE) of the Network Transport Stack (NTS).

Macro Definition Documentation

CAM_ARRAY_SIZE

#define CAM_ARRAY_SIZE   2

GLOBAL VARIABLES & DEFINES

Definition at line 62 of file toecam.cpp.

DEBUG_LEVEL

#define DEBUG_LEVEL   (TRACE_OFF)

Definition at line 52 of file toecam.cpp.

MAX_CAM_LATENCY

#define MAX_CAM_LATENCY   0

Definition at line 57 of file toecam.cpp.

THIS_NAME

#define THIS_NAME   "TOECAM"

Definition at line 46 of file toecam.cpp.

TRACE_ALL

#define TRACE_ALL   0xFFFF

Definition at line 50 of file toecam.cpp.

TRACE_CAM

#define TRACE_CAM   1 << 1

Definition at line 49 of file toecam.cpp.

TRACE_OFF

#define TRACE_OFF   0x0000

Definition at line 48 of file toecam.cpp.

Function Documentation

camDelete()

bool camDelete

(

FourTuple

key

)

Remove a key-value pair from the CAM array.

Parameters

[in]

key

The key of the entry to be removed.

Returns

true if the the key was deleted.

Definition at line 174 of file toecam.cpp.

{
    #pragma HLS pipeline II=1 enable_flush
 
    if ((CamArray0.key == key) && (CamArray0.valid == true)) {
        CamArray0.valid = false;
        return true;
    }
    else if ((CamArray1.key == key) && (CamArray1.valid == true)) {
        CamArray1.valid = false;
        return true;
    }
    else if ((CamArray2.key == key) && (CamArray2.valid == true)) {
        CamArray2.valid = false;
        return true;
    }
    else if ((CamArray3.key == key) && (CamArray3.valid == true)) {
        CamArray3.valid = false;
        return true;
    }
    else if ((CamArray4.key == key) && (CamArray4.valid == true)) {
        CamArray4.valid = false;
        return true;
    }
    else if ((CamArray5.key == key) && (CamArray5.valid == true)) {
        CamArray5.valid = false;
        return true;
    }
    else if ((CamArray6.key == key) && (CamArray6.valid == true)) {
        CamArray6.valid = false;
        return true;
    }
    else if ((CamArray7.key == key) && (CamArray7.valid == true)) {
         CamArray7.valid = false;
         return true;
     }
    else
        return false;
}

Here is the caller graph for this function:

camInsert()

bool camInsert

(

KeyValuePair

kVP

)

Insert a new key-value pair in the CAM array.

Parameters

[in]

KeyValuePair

The key-value pair to insert.

Returns

true if the the key was inserted.

Definition at line 126 of file toecam.cpp.

{
    #pragma HLS pipeline II=1 enable_flush
 
    if (CamArray0.valid == false) {
        CamArray0 = kVP;
        return true;
    }
    else if (CamArray1.valid == false) {
        CamArray1 = kVP;
        return true;
    }
    else if (CamArray2.valid == false) {
         CamArray2 = kVP;
         return true;
     }
    else if (CamArray3.valid == false) {
         CamArray3 = kVP;
         return true;
    }
    else if (CamArray4.valid == false) {
        CamArray4 = kVP;
        return true;
    }
    else if (CamArray5.valid == false) {
        CamArray5 = kVP;
        return true;
    }
    else if (CamArray6.valid == false) {
         CamArray6 = kVP;
         return true;
     }
    else if (CamArray7.valid == false) {
         CamArray7 = kVP;
         return true;
     }
    else {
        return false;
    }
}

Here is the caller graph for this function:

camLookup()

bool camLookup	(	FourTuple	key,
		RtlSessId &	value
	)

Search the CAM array for a key.

Parameters

[in]	key	The key to lookup.
[out]	value	The value corresponding to that key.

Returns

true if the the key was found.

Definition at line 80 of file toecam.cpp.

{
    #pragma HLS pipeline II=1 enable_flush
    if ((CamArray0.key == key) && (CamArray0.valid == true)) {
        value = CamArray0.value;
        return true;
    }
    else if ((CamArray1.key == key) && (CamArray1.valid == true)) {
        value = CamArray1.value;
        return true;
    }
    else if ((CamArray2.key == key) && (CamArray2.valid == true)) {
        value = CamArray2.value;
        return true;
    }
    else if ((CamArray3.key == key) && (CamArray3.valid == true)) {
            value = CamArray3.value;
            return true;
    }
    else if ((CamArray4.key == key) && (CamArray4.valid == true)) {
            value = CamArray4.value;
            return true;
    }
    else if ((CamArray5.key == key) && (CamArray5.valid == true)) {
            value = CamArray5.value;
            return true;
    }
    else if ((CamArray6.key == key) && (CamArray6.valid == true)) {
            value = CamArray6.value;
            return true;
    }
    else if ((CamArray7.key == key) && (CamArray7.valid == true)) {
            value = CamArray7.value;
            return true;
    }
    else
        return false;
}

Here is the caller graph for this function:

toecam()

void toecam	(	ap_uint< 1 > *	poMMIO_CamReady,
		stream< CamSessionLookupRequest > &	siTOE_SssLkpReq,
		stream< CamSessionLookupReply > &	soTOE_SssLkpRep,
		stream< CamSessionUpdateRequest > &	siTOE_SssUpdReq,
		stream< CamSessionUpdateReply > &	soTOE_SssUpdRep
	)

Main process of the Content-Addressable Memory (TOECAM).

Parameters

[out]	poMMIO_CamReady	A pointer to a CAM ready signal.
[in]	siTOE_SssLkpReq	Session lookup request from TCP Offload Engine (TOE).
[out]	soTOE_SssLkpRep	Session lookup reply to [TOE].
[in]	siTOE_SssUpdReq	Session update request from TOE.
[out]	soTOE_SssUpdRep	Session update reply to TOE.

Warning

About data structure packing: The bit alignment of a packed wide-word is inferred from the declaration order of the struct fields. The first field takes the least significant sector of the word and so forth until all fields are mapped. Also, note that the DATA_PACK optimization does not support packing structs which contain other structs. Finally, make sure to achieve II=1, otherwise co-simulation will not work.

Definition at line 233 of file toecam.cpp.

{
    //-- DIRECTIVES FOR THE INTERFACES -----------------------------------------
    #pragma HLS INTERFACE ap_ctrl_none port=return
    #pragma HLS INLINE
    #pragma HLS PIPELINE II=1 enable_flush
 
    const char *myName  = concat3(THIS_NAME, "/", "CAM");
 
    //-- STATIC ARRAYS ---------------------------------------------------------
    #pragma HLS RESET      variable=CamArray0
    #pragma HLS RESET      variable=CamArray1
    #pragma HLS RESET      variable=CamArray2
    #pragma HLS RESET      variable=CamArray3
    #pragma HLS RESET      variable=CamArray4
    #pragma HLS RESET      variable=CamArray5
    #pragma HLS RESET      variable=CamArray6
    #pragma HLS RESET      variable=CamArray7
 
    //-- STATIC CONTROL VARIABLES (with RESET) ---------------------------------
    static enum FsmStates { CAM_WAIT_4_REQ=0, CAM_LOOKUP_REP, CAM_UPDATE_REP } \
                               cam_fsmState=CAM_WAIT_4_REQ;
    #pragma HLS RESET variable=cam_fsmState
    static int                 cam_startupDelay = 100;
    #pragma HLS RESET variable=cam_startupDelay
 
    //-- STATIC DATAFLOW VARIABLES --------------------------------------------
    static CamSessionLookupRequest cam_request;
    static CamSessionUpdateRequest cam_update;
    static int                     cam_idleCnt = 0;
 
    //-----------------------------------------------------
    //-- EMULATE STARTUP OF CAM
    //-----------------------------------------------------
    if (cam_startupDelay) {
        *poMMIO_CamReady = 0;
        cam_startupDelay--;
        return;
    }
    else {
        *poMMIO_CamReady = 1;
    }
 
    //-----------------------------------------------------
    //-- CONTENT ADDRESSABLE MEMORY PROCESS
    //-----------------------------------------------------
    switch (cam_fsmState) {
    case CAM_WAIT_4_REQ:
        if (!siTOE_SssLkpReq.empty()) {
            siTOE_SssLkpReq.read(cam_request);
            cam_idleCnt = MAX_CAM_LATENCY;
            cam_fsmState = CAM_LOOKUP_REP;
        }
        else if (!siTOE_SssUpdReq.empty()) {
            siTOE_SssUpdReq.read(cam_update);
            cam_idleCnt = MAX_CAM_LATENCY;
            cam_fsmState = CAM_UPDATE_REP;
        }
        break;
    case CAM_LOOKUP_REP:
        //-- Wait some cycles to match the co-simulation --
        if (cam_idleCnt > 0) {
            cam_idleCnt--;
        }
        else {
            RtlSessId  rtlValue;
            bool hit = camLookup(cam_request.key, rtlValue);
            if (hit)
                soTOE_SssLkpRep.write(CamSessionLookupReply(true, rtlValue, cam_request.source));
            else
                soTOE_SssLkpRep.write(CamSessionLookupReply(false, cam_request.source));
            if (DEBUG_LEVEL & TRACE_CAM) {
                printInfo(myName, "Received a session lookup request from %d for socket pair: \n",
                          cam_request.source.to_int());
                LE_SocketPair leSocketPair(LE_SockAddr(cam_request.key.theirIp, cam_request.key.theirPort),
                LE_SockAddr(cam_request.key.myIp,    cam_request.key.myPort));
                printSockPair(myName, leSocketPair);
            }
            cam_fsmState = CAM_WAIT_4_REQ;
        }
        break;
    case CAM_UPDATE_REP:
        //-- Wait some cycles to match the co-simulation --
        if (cam_idleCnt > 0) {
            cam_idleCnt--;
        }
        else {
            // [TODO - What if element does not exist]
            if (cam_update.op == INSERT) {
                //Is there a check if it already exists?
                camInsert(KeyValuePair(cam_update.key, cam_update.value, true));
                soTOE_SssUpdRep.write(CamSessionUpdateReply(cam_update.value, INSERT, cam_update.source));
            }
            else {  // DELETE
                camDelete(cam_update.key);
                soTOE_SssUpdRep.write(CamSessionUpdateReply(cam_update.value, DELETE, cam_update.source));
            }
            if (DEBUG_LEVEL & TRACE_CAM) {
                printInfo(myName, "Received a session cam_update request (%d) from %d for socket pair: \n",
                          cam_update.op, cam_update.source.to_int());
                LE_SocketPair leSocketPair(LE_SockAddr(cam_request.key.theirIp, cam_request.key.theirPort),
                LE_SockAddr(cam_request.key.myIp,    cam_request.key.myPort));
                printSockPair(myName, leSocketPair);
            }
            cam_fsmState = CAM_WAIT_4_REQ;
        }
        break;
 
    } // End-of: switch()
 
}

Here is the call graph for this function:

Here is the caller graph for this function:

toecam_top()

void toecam_top	(	ap_uint< 1 > *	poMMIO_CamReady,
		stream< CamSessionLookupRequest > &	siTOE_SssLkpReq,
		stream< CamSessionLookupReply > &	soTOE_SssLkpRep,
		stream< CamSessionUpdateRequest > &	siTOE_SssUpdReq,
		stream< CamSessionUpdateReply > &	soTOE_SssUpdRep
	)

Top of Content-Addressable Memory (TOECAM).

Parameters

[out]	poMMIO_CamReady	A pointer to a CAM ready signal.
[in]	siTOE_SssLkpReq	Session lookup request from TCP Offload Engine (TOE).
[out]	soTOE_SssLkpRep	Session lookup reply to [TOE].
[in]	siTOE_SssUpdReq	Session update request from TOE.
[out]	soTOE_SssUpdRep	Session update reply to TOE.

ENTITY - CONTENT ADDRESSABLE MEMORY (TOECAM)

Definition at line 414 of file toecam.cpp.

{
    //-- DIRECTIVES FOR THE INTERFACES -----------------------------------------
    #pragma HLS INTERFACE ap_ctrl_none port=return
 
    #pragma HLS INTERFACE ap_none register port=poMMIO_CamReady name=poMMIO_CamReady
 
    #pragma HLS INTERFACE axis off              port=siTOE_SssLkpReq
    #pragma HLS DATA_PACK                   variable=siTOE_SssLkpReq
    #pragma HLS INTERFACE axis register both     port=soTOE_SssLkpRep
    #pragma HLS DATA_PACK                   variable=soTOE_SssLkpRep
    #pragma HLS INTERFACE axis off              port=siTOE_SssUpdReq
    #pragma HLS DATA_PACK                   variable=siTOE_SssUpdReq
    #pragma HLS INTERFACE axis register both    port=soTOE_SssUpdRep
    #pragma HLS DATA_PACK                   variable=soTOE_SssUpdRep
 
    //-- DIRECTIVES FOR THIS PROCESS -------------------------------------------
    #pragma HLS DATAFLOW disable_start_propagation
 
    //-- MAIN IPTX PROCESS -----------------------------------------------------
    toecam(
        //-- MMIO Interfaces
        poMMIO_CamReady,
        //-- CAM / This / Session Lookup & Update Interfaces
        siTOE_SssLkpReq,
        soTOE_SssLkpRep,
        siTOE_SssUpdReq,
        soTOE_SssUpdRep);
 
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

gTraceEvent

bool gTraceEvent

extern

HELPERS FOR THE DEBUGGING TRACES .e.g: DEBUG_LEVEL = (MDL_TRACE | IPS_TRACE)

Definition at line 151 of file tb_nal.cpp.