packet_matches.h

Go to the documentation of this file.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef __PACKET_MATCHES_H__
#define __PACKET_MATCHES_H__

#include <inttypes.h> 
#include <string.h> 
#include "rofl.h"
#include "ternary_fields.h"
#include "../openflow/openflow1x/pipeline/of1x_utils.h"

struct datapacket;

/* 
* Packet matching values
*/
typedef struct packet_matches{

        //Packet size
        uint32_t __pkt_size_bytes;      /* Packet size in bytes */

        //Ports
        uint32_t __port_in;             /* Switch input port. */
        uint32_t __phy_port_in;         /* Switch physical input port. */
        
        //Associated metadata
        uint64_t __metadata;            /* Metadata passed between tables. */
 
        //802
        uint64_t __eth_dst;             /* Ethernet destination address. */
        uint64_t __eth_src;             /* Ethernet source address. */
        uint16_t __eth_type;            /* Ethernet frame type (WARNING: inner payload). */
        
        //802.1q VLAN outermost tag
        bool __has_vlan;                /* VLAN flag */
        uint16_t __vlan_vid;            /* VLAN id. */
        uint8_t __vlan_pcp;             /* VLAN PCP. */

        //ARP
        uint16_t __arp_opcode;          /* ARP opcode */
        uint64_t __arp_sha;             /* ARP source hardware address */
        uint32_t __arp_spa;             /* ARP source protocol address */
        uint64_t __arp_tha;             /* ARP target hardware address */
        uint32_t __arp_tpa;             /* ARP target protocol address */

        //IP
        uint8_t __ip_proto;             /* IP protocol. */
        uint8_t __ip_dscp;              /* IP DSCP (6 bits in ToS field). */
        uint8_t __ip_ecn;                       /* IP ECN (2 bits in ToS field). */
        
        //IPv4
        uint32_t __ipv4_src;            /* IPv4 source address. */
        uint32_t __ipv4_dst;            /* IPv4 destination address. */

        //TCP
        uint16_t __tcp_src;             /* TCP source port. */
        uint16_t __tcp_dst;             /* TCP destination port. */

        //UDP
        uint16_t __udp_src;             /* UDP source port. */
        uint16_t __udp_dst;             /* UDP destination port. */

        //SCTP
        uint16_t __sctp_src;            /* SCTP source port. */
        uint16_t __sctp_dst;            /* SCTP destination port. */


        //ICMPv4
        uint8_t __icmpv4_type;          /* ICMP type. */
        uint8_t __icmpv4_code;          /* ICMP code. */

        //MPLS-outermost label 
        uint32_t __mpls_label;          /* MPLS label. */
        uint8_t __mpls_tc;              /* MPLS TC. */
        bool __mpls_bos;                /* MPLS BoS. */


        //IPv6
        uint128__t __ipv6_src;          /* IPv6 source address */
        uint128__t __ipv6_dst;          /* IPv6 source address */
        uint64_t __ipv6_flabel;         /* IPv6 flow label */
        uint128__t __ipv6_nd_target;    /* IPv6 Neighbor discovery protocol target */
        uint64_t __ipv6_nd_sll;         /* IPv6 Neighbor discovery protocol source link level */
        uint64_t __ipv6_nd_tll;         /* IPv6 Neighbor discovery protocol target link level */
        uint16_t __ipv6_exthdr;         /* IPv6 extension pseudo header */
        
        //ICMPv6 
        uint8_t __icmpv6_code;          /* ICMPv6 type */
        uint8_t __icmpv6_type;          /* ICMPv6 code */

        //PBB
        uint32_t __pbb_isid;            /* PBB_ISID code */
        
        //Tunnel id
        uint64_t __tunnel_id;           /* Tunnel id*/

        /*
        * Extensions
        */

        //PPPoE related extensions
        uint8_t __pppoe_code;           /* PPPoE code */
        uint8_t __pppoe_type;           /* PPPoE type */
        uint16_t __pppoe_sid;           /* PPPoE session id */
        
        //PPP related extensions
        uint16_t __ppp_proto;           /* PPPoE session id */
        
        //GTP related extensions
        uint8_t __gtp_msg_type;         /* GTP message type */
        uint32_t __gtp_teid;            /* GTP teid */

        //CAPWAP related extensions
        uint8_t __capwap_wbid;          /* CAPWAP WBID */
        uint8_t __capwap_rid;           /* CAPWAP RID */
        uint16_t __capwap_flags;        /* CAPWAP FLAGS */

        //WLAN related extensions
        uint16_t __wlan_fc;                     /* WLAN fc */
        uint8_t __wlan_type;            /* WLAN type */
        uint8_t __wlan_subtype;         /* WLAN subtype */
        uint8_t __wlan_direction;       /* WLAN direction */
        uint64_t __wlan_address_1;      /* WLAN address 1 */
        uint64_t __wlan_address_2;      /* WLAN address 2 */
        uint64_t __wlan_address_3;      /* WLAN address 3 */

        //GRE related extensions
        uint16_t __gre_version;         /* GRE version */
        uint16_t __gre_prot_type;       /* GRE protocol type */
        uint32_t __gre_key;                     /* GRE key */
}packet_matches_t;


