packet.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 PLATFORM_PACKET_HOOKS
#define PLATFORM_PACKET_HOOKS

#include <stdint.h>

#include "rofl.h"
#include "../common/datapacket.h"
#include "../common/ternary_fields.h"
#include "../switch_port.h"

#if defined(__COMPILING_ROFL_PIPELINE__) || !defined(ROFL_PIPELINE_PP_PRESENT) || !defined(ROFL_PIPELINE_INLINE_PP_PLATFORM_FUNCS)

//C++ extern C
ROFL_BEGIN_DECLS

// Packet mangling //

uint32_t platform_packet_get_size_bytes(datapacket_t *const pkt);

void platform_packet_output(datapacket_t* pkt, switch_port_t* port);
void platform_packet_drop(datapacket_t* pkt);
datapacket_t* platform_packet_replicate(datapacket_t* pkt);


// Ports //

uint32_t* platform_packet_get_port_in(datapacket_t *const pkt);
uint32_t* platform_packet_get_phy_port_in(datapacket_t *const pkt);     

void platform_packet_set_queue(datapacket_t* pkt, uint32_t queue);


// Ethernet //

uint64_t* platform_packet_get_eth_src(datapacket_t *const pkt);
uint64_t* platform_packet_get_eth_dst(datapacket_t *const pkt);
uint16_t* platform_packet_get_eth_type(datapacket_t *const pkt);

void platform_packet_set_eth_src(datapacket_t* pkt, uint64_t eth_src);
void platform_packet_set_eth_dst(datapacket_t* pkt, uint64_t eth_dst);
void platform_packet_set_eth_type(datapacket_t* pkt, uint16_t eth_type);


// 802.1q VLAN //

bool platform_packet_has_vlan(datapacket_t *const pkt);
uint16_t* platform_packet_get_vlan_vid(datapacket_t *const pkt);
uint8_t* platform_packet_get_vlan_pcp(datapacket_t *const pkt);
void platform_packet_set_vlan_vid(datapacket_t* pkt, uint16_t vlan_vid);
void platform_packet_set_vlan_pcp(datapacket_t* pkt, uint8_t vlan_pcp);
void platform_packet_pop_vlan(datapacket_t* pkt);
void platform_packet_push_vlan(datapacket_t* pkt, uint16_t ether_type);


// MPLS //

uint32_t* platform_packet_get_mpls_label(datapacket_t *const pkt);
uint8_t* platform_packet_get_mpls_tc(datapacket_t *const pkt);
bool platform_packet_get_mpls_bos(datapacket_t *const pkt);

void platform_packet_set_mpls_label(datapacket_t* pkt, uint32_t label);
void platform_packet_set_mpls_tc(datapacket_t* pkt, uint8_t tc);
void platform_packet_set_mpls_bos(datapacket_t* pkt, bool bos);
void platform_packet_set_mpls_ttl(datapacket_t* pkt, uint8_t new_ttl);

void platform_packet_dec_mpls_ttl(datapacket_t* pkt);
void platform_packet_pop_mpls(datapacket_t* pkt, uint16_t ether_type);
void platform_packet_push_mpls(datapacket_t* pkt, uint16_t ether_type);


// Tunnel ID //

uint64_t* platform_packet_get_tunnel_id(datapacket_t *const pkt);
void platform_packet_set_tunnel_id(datapacket_t*pkt, uint64_t tunnel_id);

// PBB //

uint32_t* platform_packet_get_pbb_isid(datapacket_t *const pkt);

void platform_packet_set_pbb_isid(datapacket_t*pkt, uint32_t pbb_isid);
void platform_packet_pop_pbb(datapacket_t* pkt);
void platform_packet_push_pbb(datapacket_t* pkt, uint16_t ether_type);

// TTL common //

void platform_packet_copy_ttl_in(datapacket_t* pkt);
void platform_packet_copy_ttl_out(datapacket_t* pkt);
void platform_packet_dec_nw_ttl(datapacket_t* pkt);
void platform_packet_set_nw_ttl(datapacket_t* pkt, uint8_t new_ttl);


// IP (common) //

uint8_t* platform_packet_get_ip_proto(datapacket_t *const pkt);
uint8_t platform_packet_get_ip_ecn(datapacket_t *const pkt);
uint8_t platform_packet_get_ip_dscp(datapacket_t *const pkt);

void platform_packet_set_ip_proto(datapacket_t* pkt, uint8_t ip_proto);
void platform_packet_set_ip_dscp(datapacket_t* pkt, uint8_t ip_dscp);
void platform_packet_set_ip_ecn(datapacket_t* pkt, uint8_t ip_ecn);

