nal.hpp

Go to the documentation of this file.

 
 
#ifndef _NAL_H_
#define _NAL_H_
 
#include <stdio.h>
#include <iostream>
#include <fstream>
#include <string>
#include <math.h>
#include <hls_stream.h>
#include "ap_int.h"
#include <stdint.h>
 
 
// CTRL LINK DEFINITONS
// =====================
 
//#define NAL_AXI_CTRL_REGISTER 0
 
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_BASE 0x2000
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH 0x3fff
//#define NAL_CTRL_LINK_SIZE (XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH/4)
//#define NAL_CTRL_LINK_CONFIG_START_ADDR (0x2000/4)
//#define NAL_CTRL_LINK_CONFIG_END_ADDR (0x203F/4)
//#define NAL_CTRL_LINK_STATUS_START_ADDR (0x2040/4)
//#define NAL_CTRL_LINK_STATUS_END_ADDR (0x207F/4)
//#define NAL_CTRL_LINK_MRT_START_ADDR (0x2080/4)
//#define NAL_CTRL_LINK_MRT_END_ADDR (0x307F/4)
 
 
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_BASE 0x400
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH 0x7ff
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_WIDTH_CTRLLINK_V     32
//#define XNAL_PIFMC_NAL_CTRLLINK_AXI_DEPTH_CTRLLINK_V     160
//#define NAL_CTRL_LINK_SIZE (XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH/4)
//#define NAL_CTRL_LINK_CONFIG_START_ADDR (0x400/4)
//#define NAL_CTRL_LINK_CONFIG_END_ADDR (0x43F/4)
//#define NAL_CTRL_LINK_STATUS_START_ADDR (0x440/4)
//#define NAL_CTRL_LINK_STATUS_END_ADDR (0x47F/4)
//#define NAL_CTRL_LINK_MRT_START_ADDR (0x480/4)
//#define NAL_CTRL_LINK_MRT_END_ADDR (0x67F/4)
 
// MRT size 64
#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_BASE 0x200
#define XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH 0x3ff
#define XNAL_PIFMC_NAL_CTRLLINK_AXI_WIDTH_CTRLLINK_V     32
#define XNAL_PIFMC_NAL_CTRLLINK_AXI_DEPTH_CTRLLINK_V     96
#define NAL_CTRL_LINK_SIZE (XNAL_PIFMC_NAL_CTRLLINK_AXI_ADDR_CTRLLINK_V_HIGH/4)
#define NAL_CTRL_LINK_CONFIG_START_ADDR (0x200/4)
#define NAL_CTRL_LINK_CONFIG_END_ADDR (0x23F/4)
#define NAL_CTRL_LINK_STATUS_START_ADDR (0x240/4)
#define NAL_CTRL_LINK_STATUS_END_ADDR (0x27F/4)
#define NAL_CTRL_LINK_MRT_START_ADDR (0x280/4)
#define NAL_CTRL_LINK_MRT_END_ADDR (0x37F/4)
 
// (CtrlLink definitions end)
 
//#define MAX_MRT_SIZE 1024
//#define MAX_MRT_SIZE 128
#define MAX_MRT_SIZE 64
 
 
#include "../../FMC/src/fmc.hpp"
 
#include "../../../../../hls/network.hpp"
#include "../../network_utils.hpp"
//#include "../../memory_utils.hpp"
#include "../../simulation_utils.hpp"
 
 
 
#ifndef __SYNTHESIS__
extern bool gTraceEvent;
#endif
 
#define THIS_NAME "NAL"
 
#define TRACE_OFF  0x0000
#define TRACE_RDP 1 <<  1
#define TRACE_WRP 1 <<  2
#define TRACE_SAM 1 <<  3
#define TRACE_LSN 1 <<  4
#define TRACE_CON 1 <<  5
#define TRACE_ALL  0xFFFF
 
#define DEBUG_LEVEL (TRACE_ALL)
 
enum DropCmd {KEEP_CMD=false, DROP_CMD};
 
 
 
//#define USE_DEPRECATED_DIRECTIVES
 
using namespace hls;
 
#define DEFAULT_TX_PORT 2718
#define DEFAULT_RX_PORT 2718
 
enum FsmStateUdp {FSM_RESET = 0, FSM_W8FORMETA, FSM_W8FORREQS, FSM_FIRST_ACC, FSM_ACC, \
  FSM_WRITE_META, FSM_DROP_PACKET};
 
enum OpnFsmStates {OPN_IDLE = 0, OPN_REQ, OPN_REP, OPN_DONE};
 
enum LsnFsmStates {LSN_IDLE = 0, LSN_SEND_REQ, LSN_WAIT_ACK, LSN_DONE};
 
