lacp: passive mode support [VPP-1551]
[vpp.git] / src / plugins / lacp / ptx_machine.c
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 #define _GNU_SOURCE
17
18 #include <vnet/bonding/node.h>
19 #include <lacp/node.h>
20
21 /*
22  *  LACP State = NO_PERIODIC
23  */
24 static lacp_fsm_state_t lacp_ptx_state_no_periodic[] = {
25   {LACP_ACTION_NO_PERIODIC, LACP_PTX_STATE_NO_PERIODIC},        // event 0 NO_PERIODIC
26   {LACP_ACTION_SLOW_PERIODIC, LACP_PTX_STATE_SLOW_PERIODIC},    // event 1 LONG_TIMEOUT
27   {LACP_ACTION_NO_PERIODIC, LACP_PTX_STATE_NO_PERIODIC},        // event 2 TIMER_EXPIRED
28   {LACP_ACTION_FAST_PERIODIC, LACP_PTX_STATE_FAST_PERIODIC},    // event 3 SHORT_TIMEOUT
29 };
30
31 /*
32  *  LACP State = FAST_PERIODIC
33  */
34 static lacp_fsm_state_t lacp_ptx_state_fast_periodic[] = {
35   {LACP_ACTION_NO_PERIODIC, LACP_PTX_STATE_NO_PERIODIC},        // event 0 NO_PERIODIC
36   {LACP_ACTION_SLOW_PERIODIC, LACP_PTX_STATE_SLOW_PERIODIC},    // event 1 LONG_TIMEOUT
37   {LACP_ACTION_TIMER_EXPIRED, LACP_PTX_STATE_PERIODIC_TX},      // event 2 TIMER_EXPIRED
38   {LACP_ACTION_FAST_PERIODIC, LACP_PTX_STATE_FAST_PERIODIC},    // event 3 SHORT_TIMEOUT
39 };
40
41 /*
42  *  LACP State = SLOW_PERIODIC
43  */
44 static lacp_fsm_state_t lacp_ptx_state_slow_periodic[] = {
45   {LACP_ACTION_NO_PERIODIC, LACP_PTX_STATE_NO_PERIODIC},        // event 0 NO_PERIODIC
46   {LACP_ACTION_SLOW_PERIODIC, LACP_PTX_STATE_SLOW_PERIODIC},    // event 1 LONG_TIMEOUT
47   {LACP_ACTION_TIMER_EXPIRED, LACP_PTX_STATE_PERIODIC_TX},      // event 2 TIMER_EXPIRED
48   {LACP_ACTION_FAST_PERIODIC, LACP_PTX_STATE_FAST_PERIODIC},    // event 3 SHORT_TIMEOUT
49 };
50
51 /*
52  *  LACP State = PERIODIC_TX
53  */
54 static lacp_fsm_state_t lacp_ptx_state_periodic_tx[] = {
55   {LACP_ACTION_NO_PERIODIC, LACP_PTX_STATE_NO_PERIODIC},        // event 0 NO_PERIODIC
56   {LACP_NOACTION, LACP_PTX_STATE_PERIODIC_TX},  // event 1 LONG_TIMEOUT
57   {LACP_ACTION_TIMER_EXPIRED, LACP_PTX_STATE_PERIODIC_TX},      // event 2 TIMER_EXPIRED
58   {LACP_NOACTION, LACP_PTX_STATE_PERIODIC_TX},  // event 3 SHORT_TIMEOUT
59 };
60
61
62 static lacp_fsm_machine_t lacp_ptx_fsm_table[] = {
63   {lacp_ptx_state_no_periodic},
64   {lacp_ptx_state_fast_periodic},
65   {lacp_ptx_state_slow_periodic},
66   {lacp_ptx_state_periodic_tx},
67 };
68
69 lacp_machine_t lacp_ptx_machine = {
70   lacp_ptx_fsm_table,
71   lacp_ptx_debug_func,
72 };
73
74 int
75 lacp_ptx_action_no_periodic (void *p1, void *p2)
76 {
77   vlib_main_t *vm = (vlib_main_t *) p1;
78   slave_if_t *sif = (slave_if_t *) p2;
79
80   lacp_stop_timer (&sif->periodic_timer);
81   lacp_ptx_post_short_timeout_event (vm, sif);
82   return 0;
83 }
84
85 int
86 lacp_ptx_action_slow_periodic (void *p1, void *p2)
87 {
88   vlib_main_t *vm = (vlib_main_t *) p1;
89   slave_if_t *sif = (slave_if_t *) p2;
90   u8 timer_expired;
91   lacp_main_t *lm = &lacp_main;
92
93   if (!(sif->partner.state & LACP_STATE_LACP_ACTIVITY) &&
94       !(sif->actor.state & LACP_STATE_LACP_ACTIVITY))
95     lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
96                            LACP_PTX_EVENT_NO_PERIODIC, &sif->ptx_state);
97   else
98     {
99       if (lacp_timer_is_running (sif->periodic_timer) &&
100           lacp_timer_is_expired (lm->vlib_main, sif->periodic_timer))
101         timer_expired = 1;
102       else
103         timer_expired = 0;
104
105       lacp_schedule_periodic_timer (lm->vlib_main, sif);
106
107       if (timer_expired || (sif->partner.state & LACP_STATE_LACP_TIMEOUT))
108         lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
109                                LACP_PTX_EVENT_TIMER_EXPIRED, &sif->ptx_state);
110     }
111
112   return 0;
113 }
114
115 int
116 lacp_ptx_action_fast_periodic (void *p1, void *p2)
117 {
118   vlib_main_t *vm = (vlib_main_t *) p1;
119   slave_if_t *sif = (slave_if_t *) p2;
120   u8 timer_expired;
121   lacp_main_t *lm = &lacp_main;
122
123   if (!(sif->partner.state & LACP_STATE_LACP_ACTIVITY) &&
124       !(sif->actor.state & LACP_STATE_LACP_ACTIVITY))
125     lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
126                            LACP_PTX_EVENT_NO_PERIODIC, &sif->ptx_state);
127   else
128     {
129       if (lacp_timer_is_running (sif->periodic_timer) &&
130           lacp_timer_is_expired (lm->vlib_main, sif->periodic_timer))
131         timer_expired = 1;
132       else
133         timer_expired = 0;
134
135       lacp_start_periodic_timer (lm->vlib_main, sif,
136                                  LACP_FAST_PERIODIC_TIMER);
137
138       if (timer_expired)
139         lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
140                                LACP_PTX_EVENT_TIMER_EXPIRED, &sif->ptx_state);
141
142       if (!(sif->partner.state & LACP_STATE_LACP_TIMEOUT))
143         lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
144                                LACP_PTX_EVENT_LONG_TIMEOUT, &sif->ptx_state);
145     }
146
147   return 0;
148 }
149
150 int
151 lacp_ptx_action_timer_expired (void *p1, void *p2)
152 {
153   vlib_main_t *vm = (vlib_main_t *) p1;
154   slave_if_t *sif = (slave_if_t *) p2;
155
156   if (!(sif->partner.state & LACP_STATE_LACP_ACTIVITY) &&
157       !(sif->actor.state & LACP_STATE_LACP_ACTIVITY))
158     lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
159                            LACP_PTX_EVENT_NO_PERIODIC, &sif->ptx_state);
160   else
161     {
162       sif->ntt = 1;
163       lacp_machine_dispatch (&lacp_tx_machine, vm, sif, LACP_TX_EVENT_NTT,
164                              &sif->tx_state);
165       if (sif->partner.state & LACP_STATE_LACP_TIMEOUT)
166         lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
167                                LACP_PTX_EVENT_SHORT_TIMEOUT, &sif->ptx_state);
168       else
169         lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
170                                LACP_PTX_EVENT_LONG_TIMEOUT, &sif->ptx_state);
171     }
172
173   return 0;
174 }
175
176 static u8 *
177 format_ptx_event (u8 * s, va_list * args)
178 {
179   static lacp_event_struct lacp_ptx_event_array[] = {
180 #define _(b, s, n) {.bit = b, .str = #s, },
181     foreach_lacp_ptx_event
182 #undef _
183     {.str = NULL}
184   };
185   int e = va_arg (*args, int);
186   lacp_event_struct *event_entry =
187     (lacp_event_struct *) & lacp_ptx_event_array;
188
189   if (e >= (sizeof (lacp_ptx_event_array) / sizeof (*event_entry)))
190     s = format (s, "Bad event %d", e);
191   else
192     s = format (s, "%s", event_entry[e].str);
193
194   return s;
195 }
196
197 void
198 lacp_ptx_debug_func (slave_if_t * sif, int event, int state,
199                      lacp_fsm_state_t * transition)
200 {
201   clib_warning ("%U-PTX: event %U, old state %U, new state %U",
202                 format_vnet_sw_if_index_name, vnet_get_main (),
203                 sif->sw_if_index, format_ptx_event,
204                 event, format_ptx_sm_state, state, format_ptx_sm_state,
205                 transition->next_state);
206 }
207
208 void
209 lacp_init_ptx_machine (vlib_main_t * vm, slave_if_t * sif)
210 {
211   lacp_machine_dispatch (&lacp_ptx_machine, vm, sif,
212                          LACP_PTX_EVENT_NO_PERIODIC, &sif->ptx_state);
213 }
214
215 /*
216  * fd.io coding-style-patch-verification: ON
217  *
218  * Local Variables:
219  * eval: (c-set-style "gnu")
220  * End:
221  */