nsim: add packet loss simulation, docs
[vpp.git] / src / plugins / nsim / nsim.h
1
2 /*
3  * nsim.h - skeleton vpp engine plug-in header file
4  *
5  * Copyright (c) <current-year> <your-organization>
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #ifndef __included_nsim_h__
19 #define __included_nsim_h__
20
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/ethernet/ethernet.h>
24
25 #include <vppinfra/hash.h>
26 #include <vppinfra/error.h>
27
28 #define WHEEL_ENTRY_DATA_SIZE 1536      /* an even multiple of 64, pls */
29
30 typedef struct
31 {
32   f64 tx_time;
33   u32 tx_sw_if_index;
34   u32 current_length;
35     CLIB_CACHE_LINE_ALIGN_MARK (pad);
36   u8 data[WHEEL_ENTRY_DATA_SIZE];
37 } nsim_wheel_entry_t;
38
39 typedef struct
40 {
41   u32 wheel_size;
42   u32 cursize;
43   u32 head;
44   u32 tail;
45   nsim_wheel_entry_t *entries;
46     CLIB_CACHE_LINE_ALIGN_MARK (pad);
47 } nsim_wheel_t;
48
49 typedef struct
50 {
51   /* API message ID base */
52   u16 msg_id_base;
53
54   /* Two interfaces, cross-connected with delay */
55   u32 sw_if_index0, sw_if_index1;
56   u32 output_next_index0, output_next_index1;
57   /* Random seed for loss-rate simulation */
58   u32 seed;
59
60   /* Per-thread buffer / scheduler wheels */
61   nsim_wheel_t **wheel_by_thread;
62   u32 **buffer_indices_by_thread;
63
64   /* Config parameters */
65   f64 delay;
66   f64 bandwidth;
67   f64 packet_size;
68   f64 drop_fraction;
69
70   u64 mmap_size;
71
72   /* Wheels are configured */
73   int is_configured;
74
75   /* convenience */
76   vlib_main_t *vlib_main;
77   vnet_main_t *vnet_main;
78 } nsim_main_t;
79
80 extern nsim_main_t nsim_main;
81
82 extern vlib_node_registration_t nsim_node;
83 extern vlib_node_registration_t nsim_input_node;
84
85 #endif /* __included_nsim_h__ */
86
87 /*
88  * fd.io coding-style-patch-verification: ON
89  *
90  * Local Variables:
91  * eval: (c-set-style "gnu")
92  * End:
93  */