enum RrhFsmStates {RRH_RESET = 0, RRH_WAIT_NOTIF, RRH_PROCESS_NOTIF, RRH_START_REQUEST, RRH_PROCESS_REQUEST, RRH_WAIT_FMC, RRH_WAIT_ROLE, RRH_DRAIN};
 
enum RrhEnqFsmStates {RRH_ENQ_RESET = 0, RRH_ENQ_STREAM};
 
enum RdpFsmStates {RDP_RESET = 0, RDP_WAIT_META, RDP_W8FORREQS_1, RDP_W8FORREQS_2, RDP_FILTER_META, RDP_STREAM_ROLE, RDP_STREAM_FMC, \
  RDP_WRITE_META_ROLE, RDP_WRITE_META_FMC, RDP_DROP_PACKET};
 
enum WrpFsmStates {WRP_RESET = 0, WRP_WAIT_META, WRP_STREAM_FMC, WRP_W8FORREQS_1,  WRP_W8FORREQS_11, WRP_W8FORREQS_2, WRP_W8FORREQS_22, WRP_WAIT_CONNECTION, \
  WRP_STREAM_ROLE, WRP_DROP_PACKET};
 
enum WbuFsmStates {WBU_WAIT_META = 0, WBU_SND_REQ, WBU_WAIT_REP, WBU_STREAM, WBU_DROP, WBU_DRAIN};
 
enum CacheInvalFsmStates {CACHE_WAIT_FOR_VALID = 0, CACHE_VALID, CACHE_INV_SEND_0, CACHE_INV_SEND_1, CACHE_INV_SEND_2, CACHE_INV_SEND_3};
 
enum ClsFsmStates {CLS_IDLE = 0, CLS_NEXT, CLS_WAIT4RESP};
 
enum DeqFsmStates {DEQ_WAIT_META = 0, DEQ_STREAM_DATA, DEQ_SEND_NOTIF};
 
enum TableFsmStates {TAB_FSM_READ = 0, TAB_FSM_WRITE};
 
enum AxiLiteFsmStates {A4L_RESET = 0, A4L_STATUS_UPDATE, A4L_COPY_CONFIG, A4L_COPY_CONFIG_2, \
  //A4L_BROADCAST_CONFIG_1, A4L_BROADCAST_CONFIG_2,
  A4L_COPY_MRT, A4L_COPY_STATUS, A4L_COPY_FINISH, A4L_WAIT_FOR_SUB_FSMS};
 
enum ConfigBcastStates {CB_WAIT = 0, CB_START, CB_1, CB_2, CB_3_0, CB_3_1, CB_3_2};
 
 
enum PortFsmStates {PORT_RESET = 0, PORT_IDLE, PORT_L4_RESET, PORT_NEW_UDP_REQ, PORT_NEW_UDP_REP, \
  PORT_NEW_FMC_REQ, PORT_NEW_FMC_REP, PORT_NEW_TCP_REQ, PORT_NEW_TCP_REP, PORT_L7_RESET, \
    PORT_WAIT_PR, PORT_START_TCP_CLS_0, PORT_START_TCP_CLS_1, PORT_START_TCP_CLS_2, PORT_START_UDP_CLS, PORT_SEND_UPDATE};
 
enum PortType {FMC = 0, UDP, TCP};
 
enum NalCntIncType {NID_MISS_RX = 0, NID_MISS_TX, PCOR_TX, TCP_CON_FAIL, LAST_RX_PORT, \
  LAST_RX_NID, LAST_TX_PORT, LAST_TX_NID, PACKET_RX, PACKET_TX, UNAUTH_ACCESS, \
    AUTH_ACCESS, FMC_TCP_BYTES};
 
 
#define MAX_NAL_SESSIONS (TOE_MAX_SESSIONS)
#define NAL_STREAMING_SPLIT_TCP (ZYC2_MSS)
//#define NAL_STREAMING_SPLIT_TCP (ZYC2_MSS - 8)
 
#define NAL_MAX_FIFO_DEPTHS_BYTES 2000 //does apply for ROLE and FMC FIFOs
#define NUMBER_CONFIG_WORDS 16
#define NUMBER_STATUS_WORDS 16
#define NAL_NUMBER_CONFIG_WORDS NUMBER_CONFIG_WORDS
#define NAL_NUMBER_STATUS_WORDS NUMBER_STATUS_WORDS
//#define NAL_READ_TIMEOUT 160000000 //is a little more than one second with 156Mhz
#define NAL_CONNECTION_TIMEOUT 160000000 //is a little more than one second with 156Mhz
#define NAL_TCP_RX_DATA_DELAY_CYCLES  80  //based on chipscope
 
#define NAL_MMIO_STABILIZE_TIME 150 //based on chipscope...
 
#define UNUSED_TABLE_ENTRY_VALUE 0x111000
#define UNUSED_SESSION_ENTRY_VALUE 0xFFFE
#define INVALID_MRT_VALUE 0xFFFFF
 
