FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
lacp.c
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 
16 #include <stdint.h>
17 #include <vlib/vlib.h>
18 #include <vlib/unix/unix.h>
19 #include <vnet/plugin/plugin.h>
20 #include <vpp/app/version.h>
21 #include <vppinfra/hash.h>
22 #include <vnet/bonding/node.h>
23 #include <lacp/node.h>
24 
26 
27 /*
28  * Generate lacp pdu
29  */
30 static void
31 lacp_fill_pdu (lacp_pdu_t * lacpdu, slave_if_t * sif)
32 {
33  /* Actor TLV */
34  lacpdu->actor.port_info = sif->actor;
35 
36  /* Partner TLV */
37  lacpdu->partner.port_info = sif->partner;
38 }
39 
40 /*
41  * send a lacp pkt on an ethernet interface
42  */
43 static void
45 {
46  lacp_main_t *lm = &lacp_main;
47  u32 *to_next;
48  ethernet_lacp_pdu_t *h0;
50  u32 bi0;
51  vlib_buffer_t *b0;
52  vlib_frame_t *f;
53  vlib_main_t *vm = lm->vlib_main;
54  vnet_main_t *vnm = lm->vnet_main;
55 
56  /*
57  * see lacp_periodic_init() to understand what's already painted
58  * into the buffer by the packet template mechanism
59  */
61  (vm, &lm->packet_templates[sif->packet_template_index], &bi0);
62 
63  if (!h0)
64  return;
65 
66  /* Add the interface's ethernet source address */
67  hw = vnet_get_sup_hw_interface (vnm, sif->sw_if_index);
68 
69  clib_memcpy (h0->ethernet.src_address, hw->hw_address,
70  vec_len (hw->hw_address));
71 
72  lacp_fill_pdu (&h0->lacp, sif);
73 
74  /* Set the outbound packet length */
75  b0 = vlib_get_buffer (vm, bi0);
76  b0->current_length = sizeof (ethernet_lacp_pdu_t);
77  b0->current_data = 0;
79 
80  /* And the outbound interface */
81  vnet_buffer (b0)->sw_if_index[VLIB_TX] = hw->sw_if_index;
82 
83  /* And output the packet on the correct interface */
85 
86  to_next = vlib_frame_vector_args (f);
87  to_next[0] = bi0;
88  f->n_vectors = 1;
89 
91 
93 }
94 
95 /*
96  * Decide which lacp packet template to use
97  */
98 static int
100 {
102 
103  return 0;
104 }
105 
106 void
108 {
109  if (sif->mode != BOND_MODE_LACP)
110  {
112  return;
113  }
114 
115  if (sif->packet_template_index == (u8) ~ 0)
116  {
117  /* If we don't know how to talk to this peer, don't try again */
118  if (lacp_pick_packet_template (sif))
119  {
121  return;
122  }
123  }
124 
125  switch (sif->packet_template_index)
126  {
129  break;
130 
131  default:
132  ASSERT (0);
133  }
134 }
135 
136 void
138 {
139  bond_main_t *bm = &bond_main;
140  lacp_main_t *lm = &lacp_main;
141  slave_if_t *sif;
142 
143  /* *INDENT-OFF* */
144  pool_foreach (sif, bm->neighbors,
145  ({
146  if (sif->port_enabled == 0)
147  continue;
148 
149  if (lacp_timer_is_running (sif->current_while_timer) &&
150  lacp_timer_is_expired (lm->vlib_main, sif->current_while_timer))
151  {
152  lacp_machine_dispatch (&lacp_rx_machine, vm, sif,
153  LACP_RX_EVENT_TIMER_EXPIRED, &sif->rx_state);
154  }
155 
158  {
159  lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
160  LACP_PTX_EVENT_TIMER_EXPIRED, &sif->ptx_state);
161  }
164  {
165  sif->ready_n = 1;
166  lacp_stop_timer (&sif->wait_while_timer);
167  lacp_selection_logic (vm, sif);
168  }
169  }));
170  /* *INDENT-ON* */
171 }
172 
173 static void
175  slave_if_t * sif, u8 enable)
176 {
177  lacp_main_t *lm = &lacp_main;
178  uword port_number;
179 
180  if (enable)
181  {
182  port_number = clib_bitmap_first_clear (bif->port_number_bitmap);
184  port_number, 1);
185  // bitmap starts at 0. Our port number starts at 1.
186  lacp_init_neighbor (sif, bif->hw_address, port_number + 1, sif->group);
187  lacp_init_state_machines (vm, sif);
188  lm->lacp_int++;
189  if (lm->lacp_int == 1)
190  {
193  }
194  }
195  else
196  {
197  lm->lacp_int--;
198  if (lm->lacp_int == 0)
199  {
202  }
203  }
204 }
205 
206 static clib_error_t *
208 {
209  lacp_main_t *lm = &lacp_main;
210  ethernet_lacp_pdu_t h;
211  ethernet_marker_pdu_t m;
212  u8 dst[] = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x02 };
213 
214  /* initialize binary API */
216 
217  /* Create the ethernet lacp packet template */
218 
219  memset (&h, 0, sizeof (h));
220 
221  memcpy (h.ethernet.dst_address, dst, sizeof (h.ethernet.dst_address));
222 
223  /* leave src address blank (fill in at send time) */
224 
225  h.ethernet.type = htons (ETHERNET_TYPE_SLOW_PROTOCOLS);
226 
227  h.lacp.subtype = LACP_SUBTYPE;
228  h.lacp.version_number = LACP_ACTOR_LACP_VERSION;
229 
230  /* Actor TLV */
231  h.lacp.actor.tlv_type = LACP_ACTOR_INFORMATION;
232  h.lacp.actor.tlv_length = sizeof (lacp_actor_partner_t);
233 
234  /* Partner TLV */
235  h.lacp.partner.tlv_type = LACP_PARTNER_INFORMATION;
236  h.lacp.partner.tlv_length = sizeof (lacp_actor_partner_t);
237 
238  /* Collector TLV */
239  h.lacp.collector.tlv_type = LACP_COLLECTOR_INFORMATION;
240  h.lacp.collector.tlv_length = sizeof (lacp_collector_t);
241  h.lacp.collector.max_delay = 0;
242 
243  /* Terminator TLV */
244  h.lacp.terminator.tlv_type = LACP_TERMINATOR_INFORMATION;
245  h.lacp.terminator.tlv_length = 0;
246 
249  /* data */ &h,
250  sizeof (h),
251  /* alloc chunk size */ 8,
252  "lacp-ethernet");
253 
254  /* Create the ethernet marker protocol packet template */
255 
256  memset (&m, 0, sizeof (m));
257 
258  memcpy (m.ethernet.dst_address, dst, sizeof (m.ethernet.dst_address));
259 
260  /* leave src address blank (fill in at send time) */
261 
262  m.ethernet.type = htons (ETHERNET_TYPE_SLOW_PROTOCOLS);
263 
264  m.marker.subtype = MARKER_SUBTYPE;
265  m.marker.version_number = MARKER_PROTOCOL_VERSION;
266 
267  m.marker.marker_info.tlv_length = sizeof (marker_information_t);
268 
269  /* Terminator TLV */
270  m.marker.terminator.tlv_type = MARKER_TERMINATOR_INFORMATION;
271  m.marker.terminator.tlv_length = 0;
272 
275  /* data */ &m,
276  sizeof (m),
277  /* alloc chunk size */ 8,
278  "marker-ethernet");
279 
281 
282  return 0;
283 }
284 
285 int
287  slave_if_t * sif, int event, int *state)
288 {
289  lacp_fsm_state_t *transition;
290  int rc = 0;
291 
292  transition = &machine->tables[*state].state_table[event];
293  LACP_DBG2 (sif, event, *state, machine, transition);
294  *state = transition->next_state;
295  if (transition->action)
296  rc = (*transition->action) ((void *) vm, (void *) sif);
297 
298  return rc;
299 }
300 
301 void
302 lacp_init_neighbor (slave_if_t * sif, u8 * hw_address, u16 port_number,
303  u32 group)
304 {
311  sif->lacp_enabled = 1;
312  sif->loopback_port = 0;
313  sif->ready = 0;
314  sif->ready_n = 0;
315  sif->port_moved = 0;
316  sif->ntt = 0;
317  sif->selected = LACP_PORT_UNSELECTED;
318  sif->actor.state = LACP_STATE_AGGREGATION;
320  sif->actor.state |= LACP_STATE_LACP_TIMEOUT;
321  if (sif->is_passive == 0)
322  sif->actor.state |= LACP_STATE_LACP_ACTIVITY;
323  clib_memcpy (sif->actor.system, hw_address, 6);
324  sif->actor.system_priority = htons (LACP_DEFAULT_SYSTEM_PRIORITY);
325  sif->actor.key = htons (group);
326  sif->actor.port_number = htons (port_number);
327  sif->actor.port_priority = htons (LACP_DEFAULT_PORT_PRIORITY);
328 
329  sif->partner.system_priority = htons (LACP_DEFAULT_SYSTEM_PRIORITY);
330  sif->partner.key = htons (group);
331  sif->partner.port_number = htons (port_number);
332  sif->partner.port_priority = htons (LACP_DEFAULT_PORT_PRIORITY);
333  sif->partner.key = htons (group);
334  sif->partner.state = LACP_STATE_LACP_ACTIVITY;
335 
336  sif->actor_admin = sif->actor;
337  sif->partner_admin = sif->partner;
338 }
339 
340 void
342 {
343  lacp_init_tx_machine (vm, sif);
344  lacp_init_mux_machine (vm, sif);
345  lacp_init_ptx_machine (vm, sif);
346  lacp_init_rx_machine (vm, sif);
347 }
348 
350 
351 static clib_error_t *
353 {
354  lacp_main_t *lm = &lacp_main;
355  slave_if_t *sif;
356  vlib_main_t *vm = lm->vlib_main;
357 
358  sif = bond_get_slave_by_sw_if_index (sw_if_index);
359  if (sif)
360  {
362  if (sif->port_enabled == 0)
363  {
364  if (sif->lacp_enabled)
365  {
366  lacp_init_state_machines (vm, sif);
367  lacp_init_neighbor (sif, sif->actor_admin.system,
368  ntohs (sif->actor_admin.port_number),
369  ntohs (sif->actor_admin.key));
370  }
371  }
372  }
373 
374  return 0;
375 }
376 
378 
379 static clib_error_t *
381 {
382  lacp_main_t *lm = &lacp_main;
383  slave_if_t *sif;
385  vlib_main_t *vm = lm->vlib_main;
386 
387  sw = vnet_get_hw_sw_interface (vnm, hw_if_index);
389  if (sif)
390  {
391  if (!(flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
392  {
393  if (sif->lacp_enabled)
394  {
395  lacp_init_state_machines (vm, sif);
396  lacp_init_neighbor (sif, sif->actor_admin.system,
397  ntohs (sif->actor_admin.port_number),
398  ntohs (sif->actor_admin.key));
399  }
400  }
401  }
402 
403  return 0;
404 }
405 
407 
408 /* *INDENT-OFF* */
410  .version = VPP_BUILD_VER,
411  .description = "Link Aggregation Control Protocol",
412 };
413 /* *INDENT-ON* */
414 
415 /*
416  * fd.io coding-style-patch-verification: ON
417  *
418  * Local Variables:
419  * eval: (c-set-style "gnu")
420  * End:
421  */
void lacp_send_lacp_pdu(vlib_main_t *vm, slave_if_t *sif)
Definition: lacp.c:107
void lacp_init_mux_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: mux_machine.c:224
vlib_main_t * vlib_main
Definition: node.h:119
void lacp_init_ptx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: ptx_machine.c:190
int selected
Definition: node.h:240
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
static void lacp_send_ethernet_lacp_pdu(slave_if_t *sif)
Definition: lacp.c:44
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:227
void lacp_init_neighbor(slave_if_t *sif, u8 *hw_address, u16 port_number, u32 group)
Definition: lacp.c:302
bond_main_t bond_main
Definition: node.c:24
static uword * clib_bitmap_set(uword *ai, uword i, uword value)
Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap. ...
Definition: bitmap.h:167
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:390
u32 lacp_int
Definition: node.h:132
f64 current_while_timer
Definition: node.h:246
u8 mode
Definition: node.h:279
f64 last_lacpdu_time
Definition: node.h:252
lacp_fsm_state_t * state_table
Definition: machine.h:37
u8 ntt
Definition: node.h:222
static vnet_sw_interface_t * vnet_get_hw_sw_interface(vnet_main_t *vnm, u32 hw_if_index)
f64 periodic_timer
Definition: node.h:255
static void bond_register_callback(lacp_enable_disable_func func)
Definition: node.h:409
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:104
f32 ttl_in_seconds
Definition: node.h:184
void * vlib_packet_template_get_packet(vlib_main_t *vm, vlib_packet_template_t *t, u32 *bi_result)
Definition: buffer.c:773
static u8 lacp_timer_is_running(f64 timer)
Definition: node.h:163
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:440
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
vnet_main_t * vnet_main
Definition: node.h:120
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(lacp_sw_interface_up_down)
vlib_packet_template_t packet_templates[LACP_N_PACKET_TEMPLATES]
Definition: node.h:126
action_func action
Definition: machine.h:28
lacp_port_info_t actor
Definition: node.h:215
static u8 lacp_timer_is_expired(vlib_main_t *vm, f64 timer)
Definition: node.h:169
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:182
f64 partner_churn_timer
Definition: node.h:258
static void lacp_fill_pdu(lacp_pdu_t *lacpdu, slave_if_t *sif)
Definition: lacp.c:31
#define LACP_DEFAULT_SYSTEM_PRIORITY
Definition: protocol.h:95
void lacp_periodic(vlib_main_t *vm)
Definition: lacp.c:137
#define MARKER_SUBTYPE
Definition: protocol.h:128
u8 ready
Definition: node.h:237
void vlib_packet_template_init(vlib_main_t *vm, vlib_packet_template_t *t, void *packet_data, uword n_packet_data_bytes, uword min_n_buffers_each_alloc, char *fmt,...)
Definition: buffer.c:725
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:108
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:952
static void lacp_stop_timer(f64 *timer)
Definition: node.h:157
VLIB_PLUGIN_REGISTER()
u8 port_moved
Definition: node.h:243
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:191
static void lacp_interface_enable_disable(vlib_main_t *vm, bond_if_t *bif, slave_if_t *sif, u8 enable)
Definition: lacp.c:174
#define LACP_SUBTYPE
Definition: protocol.h:25
#define LACP_SHORT_TIMOUT_TIME
Definition: node.h:26
#define MARKER_PROTOCOL_VERSION
Definition: protocol.h:129
static int lacp_pick_packet_template(slave_if_t *sif)
Definition: lacp.c:99
static clib_error_t * lacp_periodic_init(vlib_main_t *vm)
Definition: lacp.c:207
u16 n_vectors
Definition: node.h:344
u8 is_passive
Definition: node.h:211
u32 sw_if_index
Definition: node.h:181
vlib_main_t * vm
Definition: buffer.c:294
lacp_port_info_t partner
Definition: node.h:214
#define LACP_DEFAULT_PORT_PRIORITY
Definition: protocol.h:94
u32 group
Definition: node.h:270
#define clib_memcpy(a, b, c)
Definition: string.h:75
void lacp_init_rx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: rx_machine.c:411
lacp_main_t lacp_main
Definition: lacp.c:25
clib_error_t * lacp_plugin_api_hookup(vlib_main_t *vm)
Definition: lacp_api.c:178
u8 loopback_port
Definition: node.h:276
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:588
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
#define LACP_DBG2(n, e, s, m, t)
Definition: node.h:53
vhost_vring_state_t state
Definition: vhost-user.h:82
static clib_error_t * lacp_hw_interface_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: lacp.c:380
vlib_packet_template_t marker_packet_templates[MARKER_N_PACKET_TEMPLATES]
Definition: node.h:129
u8 ready_n
Definition: node.h:234
u64 uword
Definition: types.h:112
void lacp_init_tx_machine(vlib_main_t *vm, slave_if_t *sif)
Definition: tx_machine.c:96
u32 total_length_not_including_first_buffer
Only valid for first buffer in chain.
Definition: buffer.h:159
u8 lacp_enabled
Definition: node.h:231
Definition: defs.h:47
unsigned short u16
Definition: types.h:57
u32 lacp_process_node_index
Definition: node.h:123
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
uword * port_number_bitmap
Definition: node.h:168
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
lacp_port_info_t partner_admin
Definition: node.h:215
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(lacp_hw_interface_up_down)
#define vnet_buffer(b)
Definition: buffer.h:372
slave_if_t * neighbors
Definition: node.h:293
u8 hw_address[6]
Definition: node.h:170
f64 actor_churn_timer
Definition: node.h:249
u8 port_enabled
Definition: node.h:225
static slave_if_t * bond_get_slave_by_sw_if_index(u32 sw_if_index)
Definition: node.h:440
lacp_port_info_t actor_admin
Definition: node.h:219
static uword clib_bitmap_first_clear(uword *ai)
Return the lowest numbered clear bit in a bitmap.
Definition: bitmap.h:424
u32 flags
Definition: vhost-user.h:77
u8 packet_template_index
Definition: node.h:193
void lacp_init_state_machines(vlib_main_t *vm, slave_if_t *sif)
Definition: lacp.c:341
f64 wait_while_timer
Definition: node.h:261
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
lacp_fsm_machine_t * tables
Definition: machine.h:42
static clib_error_t * lacp_sw_interface_up_down(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: lacp.c:352
int lacp_machine_dispatch(lacp_machine_t *machine, vlib_main_t *vm, slave_if_t *sif, int event, int *state)
Definition: lacp.c:286
#define LACP_ACTOR_LACP_VERSION
Definition: protocol.h:26