// ARP //

uint16_t* platform_packet_get_arp_opcode(datapacket_t *const pkt);
uint64_t* platform_packet_get_arp_sha(datapacket_t *const pkt);
uint32_t* platform_packet_get_arp_spa(datapacket_t *const pkt);
uint64_t* platform_packet_get_arp_tha(datapacket_t *const pkt);
uint32_t* platform_packet_get_arp_tpa(datapacket_t *const pkt);

void platform_packet_set_arp_opcode(datapacket_t* pkt, uint16_t arp_opcode);
void platform_packet_set_arp_sha(datapacket_t* pkt, uint64_t arp_sha);
void platform_packet_set_arp_spa(datapacket_t* pkt, uint32_t arp_spa);
void platform_packet_set_arp_tha(datapacket_t* pkt, uint64_t arp_tha);
void platform_packet_set_arp_tpa(datapacket_t* pkt, uint32_t arp_tpa);


// IPv4 //

uint32_t* platform_packet_get_ipv4_src(datapacket_t *const pkt);
uint32_t* platform_packet_get_ipv4_dst(datapacket_t *const pkt);

void platform_packet_set_ipv4_src(datapacket_t* pkt, uint32_t ip_src);

void platform_packet_set_ipv4_dst(datapacket_t* pkt, uint32_t ip_dst);


// IPv6 //

uint128__t* platform_packet_get_ipv6_src(datapacket_t *const pkt);
uint128__t* platform_packet_get_ipv6_dst(datapacket_t *const pkt);
uint32_t* platform_packet_get_ipv6_flabel(datapacket_t *const pkt);
uint128__t* platform_packet_get_ipv6_nd_target(datapacket_t *const pkt);
uint64_t* platform_packet_get_ipv6_nd_sll(datapacket_t *const pkt);
uint64_t* platform_packet_get_ipv6_nd_tll(datapacket_t *const pkt);
uint16_t* platform_packet_get_ipv6_exthdr(datapacket_t *const pkt);

void platform_packet_set_ipv6_src(datapacket_t*pkt, uint128__t ipv6_src);
void platform_packet_set_ipv6_dst(datapacket_t*pkt, uint128__t ipv6_dst);
void platform_packet_set_ipv6_flabel(datapacket_t*pkt, uint64_t ipv6_flabel);
void platform_packet_set_ipv6_nd_target(datapacket_t*pkt, uint128__t ipv6_nd_target);
void platform_packet_set_ipv6_nd_sll(datapacket_t*pkt, uint64_t ipv6_nd_sll);
void platform_packet_set_ipv6_nd_tll(datapacket_t*pkt, uint64_t ipv6_nd_tll);
void platform_packet_set_ipv6_exthdr(datapacket_t*pkt, uint16_t ipv6_exthdr);

// TCP //

uint16_t* platform_packet_get_tcp_src(datapacket_t *const pkt);
uint16_t* platform_packet_get_tcp_dst(datapacket_t *const pkt);

void platform_packet_set_tcp_src(datapacket_t* pkt, uint16_t tcp_src);
void platform_packet_set_tcp_dst(datapacket_t* pkt, uint16_t tcp_dst);


// UDP //

uint16_t* platform_packet_get_udp_src(datapacket_t *const pkt);
uint16_t* platform_packet_get_udp_dst(datapacket_t *const pkt);

void platform_packet_set_udp_src(datapacket_t* pkt, uint16_t udp_src);
void platform_packet_set_udp_dst(datapacket_t* pkt, uint16_t udp_dst);


// SCTP //

uint16_t* platform_packet_get_sctp_src(datapacket_t *const pkt);
uint16_t* platform_packet_get_sctp_dst(datapacket_t *const pkt);

void platform_packet_set_sctp_src(datapacket_t* pkt, uint16_t sctp_src);
void platform_packet_set_sctp_dst(datapacket_t* pkt, uint16_t sctp_dst);


// ICMPv4 //

uint8_t* platform_packet_get_icmpv4_type(datapacket_t *const pkt);
uint8_t* platform_packet_get_icmpv4_code(datapacket_t *const pkt);

void platform_packet_set_icmpv4_type(datapacket_t* pkt, uint8_t type);
void platform_packet_set_icmpv4_code(datapacket_t* pkt, uint8_t code);


// ICMPv6 //

uint8_t* platform_packet_get_icmpv6_type(datapacket_t *const pkt);
uint8_t* platform_packet_get_icmpv6_code(datapacket_t *const pkt);

void platform_packet_set_icmpv6_type(datapacket_t*pkt, uint8_t icmpv6_type);
void platform_packet_set_icmpv6_code(datapacket_t*pkt, uint8_t icmpv6_code);