/*
 * ctrlLINK Structure:
 * 1.         0 --            NUMBER_CONFIG_WORDS -1 :  possible configuration from FMC to NAL
 * 2. NUMBER_CONFIG_WORDS --  NUMBER_STATUS_WORDS -1 :  possible status from NAL to FMC
 * 3. NUMBER_STATUS_WORDS 
 *     + NUMBER_STATUS_WORDS --  MAX_MRT_SIZE +
 *                              NUMBER_CONFIG_WORDS +
 *                              NUMBER_STATUS_WORDS    : Message Routing Table (MRT)
 *
 */
#define NAL_CONFIG_OWN_RANK 0
#define NAL_CONFIG_MRT_VERSION 1
#define NAL_CONFIG_SAVED_UDP_PORTS 2
#define NAL_CONFIG_SAVED_TCP_PORTS 3
#define NAL_CONFIG_SAVED_FMC_PORTS 4
 
#define NAL_STATUS_MRT_VERSION 0
#define NAL_STATUS_OPEN_UDP_PORTS 1
#define NAL_STATUS_OPEN_TCP_PORTS 2
#define NAL_STATUS_FMC_PORT_PROCESSED 3
#define NAL_STATUS_OWN_RANK 13
 
//#define NAL_STATUS_WRITE_ERROR_CNT 4
//#define NAL_STATUS_UNUSED_1 4
#define NAL_UNAUTHORIZED_ACCESS 4
//#define NAL_STATUS_READ_ERROR_CNT 5
#define NAL_AUTHORIZED_ACCESS 5
//#define NAL_STATUS_UNUSED_2 5
#define NAL_STATUS_SEND_STATE 6
#define NAL_STATUS_RECEIVE_STATE 7
#define NAL_STATUS_GLOBAL_STATE 8
#define NAL_STATUS_LAST_RX_NODE_ID 9
#define NAL_STATUS_RX_NODEID_ERROR 10
#define NAL_STATUS_LAST_TX_NODE_ID 11
#define NAL_STATUS_TX_NODEID_ERROR 12
//#define NAL_STATUS_TX_PORT_CORRECTIONS 13
#define NAL_STATUS_PACKET_CNT_RX 14
#define NAL_STATUS_PACKET_CNT_TX 15
 
 
 
typedef bool StsBool;  // Status     : Noun or verb indicating a status (.e.g isOpen). Does not  have to go back to source of stimulus.
typedef ap_uint<16> UdpSrcPort;     // UDP Source Port
typedef ap_uint<16> UdpDstPort;     // UDP Destination Port
typedef ap_uint<16> UdpPort;        // UDP source or destination Port
typedef ap_uint<16> UdpLen;         // UDP header and data Length
//DELME typedef SocketPair   UdpAppMeta;
//typedef Axis<64>     UdpAppData;
//typedef NetworkWord  UdpAppData;
//typedef UdpMeta      UdpAppMeta;
typedef UdpLen       UdpAppDLen;
 
//DELME typedef UdpAppMeta  UdpMeta;
typedef UdpAppDLen  UdpPLen;
 
typedef ap_uint<16> PacketLen;
 
 
 
struct NalEventNotif {
  NalCntIncType type;
  ap_uint<32>   update_value;
  //in case of LAST_* types, the update_value is the new value
  //on other cases, it is an increment value
  NalEventNotif() {}
  NalEventNotif(NalCntIncType nt, ap_uint<32> uv): type(nt), update_value(uv) {}
};
 
typedef ap_uint<64> NalTriple;
 
struct NalNewTableEntry {
  NalTriple  new_triple;
  SessionId sessId;
  NalNewTableEntry() {}
  NalNewTableEntry(NalTriple nt, SessionId sid): new_triple(nt), sessId(sid) {}
};
 
struct NalNewTcpConRep {
  NalTriple new_triple;
  SessionId newSessionId;
  bool    failure;
  NalNewTcpConRep() {}
  NalNewTcpConRep(NalTriple nt, SessionId ns, bool fail): new_triple(nt), newSessionId(ns), failure(fail) {}
};
 
struct NalConfigUpdate {
  ap_uint<16>   config_addr;
  ap_uint<32>   update_value;
  NalConfigUpdate() {}
  NalConfigUpdate(ap_uint<16> ca, ap_uint<32> uv): config_addr(ca), update_value(uv) {}
};
 
struct NalMrtUpdate {
  NodeId    nid;
  Ip4Addr   ip4a;
  NalMrtUpdate() {}
  NalMrtUpdate(NodeId node, Ip4Addr addr): nid(node), ip4a(addr) {}
};
 
struct NalStatusUpdate {
  ap_uint<16>   status_addr;
  ap_uint<32>   new_value;
  NalStatusUpdate() {}
  NalStatusUpdate(ap_uint<16> sa, ap_uint<32> nv): status_addr(sa), new_value(nv) {}
};
 