//C++ extern C
ROFL_BEGIN_DECLS

void dump_packet_matches(struct datapacket *const pkt, bool raw_nbo);

void fill_packet_matches(struct datapacket *const pkt, packet_matches_t* pkt_matches);


static inline
uint32_t packet_matches_get_size_bytes(packet_matches_t *const pkt_matches){
        return pkt_matches->__pkt_size_bytes;
};
//Phy
static inline
uint32_t packet_matches_get_port_in_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__port_in;
};
static inline
uint32_t packet_matches_get_phy_port_in_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__phy_port_in;
};


//METADATA
static inline
uint64_t packet_matches_get_metadata_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__metadata;
};

//ETHERNET
static inline
uint64_t packet_matches_get_eth_dst_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__eth_dst));
};
static inline
uint64_t packet_matches_get_eth_src_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__eth_src));
};
static inline
uint16_t packet_matches_get_eth_type_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__eth_type);
};

//8021.q
static inline
bool packet_matches_has_vlan(packet_matches_t *const pkt_matches){
        return pkt_matches->__has_vlan;
};
static inline
uint16_t packet_matches_get_vlan_vid_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__vlan_vid);
};

static inline
uint8_t packet_matches_get_vlan_pcp_value(packet_matches_t *const pkt_matches){
        return OF1X_VLAN_PCP_VALUE(pkt_matches->__vlan_pcp);
};

//MPLS
static inline
uint32_t packet_matches_get_mpls_label_value(packet_matches_t *const pkt_matches){
        return OF1X_MPLS_LABEL_VALUE(NTOHB32(pkt_matches->__mpls_label));
};
static inline
uint8_t packet_matches_get_mpls_tc_value(packet_matches_t *const pkt_matches){
        return OF1X_MPLS_TC_VALUE(pkt_matches->__mpls_tc);
};
static inline
bool packet_matches_get_mpls_bos_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__mpls_bos;
};

//ARP
static inline
uint16_t packet_matches_get_arp_opcode_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__arp_opcode);
};
static inline
uint64_t packet_matches_get_arp_tha_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__arp_tha));
};
static inline
uint64_t packet_matches_get_arp_sha_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__arp_sha));
};
static inline
uint32_t packet_matches_get_arp_tpa_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__arp_tpa);
};
static inline
uint32_t packet_matches_get_arp_spa_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__arp_spa);
};


//IP
static inline
uint8_t packet_matches_get_ip_proto_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__ip_proto;
};
static inline
uint8_t packet_matches_get_ip_ecn_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__ip_ecn;
};
static inline
uint8_t packet_matches_get_ip_dscp_value(packet_matches_t *const pkt_matches){
        return OF1X_IP_DSCP_VALUE(pkt_matches->__ip_dscp);
};

//IPv4
static inline
uint32_t packet_matches_get_ipv4_src_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__ipv4_src);
};
static inline
uint32_t packet_matches_get_ipv4_dst_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__ipv4_dst);
};

//TCP
static inline
uint16_t packet_matches_get_tcp_src_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__tcp_src);
};
static inline
uint16_t packet_matches_get_tcp_dst_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__tcp_dst);
};

//UDP
static inline
uint16_t packet_matches_get_udp_src_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__udp_src);
};
static inline
uint16_t packet_matches_get_udp_dst_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__udp_dst);
};

//SCTP
static inline
uint16_t packet_matches_get_sctp_src_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__sctp_src);
};
static inline
uint16_t packet_matches_get_sctp_dst_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__sctp_dst);
};

