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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_lacp_node_h__
16 #define __included_lacp_node_h__
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>
30 LACP_PACKET_TEMPLATE_ETHERNET,
31 LACP_N_PACKET_TEMPLATES,
32 } lacp_packet_template_id_t;
36 MARKER_PACKET_TEMPLATE_ETHERNET,
37 MARKER_N_PACKET_TEMPLATES,
38 } marker_packet_template_id_t;
42 LACP_PROCESS_EVENT_START = 1,
43 LACP_PROCESS_EVENT_STOP = 2,
44 } lacp_process_event_t;
46 #define LACP_DBG(n, args...) \
48 lacp_main_t *_lm = &lacp_main; \
49 if (_lm->debug || n->debug) \
50 clib_warning (args); \
53 #define LACP_DBG2(n, e, s, m, t) \
55 lacp_main_t *_lm = &lacp_main; \
56 if ((m)->debug && (_lm->debug || (n)->debug)) \
57 (*m->debug)(n, e, s, t); \
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")
71 #define _(sym,str) LACP_ERROR_##sym,
77 /* lacp packet trace capture */
89 /** LACP interface details struct */
93 u8 interface_name[64];
98 u8 bond_interface_name[64];
99 u16 actor_system_priority;
102 u16 actor_port_priority;
103 u16 actor_port_number;
105 u16 partner_system_priority;
106 u8 partner_system[6];
108 u16 partner_port_priority;
109 u16 partner_port_number;
111 } lacp_interface_details_t;
115 /** API message ID base */
118 /* convenience variables */
119 vlib_main_t *vlib_main;
120 vnet_main_t *vnet_main;
122 /* Background process node index */
123 u32 lacp_process_node_index;
125 /* Packet templates for different encap types */
126 vlib_packet_template_t packet_templates[LACP_N_PACKET_TEMPLATES];
128 /* Packet templates for different encap types */
129 vlib_packet_template_t marker_packet_templates[MARKER_N_PACKET_TEMPLATES];
131 /* LACP interface count */
134 /* debug is on or off */
138 extern lacp_state_struct lacp_state_array[];
139 extern lacp_main_t lacp_main;
141 clib_error_t *lacp_plugin_api_hookup (vlib_main_t * vm);
142 int lacp_dump_ifs (lacp_interface_details_t ** out_bondids);
143 lacp_error_t lacp_input (vlib_main_t * vm, vlib_buffer_t * b0, u32 bi0);
144 void lacp_periodic (vlib_main_t * vm);
145 u8 *lacp_input_format_trace (u8 * s, va_list * args);
146 void lacp_init_neighbor (slave_if_t * sif, u8 * hw_address,
147 u16 port_number, u32 group);
148 void lacp_init_state_machines (vlib_main_t * vm, slave_if_t * sif);
149 void lacp_init_rx_machine (vlib_main_t * vm, slave_if_t * sif);
150 void lacp_init_tx_machine (vlib_main_t * vm, slave_if_t * sif);
151 void lacp_init_ptx_machine (vlib_main_t * vm, slave_if_t * sif);
152 void lacp_init_mux_machine (vlib_main_t * vm, slave_if_t * sif);
153 void lacp_selection_logic (vlib_main_t * vm, slave_if_t * sif);
154 void lacp_send_lacp_pdu (vlib_main_t * vm, slave_if_t * sif);
157 lacp_stop_timer (f64 * timer)
163 lacp_timer_is_running (f64 timer)
165 return (timer != 0.0);
169 lacp_timer_is_expired (vlib_main_t * vm, f64 timer)
171 f64 now = vlib_time_now (vm);
173 return (now >= timer);
177 format_rx_sm_state (u8 * s, va_list * args)
179 lacp_state_struct lacp_rx_sm_state_array[] = {
180 #define _(b, s, n) {.bit = b, .str = #s, },
181 foreach_lacp_rx_sm_state
185 int state = va_arg (*args, int);
186 lacp_state_struct *state_entry =
187 (lacp_state_struct *) & lacp_rx_sm_state_array;
189 if (state >= (sizeof (lacp_rx_sm_state_array) / sizeof (*state_entry)))
190 s = format (s, "Bad state %d", state);
192 s = format (s, "%s", state_entry[state].str);
198 format_tx_sm_state (u8 * s, va_list * args)
200 lacp_state_struct lacp_tx_sm_state_array[] = {
201 #define _(b, s, n) {.bit = b, .str = #s, },
202 foreach_lacp_tx_sm_state
206 int state = va_arg (*args, int);
207 lacp_state_struct *state_entry =
208 (lacp_state_struct *) & lacp_tx_sm_state_array;
210 if (state >= (sizeof (lacp_tx_sm_state_array) / sizeof (*state_entry)))
211 s = format (s, "Bad state %d", state);
213 s = format (s, "%s", state_entry[state].str);
219 format_mux_sm_state (u8 * s, va_list * args)
221 lacp_state_struct lacp_mux_sm_state_array[] = {
222 #define _(b, s, n) {.bit = b, .str = #s, },
223 foreach_lacp_mux_sm_state
227 int state = va_arg (*args, int);
228 lacp_state_struct *state_entry =
229 (lacp_state_struct *) & lacp_mux_sm_state_array;
231 if (state >= (sizeof (lacp_mux_sm_state_array) / sizeof (*state_entry)))
232 s = format (s, "Bad state %d", state);
234 s = format (s, "%s", state_entry[state].str);
240 format_ptx_sm_state (u8 * s, va_list * args)
242 lacp_state_struct lacp_ptx_sm_state_array[] = {
243 #define _(b, s, n) {.bit = b, .str = #s, },
244 foreach_lacp_ptx_sm_state
248 int state = va_arg (*args, int);
249 lacp_state_struct *state_entry =
250 (lacp_state_struct *) & lacp_ptx_sm_state_array;
252 if (state >= (sizeof (lacp_ptx_sm_state_array) / sizeof (*state_entry)))
253 s = format (s, "Bad state %d", state);
255 s = format (s, "%s", state_entry[state].str);
261 lacp_bit_test (u8 val, u8 bit)
263 if (val & (1 << bit))
269 #endif /* __included_lacp_node_h__ */
272 * fd.io coding-style-patch-verification: ON
275 * eval: (c-set-style "gnu")