struct NalPortUpdate {
  PortType    port_type;
  ap_uint<32> new_value;
  NalPortUpdate () {}
  NalPortUpdate(PortType pt, ap_uint<32> nv): port_type(pt), new_value(nv) {}
};
 
struct NalWaitingData {
  SessionId sessId;
  bool      fmc_con;
  NalWaitingData () {}
  NalWaitingData(SessionId si, bool is_fmc): sessId(si), fmc_con(is_fmc) {}
};
 
 
//INLINE METHODS
ap_uint<32> getRightmostBitPos(ap_uint<32> num);
NalTriple newTriple(Ip4Addr ipRemoteAddres, TcpPort tcpRemotePort, TcpPort tcpLocalPort);
Ip4Addr getRemoteIpAddrFromTriple(NalTriple triple);
TcpPort getRemotePortFromTriple(NalTriple triple);
TcpPort getLocalPortFromTriple(NalTriple triple);
uint8_t extractByteCnt(AxisRaw currWord);
uint8_t extractByteCnt(NetworkWord currWord);
 
 
#include "uss.hpp"
#include "tss.hpp"
#include "hss.hpp"
#include "cam8.hpp"
//#include "cam16.hpp"
 
void nal_main(
    // ----- link to FMC -----
    ap_uint<32> ctrlLink[MAX_MRT_SIZE + NUMBER_CONFIG_WORDS + NUMBER_STATUS_WORDS],
    //state of the FPGA
    ap_uint<1>                  *layer_4_enabled,
    ap_uint<1>                  *layer_7_enabled,
    ap_uint<1>                  *role_decoupled,
    // ready signal from NTS
    ap_uint<1>                  *piNTS_ready,
    // ----- link to MMIO ----
    ap_uint<16>                 *piMMIO_FmcLsnPort,
    ap_uint<32>                 *piMMIO_CfrmIp4Addr,
    // -- my IP address 
    ap_uint<32>                 *myIpAddress,
 
    //-- ROLE UDP connection
    ap_uint<32>                 *pi_udp_rx_ports,
    stream<NetworkWord>         &siUdp_data,
    stream<NetworkWord>         &soUdp_data,
    stream<NetworkMetaStream>   &siUdp_meta,
    stream<NetworkMetaStream>   &soUdp_meta,
 
    // -- ROLE TCP connection
    ap_uint<32>                 *pi_tcp_rx_ports,
    stream<NetworkWord>         &siTcp_data,
    stream<NetworkMetaStream>   &siTcp_meta,
    stream<NetworkWord>         &soTcp_data,
    stream<NetworkMetaStream>   &soTcp_meta,
 
    // -- FMC TCP connection
    stream<NetworkWord>         &siFMC_data,
    stream<TcpSessId>           &siFMC_SessId,
    stream<NetworkWord>         &soFMC_data,
    stream<TcpSessId>           &soFMC_SessId,
 
    //-- UOE / Control Port Interfaces
    stream<UdpPort>             &soUOE_LsnReq,
    stream<StsBool>             &siUOE_LsnRep,
    stream<UdpPort>             &soUOE_ClsReq,
    stream<StsBool>             &siUOE_ClsRep,
 
    //-- UOE / Rx Data Interfaces
    stream<UdpAppData>          &siUOE_Data,
    stream<UdpAppMeta>          &siUOE_Meta,
    stream<UdpAppDLen>          &siUOE_DLen,
 
    //-- UOE / Tx Data Interfaces
    stream<UdpAppData>          &soUOE_Data,
    stream<UdpAppMeta>          &soUOE_Meta,
    stream<UdpAppDLen>          &soUOE_DLen,
 
    //-- TOE / Rx Data Interfaces
    stream<TcpAppNotif>         &siTOE_Notif,
    stream<TcpAppRdReq>         &soTOE_DReq,
    stream<TcpAppData>          &siTOE_Data,
    stream<TcpAppMeta>          &siTOE_SessId,
    //-- TOE / Listen Interfaces
    stream<TcpAppLsnReq>        &soTOE_LsnReq,
    stream<TcpAppLsnRep>        &siTOE_LsnRep,
    //-- TOE / Tx Data Interfaces
    stream<TcpAppData>          &soTOE_Data,
    stream<TcpAppSndReq>        &soTOE_SndReq,
    stream<TcpAppSndRep>        &siTOE_SndRep,
    //-- TOE / Open Interfaces
    stream<TcpAppOpnReq>        &soTOE_OpnReq,
    stream<TcpAppOpnRep>        &siTOE_OpnRep,
    //-- TOE / Close Interfaces
    stream<TcpAppClsReq>        &soTOE_ClsReq
    );
 
#endif