FD.io VPP  v20.05-21-gb1500e9ff
Vector Packet Processing
node.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __included_lacp_node_h__
16 #define __included_lacp_node_h__
17 
18 #include <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vppinfra/format.h>
21 #include <vppinfra/hash.h>
22 #include <lacp/protocol.h>
23 #include <lacp/rx_machine.h>
24 #include <lacp/tx_machine.h>
25 #include <lacp/mux_machine.h>
26 #include <lacp/ptx_machine.h>
27 
28 typedef enum
29 {
33 
34 typedef enum
35 {
39 
40 typedef enum
41 {
45 
46 #define LACP_DBG(n, args...) \
47  { \
48  lacp_main_t *_lm = &lacp_main; \
49  if (_lm->debug || n->debug) \
50  clib_warning (args); \
51  }
52 
53 #define LACP_DBG2(n, e, s, m, t) \
54  { \
55  lacp_main_t *_lm = &lacp_main; \
56  if ((m)->debug && (_lm->debug || (n)->debug)) \
57  (*m->debug)(n, e, s, t); \
58  }
59 
60 /* Packet counters */
61 #define foreach_lacp_error \
62 _ (NONE, "good lacp packets -- consumed") \
63 _ (CACHE_HIT, "good lacp packets -- cache hit") \
64 _ (UNSUPPORTED, "unsupported slow protocol packets") \
65 _ (TOO_SMALL, "bad lacp packets -- packet too small") \
66 _ (BAD_TLV, "bad lacp packets -- bad TLV length") \
67 _ (DISABLED, "lacp packets received on disabled interfaces")
68 
69 typedef enum
70 {
71 #define _(sym,str) LACP_ERROR_##sym,
73 #undef _
75 } lacp_error_t;
76 
77 #define SECS_IN_A_DAY 86400.0
78 
79 /* lacp packet trace capture */
80 typedef struct
81 {
84  union
85  {
86  marker_pdu_t marker;
87  lacp_pdu_t lacpdu;
88  } pkt;
90 
91 /** LACP interface details struct */
92 typedef struct
93 {
95  u8 interface_name[64];
100  u8 bond_interface_name[64];
102  u8 actor_system[6];
108  u8 partner_system[6];
114 
115 typedef struct
116 {
117  /** API message ID base */
119 
120  /* convenience variables */
123 
124  /* Background process node index */
126 
127  /* Packet templates for different encap types */
129 
130  /* Packet templates for different encap types */
132 
133  /* LACP interface count */
134  volatile u32 lacp_int;
135 
136  /* debug is on or off */
138 } lacp_main_t;
139 
140 extern lacp_state_struct lacp_state_array[];
141 extern lacp_main_t lacp_main;
142 
143 void lacp_create_periodic_process (void);
145 int lacp_dump_ifs (lacp_interface_details_t ** out_bondids);
147 void lacp_periodic (vlib_main_t * vm);
148 u8 *lacp_input_format_trace (u8 * s, va_list * args);
149 void lacp_init_neighbor (slave_if_t * sif, u8 * hw_address,
150  u16 port_number, u32 group);
158 
159 static inline void
161 {
162  *timer = 0.0;
163 }
164 
165 static inline u8
167 {
168  return (timer != 0.0);
169 }
170 
171 static inline u8
173 {
174  f64 now = vlib_time_now (vm);
175 
176  return (now >= timer);
177 }
178 
179 static inline u8 *
180 format_rx_sm_state (u8 * s, va_list * args)
181 {
182  lacp_state_struct lacp_rx_sm_state_array[] = {
183 #define _(b, s, n) {.bit = b, .str = #s, },
185 #undef _
186  {.str = NULL}
187  };
188  int state = va_arg (*args, int);
189  lacp_state_struct *state_entry = lacp_rx_sm_state_array;
190 
191  if (state >= (sizeof (lacp_rx_sm_state_array) / sizeof (*state_entry)))
192  s = format (s, "Bad state %d", state);
193  else
194  s = format (s, "%s", state_entry[state].str);
195 
196  return s;
197 }
198 
199 static inline u8 *
200 format_tx_sm_state (u8 * s, va_list * args)
201 {
202  lacp_state_struct lacp_tx_sm_state_array[] = {
203 #define _(b, s, n) {.bit = b, .str = #s, },
205 #undef _
206  {.str = NULL}
207  };
208  int state = va_arg (*args, int);
209  lacp_state_struct *state_entry = lacp_tx_sm_state_array;
210 
211  if (state >= (sizeof (lacp_tx_sm_state_array) / sizeof (*state_entry)))
212  s = format (s, "Bad state %d", state);
213  else
214  s = format (s, "%s", state_entry[state].str);
215 
216  return s;
217 }
218 
219 static inline u8 *
220 format_mux_sm_state (u8 * s, va_list * args)
221 {
222  lacp_state_struct lacp_mux_sm_state_array[] = {
223 #define _(b, s, n) {.bit = b, .str = #s, },
225 #undef _
226  {.str = NULL}
227  };
228  int state = va_arg (*args, int);
229  lacp_state_struct *state_entry = lacp_mux_sm_state_array;
230 
231  if (state >= (sizeof (lacp_mux_sm_state_array) / sizeof (*state_entry)))
232  s = format (s, "Bad state %d", state);
233  else
234  s = format (s, "%s", state_entry[state].str);
235 
236  return s;
237 }
238 
239 static inline u8 *
240 format_ptx_sm_state (u8 * s, va_list * args)
241 {
242  lacp_state_struct lacp_ptx_sm_state_array[] = {
243 #define _(b, s, n) {.bit = b, .str = #s, },
245 #undef _
246  {.str = NULL}
247  };
248  int state = va_arg (*args, int);
249  lacp_state_struct *state_entry = lacp_ptx_sm_state_array;
250 
251  if (state >= (sizeof (lacp_ptx_sm_state_array) / sizeof (*state_entry)))
252  s = format (s, "Bad state %d", state);
253  else
254  s = format (s, "%s", state_entry[state].str);
255 
256  return s;
257 }
258 
259 static inline int
260 lacp_bit_test (u8 val, u8 bit)
261 {
262  if (val & (1 << bit))
263  return 1;
264  else
265  return 0;
266 }
267 
268 #endif /* __included_lacp_node_h__ */
269 
270 /*
271  * fd.io coding-style-patch-verification: ON
272  *
273  * Local Variables:
274  * eval: (c-set-style "gnu")
275  * End:
276  */
void lacp_periodic(vlib_main_t *vm)
Definition: lacp.c:138
vlib_main_t * vlib_main
Definition: node.h:121
void lacp_init_ptx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: ptx_machine.c:220
volatile u32 lacp_int
Definition: node.h:134
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:291
int lacp_dump_ifs(lacp_interface_details_t **out_bondids)
Definition: cli.c:21
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
void lacp_init_neighbor(slave_if_t *sif, u8 *hw_address, u16 port_number, u32 group)
Definition: lacp.c:333
void lacp_init_mux_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: mux_machine.c:233
marker_pdu_t marker
Definition: node.h:86
static u8 * format_rx_sm_state(u8 *s, va_list *args)
Definition: node.h:180
static u8 lacp_timer_is_running(f64 timer)
Definition: node.h:166
vnet_main_t * vnet_main
Definition: node.h:122
static u8 lacp_timer_is_expired(vlib_main_t *vm, f64 timer)
Definition: node.h:172
unsigned int u32
Definition: types.h:88
lacp_error_t lacp_input(vlib_main_t *vm, vlib_buffer_t *b0, u32 bi0)
Definition: input.c:137
LACP interface details struct.
Definition: node.h:92
static void lacp_stop_timer(f64 *timer)
Definition: node.h:160
unsigned short u16
Definition: types.h:57
u8 debug
Definition: node.h:137
vlib_main_t * vm
Definition: in2out_ed.c:1599
void lacp_create_periodic_process(void)
Definition: node.c:229
lacp_packet_template_id_t
Definition: node.h:28
lacp_error_t
Definition: node.h:69
static u8 * format_mux_sm_state(u8 *s, va_list *args)
Definition: node.h:220
void lacp_init_rx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: rx_machine.c:425
void lacp_send_lacp_pdu(vlib_main_t *vm, slave_if_t *sif)
Definition: lacp.c:108
#define foreach_lacp_error
Definition: node.h:61
lacp_pdu_t lacpdu
Definition: node.h:87
lacp_main_t lacp_main
Definition: lacp.c:26
static u8 * format_ptx_sm_state(u8 *s, va_list *args)
Definition: node.h:240
void lacp_init_tx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: tx_machine.c:108
void lacp_selection_logic(vlib_main_t *vm, slave_if_t *sif)
Definition: selection.c:56
u8 * lacp_input_format_trace(u8 *s, va_list *args)
Definition: input.c:257
u32 lacp_process_node_index
Definition: node.h:125
u32 sw_if_index
Definition: node.h:82
VLIB buffer representation.
Definition: buffer.h:102
void lacp_init_state_machines(vlib_main_t *vm, slave_if_t *sif)
Definition: lacp.c:374
static int lacp_bit_test(u8 val, u8 bit)
Definition: node.h:260
clib_error_t * lacp_plugin_api_hookup(vlib_main_t *vm)
Definition: lacp_api.c:119
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
static u8 * format_tx_sm_state(u8 *s, va_list *args)
Definition: node.h:200
lacp_process_event_t
Definition: node.h:40
u16 msg_id_base
API message ID base.
Definition: node.h:118
marker_packet_template_id_t
Definition: node.h:34