#ifdef ROFL_EXPERIMENTAL
/*******************/
/*** Extensions ***/
/*****************/

// PPPoE //

uint8_t* platform_packet_get_pppoe_code(datapacket_t *const pkt);
uint8_t* platform_packet_get_pppoe_type(datapacket_t *const pkt);
uint16_t* platform_packet_get_pppoe_sid(datapacket_t *const pkt);

void platform_packet_set_pppoe_type(datapacket_t* pkt, uint8_t type);
void platform_packet_set_pppoe_code(datapacket_t* pkt, uint8_t code);
void platform_packet_set_pppoe_sid(datapacket_t* pkt, uint16_t sid);

void platform_packet_pop_pppoe(datapacket_t* pkt, uint16_t ether_type);
void platform_packet_push_pppoe(datapacket_t* pkt, uint16_t ether_type);

// PPP //

uint16_t* platform_packet_get_ppp_proto(datapacket_t *const pkt);

void platform_packet_set_ppp_proto(datapacket_t* pkt, uint16_t proto);

// GTP //

uint8_t* platform_packet_get_gtp_msg_type(datapacket_t *const pkt);
uint32_t* platform_packet_get_gtp_teid(datapacket_t *const pkt);

void platform_packet_set_gtp_msg_type(datapacket_t* pkt, uint8_t msg_type);
void platform_packet_set_gtp_teid(datapacket_t* pkt, uint32_t teid);

void platform_packet_pop_gtp(datapacket_t* pkt, uint16_t ether_type);
void platform_packet_push_gtp(datapacket_t* pkt, uint16_t ether_type);



// CAPWAP //

uint8_t* platform_packet_get_capwap_wbid(datapacket_t *const pkt);
uint8_t* platform_packet_get_capwap_rid(datapacket_t *const pkt);
uint16_t* platform_packet_get_capwap_flags(datapacket_t *const pkt);

void platform_packet_set_capwap_wbid(datapacket_t* pkt, uint8_t wbid);
void platform_packet_set_capwap_rid(datapacket_t* pkt, uint8_t rid);
void platform_packet_set_capwap_flags(datapacket_t* pkt, uint16_t flags);

void platform_packet_pop_capwap(datapacket_t* pkt);
void platform_packet_push_capwap(datapacket_t* pkt);



// WLAN //

uint16_t* platform_packet_get_wlan_fc(datapacket_t *const pkt);
uint8_t* platform_packet_get_wlan_type(datapacket_t *const pkt);
uint8_t* platform_packet_get_wlan_subtype(datapacket_t *const pkt);
uint8_t* platform_packet_get_wlan_direction(datapacket_t *const pkt);
uint64_t* platform_packet_get_wlan_address_1(datapacket_t *const pkt);
uint64_t* platform_packet_get_wlan_address_2(datapacket_t *const pkt);
uint64_t* platform_packet_get_wlan_address_3(datapacket_t *const pkt);

void platform_packet_set_wlan_fc(datapacket_t* pkt, uint16_t fc);
void platform_packet_set_wlan_type(datapacket_t* pkt, uint8_t type);
void platform_packet_set_wlan_subtype(datapacket_t* pkt, uint8_t subtype);
void platform_packet_set_wlan_direction(datapacket_t* pkt, uint8_t direction);
void platform_packet_set_wlan_address_1(datapacket_t* pkt, uint64_t address_1);
void platform_packet_set_wlan_address_2(datapacket_t* pkt, uint64_t address_2);
void platform_packet_set_wlan_address_3(datapacket_t* pkt, uint64_t address_3);

void platform_packet_pop_wlan(datapacket_t* pkt);
void platform_packet_push_wlan(datapacket_t* pkt);


// GRE //

uint16_t* platform_packet_get_gre_version(datapacket_t *const pkt);
uint16_t* platform_packet_get_gre_prot_type(datapacket_t *const pkt);
uint32_t* platform_packet_get_gre_key(datapacket_t *const pkt);

void platform_packet_set_gre_version(datapacket_t* pkt, uint16_t version);
void platform_packet_set_gre_prot_type(datapacket_t* pkt, uint16_t prot_type);
void platform_packet_set_gre_key(datapacket_t* pkt, uint32_t key);

void platform_packet_pop_gre(datapacket_t* pkt, uint16_t ether_type);
void platform_packet_push_gre(datapacket_t* pkt, uint16_t ether_type);




/* end of extensions */
#endif


//C++ extern C
ROFL_END_DECLS

#endif //if
#endif //PLATFORM_PACKET_HOOKS