network-packet 0.1.1

A domain model of network packets.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

// This file is part of network. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/network/master/COPYRIGHT. No part of predicator, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2016-2018 The developers of network. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/network/master/COPYRIGHT.


/// Represents an incoming packet of contiguous data from a network card, with the Frame Check Sequence (FCS) (also known as Cyclic Redundancy Check, CRC) omitted.
pub trait IncomingNetworkPacket: Sized + Copy
{
	/// Optimized routine that only works on direct, contiguous packets with a reference count of 1.
	#[inline(always)]
	fn free_direct_contiguous_packet(self);
	
	/// Packet length if contiguous.
	///
	/// Same as `data_length()` for DPDK.
	#[inline(always)]
	fn packet_length_if_contiguous(self) -> u16;
	
	/// Offset into data, returned as a reference.
	///
	/// No length checks are made, although in debug builds an assertion may check.
	#[inline(always)]
	fn offset_into_data_reference<'a, T: 'a>(self, offset: usize) -> &'a T
	{
		unsafe { & * (self.offset_into_data::<T>(offset).as_ptr() as *const T) }
	}
	
	/// Offset into data, returned as a non-null pointer.
	///
	/// No length checks are made, although in debug builds an assertion may check.
	///
	/// A DPDK implementation would be a wrapper around `rte_pktmbuf_mtod` and `rte_pktmbuf_mtod_offset`.
	///
	/// Compare with DPDK's `io_virtual_address_offset()`.
	#[inline(always)]
	fn offset_into_data<T>(self, offset: usize) -> NonNull<T>;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet.
	///
	/// This provides access to its categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_layer_2_packet_type(self) -> HardwareOffloadLayer2PacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet.
	///
	/// This provides access to its categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_layer_3_packet_type(self) -> HardwareOffloadLayer3PacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet.
	///
	/// This provides access to its categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_layer_4_packet_type(self) -> HardwareOffloadLayer4PacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet.
	///
	/// This provides access to its categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_tunnel_packet_type(self) -> HardwareOffloadTunnelPacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.
	///
	/// This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_tunnel_inner_layer_2_packet_type(self) -> HardwareOffloadLayer2PacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.
	///
	/// This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_tunnel_inner_layer_3_packet_type(self) -> HardwareOffloadLayer3PacketType;
	
	/// A network driver may support hardware offload categorisation of an incoming network packet which is for a tunnel.
	///
	/// This provides access to a tunnel packet's inner categorisation, which can be used for short-circuiting some packet analysis.
	///
	/// Hardware offload features need to be used with caution as they vary widely amongst vendors and their is no way to validate the quality of code they rely upon.
	#[inline(always)]
	fn hardware_offload_tunnel_inner_layer_4_packet_type(self) -> HardwareOffloadLayer4PacketType;
	
	/// Determines the internet protocol (IP) version 4 check sum status.
	#[inline(always)]
	fn hardware_offload_internet_protocol_version_4_check_sum_status(self) -> HardwareOffloadCheckSumStatus;
	
	/// Determines the layer 4 (TCP, UDP, SCTP) check sum check sum status.
	#[inline(always)]
	fn hardware_offload_layer_4_check_sum_status(self) -> HardwareOffloadCheckSumStatus;
	
	/// Hardware offloading categorisation indicates an unwanted packet.
	#[inline(always)]
	fn hardware_offload_categorisation_indicates_an_unwanted_packet(self) -> bool;
}