vpp_plugin/vnet/
buffer.rs1#![allow(missing_docs)]
2
3use bitflags::bitflags;
6
7use crate::{
8 bindings::{
9 VNET_BUFFER_F_AVAIL1, VNET_BUFFER_F_AVAIL2, VNET_BUFFER_F_AVAIL3, VNET_BUFFER_F_AVAIL4,
10 VNET_BUFFER_F_AVAIL5, VNET_BUFFER_F_AVAIL6, VNET_BUFFER_F_AVAIL7, VNET_BUFFER_F_AVAIL8,
11 VNET_BUFFER_F_AVAIL9, VNET_BUFFER_F_FLOW_REPORT, VNET_BUFFER_F_GSO, VNET_BUFFER_F_IS_DVR,
12 VNET_BUFFER_F_IS_IP4, VNET_BUFFER_F_IS_IP6, VNET_BUFFER_F_IS_NATED,
13 VNET_BUFFER_F_L2_HDR_OFFSET_VALID, VNET_BUFFER_F_L3_HDR_OFFSET_VALID,
14 VNET_BUFFER_F_L4_CHECKSUM_COMPUTED, VNET_BUFFER_F_L4_CHECKSUM_CORRECT,
15 VNET_BUFFER_F_L4_HDR_OFFSET_VALID, VNET_BUFFER_F_LOCALLY_ORIGINATED,
16 VNET_BUFFER_F_LOOP_COUNTER_VALID, VNET_BUFFER_F_OFFLOAD, VNET_BUFFER_F_QOS_DATA_VALID,
17 VNET_BUFFER_F_SPAN_CLONE, VNET_BUFFER_F_VLAN_1_DEEP, VNET_BUFFER_F_VLAN_2_DEEP,
18 feature_main, vlib_rx_or_tx_t_VLIB_RX, vlib_rx_or_tx_t_VLIB_TX, vnet_buffer_opaque_t,
19 },
20 vnet::types::SwIfIndex,
21};
22
23bitflags! {
24 pub struct BufferFlags: u32 {
26 const L4_CHECKSUM_COMPUTED = VNET_BUFFER_F_L4_CHECKSUM_COMPUTED as u32;
27 const L4_CHECKSUM_CORRECT = VNET_BUFFER_F_L4_CHECKSUM_CORRECT as u32;
28 const VLAN_2_DEEP = VNET_BUFFER_F_VLAN_2_DEEP as u32;
29 const VLAN_1_DEEP = VNET_BUFFER_F_VLAN_1_DEEP as u32;
30 const SPAN_CLONE = VNET_BUFFER_F_SPAN_CLONE as u32;
31 const LOOP_COUNTER_VALID = VNET_BUFFER_F_LOOP_COUNTER_VALID as u32;
32 const LOCALLY_ORIGINATED = VNET_BUFFER_F_LOCALLY_ORIGINATED as u32;
33 const IS_IP4 = VNET_BUFFER_F_IS_IP4 as u32;
34 const IS_IP6 = VNET_BUFFER_F_IS_IP6 as u32;
35 const OFFLOAD = VNET_BUFFER_F_OFFLOAD as u32;
36 const IS_NATED = VNET_BUFFER_F_IS_NATED as u32;
37 const L2_HDR_OFFSET_VALID = VNET_BUFFER_F_L2_HDR_OFFSET_VALID as u32;
38 const L3_HDR_OFFSET_VALID = VNET_BUFFER_F_L3_HDR_OFFSET_VALID as u32;
39 const L4_HDR_OFFSET_VALID = VNET_BUFFER_F_L4_HDR_OFFSET_VALID as u32;
40 const FLOW_REPORT = VNET_BUFFER_F_FLOW_REPORT as u32;
41 const IS_DVR = VNET_BUFFER_F_IS_DVR as u32;
42 const QOS_DATA_VALID = VNET_BUFFER_F_QOS_DATA_VALID as u32;
43 const GSO = VNET_BUFFER_F_GSO as u32;
44 const AVAIL1 = VNET_BUFFER_F_AVAIL1 as u32;
45 const AVAIL2 = VNET_BUFFER_F_AVAIL2 as u32;
46 const AVAIL3 = VNET_BUFFER_F_AVAIL3 as u32;
47 const AVAIL4 = VNET_BUFFER_F_AVAIL4 as u32;
48 const AVAIL5 = VNET_BUFFER_F_AVAIL5 as u32;
49 const AVAIL6 = VNET_BUFFER_F_AVAIL6 as u32;
50 const AVAIL7 = VNET_BUFFER_F_AVAIL7 as u32;
51 const AVAIL8 = VNET_BUFFER_F_AVAIL8 as u32;
52 const AVAIL9 = VNET_BUFFER_F_AVAIL9 as u32;
53
54 const _ = !0;
56 }
57}
58
59impl BufferFlags {
60 pub fn as_vlib_flags(&self) -> crate::vlib::buffer::BufferFlags {
62 crate::vlib::buffer::BufferFlags::from_bits_retain(self.bits())
63 }
64}
65
66impl crate::vlib::buffer::BufferFlags {
67 pub fn vnet_flags(&self) -> BufferFlags {
69 BufferFlags::from_bits_retain(self.bits())
70 }
71}
72
73#[repr(transparent)]
78pub struct BufferRef(foreign_types::Opaque);
79
80impl BufferRef {
81 #[inline(always)]
89 pub unsafe fn from_ptr<'a>(ptr: *const vnet_buffer_opaque_t) -> &'a BufferRef {
90 unsafe { &*(ptr as *mut _) }
92 }
93
94 #[inline(always)]
102 pub unsafe fn from_ptr_mut<'a>(ptr: *mut vnet_buffer_opaque_t) -> &'a mut BufferRef {
103 unsafe { &mut *(ptr as *mut _) }
105 }
106
107 #[inline(always)]
109 pub fn as_ptr(&self) -> *mut vnet_buffer_opaque_t {
110 self as *const _ as *mut _
111 }
112
113 pub fn rx_sw_if_index(&self) -> SwIfIndex {
115 SwIfIndex::new(unsafe { (*self.as_ptr()).sw_if_index[vlib_rx_or_tx_t_VLIB_RX as usize] })
117 }
118
119 pub fn set_rx_sw_if_index(&mut self, sw_if_index: SwIfIndex) {
121 unsafe {
123 (*self.as_ptr()).sw_if_index[vlib_rx_or_tx_t_VLIB_TX as usize] = sw_if_index.into()
124 };
125 }
126
127 pub fn tx_sw_if_index(&self) -> Option<SwIfIndex> {
129 let sw_if_index = unsafe { (*self.as_ptr()).sw_if_index[vlib_rx_or_tx_t_VLIB_TX as usize] };
131 if sw_if_index == u32::MAX {
132 None
133 } else {
134 Some(sw_if_index.into())
135 }
136 }
137
138 pub fn set_tx_sw_if_index(&mut self, sw_if_index: Option<SwIfIndex>) {
143 let sw_if_index = sw_if_index.map(u32::from).unwrap_or(u32::MAX);
144 unsafe { (*self.as_ptr()).sw_if_index[vlib_rx_or_tx_t_VLIB_TX as usize] = sw_if_index };
146 }
147}
148
149impl<FeatureData> crate::vlib::BufferRef<FeatureData> {
150 pub fn vnet_buffer(&self) -> &BufferRef {
151 let ptr = &self.as_metadata().opaque as *const _;
152 unsafe { BufferRef::from_ptr(ptr as *const vnet_buffer_opaque_t) }
155 }
156
157 pub fn vnet_buffer_mut(&mut self) -> &mut BufferRef {
158 let ptr = &mut self.as_metadata_mut().opaque as *mut _;
159 unsafe { BufferRef::from_ptr_mut(ptr as *mut vnet_buffer_opaque_t) }
162 }
163}
164
165#[inline(always)]
180unsafe fn vnet_get_config_data<FeatureData: Copy>(
181 config_string_heap: *const u32,
182 config_index: &mut u32,
183) -> (u32, FeatureData) {
184 unsafe {
187 let index = *config_index;
188
189 let d = config_string_heap.add(index as usize);
190
191 let n = std::mem::size_of::<FeatureData>().div_ceil(std::mem::size_of_val(&*d));
192
193 let next = *d.add(n);
195
196 *config_index = index + n as u32 + 1;
198
199 (next, *(d as *const FeatureData))
200 }
201}
202
203impl<FeatureData: Copy> crate::vlib::BufferRef<FeatureData> {
204 #[inline(always)]
212 pub unsafe fn vnet_feature_next(&mut self) -> (u32, FeatureData) {
213 unsafe {
218 vnet_get_config_data(
219 feature_main.shared_feature_config_heap,
220 self.current_config_index_mut(),
221 )
222 }
223 }
224
225 #[inline(always)]
231 pub fn current_config_index(&self) -> u32 {
232 unsafe { self.as_metadata().__bindgen_anon_1.current_config_index }
234 }
235
236 #[inline(always)]
240 pub fn current_config_index_mut(&mut self) -> &mut u32 {
241 unsafe { &mut self.as_metadata_mut().__bindgen_anon_1.current_config_index }
245 }
246}