LCOV - code coverage report
Current view: top level - plugins/lacp - rx_machine.c (source / functions) Hit Total Coverage
Test: coverage-filtered.info Lines: 116 163 71.2 %
Date: 2023-07-05 22:20:52 Functions: 15 18 83.3 %

          Line data    Source code
       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 = INITIALIZE
      23             :  */
      24             : static lacp_fsm_state_t lacp_rx_state_initialize[] = {
      25             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_PORT_DISABLED},        // event 0 BEGIN
      26             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_PORT_DISABLED},        // event 1 PORT_DISABLED
      27             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_PORT_DISABLED},        // event 2 PORT_MOVED
      28             :   {LACP_NOACTION, LACP_RX_STATE_INITIALIZE},    // event 3 LACP_ENABLED
      29             :   {LACP_NOACTION, LACP_RX_STATE_INITIALIZE},    // event 4 LACP_DISABLED
      30             :   {LACP_NOACTION, LACP_RX_STATE_INITIALIZE},    // event 5 PDU_RECEIVED
      31             :   {LACP_NOACTION, LACP_RX_STATE_INITIALIZE},    // event 6 TIMER_EXPIRED
      32             : };
      33             : 
      34             : /*
      35             :  *  LACP State = PORT_DISABLED
      36             :  */
      37             : static lacp_fsm_state_t lacp_rx_state_port_disabled[] = {
      38             :   {LACP_ACTION_PORT_DISABLED, LACP_RX_STATE_PORT_DISABLED},     // event 0 BEGIN
      39             :   {LACP_ACTION_PORT_DISABLED, LACP_RX_STATE_PORT_DISABLED},     // event 1 PORT_DISABLED
      40             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_INITIALIZE},   // event 2 PORT_MOVED
      41             :   {LACP_ACTION_EXPIRED, LACP_RX_STATE_EXPIRED}, // event 3 LACP_ENABLED
      42             :   {LACP_ACTION_LACP_DISABLED, LACP_RX_STATE_LACP_DISABLED},     // event 4 LACP_DISABLED
      43             :   {LACP_NOACTION, LACP_RX_STATE_PORT_DISABLED}, // event 5 PDU_RECEIVED
      44             :   {LACP_NOACTION, LACP_RX_STATE_PORT_DISABLED}, // event 6 TIMER_EXPIRED
      45             : };
      46             : 
      47             : /*
      48             :  *  LACP State = EXPIRED
      49             :  */
      50             : static lacp_fsm_state_t lacp_rx_state_expired[] = {
      51             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_INITIALIZE},   // event 0 BEGIN
      52             :   {LACP_NOACTION, LACP_RX_STATE_EXPIRED},       // event 1 PORT_DISABLED
      53             :   {LACP_NOACTION, LACP_RX_STATE_EXPIRED},       // event 2 PORT_MOVED
      54             :   {LACP_NOACTION, LACP_RX_STATE_EXPIRED},       // event 3 LACP_ENABLED
      55             :   {LACP_NOACTION, LACP_RX_STATE_EXPIRED},       // event 4 LACP_DISABLED
      56             :   {LACP_ACTION_CURRENT, LACP_RX_STATE_CURRENT}, // event 5 PDU_RECEIVED
      57             :   {LACP_ACTION_DEFAULTED, LACP_RX_STATE_DEFAULTED},     // event 6 TIMER_EXPIRED
      58             : };
      59             : 
      60             : /*
      61             :  *  LACP State = LACP_DISABLED
      62             :  */
      63             : static lacp_fsm_state_t lacp_rx_state_lacp_disabled[] = {
      64             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_INITIALIZE},   // event 0 BEGIN
      65             :   {LACP_NOACTION, LACP_RX_STATE_LACP_DISABLED}, // event 1 PORT_DISABLED
      66             :   {LACP_NOACTION, LACP_RX_STATE_LACP_DISABLED}, // event 2 PORT_MOVED
      67             :   {LACP_ACTION_EXPIRED, LACP_RX_STATE_EXPIRED}, // event 3 LACP_ENABLED XXX
      68             :   {LACP_ACTION_LACP_DISABLED, LACP_RX_STATE_LACP_DISABLED},     // event 4 LACP_DISABLED
      69             :   {LACP_NOACTION, LACP_RX_STATE_LACP_DISABLED}, // event 5 PDU_RECEIVED
      70             :   {LACP_NOACTION, LACP_RX_STATE_LACP_DISABLED}, // event 6 TIMER_EXPIRED
      71             : };
      72             : 
      73             : /*
      74             :  *  LACP State = DEFAULTED
      75             :  */
      76             : static lacp_fsm_state_t lacp_rx_state_defaulted[] = {
      77             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_INITIALIZE},   // event 0 BEGIN
      78             :   {LACP_NOACTION, LACP_RX_STATE_DEFAULTED},     // event 1 PORT_DISABLED
      79             :   {LACP_NOACTION, LACP_RX_STATE_DEFAULTED},     // event 2 PORT_MOVED
      80             :   {LACP_NOACTION, LACP_RX_STATE_DEFAULTED},     // event 3 LACP_ENABLED
      81             :   {LACP_ACTION_LACP_DISABLED, LACP_RX_STATE_LACP_DISABLED},     // event 4 LACP_DISABLED
      82             :   {LACP_ACTION_CURRENT, LACP_RX_STATE_CURRENT}, // event 5 PDU_RECEIVED
      83             :   {LACP_ACTION_DEFAULTED, LACP_RX_STATE_DEFAULTED},     // event 6 TIMER_EXPIRED
      84             : };
      85             : 
      86             : /*
      87             :  *  LACP State = CURRENT
      88             :  */
      89             : static lacp_fsm_state_t lacp_rx_state_current[] = {
      90             :   {LACP_ACTION_INITIALIZE, LACP_RX_STATE_INITIALIZE},   // event 0 BEGIN
      91             :   {LACP_NOACTION, LACP_RX_STATE_CURRENT},       // event 1 PORT_DISABLED
      92             :   {LACP_NOACTION, LACP_RX_STATE_CURRENT},       // event 1 PORT_MOVED
      93             :   {LACP_NOACTION, LACP_RX_STATE_CURRENT},       // event 2 LACP_ENABLED
      94             :   {LACP_ACTION_LACP_DISABLED, LACP_RX_STATE_LACP_DISABLED},     // event 3 LACP_DISABLED
      95             :   {LACP_ACTION_CURRENT, LACP_RX_STATE_CURRENT}, // event 4 PDU_RECEIVED
      96             :   {LACP_ACTION_EXPIRED, LACP_RX_STATE_EXPIRED}, // event 5 TIMER_EXPIRED
      97             : };
      98             : 
      99             : static lacp_fsm_machine_t lacp_rx_fsm_table[] = {
     100             :   {lacp_rx_state_initialize},
     101             :   {lacp_rx_state_port_disabled},
     102             :   {lacp_rx_state_expired},
     103             :   {lacp_rx_state_lacp_disabled},
     104             :   {lacp_rx_state_defaulted},
     105             :   {lacp_rx_state_current},
     106             : };
     107             : 
     108             : lacp_machine_t lacp_rx_machine = {
     109             :   lacp_rx_fsm_table,
     110             :   lacp_rx_debug_func,
     111             : };
     112             : 
     113             : static void
     114          16 : lacp_set_port_unselected (vlib_main_t * vm, member_if_t * mif)
     115             : {
     116          16 :   mif->selected = LACP_PORT_UNSELECTED;
     117             : 
     118          16 :   switch (mif->mux_state)
     119             :     {
     120          16 :     case LACP_MUX_STATE_DETACHED:
     121          16 :       break;
     122           0 :     case LACP_MUX_STATE_WAITING:
     123           0 :       break;
     124           0 :     case LACP_MUX_STATE_ATTACHED:
     125           0 :       return;
     126             :       break;
     127           0 :     case LACP_MUX_STATE_COLLECTING_DISTRIBUTING:
     128           0 :       if (mif->partner.state & LACP_STATE_SYNCHRONIZATION)
     129           0 :         return;
     130           0 :       break;
     131           0 :     default:
     132           0 :       break;
     133             :     }
     134          16 :   lacp_machine_dispatch (&lacp_mux_machine, vm, mif,
     135             :                          LACP_MUX_EVENT_UNSELECTED, &mif->mux_state);
     136             : }
     137             : 
     138             : static void
     139           0 : lacp_update_default_selected (vlib_main_t * vm, member_if_t * mif)
     140             : {
     141           0 :   if ((mif->partner_admin.state & LACP_STATE_AGGREGATION) !=
     142           0 :       (mif->partner.state & LACP_STATE_AGGREGATION) ||
     143           0 :       memcmp (&mif->partner, &mif->partner_admin,
     144             :               sizeof (mif->partner) - sizeof (mif->partner.state)))
     145             :     {
     146           0 :       lacp_set_port_unselected (vm, mif);
     147             :     }
     148           0 : }
     149             : 
     150             : static void
     151          11 : lacp_record_default (member_if_t * mif)
     152             : {
     153          11 :   mif->partner = mif->partner_admin;
     154          11 :   mif->actor.state |= LACP_STATE_DEFAULTED;
     155          11 : }
     156             : 
     157             : static void
     158          15 : lacp_update_selected (vlib_main_t * vm, member_if_t * mif)
     159             : {
     160          15 :   lacp_pdu_t *lacpdu = (lacp_pdu_t *) mif->last_rx_pkt;
     161             : 
     162          15 :   if ((lacpdu->actor.port_info.state & LACP_STATE_AGGREGATION) !=
     163          15 :       (mif->partner.state & LACP_STATE_AGGREGATION) ||
     164          10 :       memcmp (&mif->partner, &lacpdu->actor.port_info,
     165             :               sizeof (mif->partner) - sizeof (mif->partner.state)))
     166             :     {
     167           5 :       lacp_set_port_unselected (vm, mif);
     168             :     }
     169          15 : }
     170             : 
     171             : static void
     172          15 : lacp_update_ntt (vlib_main_t * vm, member_if_t * mif)
     173             : {
     174          15 :   lacp_pdu_t *lacpdu = (lacp_pdu_t *) mif->last_rx_pkt;
     175          15 :   u8 states = LACP_STATE_LACP_ACTIVITY | LACP_STATE_LACP_TIMEOUT |
     176             :     LACP_STATE_SYNCHRONIZATION | LACP_STATE_AGGREGATION;
     177             : 
     178          15 :   if ((states & lacpdu->partner.port_info.state) !=
     179          15 :       (states & mif->actor.state)
     180          10 :       || memcmp (&mif->actor, &lacpdu->partner.port_info,
     181             :                  sizeof (mif->actor) - sizeof (mif->actor.state)))
     182             :     {
     183           5 :       mif->ntt = 1;
     184           5 :       lacp_start_periodic_timer (vm, mif, 0);
     185             :     }
     186          15 : }
     187             : 
     188             : /*
     189             :  * compare lacpdu partner info against mif->partner. Return 1 if they match, 0
     190             :  * otherwise.
     191             :  */
     192             : static u8
     193          15 : lacp_compare_partner (member_if_t * mif)
     194             : {
     195          15 :   lacp_pdu_t *lacpdu = (lacp_pdu_t *) mif->last_rx_pkt;
     196             : 
     197          15 :   if ((!memcmp (&mif->partner, &lacpdu->actor.port_info,
     198          10 :                 sizeof (mif->partner) - sizeof (mif->partner.state)) &&
     199          10 :        ((mif->actor.state & LACP_STATE_AGGREGATION) ==
     200          10 :         (lacpdu->partner.port_info.state & LACP_STATE_AGGREGATION))) ||
     201           5 :       ((lacpdu->actor.port_info.state & LACP_STATE_AGGREGATION) == 0))
     202          10 :     return 1;
     203             : 
     204           5 :   return 0;
     205             : }
     206             : 
     207             : static void
     208          15 : lacp_record_pdu (vlib_main_t * vm, member_if_t * mif)
     209             : {
     210          15 :   lacp_pdu_t *lacpdu = (lacp_pdu_t *) mif->last_rx_pkt;
     211             :   u8 match;
     212             : 
     213             :   /* Transition PTX out of NO_PERIODIC if needed */
     214          15 :   if (!(mif->partner.state & LACP_STATE_LACP_ACTIVITY) &&
     215           5 :       (lacpdu->actor.port_info.state & LACP_STATE_LACP_ACTIVITY))
     216           5 :     lacp_ptx_post_short_timeout_event (vm, mif);
     217          15 :   match = lacp_compare_partner (mif);
     218          15 :   mif->partner = lacpdu->actor.port_info;
     219          15 :   mif->actor.state &= ~LACP_STATE_DEFAULTED;
     220          15 :   if (match && (lacpdu->actor.port_info.state & LACP_STATE_SYNCHRONIZATION))
     221           8 :     mif->partner.state |= LACP_STATE_SYNCHRONIZATION;
     222             :   else
     223           7 :     mif->partner.state &= ~LACP_STATE_SYNCHRONIZATION;
     224          15 : }
     225             : 
     226             : static void
     227          11 : lacp_set_port_moved (vlib_main_t * vm, member_if_t * mif, u8 val)
     228             : {
     229          11 :   mif->port_moved = val;
     230             : 
     231          11 :   if (mif->port_moved)
     232           0 :     lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     233             :                            LACP_RX_EVENT_PORT_MOVED, &mif->rx_state);
     234          11 :   else if (!mif->port_enabled)
     235           2 :     lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     236             :                            LACP_RX_EVENT_PORT_DISABLED, &mif->rx_state);
     237          11 : }
     238             : 
     239             : int
     240          11 : lacp_rx_action_initialize (void *p1, void *p2)
     241             : {
     242          11 :   vlib_main_t *vm = p1;
     243          11 :   member_if_t *mif = p2;
     244             : 
     245          11 :   lacp_set_port_unselected (vm, mif);
     246          11 :   lacp_record_default (mif);
     247          11 :   mif->actor.state &= ~LACP_STATE_EXPIRED;
     248          11 :   lacp_set_port_moved (vm, mif, 0);
     249             :   /* UCT */
     250          11 :   lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     251             :                          LACP_RX_EVENT_BEGIN, &mif->rx_state);
     252             : 
     253          11 :   return 0;
     254             : }
     255             : 
     256             : int
     257          13 : lacp_rx_action_port_disabled (void *p1, void *p2)
     258             : {
     259          13 :   vlib_main_t *vm = p1;
     260          13 :   member_if_t *mif = p2;
     261             : 
     262          13 :   mif->partner.state &= ~LACP_STATE_SYNCHRONIZATION;
     263          13 :   if (mif->port_moved)
     264             :     {
     265           0 :       lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     266             :                              LACP_RX_EVENT_PORT_MOVED, &mif->rx_state);
     267             :     }
     268          13 :   if (mif->port_enabled)
     269             :     {
     270           9 :       if (mif->lacp_enabled)
     271           9 :         lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     272             :                                LACP_RX_EVENT_LACP_ENABLED, &mif->rx_state);
     273             :       else
     274           0 :         lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     275             :                                LACP_RX_EVENT_LACP_DISABLED, &mif->rx_state);
     276             :     }
     277             : 
     278          13 :   return 0;
     279             : }
     280             : 
     281             : int
     282          11 : lacp_rx_action_expired (void *p1, void *p2)
     283             : {
     284          11 :   vlib_main_t *vm = p1;
     285          11 :   member_if_t *mif = p2;
     286             :   u8 timer_expired;
     287             : 
     288          11 :   mif->partner.state &= ~LACP_STATE_SYNCHRONIZATION;
     289          11 :   mif->partner.state |= LACP_STATE_LACP_TIMEOUT;
     290          11 :   lacp_ptx_post_short_timeout_event (vm, mif);
     291          11 :   if (lacp_timer_is_running (mif->current_while_timer) &&
     292           0 :       lacp_timer_is_expired (vm, mif->current_while_timer))
     293           0 :     timer_expired = 1;
     294             :   else
     295          11 :     timer_expired = 0;
     296          11 :   lacp_start_current_while_timer (vm, mif, mif->ttl_in_seconds);
     297          11 :   mif->actor.state |= LACP_STATE_EXPIRED;
     298          11 :   if (timer_expired)
     299           0 :     lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     300             :                            LACP_RX_EVENT_TIMER_EXPIRED, &mif->rx_state);
     301          11 :   if (mif->last_rx_pkt && vec_len (mif->last_rx_pkt))
     302           0 :     lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     303             :                            LACP_RX_EVENT_PDU_RECEIVED, &mif->rx_state);
     304             : 
     305          11 :   return 0;
     306             : }
     307             : 
     308             : int
     309           0 : lacp_rx_action_lacp_disabled (void *p1, void *p2)
     310             : {
     311           0 :   vlib_main_t *vm = p1;
     312           0 :   member_if_t *mif = p2;
     313             : 
     314           0 :   lacp_set_port_unselected (vm, mif);
     315           0 :   lacp_record_default (mif);
     316           0 :   mif->partner.state &= ~LACP_STATE_AGGREGATION;
     317           0 :   mif->actor.state &= ~LACP_STATE_EXPIRED;
     318             : 
     319           0 :   return 0;
     320             : }
     321             : 
     322             : int
     323           0 : lacp_rx_action_defaulted (void *p1, void *p2)
     324             : {
     325           0 :   vlib_main_t *vm = p1;
     326           0 :   member_if_t *mif = p2;
     327             : 
     328           0 :   lacp_stop_timer (&mif->current_while_timer);
     329           0 :   lacp_update_default_selected (vm, mif);
     330           0 :   lacp_record_default (mif);
     331           0 :   mif->actor.state &= ~LACP_STATE_EXPIRED;
     332           0 :   if (mif->last_rx_pkt && vec_len (mif->last_rx_pkt))
     333           0 :     lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     334             :                            LACP_RX_EVENT_PDU_RECEIVED, &mif->rx_state);
     335             : 
     336           0 :   return 0;
     337             : }
     338             : 
     339             : static int
     340          15 : lacp_port_is_moved (vlib_main_t * vm, member_if_t * mif)
     341             : {
     342          15 :   bond_main_t *bm = &bond_main;
     343             :   member_if_t *mif2;
     344          15 :   lacp_pdu_t *lacpdu = (lacp_pdu_t *) mif->last_rx_pkt;
     345             : 
     346             :   /* *INDENT-OFF* */
     347          72 :   pool_foreach (mif2, bm->neighbors) {
     348             :       {
     349          57 :         if ((mif != mif2) && (mif2->rx_state == LACP_RX_STATE_PORT_DISABLED) &&
     350           0 :             !memcmp (mif2->partner.system,
     351           0 :                      lacpdu->partner.port_info.system, 6) &&
     352           0 :             (mif2->partner.port_number == lacpdu->partner.port_info.port_number))
     353           0 :           return 1;
     354             :       }
     355             :   }
     356             :   /* *INDENT-ON* */
     357             : 
     358          15 :   return 0;
     359             : }
     360             : 
     361             : int
     362          15 : lacp_rx_action_current (void *p1, void *p2)
     363             : {
     364          15 :   vlib_main_t *vm = p1;
     365          15 :   member_if_t *mif = p2;
     366             : 
     367          15 :   lacp_update_selected (vm, mif);
     368          15 :   lacp_update_ntt (vm, mif);
     369          15 :   lacp_record_pdu (vm, mif);
     370          15 :   lacp_start_current_while_timer (vm, mif, mif->ttl_in_seconds);
     371          15 :   mif->actor.state &= ~LACP_STATE_EXPIRED;
     372          15 :   if (lacp_port_is_moved (vm, mif))
     373           0 :     lacp_set_port_moved (vm, mif, 1);
     374             : 
     375          15 :   return lacp_selection_logic (vm, mif);
     376             : }
     377             : 
     378             : static u8 *
     379          30 : format_rx_event (u8 * s, va_list * args)
     380             : {
     381             :   static lacp_event_struct lacp_rx_event_array[] = {
     382             : #define _(b, s, n) {.bit = b, .str = #s, },
     383             :     foreach_lacp_rx_event
     384             : #undef _
     385             :     {.str = NULL}
     386             :   };
     387          30 :   int e = va_arg (*args, int);
     388          30 :   lacp_event_struct *event_entry = lacp_rx_event_array;
     389             : 
     390          30 :   if (e >= (sizeof (lacp_rx_event_array) / sizeof (*event_entry)))
     391           0 :     s = format (s, "Bad event %d", e);
     392             :   else
     393          30 :     s = format (s, "%s", event_entry[e].str);
     394             : 
     395          30 :   return s;
     396             : }
     397             : 
     398             : void
     399          30 : lacp_rx_debug_func (member_if_t * mif, int event, int state,
     400             :                     lacp_fsm_state_t * transition)
     401             : {
     402          30 :   vlib_worker_thread_t *w = vlib_worker_threads + os_get_thread_index ();
     403             :   /* *INDENT-OFF* */
     404             :   ELOG_TYPE_DECLARE (e) =
     405             :     {
     406             :       .format = "%s",
     407             :       .format_args = "T4",
     408             :     };
     409             :   /* *INDENT-ON* */
     410             :   struct
     411             :   {
     412             :     u32 event;
     413          30 :   } *ed = 0;
     414             : 
     415          30 :   ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);
     416          30 :   ed->event = elog_string (&vlib_global_main.elog_main, "%U-RX: %U, %U->%U%c",
     417             :                            format_vnet_sw_if_index_name, vnet_get_main (),
     418             :                            mif->sw_if_index, format_rx_event, event,
     419             :                            format_rx_sm_state, state, format_rx_sm_state,
     420             :                            transition->next_state, 0);
     421          30 : }
     422             : 
     423             : void
     424          11 : lacp_init_rx_machine (vlib_main_t * vm, member_if_t * mif)
     425             : {
     426          11 :   lacp_machine_dispatch (&lacp_rx_machine, vm, mif, LACP_RX_EVENT_BEGIN,
     427             :                          &mif->rx_state);
     428          11 :   lacp_machine_dispatch (&lacp_rx_machine, vm, mif,
     429             :                          LACP_RX_EVENT_LACP_ENABLED, &mif->rx_state);
     430          11 : }
     431             : 
     432             : /*
     433             :  * fd.io coding-style-patch-verification: ON
     434             :  *
     435             :  * Local Variables:
     436             :  * eval: (c-set-style "gnu")
     437             :  * End:
     438             :  */

Generated by: LCOV version 1.14