4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai/************************************************************************
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * RSTP library - Rapid Spanning Tree (802.1t, 802.1w)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * Copyright (C) 2001-2003 Optical Access
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * Author: Alex Rozin
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * This file is part of RSTP library.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * RSTP library is free software; you can redistribute it and/or modify it
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * under the terms of the GNU Lesser General Public License as published by the
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * Free Software Foundation; version 2.1
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * RSTP library is distributed in the hope that it will be useful, but
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * WITHOUT ANY WARRANTY; without even the implied warranty of
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * General Public License for more details.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * You should have received a copy of the GNU Lesser General Public License
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * along with RSTP library; see the file COPYING. If not, write to the Free
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai * 02111-1307, USA.
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai **********************************************************************/
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai/* Generic (abstract) state machine : 17.13, 17.14 */
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#include "base.h"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#include "statmch.h"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#include "stp_vectors.h"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#if STP_DBG
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai# include "stpm.h"
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#endif
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTATE_MACH_T *
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTP_state_mach_create (void (*concreteEnterState) (STATE_MACH_T*),
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Bool (*concreteCheckCondition) (STATE_MACH_T*),
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai char *(*concreteGetStatName) (int),
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai void *owner, char *name)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai{
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai STATE_MACH_T *this;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai STP_MALLOC(this, STATE_MACH_T, "state machine");
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->State = BEGIN;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->name = (char*) strdup (name);
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->changeState = False;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#if STP_DBG
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->debug = False;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->ignoreHop2State = BEGIN;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#endif
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->concreteEnterState = concreteEnterState;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->concreteCheckCondition = concreteCheckCondition;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->concreteGetStatName = concreteGetStatName;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->owner.owner = owner;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai return this;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai}
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavaivoid
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTP_state_mach_delete (STATE_MACH_T *this)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai{
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai free (this->name);
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai STP_FREE(this, "state machine");
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai}
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiBool
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTP_check_condition (STATE_MACH_T* this)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai{
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai Bool bret;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai bret = (*(this->concreteCheckCondition)) (this);
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai if (bret) {
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->changeState = True;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai }
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai return bret;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai}
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiBool
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTP_change_state (STATE_MACH_T* this)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai{
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai register int number_of_loops;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai for (number_of_loops = 0; ; number_of_loops++) {
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai if (! this->changeState) break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (*(this->concreteEnterState)) (this);
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->changeState = False;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (void) STP_check_condition (this);
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai }
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai return number_of_loops;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai}
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiBool
4eaa471005973e11a6110b69fe990530b3b95a38Rishi SrivatsavaiSTP_hop_2_state (STATE_MACH_T* this, unsigned int new_state)
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai{
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#ifdef STP_DBG
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai switch (this->debug) {
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai case 0: break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai case 1:
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai if (new_state == this->State || new_state == this->ignoreHop2State) break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai stp_trace ("%-8s(%s-%s): %s=>%s",
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->name,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *this->owner.port->owner->name ? this->owner.port->owner->name : "Glbl",
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->owner.port->port_name,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (*(this->concreteGetStatName)) (this->State),
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (*(this->concreteGetStatName)) (new_state));
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai case 2:
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai if (new_state == this->State) break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai stp_trace ("%s(%s): %s=>%s",
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->name,
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai *this->owner.stpm->name ? this->owner.stpm->name : "Glbl",
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (*(this->concreteGetStatName)) (this->State),
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai (*(this->concreteGetStatName)) (new_state));
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai break;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai }
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai#endif
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->State = new_state;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai this->changeState = True;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai return True;
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai}
4eaa471005973e11a6110b69fe990530b3b95a38Rishi Srivatsavai