//ICMPv4
static inline
uint8_t packet_matches_get_icmpv4_type_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__icmpv4_type;
};
static inline
uint8_t packet_matches_get_icmpv4_code_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__icmpv4_code;
};

//IPv6
static inline
uint128__t packet_matches_get_ipv6_src_value(packet_matches_t *const pkt_matches){
        uint128__t tmp =  pkt_matches->__ipv6_src;
        NTOHB128(tmp);
        return tmp;
};
static inline
uint128__t packet_matches_get_ipv6_dst_value(packet_matches_t *const pkt_matches){
        uint128__t tmp =  pkt_matches->__ipv6_dst;
        NTOHB128(tmp);
        return tmp;
};
static inline
uint64_t packet_matches_get_ipv6_flabel_value(packet_matches_t *const pkt_matches){
        return OF1X_IP6_FLABEL_VALUE(NTOHB64(pkt_matches->__ipv6_flabel));
};
static inline
uint128__t packet_matches_get_ipv6_nd_target_value(packet_matches_t *const pkt_matches){
        uint128__t tmp = pkt_matches->__ipv6_nd_target;
        NTOHB128(tmp);
        return tmp;
};
static inline
uint64_t packet_matches_get_ipv6_nd_sll_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__ipv6_nd_sll));
};
static inline
uint64_t packet_matches_get_ipv6_nd_tll_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__ipv6_nd_tll));
};
static inline
uint16_t packet_matches_get_ipv6_exthdr_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__ipv6_exthdr); //TODO align?
};

//ICMPv6
static inline
uint8_t packet_matches_get_icmpv6_type_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__icmpv6_type;
};
static inline
uint8_t packet_matches_get_icmpv6_code_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__icmpv6_code;
};

/*
 * @brief Get the packet match PBB_ISD value in HOST BYTE ORDER
 * @ingroup core_of1x
 */
static inline
uint32_t packet_matches_get_pbb_isid_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__pbb_isid); //TODO align?
};

static inline
uint64_t packet_matches_get_tunnel_id_value(packet_matches_t *const pkt_matches){
        return NTOHB64(pkt_matches->__tunnel_id);
};


//PPPoE
static inline
uint8_t packet_matches_get_pppoe_code_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__pppoe_code;
};
static inline
uint8_t packet_matches_get_pppoe_type_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__pppoe_type;
};
static inline
uint16_t packet_matches_get_pppoe_sid_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__pppoe_sid);
};

//PPP
static inline
uint16_t packet_matches_get_ppp_proto_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__ppp_proto);
};

//GTP
static inline
uint8_t packet_matches_get_gtp_msg_type_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__gtp_msg_type;
};
static inline
uint32_t packet_matches_get_gtp_teid_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__gtp_teid);
};

//CAPWAP
static inline
uint8_t packet_matches_get_capwap_wbid_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__capwap_wbid;
};
static inline
uint8_t packet_matches_get_capwap_rid_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__capwap_rid;
};
static inline
uint16_t packet_matches_get_capwap_flags_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__capwap_flags);
};

//WLAN
static inline
uint16_t packet_matches_get_wlan_fc_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__wlan_fc);
};
static inline
uint8_t packet_matches_get_wlan_type_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__wlan_type;
};
static inline
uint8_t packet_matches_get_wlan_subtype_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__wlan_subtype;
};
static inline
uint8_t packet_matches_get_wlan_direction_value(packet_matches_t *const pkt_matches){
        return pkt_matches->__wlan_direction;
};
static inline
uint64_t packet_matches_get_wlan_address_1_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__wlan_address_1));
};
static inline
uint64_t packet_matches_get_wlan_address_2_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__wlan_address_2));
};
static inline
uint64_t packet_matches_get_wlan_address_3_value(packet_matches_t *const pkt_matches){
        return OF1X_MAC_VALUE(NTOHB64(pkt_matches->__wlan_address_3));
};

//GRE
static inline
uint16_t packet_matches_get_gre_version_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__gre_version);
};
static inline
uint16_t packet_matches_get_gre_prot_type_value(packet_matches_t *const pkt_matches){
        return NTOHB16(pkt_matches->__gre_prot_type);
};
static inline
uint32_t packet_matches_get_gre_key_value(packet_matches_t *const pkt_matches){
        return NTOHB32(pkt_matches->__gre_key);
};

//C++ extern C
ROFL_END_DECLS

#endif //PACKET_MATCHES